liveCuepoint
資源和 liveCuepoints.insert
方法已淘汰,並由 liveBroadcasts.cuepoint
方法取代。
liveCuepoint
資源會在廣播影片串流中插入提示點,這可能會觸發廣告插播。
注意:這個 API 指令實際上是 YouTube Content ID API 的一部分,且與管理 liveBroadcast
和 liveStream
資源的要求不同。
方法
這個 API 支援下列 liveCuepoints
資源的方法:
資源表示法
以下 JSON 結構顯示了 liveCuepoints
資源的格式:
{ "id": string, "kind": "youtubePartner#liveCuepoint", "broadcastId": string, "settings": { "offsetTimeMs": long, "walltime": datetime, "cueType": string, "durationSecs": unsigned integer } }
屬性
下表定義此資源中顯示的屬性:
屬性 | |
---|---|
id |
string YouTube 指派的值來明確識別提示點。 |
kind |
string API 資源類型。對於 liveCuepoint 資源,這個值為 youtubePartner#liveCuepoint 。 |
broadcastId |
string YouTube 指派的 ID,用於識別插入提示點的廣播。 |
settings |
object settings 物件定義提示點的設定。 |
settings.offsetTimeMs |
long 這個值可指定觀眾看到廣告或串流內廣告插入畫面時的時間點。屬性值會識別監控串流開始時的時間偏移 (以毫秒為單位)。雖然是以毫秒為單位進行測量,雖然實際值是預估值,YouTube 會盡可能插入提示點。如果你的廣播沒有監控串流,則不應指定這個參數的值。 這個屬性的預設值是 0 ,表示應盡快插入提示點。如果播送串流未延遲,則 0 也是唯一有效的值。不過,如果您的廣播串流延遲,則屬性值可以指定插入提示點的時間。詳情請參閱入門指南。注意:如果您的廣播階段處於測試階段,系統會從測試開始的時間開始計算偏移量。 |
settings.walltime |
datetime 這個值會指定插入提示點的壁鐘時間。這個值以 ISO 8601 ( YYYY-MM-DDThh:mm:ss.sssZ ) 格式指定。如果要求嘗試插入為這個屬性及 settings.offsetTimeMs 屬性指定值的提示點,API 會傳回錯誤。 |
settings.cueType |
string 提示點的類型。如需不同類型的提示點,請參閱開始使用指南。另請參閱廣播的生命週期文件,瞭解在播送期間插入提示點的最佳做法。 這項屬性的有效值如下:
|
settings.durationSecs |
unsigned integer 提示點的持續時間 (以秒為單位)。如果 cueType 是 ad ,則必須指定這個值,否則系統會忽略此值。 |