LiveBroadcastsApi
extends AbstractApi
in package
This file is generated from spec/discovery.json (YouTube Data API v3, revision 20260924) by tools/generate.php. Do not edit it by hand - run `composer spec:build` instead.
Live broadcasts: scheduling one, binding it to a stream, going live and ending it.
Reach it as $youtube->liveBroadcasts. Every method takes the parameters Google
documents, by the same names: use named arguments for the optional ones.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- bind() : PromiseInterface<string|int, LiveBroadcast>
- Bind a broadcast to a stream.
- delete() : PromiseInterface<string|int, null>
- Delete a given broadcast.
- insert() : PromiseInterface<string|int, LiveBroadcast>
- Inserts a new stream for the authenticated user.
- insertCuepoint() : PromiseInterface<string|int, Cuepoint>
- Insert cuepoints in a broadcast
- list() : PromiseInterface<string|int, LiveBroadcastListResponse>
- Retrieve the list of broadcasts associated with the given channel.
- transition() : PromiseInterface<string|int, LiveBroadcast>
- Transition a broadcast to a given status.
- update() : PromiseInterface<string|int, LiveBroadcast>
- Updates an existing broadcast for the authenticated user.
- call() : PromiseInterface<string|int, mixed>
- streamed() : PromiseInterface<string|int, ResponseStream>
- Opens a server-streamed call and reads its body as it arrives.
Properties
$youtube read-only
protected
YouTube
$youtube
Methods
__construct()
public
__construct(YouTube $youtube) : mixed
Parameters
- $youtube : YouTube
bind()
Bind a broadcast to a stream.
public
bind(string $id, array<int, string>|string $part[, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ][, string|null $streamId = null ]) : PromiseInterface<string|int, LiveBroadcast>
Costs 50 units of quota.
Parameters
- $id : string
-
Broadcast to bind to the stream
- $part : array<int, string>|string
-
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.
- $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
- $streamId : string|null = null
-
Stream to bind, if not set unbind the current one.
Tags
Return values
PromiseInterface<string|int, LiveBroadcast>delete()
Delete a given broadcast.
public
delete(string $id[, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ]) : PromiseInterface<string|int, null>
Costs 50 units of quota.
Parameters
- $id : string
-
Broadcast to delete.
- $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, null>insert()
Inserts a new stream for the authenticated user.
public
insert(array<int, string>|string $part, LiveBroadcast|array<string, mixed> $body[, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ]) : PromiseInterface<string|int, LiveBroadcast>
Costs 50 units of quota.
Parameters
- $part : array<int, string>|string
-
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.
- $body : LiveBroadcast|array<string, mixed>
-
The LiveBroadcast to send.
- $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, LiveBroadcast>insertCuepoint()
Insert cuepoints in a broadcast
public
insertCuepoint(Cuepoint|array<string, mixed> $body[, string|null $id = null ][, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ][, array<int, string>|string|null $part = null ]) : PromiseInterface<string|int, Cuepoint>
Costs 50 units of quota.
Parameters
- $body : Cuepoint|array<string, mixed>
-
The Cuepoint to send.
- $id : string|null = null
-
Broadcast to insert ads to, or equivalently
external_video_idfor internal use. - $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
- $part : array<int, string>|string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, Cuepoint>list()
Retrieve the list of broadcasts associated with the given channel.
public
list(array<int, string>|string $part[, string|null $broadcastStatus = null ][, string|null $broadcastType = null ][, array<int, string>|string|null $id = null ][, int|null $maxResults = null ][, bool|null $mine = null ][, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ][, string|null $pageToken = null ]) : PromiseInterface<string|int, LiveBroadcastListResponse>
Costs 1 unit of quota.
Parameters
- $part : array<int, string>|string
-
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.
- $broadcastStatus : string|null = null
-
Return broadcasts with a certain status, e.g. active broadcasts. One of
broadcastStatusFilterUnspecified,all,active,upcoming,completed. - $broadcastType : string|null = null
-
Return only broadcasts with the selected type. One of
broadcastTypeFilterUnspecified,all,event,persistent. YouTube assumeseventwhen it is left out. - $id : array<int, string>|string|null = null
-
Return broadcasts with the given ids from Stubby or Apiary.
- $maxResults : int|null = null
-
The maxResults parameter specifies the maximum number of items that should be returned in the result set. From 0 to 50. YouTube assumes
5when it is left out. - $mine : bool|null = null
- $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
- $pageToken : string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, LiveBroadcastListResponse>transition()
Transition a broadcast to a given status.
public
transition(string $broadcastStatus, string $id, array<int, string>|string $part[, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ]) : PromiseInterface<string|int, LiveBroadcast>
Costs 50 units of quota.
Parameters
- $broadcastStatus : string
-
The status to which the broadcast is going to transition. One of
statusUnspecified,testing,live,complete. - $id : string
-
Broadcast to transition.
- $part : array<int, string>|string
-
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.
- $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, LiveBroadcast>update()
Updates an existing broadcast for the authenticated user.
public
update(array<int, string>|string $part, LiveBroadcast|array<string, mixed> $body[, string|null $onBehalfOfContentOwner = null ][, string|null $onBehalfOfContentOwnerChannel = null ]) : PromiseInterface<string|int, LiveBroadcast>
Costs 50 units of quota.
Parameters
- $part : array<int, string>|string
-
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.
- $body : LiveBroadcast|array<string, mixed>
-
The LiveBroadcast to send.
- $onBehalfOfContentOwner : string|null = null
-
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.
- $onBehalfOfContentOwnerChannel : string|null = null
-
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.
Tags
Return values
PromiseInterface<string|int, LiveBroadcast>call()
protected
call(string $endpoint, string $method, string $path[, array<string, mixed> $query = [] ][, array<string, mixed>|JsonSerializable|null $body = null ][, string|null $returns = null ][, ?Media $media = null ][, ?string $uploadPath = null ][, bool $download = false ]) : PromiseInterface<string|int, mixed>
Parameters
- $endpoint : string
-
The API method, e.g.
liveChatMessages.list. - $method : string
- $path : string
- $query : array<string, mixed> = []
- $body : array<string, mixed>|JsonSerializable|null = null
- $returns : string|null = null
-
The type token the result hydrates as; null leaves it raw.
- $media : ?Media = null
- $uploadPath : ?string = null
- $download : bool = false
Return values
PromiseInterface<string|int, mixed>streamed()
Opens a server-streamed call and reads its body as it arrives.
protected
streamed(string $endpoint, string $path, array<string, mixed> $query, string $returns) : PromiseInterface<string|int, ResponseStream>
Parameters
- $endpoint : string
- $path : string
- $query : array<string, mixed>
- $returns : string
-
The type token each element hydrates as.