Class Google_Service_YouTube_LiveBroadcasts_Resource
The "liveBroadcasts" collection of methods. Typical usage is:
$youtubeService = new Google_Service_YouTube(...); $liveBroadcasts = $youtubeService->liveBroadcasts;
- Google_Service_Resource
- Google_Service_YouTube_LiveBroadcasts_Resource
public
|
#
bind( string $id, string $part, array $optParams = array() )
Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. (liveBroadcasts.bind) Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. (liveBroadcasts.bind) Parameters
ReturnsOpt_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.
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. string streamId The streamId parameter specifies the unique ID of the video stream that is being bound to a broadcast. If this parameter is omitted, the API will remove any existing binding between the broadcast and a video stream. |
public
|
#
control( string $id, string $part, array $optParams = array() )
Controls the settings for a slate that can be displayed in the broadcast stream. (liveBroadcasts.control) Controls the settings for a slate that can be displayed in the broadcast stream. (liveBroadcasts.control) Parameters
ReturnsOpt_param
bool displaySlate The displaySlate parameter specifies whether the slate is
being enabled or disabled.
string offsetTimeMs The offsetTimeMs parameter specifies a positive time offset when the specified slate change will occur. The value is measured in milliseconds from the beginning of the broadcast's monitor stream, which is the time that the testing phase for the broadcast began. Even though it is specified in milliseconds, the value is actually an approximation, and YouTube completes the requested action as closely as possible to that time. If you do not specify a value for this parameter, then YouTube performs the action as soon as possible. See the Getting started guide for more details. Important: You should only specify a value for this parameter if your broadcast stream is delayed. 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. 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. string walltime The walltime parameter specifies the wall clock time at which the specified slate change will occur. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sssZ) format. |
public
|
#
delete( string $id, array $optParams = array() )
Deletes a broadcast. (liveBroadcasts.delete) Deletes a broadcast. (liveBroadcasts.delete) 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.
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
|
#
insert( string $part,
Creates a broadcast. (liveBroadcasts.insert) Creates a broadcast. (liveBroadcasts.insert) Parameters
ReturnsOpt_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.
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
|
#
listLiveBroadcasts( string $part, array $optParams = array() )
Returns a list of YouTube broadcasts that match the API request parameters. (liveBroadcasts.listLiveBroadcasts) Returns a list of YouTube broadcasts that match the API request parameters. (liveBroadcasts.listLiveBroadcasts) Parameters
ReturnsOpt_param
string broadcastStatus The broadcastStatus parameter filters the API response to
only include broadcasts with the specified status.
string broadcastType The broadcastType parameter filters the API response to only include broadcasts with the specified type. This is only compatible with the mine filter for now. string id The id parameter specifies a comma-separated list of YouTube broadcast IDs that identify the broadcasts being retrieved. In a liveBroadcast resource, the id property specifies the broadcast's ID. string maxResults The maxResults parameter specifies the maximum number of items that should be returned in the result set. bool mine The mine parameter can be used to instruct the API to only return broadcasts owned by the authenticated user. Set the parameter value to true to only retrieve your own broadcasts. 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. 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. 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. |
public
|
#
transition( string $broadcastStatus, string $id, string $part, array $optParams = array() )
Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. (liveBroadcasts.transition) Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. (liveBroadcasts.transition) Parameters
ReturnsOpt_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.
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
|
#
update( string $part,
Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. (liveBroadcasts.update) Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. (liveBroadcasts.update) Parameters
ReturnsOpt_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.
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. |