變更 YouTube 直播的狀態,並啟動與新狀態相關的任何程序。舉例來說,當你將直播狀態切換為 testing
時,YouTube 就會開始將影片傳送至該直播的監控串流。呼叫此方法前,請確認與廣播綁定的串流 status.streamStatus
屬性值為 active
。
常見用途
要求
HTTP 要求
POST https://www.googleapis.com/youtube/v3/liveBroadcasts/transition
授權
這項要求需要至少具備下列其中一個範圍的授權。如要進一步瞭解驗證和授權,請參閱「實作 OAuth 2.0 驗證」。
範圍 |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
broadcastStatus |
string broadcastStatus 參數會指出廣播變更的狀態。請注意,如要將廣播轉換為 testing 或 live 狀態,廣播所繫結的串流 status.streamStatus 必須為 active 。可接受的值如下:
|
|
id |
string id 參數會指定轉換為其他狀態的廣播專屬 ID。 |
|
part |
string part 參數會指定以半形逗號分隔的清單,其中包含 API 回應會包含的一或多個 liveBroadcast 資源屬性。您可以在參數值中加入的 part 名稱為 id 、snippet 、contentDetails 和 status 。 |
|
選用參數 | ||
onBehalfOfContentOwner |
string 這個參數只能用於適當的授權要求。 注意:這個參數僅供 YouTube 內容合作夥伴使用。 onBehalfOfContentOwner 參數表示要求的授權憑證可識別 YouTube CMS 使用者,該使用者會代表參數值中指定的內容擁有者行事。這個參數適用於擁有及管理多個 YouTube 頻道的 YouTube 內容合作夥伴。這項功能可讓內容擁有者驗證一次,即可存取所有影片和頻道資料,不必為每個頻道提供驗證憑證。使用者驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。 |
|
onBehalfOfContentOwnerChannel |
string 這個參數只能用於已授權的請求。 注意:這個參數僅供 YouTube 內容合作夥伴使用。 onBehalfOfContentOwnerChannel 參數會指定要新增影片的 YouTube 頻道 ID。當要求指定 onBehalfOfContentOwner 參數的值時,就必須使用這個參數,且只能與該參數搭配使用。此外,要求必須使用與 onBehalfOfContentOwner 參數指定內容擁有者相關聯的 CMS 帳戶授權。最後,onBehalfOfContentOwnerChannel 參數值指定的頻道必須連結至 onBehalfOfContentOwner 參數指定的內容擁有者。這個參數適用於擁有及管理多個 YouTube 頻道的 YouTube 內容合作夥伴。這項功能可讓內容擁有者驗證一次,並代表參數值中指定的管道執行動作,而不必為每個管道分別提供驗證憑證。 |
要求主體
呼叫此方法時,請勿提供要求主體。
回應
如果成功,這個方法會在回應內文中傳回 liveBroadcast 資源。
錯誤
下表列出 API 在回應對此方法的呼叫時可能傳回的錯誤訊息。詳情請參閱「YouTube Live Streaming API - Errors」。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
backendError |
errorExecutingTransition |
變更廣播狀態時發生錯誤。 |
forbidden (403) |
errorStreamInactive |
如果與廣播活動繫結的串流處於停用狀態,系統就不會允許要求的轉換。 |
forbidden (403) |
invalidTransition |
直播無法從目前狀態轉換為要求的狀態。 |
forbidden (403) |
redundantTransition |
直播已處於要求的狀態,或正在處理要求的狀態。 |
insufficientPermissions |
insufficientLivePermissions |
要求未獲授權,無法轉換直播。 |
insufficientPermissions |
livePermissionBlocked |
授權要求的使用者目前無法在 YouTube 上進行直播。如要進一步瞭解使用者無法串流直播影片的原因,請參閱「功能使用資格」一節,瞭解使用者的頻道設定。 |
insufficientPermissions |
liveStreamingNotEnabled |
授權要求的使用者無法在 YouTube 上進行直播。詳情請參閱「功能資格條件」。 |
notFound (404) |
liveBroadcastNotFound |
id 參數指定的廣播不存在。 |
rateLimitExceeded (403) |
userRequestsExceedRateLimit |
使用者在特定時間範圍內傳送過多要求。 |
required (400) |
idRequired |
必要的 id 參數必須指出要轉換狀態的廣播。 |
required (400) |
statusRequired |
API 要求必須指定 status 參數的值。 |
試試看!
使用 APIs Explorer 呼叫此 API,並查看 API 要求和回應。