1. class
  2. Google
  3. \
  4. Service
  5. \
  6. YouTube
  7. \
  8. Resource
  9. \
  10. LiveBroadcasts

LiveBroadcasts

class LiveBroadcasts extends Resource (View source)

The "liveBroadcasts" collection of methods.

Typical usage is:

 $youtubeService = new Google\Service\YouTube(...);
 $liveBroadcasts = $youtubeService->liveBroadcasts;

Methods

LiveBroadcast
bind(string $id, string|array $part, array $optParams = [])

Bind a broadcast to a stream. (liveBroadcasts.bind)

delete(string $id, array $optParams = [])

Delete a given broadcast. (liveBroadcasts.delete)

LiveBroadcast
insert(string|array $part, LiveBroadcast $postBody, array $optParams = [])

Inserts a new stream for the authenticated user. (liveBroadcasts.insert)

Cuepoint
insertCuepoint(Cuepoint $postBody, array $optParams = [])

Insert cuepoints in a broadcast (liveBroadcasts.insertCuepoint)

LiveBroadcastListResponse
listLiveBroadcasts(string|array $part, array $optParams = [])

Retrieve the list of broadcasts associated with the given channel.

LiveBroadcast
transition(string $broadcastStatus, string $id, string|array $part, array $optParams = [])

Transition a broadcast to a given status. (liveBroadcasts.transition)

LiveBroadcast
update(string|array $part, LiveBroadcast $postBody, array $optParams = [])

Updates an existing broadcast for the authenticated user.

Details

at line 74
LiveBroadcast bind(string $id, string|array $part, array $optParams = [])

Bind a broadcast to a stream. (liveBroadcasts.bind)

Parameters

string $id

Broadcast to bind to the stream
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.
array $optParams

Optional parameters.

Return Value

LiveBroadcast

Exceptions

Exception

at line 114
delete(string $id, array $optParams = [])

Delete a given broadcast. (liveBroadcasts.delete)

Parameters

string $id

Broadcast to delete.
array $optParams

Optional parameters.

Exceptions

Exception

at line 160
LiveBroadcast insert(string|array $part, LiveBroadcast $postBody, array $optParams = [])

Inserts a new stream for the authenticated user. (liveBroadcasts.insert)

Parameters

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.
LiveBroadcast $postBody
array $optParams

Optional parameters.

Return Value

LiveBroadcast

Exceptions

Exception

at line 207
Cuepoint insertCuepoint(Cuepoint $postBody, array $optParams = [])

Insert cuepoints in a broadcast (liveBroadcasts.insertCuepoint)

Parameters

Cuepoint $postBody
array $optParams

Optional parameters.

Return Value

Cuepoint

Exceptions

Exception

at line 265
LiveBroadcastListResponse listLiveBroadcasts(string|array $part, array $optParams = [])

Retrieve the list of broadcasts associated with the given channel.

(liveBroadcasts.listLiveBroadcasts)

Parameters

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.
array $optParams

Optional parameters.

Return Value

LiveBroadcastListResponse

Exceptions

Exception

at line 312
LiveBroadcast transition(string $broadcastStatus, string $id, string|array $part, array $optParams = [])

Transition a broadcast to a given status. (liveBroadcasts.transition)

Parameters

string $broadcastStatus

The status to which the broadcast is going to transition.
string $id

Broadcast to transition.
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.
array $optParams

Optional parameters.

Return Value

LiveBroadcast

Exceptions

Exception

at line 367
LiveBroadcast update(string|array $part, LiveBroadcast $postBody, array $optParams = [])

Updates an existing broadcast for the authenticated user.

(liveBroadcasts.update)

Parameters

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.
LiveBroadcast $postBody
array $optParams

Optional parameters.

Return Value

LiveBroadcast

Exceptions

Exception