The liveCuepoint
resource and the liveCuepoints.insert
method have been deprecated and replaced by the liveBroadcasts.cuepoint
method.
A liveCuepoint
resource inserts a cuepoint in the broadcast video
stream, which might trigger an ad break.
Note:This API command is
actually part of the YouTube Content ID API and has different authorization requirements than
requests to manage liveBroadcast
and liveStream
resources.
Methods
The API supports the following methods for liveCuepoints
resources:
- insert
- Inserts a cuepoint into a live broadcast. Currently, requests to this method must be authorized by an account associated with a YouTube Content Owner. Try it now .
Resource representation
The following JSON structure shows the format of a liveCuepoints
resource:
{ " id ": string , " kind ": "youtubePartner#liveCuepoint", " broadcastId ": string , " settings ": { " offsetTimeMs ": long , " walltime ": datetime , " cueType ": string , " durationSecs ": unsigned integer } }
Properties
The following table defines the properties that appear in this resource:
Properties
id
string
A value that YouTube assigns to uniquely identify the cuepoint.
kind
string
The type of the API resource. For
liveCuepoint
resources, the value is youtubePartner#liveCuepoint
.broadcastId
string
The ID that YouTube assigns to uniquely identify the broadcast into which the cuepoint is being inserted.
settings
object
The
settings
object defines the cuepoint's settings. settings.
offsetTimeMs
long
This value specifies a point in time in the video when viewers should see an ad or in-stream slate . The property value identifies a time offset, in milliseconds, from the beginning of the monitor stream. Though measured in milliseconds, the value is actually an approximation, and YouTube will insert the cuepoint as closely as possible to that time. You should not specify a value for this parameter if your broadcast does not have a monitor stream.
This property's default value is
0
, which indicates that the cuepoint should be inserted as soon as possible. If your broadcast stream is not delayed, then 0
is also the only valid value. However, if your broadcast stream is delayed, then the property value can specify the time when the cuepoint should be inserted. See the Getting started
guide for more details.Note:If your broadcast had a testing phase, the offset is measured from the time that the testing phase began.
settings.
walltime
datetime
This value specifies the wall clock time at which the cuepoint should be inserted. The value is specified in ISO 8601 (
YYYY-MM-DDThh:mm:ss.sssZ
) format.The API returns an error if a request tries to insert a cuepoint that specifies a value for this property and for the
settings.offsetTimeMs
property. settings.
cueType
string
The cuepoint's type. See the Getting started guide for an explanation of the different types of cuepoints. Also see the Life of a broadcast document for best practices about inserting cuepoints during your broadcast.
Valid values for this property are:
-
ad
settings.
durationSecs
unsigned integer
The cuepoint's duration, in seconds. This value must be specified if the
cueType
is ad
and is ignored otherwise.