Server : Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.4.20 System : Linux st2.domain.com 3.10.0-1127.10.1.el7.x86_64 #1 SMP Wed Jun 3 14:28:03 UTC 2020 x86_64 User : apache ( 48) PHP Version : 7.4.20 Disable Function : NONE Directory : /var/www/html/netphim/vendor/google/apiclient-services/src/YouTube/Resource/ |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\YouTube\Resource;
use Google\Service\YouTube\Cuepoint;
use Google\Service\YouTube\LiveBroadcast;
use Google\Service\YouTube\LiveBroadcastListResponse;
/**
* The "liveBroadcasts" collection of methods.
* Typical usage is:
* <code>
* $youtubeService = new Google\Service\YouTube(...);
* $liveBroadcasts = $youtubeService->liveBroadcasts;
* </code>
*/
class LiveBroadcasts extends \Google\Service\Resource
{
/**
* Bind a broadcast to a stream. (liveBroadcasts.bind)
*
* @param string $id Broadcast to bind to the stream
* @param string|array $part The *part* parameter specifies a comma-separated
* list of one or more liveBroadcast resource properties that the API response
* will include. The part names that you can include in the parameter value are
* id, snippet, contentDetails, and status.
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
* used in a properly authorized request. *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
* parameter specifies the YouTube channel ID of the channel to which a video is
* being added. This parameter is required when a request specifies a value for
* the onBehalfOfContentOwner parameter, and it can only be used in conjunction
* with that parameter. In addition, the request must be authorized using a CMS
* account that is linked to the content owner that the onBehalfOfContentOwner
* parameter specifies. Finally, the channel that the
* onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
* content owner that the onBehalfOfContentOwner parameter specifies. This
* parameter is intended for YouTube content partners that own and manage many
* different YouTube channels. It allows content owners to authenticate once and
* perform actions on behalf of the channel specified in the parameter value,
* without having to provide authentication credentials for each separate
* channel.
* @opt_param string streamId Stream to bind, if not set unbind the current one.
* @return LiveBroadcast
*/
public function bind($id, $part, $optParams = [])
{
$params = ['id' => $id, 'part' => $part];
$params = array_merge($params, $optParams);
return $this->call('bind', [$params], LiveBroadcast::class);
}
/**
* Delete a given broadcast. (liveBroadcasts.delete)
*
* @param string $id Broadcast to delete.
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
* used in a properly authorized request. *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
* parameter specifies the YouTube channel ID of the channel to which a video is
* being added. This parameter is required when a request specifies a value for
* the onBehalfOfContentOwner parameter, and it can only be used in conjunction
* with that parameter. In addition, the request must be authorized using a CMS
* account that is linked to the content owner that the onBehalfOfContentOwner
* parameter specifies. Finally, the channel that the
* onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
* content owner that the onBehalfOfContentOwner parameter specifies. This
* parameter is intended for YouTube content partners that own and manage many
* different YouTube channels. It allows content owners to authenticate once and
* perform actions on behalf of the channel specified in the parameter value,
* without having to provide authentication credentials for each separate
* channel.
*/
public function delete($id, $optParams = [])
{
$params = ['id' => $id];
$params = array_merge($params, $optParams);
return $this->call('delete', [$params]);
}
/**
* Inserts a new stream for the authenticated user. (liveBroadcasts.insert)
*
* @param string|array $part The *part* parameter serves two purposes in this
* operation. It identifies the properties that the write operation will set as
* well as the properties that the API response will include. The part
* properties that you can include in the parameter value are id, snippet,
* contentDetails, and status.
* @param LiveBroadcast $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
* used in a properly authorized request. *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
* parameter specifies the YouTube channel ID of the channel to which a video is
* being added. This parameter is required when a request specifies a value for
* the onBehalfOfContentOwner parameter, and it can only be used in conjunction
* with that parameter. In addition, the request must be authorized using a CMS
* account that is linked to the content owner that the onBehalfOfContentOwner
* parameter specifies. Finally, the channel that the
* onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
* content owner that the onBehalfOfContentOwner parameter specifies. This
* parameter is intended for YouTube content partners that own and manage many
* different YouTube channels. It allows content owners to authenticate once and
* perform actions on behalf of the channel specified in the parameter value,
* without having to provide authentication credentials for each separate
* channel.
* @return LiveBroadcast
*/
public function insert($part, LiveBroadcast $postBody, $optParams = [])
{
$params = ['part' => $part, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insert', [$params], LiveBroadcast::class);
}
/**
* Insert cuepoints in a broadcast (liveBroadcasts.insertCuepoint)
*
* @param Cuepoint $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string id Broadcast to insert ads to, or equivalently
* `external_video_id` for internal use.
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
* used in a properly authorized request. *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
* parameter specifies the YouTube channel ID of the channel to which a video is
* being added. This parameter is required when a request specifies a value for
* the onBehalfOfContentOwner parameter, and it can only be used in conjunction
* with that parameter. In addition, the request must be authorized using a CMS
* account that is linked to the content owner that the onBehalfOfContentOwner
* parameter specifies. Finally, the channel that the
* onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
* content owner that the onBehalfOfContentOwner parameter specifies. This
* parameter is intended for YouTube content partners that own and manage many
* different YouTube channels. It allows content owners to authenticate once and
* perform actions on behalf of the channel specified in the parameter value,
* without having to provide authentication credentials for each separate
* channel.
* @opt_param string part The *part* parameter specifies a comma-separated list
* of one or more liveBroadcast resource properties that the API response will
* include. The part names that you can include in the parameter value are id,
* snippet, contentDetails, and status.
* @return Cuepoint
*/
public function insertCuepoint(Cuepoint $postBody, $optParams = [])
{
$params = ['postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('insertCuepoint', [$params], Cuepoint::class);
}
/**
* Retrieve the list of broadcasts associated with the given channel.
* (liveBroadcasts.listLiveBroadcasts)
*
* @param string|array $part The *part* parameter specifies a comma-separated
* list of one or more liveBroadcast resource properties that the API response
* will include. The part names that you can include in the parameter value are
* id, snippet, contentDetails, status and statistics.
* @param array $optParams Optional parameters.
*
* @opt_param string broadcastStatus Return broadcasts with a certain status,
* e.g. active broadcasts.
* @opt_param string broadcastType Return only broadcasts with the selected
* type.
* @opt_param string id Return broadcasts with the given ids from Stubby or
* Apiary.
* @opt_param string maxResults The *maxResults* parameter specifies the maximum
* number of items that should be returned in the result set.
* @opt_param bool mine
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
* used in a properly authorized request. *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
* parameter specifies the YouTube channel ID of the channel to which a video is
* being added. This parameter is required when a request specifies a value for
* the onBehalfOfContentOwner parameter, and it can only be used in conjunction
* with that parameter. In addition, the request must be authorized using a CMS
* account that is linked to the content owner that the onBehalfOfContentOwner
* parameter specifies. Finally, the channel that the
* onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
* content owner that the onBehalfOfContentOwner parameter specifies. This
* parameter is intended for YouTube content partners that own and manage many
* different YouTube channels. It allows content owners to authenticate once and
* perform actions on behalf of the channel specified in the parameter value,
* without having to provide authentication credentials for each separate
* channel.
* @opt_param string pageToken The *pageToken* parameter identifies a specific
* page in the result set that should be returned. In an API response, the
* nextPageToken and prevPageToken properties identify other pages that could be
* retrieved.
* @return LiveBroadcastListResponse
*/
public function listLiveBroadcasts($part, $optParams = [])
{
$params = ['part' => $part];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], LiveBroadcastListResponse::class);
}
/**
* Transition a broadcast to a given status. (liveBroadcasts.transition)
*
* @param string $broadcastStatus The status to which the broadcast is going to
* transition.
* @param string $id Broadcast to transition.
* @param string|array $part The *part* parameter specifies a comma-separated
* list of one or more liveBroadcast resource properties that the API response
* will include. The part names that you can include in the parameter value are
* id, snippet, contentDetails, and status.
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
* used in a properly authorized request. *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
* parameter specifies the YouTube channel ID of the channel to which a video is
* being added. This parameter is required when a request specifies a value for
* the onBehalfOfContentOwner parameter, and it can only be used in conjunction
* with that parameter. In addition, the request must be authorized using a CMS
* account that is linked to the content owner that the onBehalfOfContentOwner
* parameter specifies. Finally, the channel that the
* onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
* content owner that the onBehalfOfContentOwner parameter specifies. This
* parameter is intended for YouTube content partners that own and manage many
* different YouTube channels. It allows content owners to authenticate once and
* perform actions on behalf of the channel specified in the parameter value,
* without having to provide authentication credentials for each separate
* channel.
* @return LiveBroadcast
*/
public function transition($broadcastStatus, $id, $part, $optParams = [])
{
$params = ['broadcastStatus' => $broadcastStatus, 'id' => $id, 'part' => $part];
$params = array_merge($params, $optParams);
return $this->call('transition', [$params], LiveBroadcast::class);
}
/**
* Updates an existing broadcast for the authenticated user.
* (liveBroadcasts.update)
*
* @param string|array $part The *part* parameter serves two purposes in this
* operation. It identifies the properties that the write operation will set as
* well as the properties that the API response will include. The part
* properties that you can include in the parameter value are id, snippet,
* contentDetails, and status. Note that this method will override the existing
* values for all of the mutable properties that are contained in any parts that
* the parameter value specifies. For example, a broadcast's privacy status is
* defined in the status part. As such, if your request is updating a private or
* unlisted broadcast, and the request's part parameter value includes the
* status part, the broadcast's privacy setting will be updated to whatever
* value the request body specifies. If the request body does not specify a
* value, the existing privacy setting will be removed and the broadcast will
* revert to the default privacy setting.
* @param LiveBroadcast $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string onBehalfOfContentOwner *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwner*
* parameter indicates that the request's authorization credentials identify a
* YouTube CMS user who is acting on behalf of the content owner specified in
* the parameter value. This parameter is intended for YouTube content partners
* that own and manage many different YouTube channels. It allows content owners
* to authenticate once and get access to all their video and channel data,
* without having to provide authentication credentials for each individual
* channel. The CMS account that the user authenticates with must be linked to
* the specified YouTube content owner.
* @opt_param string onBehalfOfContentOwnerChannel This parameter can only be
* used in a properly authorized request. *Note:* This parameter is intended
* exclusively for YouTube content partners. The *onBehalfOfContentOwnerChannel*
* parameter specifies the YouTube channel ID of the channel to which a video is
* being added. This parameter is required when a request specifies a value for
* the onBehalfOfContentOwner parameter, and it can only be used in conjunction
* with that parameter. In addition, the request must be authorized using a CMS
* account that is linked to the content owner that the onBehalfOfContentOwner
* parameter specifies. Finally, the channel that the
* onBehalfOfContentOwnerChannel parameter value specifies must be linked to the
* content owner that the onBehalfOfContentOwner parameter specifies. This
* parameter is intended for YouTube content partners that own and manage many
* different YouTube channels. It allows content owners to authenticate once and
* perform actions on behalf of the channel specified in the parameter value,
* without having to provide authentication credentials for each separate
* channel.
* @return LiveBroadcast
*/
public function update($part, LiveBroadcast $postBody, $optParams = [])
{
$params = ['part' => $part, 'postBody' => $postBody];
$params = array_merge($params, $optParams);
return $this->call('update', [$params], LiveBroadcast::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(LiveBroadcasts::class, 'Google_Service_YouTube_Resource_LiveBroadcasts');