本頁說明如何建立及管理 Live Stream API 頻道活動。頻道活動是頻道的子資源。您可以使用管道事件對管道資源執行作業,不必停止管道。
設定 Google Cloud 專案和驗證
如果您尚未建立Google Cloud 專案和憑證,請參閱「事前準備」一節。必要條件
建立頻道活動前,請先建立下列資源:
建立頻道活動
建立頻道活動前,請務必啟動頻道。
如要建立頻道活動,請使用 projects.locations.channels.events.create
方法。支援的事件類型如下:
頻道活動執行七天後,Live Stream API 會自動刪除該活動。這項刪除作業包括失敗的事件。
廣告插播事件
使用 adBreak
物件插入新的廣告商機。
REST
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/EVENT_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "adBreak": { "duration": "100s" }, "executeNow": true, "state": "PENDING" }
C#
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API C# API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Go
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Go API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Java
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Java API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Node.js
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Node.js API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
PHP
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API PHP API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Python
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Python API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Ruby
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Ruby API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
插入插入畫面事件
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 IDASSET_ID
:使用者定義的板岩資產 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/EVENT_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "slate": { "duration": "60s", "asset": "projects/PROJECT_NUMBER/locations/LOCATION/assets/ASSET_ID" }, "executeNow": "true", "state": "PENDING" }
返回節目活動
使用 returnToProgram
物件停止所有正在執行的 adBreak
事件。您可以使用 executionTime
欄位,立即停止這些事件,或排定日後停止。
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/EVENT_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "executeNow": true, "state": "PENDING", "returnToProgram": {} }
忽略活動
使用 mute
物件將直播設為靜音。您可以指定要將串流靜音的時間長度,也可以將串流設為靜音,直到執行取消靜音事件為止。
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/EVENT_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "mute": { "duration": "30s" }, "executeNow": true, "state": "PENDING" }
取消忽略活動
使用 unmute
物件取消直播影片的靜音 (即還原音訊)。
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/EVENT_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "unmute": {}, "executeNow": true, "state": "PENDING" }
切換輸入事件
使用 inputSwitch
物件手動切換頻道輸入。如要進一步瞭解如何建立含有額外輸入內容的頻道,請參閱「建立含有備份輸入串流的頻道」。
手動切換輸入內容時,InputSwitchMode
會變更為 MANUAL
。即使指定輸入串流的 automaticFailover
欄位已設定備份輸入串流,系統仍會一律使用指定輸入串流。由於自動容錯移轉功能已停用,因此指定輸入串流中斷連線時,頻道不會切換至備份輸入串流。如要再次啟用容錯移轉,請參閱「啟用自動容錯移轉」。
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/EVENT_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "inputSwitch": { "inputKey": "input-backup" }, "executeNow": true, "state": "PENDING" }
啟用自動容錯移轉
如要在手動切換輸入後啟用自動容錯移轉,請按照下列步驟操作:
取得頻道活動詳細資料
如要取得頻道事件的詳細資料,請使用 projects.locations.channels.events.get
方法。
REST
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/EVENT_ID", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "adBreak": { "duration": "10s" }, "executeNow": true, "state": "SCHEDULED" }
C#
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API C# API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Go
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Go API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Java
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Java API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Node.js
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Node.js API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
PHP
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API PHP API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Python
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Python API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Ruby
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Ruby API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
列出頻道事件
如要列出為管道建立的所有管道事件,請使用 projects.locations.channels.events.list
方法。
REST
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{ "events": [ { "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/my-event", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "adBreak": { "duration": "10s" }, "executeNow": true, "state": "SCHEDULED" }, { "name": "projects/PROJECT_NUMBER/locations/LOCATION/channels/CHANNEL_ID/events/my-event2", "createTime": CREATE_TIME, "updateTime": UPDATE_TIME, "adBreak": { "duration": "10s" }, "executeNow": true, "state": "SCHEDULED" } ] }
C#
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API C# API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Go
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Go API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Java
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Java API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Node.js
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Node.js API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
PHP
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API PHP API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Python
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Python API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Ruby
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Ruby API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
刪除頻道活動
如要刪除管道事件,請使用 projects.locations.channels.events.delete
方法。
頻道活動執行七天後,Live Stream API 會自動刪除該活動。這項刪除作業包括失敗的事件。
REST
使用任何要求資料之前,請先替換以下項目:
PROJECT_NUMBER
:您的 Google Cloud 專案編號,位於「IAM Settings」(IAM 設定) 頁面的「Project number」(專案編號) 欄位LOCATION
:頻道所在位置;請使用支援的區域之一顯示地區us-central1
us-east1
us-east4
us-west1
us-west2
northamerica-northeast1
southamerica-east1
asia-east1
asia-east2
asia-south1
asia-northeast1
asia-southeast1
australia-southeast1
europe-north1
europe-west1
europe-west2
europe-west3
europe-west4
CHANNEL_ID
:使用者定義的管道 IDEVENT_ID
:使用者定義的事件 ID
如要傳送要求,請展開以下其中一個選項:
您應該會收到如下的 JSON 回應:
{}
C#
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API C# API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Go
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Go API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Java
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Java API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Node.js
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Node.js API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
PHP
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API PHP API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Python
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Python API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。
Ruby
如要瞭解如何安裝及使用 Live Stream API 的用戶端程式庫,請參閱這篇文章。 詳情請參閱 Live Stream API Ruby API 參考說明文件。
如要向 Live Stream API 進行驗證,請設定應用程式預設憑證。 詳情請參閱「為本機開發環境設定驗證」。