更新影片串流。如果無法更新要變更的屬性,則必須建立新的串流並設定正確的選項。
常見用途
要求
HTTP 要求
PUT https://www.googleapis.com/youtube/v3/liveStreams
授權
這項要求需要至少具備下列其中一個範圍的授權。如要進一步瞭解驗證和授權,請參閱「實作 OAuth 2.0 授權」。
範圍 |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
參數
下表列出這項查詢支援的參數。列出的所有參數都是查詢參數。
參數 | ||
---|---|---|
必要參數 | ||
part |
string part 參數在這項作業中具有兩個用途。它會指出寫入作業將設定的屬性,以及 API 回應將納入的屬性。您可以在參數值中納入的 part 屬性包括 id 、snippet 、cdn 和 status 。請注意,這個方法會覆寫參數值所指定的任何部分中包含的所有可變更屬性現有值。如果要求主體未指定可變動屬性的值,系統會移除該屬性的現有值。 |
|
選用參數 | ||
onBehalfOfContentOwner |
string 這個參數只能用於適當的授權要求。 注意:這個參數僅供 YouTube 內容合作夥伴使用。 onBehalfOfContentOwner 參數表示要求的授權憑證可識別 YouTube CMS 使用者,該使用者會代表參數值中指定的內容擁有者行事。這個參數適用於擁有及管理多個 YouTube 頻道的 YouTube 內容合作夥伴。這項功能可讓內容擁有者驗證一次,即可存取所有影片和頻道資料,不必為每個頻道提供驗證憑證。使用者驗證的 CMS 帳戶必須連結至指定的 YouTube 內容擁有者。 |
|
onBehalfOfContentOwnerChannel |
string 這個參數只能用於已授權的請求。 注意:這個參數僅供 YouTube 內容合作夥伴使用。 onBehalfOfContentOwnerChannel 參數會指定要新增影片的 YouTube 頻道 ID。當要求指定 onBehalfOfContentOwner 參數的值時,就必須使用這個參數,且只能與該參數搭配使用。此外,要求必須使用與 onBehalfOfContentOwner 參數指定內容擁有者相關聯的 CMS 帳戶授權。最後,onBehalfOfContentOwnerChannel 參數值指定的頻道必須連結至 onBehalfOfContentOwner 參數指定的內容擁有者。這個參數適用於擁有及管理多個 YouTube 頻道的 YouTube 內容合作夥伴。這項功能可讓內容擁有者驗證一次,並代表參數值中指定的管道執行動作,而不必為每個管道分別提供驗證憑證。 |
要求主體
在要求主體中提供 liveStream 資源。針對該資源:
-
您必須為下列屬性指定值:
id
snippet.title
cdn.frameRate
cdn.ingestionType
cdn.resolution
-
您可以為這些屬性設定值:
snippet.title
snippet.description
如果您提交更新要求,但未為已設有值的屬性指定值,則系統會刪除該屬性現有的值。
回應
如果成功的話,這個方法會在回應內文中傳回 liveStream 資源。
錯誤
下表列出 API 在回應對此方法的呼叫時可能傳回的錯誤訊息。詳情請參閱「YouTube Live Streaming API - Errors」。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
forbidden (403) |
liveStreamModificationNotAllowed |
無法在指定直播的目前狀態下修改。詳情請參閱「廣播的生命週期」。 |
forbidden (403) |
liveStreamModificationNotAllowed |
建立串流後,API 不允許您變更 cdn.format 、cdn.frameRate 、cdn.ingestionType 或 cdn.resolution 欄位的值。 |
forbidden (403) |
liveStreamModificationNotAllowed |
API 不允許您將可重複使用的串流變更為不可重複使用的串流,反之亦然。詳情請參閱「瞭解廣播和串流」。 |
insufficientPermissions |
insufficientLivePermissions |
要求沒有更新指定直播的權限。詳情請參閱「實作 OAuth2 驗證」。 |
insufficientPermissions |
liveStreamingNotEnabled |
授權要求的使用者無法在 YouTube 上進行直播。使用者可以參閱「功能使用資格」進一步瞭解相關資訊。 |
invalidValue (400) |
invalidDescription |
liveStream 資源中的 snippet.description 屬性值最多可包含 10000 個字元。 |
invalidValue (400) |
invalidTitle |
liveStream 資源中的 snippet.title 屬性值長度必須介於 1 至 128 個半形字元之間。 |
notFound (404) |
liveStreamNotFound |
指定的直播不存在。 |
required (400) |
idRequired |
liveStream 資源必須指定 id 屬性的值。 |
required (400) |
ingestionTypeRequired |
liveStream 資源必須指定 cdn.ingestionType 屬性的值。 |
required (400) |
titleRequired |
liveStream 資源必須指定 snippet.title 屬性的值。 |
試試看!
使用 APIs Explorer 呼叫這個 API,並查看 API 要求和回應。