REST Resource: liveCuepoints

Resource: LiveCuepoint

A cuepoint resource represents a specific marker at a certain time of the live broadcast, which can trigger a given event, for example, showing an ad or a slate.

JSON representation 
{
  "kind": string,
  "settings": {
    object (CuepointSettings)
  },
  "id": string,
  "broadcastId": string
}
Fields
kind

string

The type of the API resource. For liveCuepoint resources, the value is youtubePartner#liveCuepoint.
settings

object (CuepointSettings)

The settings object defines the cuepoint's settings.
id

string

A value that YouTube assigns to uniquely identify the cuepoint.
broadcastId

string

The ID that YouTube assigns to uniquely identify the broadcast into which the cuepoint is being inserted.

CuepointSettings

A cuepoint settings resource includes all of the detailed settings for a cuepoint.

JSON representation 
{
  "offsetTimeMs": string,
  "cueType": string,
  "durationSecs": integer,
  "walltime": string
}
Fields
offsetTimeMs

string (int64 format)

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.
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.
durationSecs

integer (uint32 format)

The cuepoint's duration, in seconds. This value must be specified if the cueType is ad and is ignored otherwise.
walltime

string

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.

Methods

insert

 Inserts a cuepoint into a live broadcast.