LiveCuepoints: insert

  • This API method for inserting a cuepoint into a live broadcast has been deprecated and is now replaced by the liveBroadcasts.cuepoint method.

  • Using this method requires authorization with the https://www.googleapis.com/auth/youtubepartner scope and being associated with a YouTube Content Owner.

  • The required parameters for this method are channelId, which identifies the channel owning the broadcast, and onBehalfOfContentOwner, which identifies the content owner.

  • The request body must include a liveCuepoint resource with specified values for broadcastId and settings.cueType, and can optionally set settings.offsetTimeMs, settings.walltime, or settings.durationSecs.

  • The API returns a liveCuepoint resource upon success, and an error, such as invalidValue (400) for conflictingTimeFields is returned if there are any errors.

This method has been deprecated and replaced by the liveBroadcasts.cuepoint method.

Inserts a cuepoint into a live broadcast. Currently, requests to this method must be authorized by an account associated with a YouTube Content Owner.

Request

HTTP request

POST https://www.googleapis.com/youtube/partner/v1/liveCuepoints

Authorization

This request requires authorization with at least one of the following scopes (read more about authentication and authorization).

Scope
https://www.googleapis.com/auth/youtubepartner

Parameters

The following table lists the parameters that this query supports. All of the parameters listed are query parameters.

Parameters
Required parameters
channelId string
The channelId parameter identifies the channel that owns the broadcast into which the cuepoint is being inserted.
onBehalfOfContentOwner string
The onBehalfOfContentOwner parameter identifies the content owner that the user is acting on behalf of.

Request body

Provide a liveCuepoint resource in the request body. For that resource:

  • You must specify a value for these properties:

    • broadcastId
    • settings.cueType

  • You can set values for these properties:

    • settings.offsetTimeMs
    • settings.walltime
    • settings.durationSecs

Response

If successful, this method returns a liveCuepoint resource in the response body.

Errors

The following table identifies error messages that the API could return in response to a call to this method. Please see the error message documentation for more detail.

Error type Error detail Description
invalidValue (400) conflictingTimeFields Only one of offsetTimeMs and walltime may be specified.