更新影片串流。如果無法變更要變更的屬性,就必須使用適當的設定來建立新串流。
常見用途
要求
HTTP 要求
PUT https://www.googleapis.com/youtube/v3/liveStreams
授權
這項要求需要至少下列其中一個範圍的授權 (進一步瞭解驗證和授權)。
內容範圍 |
---|
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 回應此方法時可能傳回的錯誤訊息。詳情請參閱錯誤訊息的說明文件。
錯誤類型 | 錯誤詳細資料 | 說明 |
---|---|---|
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 即時影像串流。使用者可以前往 https://www.youtube.com/features 瞭解更多資訊。 |
invalidValue (400) |
invalidDescription |
liveStream 資源中的 snippet.description 屬性值最多可包含 10,000 個字元。 |
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 要求和回應。