REST Resource: liveCuepoints
Stay organized with collections
Save and categorize content based on your preferences.
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.
CuepointSettings
A cuepoint settings resource includes all of the detailed settings for a cuepoint.
All rights reserved. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-20 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003eLiveCuepoint resources represent markers in a live broadcast that can trigger events like showing an ad or slate.\u003c/p\u003e\n"],["\u003cp\u003eA LiveCuepoint resource contains a unique ID, a broadcast ID, and settings that define the specific characteristics of the cuepoint.\u003c/p\u003e\n"],["\u003cp\u003eCuepointSettings define detailed aspects of a cuepoint, such as \u003ccode\u003eoffsetTimeMs\u003c/code\u003e for timing, \u003ccode\u003ecueType\u003c/code\u003e to indicate its function, \u003ccode\u003edurationSecs\u003c/code\u003e for ad length, and \u003ccode\u003ewalltime\u003c/code\u003e for a specific clock time.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eoffsetTimeMs\u003c/code\u003e specifies when a cuepoint should be triggered relative to the start of the monitor stream, measured in milliseconds.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003einsert\u003c/code\u003e method allows for adding a new cuepoint to an ongoing live broadcast.\u003c/p\u003e\n"]]],["LiveCuepoints are markers in a live broadcast that trigger events. Each LiveCuepoint has an `id`, `kind`, `broadcastId`, and `settings`. `CuepointSettings` define these settings, including `offsetTimeMs` (time offset from the monitor stream's start), `cueType` (type of cuepoint), `durationSecs` (cuepoint duration in seconds, required for \"ad\" type), and `walltime` (absolute time for cuepoint insertion). The `insert` method is used to add a cuepoint into a live broadcast.\n"],null,["# REST Resource: liveCuepoints\n\n- [Resource: LiveCuepoint](#LiveCuepoint)\n - [JSON representation](#LiveCuepoint.SCHEMA_REPRESENTATION)\n- [CuepointSettings](#CuepointSettings)\n - [JSON representation](#CuepointSettings.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: LiveCuepoint\n----------------------\n\nA 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.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"settings\": { object (/youtube/partner/reference/rest/v1/liveCuepoints#CuepointSettings) }, \"id\": string, \"broadcastId\": string } ``` |\n\n| Fields ||\n|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` The type of the API resource. For `liveCuepoint` resources, the value is `youtubePartner#liveCuepoint`. |\n| `settings` | `object (`[CuepointSettings](/youtube/partner/reference/rest/v1/liveCuepoints#CuepointSettings)`)` The `settings` object defines the cuepoint's settings. |\n| `id` | `string` A value that YouTube assigns to uniquely identify the cuepoint. |\n| `broadcastId` | `string` The ID that YouTube assigns to uniquely identify the broadcast into which the cuepoint is being inserted. |\n\nCuepointSettings\n----------------\n\nA cuepoint settings resource includes all of the detailed settings for a cuepoint.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------|\n| ``` { \"offsetTimeMs\": string, \"cueType\": string, \"durationSecs\": integer, \"walltime\": string } ``` |\n\n| Fields ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `offsetTimeMs` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` This value specifies a point in time in the video when viewers should see an ad or [in-stream slate](/youtube/v3/live/getting-started#Displaying_Slates). 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](/youtube/v3/live/getting-started#Setting_Time_Offsets) guide for more details. **Note:** If your broadcast had a testing phase, the offset is measured from the time that the testing phase began. |\n| `cueType` | `string` The cuepoint's type. See the [Getting started](/youtube/v3/live/getting-started#Inserting_Cuepoints) guide for an explanation of the different types of cuepoints. Also see the [Life of a broadcast](/youtube/v3/live/life-of-a-broadcast#Insert_Cuepoints) document for best practices about inserting cuepoints during your broadcast. |\n| `durationSecs` | `integer (`[uint32](https://developers.google.com/discovery/v1/type-format)` format)` The cuepoint's duration, in seconds. This value must be specified if the [cueType](#cueType) is `ad` and is ignored otherwise. |\n| `walltime` | `string` This value specifies the wall clock time at which the cuepoint should be inserted. The value is specified in [ISO 8601](//www.w3.org/TR/NOTE-datetime) (`YYYY-MM-DDThh:mm:ss.sssZ`) format. |\n\n| Methods ------- ||\n|-----------------------------------------------------------------------|-------------------------------------------|\n| ### [insert](/youtube/partner/reference/rest/v1/liveCuepoints/insert) | Inserts a cuepoint into a live broadcast. |"]]
