命名空間：cast

chrome.投放

命名空間   靜態

這是 chrome.cast 命名空間。

類別

命名空間

列舉

自動彙整政策

靜態

字串

自動彙整政策會決定 SDK 初始化後，SDK 何時會自動將寄件者應用程式連結至現有的工作階段。

值

TAB_AND_ORIGIN_SCOPED

字串

在使用相同分頁和網頁來源啟動相同 appId 時，自動連線。

ORIGIN_SCOPED

字串

在使用相同 appId 和相同網頁來源時啟動 (無論分頁為何)，自動連線。

頁面設計

字串

不會自動連線。

技術能力

靜態

字串

接收器裝置支援的功能。

值

製作影片

字串

接收器支援視訊輸出。

音訊_輸出

字串

接收器支援音訊輸出。

影片廣告

字串

接收器支援視訊輸入 (攝影機)。

音訊_INS

字串

接收器支援音訊輸入 (麥克風)。

多區域群組

字串

接收器代表多可用區群組。

預設動作政策

靜態

字串

預設動作政策會決定 SDK 初始化 API 後，會自動建立工作階段的時間。這也會控制擴充功能彈出式視窗中的分頁預設動作。

值

CREATE_SESSION

字串

如果包含應用程式的分頁在 API 初始化時進行投放，SDK 會停止投放分頁，並自動啟動應用程式。擴充功能彈出式視窗會提示使用者投放應用程式。

CAST_THIS_TAB

字串

初始化 API 後，即使投放分頁，系統也不會自動啟動。這個擴充功能彈出式視窗會提示使用者投放分頁。

撥號應用程式狀態

靜態

字串

DIAL 應用程式的可能狀態。

值

執行中

字串

已停止

字串

錯誤

字串

不是規格，可用來發出錯誤。

ErrorCode

靜態

字串

SDK 可能傳回的錯誤。

值

取消

字串

使用者已取消作業。

TIMEOUT

字串

作業逾時，

API_NOT_INITIALIZED

字串

API 未初始化。

無效

字串

作業的參數無效。

Extension_NOT_COMPATIBLE

字串

API 指令碼與已安裝的 Cast 擴充功能不相容。

額外資訊

字串

Cast 擴充功能無法使用，

RECEIVER_UNAVAILABLE

字串

接收器與工作階段要求不相容。

SESSION_ERROR

字串

無法建立工作階段或工作階段無效。

管道錯誤

字串

無法接收頻道。

LOAD_MEDIA_失敗

字串

媒體載入失敗。

接收動作

靜態

字串

使用者可以在擴充功能中對接收器執行的動作。可用來在寄件者應用程式 UI 顯示轉換之後，或是投放動作完成 (或失敗) 之前。

值

投放

字串

使用者選取接收端，以便透過傳送者應用程式投放內容。收款人的確切身分可能不明。

停止

字串

使用者已要求停止在接收器中執行工作階段。

接收器可用性

靜態

字串

說明投放接收端的可用性。

值

有現貨

字串

至少有一個可用的接收器與工作階段要求相容。

無法使用

字串

沒有可用的接收器。

接收器類型

靜態

字串

值

投放

字串

投放接收端，例如 Chromecast

實體

字串

分散式裝置，例如智慧型電視

掛斷

字串

去晃晃

自訂

字串

用戶端提供的自訂接收器

傳送者平台

靜態

字串

說明傳送者應用程式平台。

值

Chrome

字串

iOS

字串

Android

字串

工作階段狀態

靜態

字串

說明投放工作階段對接收端應用程式的狀態。

值

連通整合

字串

工作階段已連線至接收端應用程式。

連線中斷

字串

工作階段與接收器應用程式中斷連線。接收器應用程式不一定正在運作。

已停止

字串

接收端應用程式已停止。

音量控制類型

靜態

字串

說明音量控制的類型。

值

執行

字串

可變更投放裝置的音量。

完成

字串

投放裝置音量是固定的，無法變更。

刊頭廣告

字串

主系統音量控制，例如電視或音訊裝置的音量已變更。

屬性

自動彙整政策

靜態

字串

自動彙整政策會決定 SDK 初始化後，SDK 何時會自動將寄件者應用程式連結至現有的工作階段。

值

TAB_AND_ORIGIN_SCOPED

字串

在使用相同分頁和網頁來源啟動相同 appId 時，自動連線。

ORIGIN_SCOPED

字串

在使用相同 appId 和相同網頁來源時啟動 (無論分頁為何)，自動連線。

頁面設計

字串

不會自動連線。

技術能力

靜態

字串

接收器裝置支援的功能。

值

製作影片

字串

接收器支援視訊輸出。

音訊_輸出

字串

接收器支援音訊輸出。

影片廣告

字串

接收器支援視訊輸入 (攝影機)。

音訊_INS

字串

接收器支援音訊輸入 (麥克風)。

多區域群組

字串

接收器代表多可用區群組。

預設動作政策

靜態

字串

預設動作政策會決定 SDK 初始化 API 後，會自動建立工作階段的時間。這也會控制擴充功能彈出式視窗中的分頁預設動作。

值

CREATE_SESSION

字串

如果包含應用程式的分頁在 API 初始化時進行投放，SDK 會停止投放分頁，並自動啟動應用程式。擴充功能彈出式視窗會提示使用者投放應用程式。

CAST_THIS_TAB

字串

初始化 API 後，即使投放分頁，系統也不會自動啟動。這個擴充功能彈出式視窗會提示使用者投放分頁。

撥號應用程式狀態

靜態

字串

DIAL 應用程式的可能狀態。

值

執行中

字串

已停止

字串

錯誤

字串

不是規格，可用來發出錯誤。

ErrorCode

靜態

字串

SDK 可能傳回的錯誤。

值

取消

字串

使用者已取消作業。

TIMEOUT

字串

作業逾時，

API_NOT_INITIALIZED

字串

API 未初始化。

無效

字串

作業的參數無效。

Extension_NOT_COMPATIBLE

字串

API 指令碼與已安裝的 Cast 擴充功能不相容。

額外資訊

字串

Cast 擴充功能無法使用，

RECEIVER_UNAVAILABLE

字串

接收器與工作階段要求不相容。

SESSION_ERROR

字串

無法建立工作階段或工作階段無效。

管道錯誤

字串

無法接收頻道。

LOAD_MEDIA_失敗

字串

媒體載入失敗。

提供

靜態

布林值

標記用戶端，檢查 API 是否已載入。

接收動作

靜態

字串

使用者可以在擴充功能中對接收器執行的動作。可用來在寄件者應用程式 UI 顯示轉換之後，或是投放動作完成 (或失敗) 之前。

值

投放

字串

使用者選取接收端，以便透過傳送者應用程式投放內容。收款人的確切身分可能不明。

停止

字串

使用者已要求停止在接收器中執行工作階段。

接收器可用性

靜態

字串

說明投放接收端的可用性。

值

有現貨

字串

至少有一個可用的接收器與工作階段要求相容。

無法使用

字串

沒有可用的接收器。

接收器類型

靜態

字串

值

投放

字串

投放接收端，例如 Chromecast

實體

字串

分散式裝置，例如智慧型電視

掛斷

字串

去晃晃

自訂

字串

用戶端提供的自訂接收器

傳送者平台

靜態

字串

說明傳送者應用程式平台。

值

Chrome

字串

iOS

字串

Android

字串

工作階段狀態

靜態

字串

說明投放工作階段對接收端應用程式的狀態。

值

連通整合

字串

工作階段已連線至接收端應用程式。

連線中斷

字串

工作階段與接收器應用程式中斷連線。接收器應用程式不一定正在運作。

已停止

字串

接收端應用程式已停止。

逾時

靜態

非空值的 chrome.cast.Timeout

API 方法的預設逾時值 (以毫秒為單位)。

版本

常數   靜態

非空值的陣列

API 版本。第一個數字是主要版本，第二個值則是主要版本。

音量控制類型

靜態

字串

說明音量控制的類型。

值

執行

字串

可變更投放裝置的音量。

完成

字串

投放裝置音量是固定的，無法變更。

刊頭廣告

字串

主系統音量控制，例如電視或音訊裝置的音量已變更。

方法

addReceiverActionListener

靜態

addReceiverActionListener(監聽器)

新增監聽器函式，在使用者透過 UI 開始或停止投放時，將叫用該函式。在傳送動作完成或失敗之前，傳送端應用程式可利用使用者介面在轉場 (例如暫停本機播放媒體) 中顯示轉換。

  • 我們不保證會叫用事件監聽器，因此應用程式不應仰賴其正常運作。
  • 事件監聽器將傳遞給接收方的接收端 (如果有的話)。不過，系統可能不知道接收者，而是會傳遞空值。
  • 使用者採取行動後，系統會盡快呼叫事件監聽器。您應該透過應用程式透過 API 收到最終狀態變更的通知。

如果您使用 Framework API，請改用 cast.framework.CastContext#addEventListener，並監聽 cast.framework.CastContextEventType#CAST_STATE_CHANGED 事件。

參數

事件監聽器

chrome.cast.ReceiverActionListener

要新增的事件監聽器函式。事件監聽器的第一個引數是已執行的接收器。事件監聽器的第二個引數是所要求的動作 (請參閱 chrome.cast.ReceiverAction)。

值不得為空值。

initialize

靜態

初始化(apiConfig、successCallback、errorCallback)

初始化 API。請注意，在 API 完成初始化後，系統會叫用 successCallback 和 errorCallback。之後，系統可能會隨時叫用 sessionListener 和 rrListener，甚至可能會多次叫用。

如果您使用 Framework API，請使用 cast.framework.CastContext#setOptions 取代這個函式。

參數

API 設定

chrome.cast.ApiConfig

用於初始化 API 的物件。

值不得為空值。

成功的回呼

函式()

errorCallback (錯誤呼叫)

function(非空值 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、INVALID_PARAMETER、EXTENSION_MISSING。

記錄訊息

靜態

logMessage(訊息)

記錄應用程式的偵錯訊息。如果使用者明確選擇加入詳細記錄，這則訊息可能會以意見回饋報告的形式傳送給 Google。

參數

訊息

字串

要記錄的訊息。
已淘汰
不適用於 Presentation API 的 Cast SDK。

預先快取

靜態

快取(資料)

傳送快取資料要求。如果工作階段已連結，就會傳送直接要求，否則將傳送至網路中的所有裝置。

參數

資料或曾存取這類資料的人員

字串

可預先載入的資料。
已淘汰
不支援。

移除接收器事件監聽器

靜態

removeReceiverActionListener(監聽器)

移除先前透過 addReceiverActionListener 新增的事件監聽器函式。

參數

事件監聽器

chrome.cast.ReceiverActionListener

要移除的監聽器函式。

值不得為空值。

requestSession

靜態

requestSession(successCallback, errorcallback, sessionRequest)

建立或接收接收器應用程式工作階段的要求。預設會使用在初始化期間傳送至 API 的 SessionRequest；透過 sessionRequest 傳遞不同的工作階段要求，即可覆寫這個工作階段。

如果您使用的是 Framework API，請使用 cast.framework.CastContext#requestSession 而非這個函式。

參數

成功的回呼

function(非空值 chrome.cast.Session)

errorCallback (錯誤呼叫)

function(非空值 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、CANCEL、CHANNEL_ERROR、SESEION_ERROR、RECEIVER_UNAVAILABLE 和 Extension_MISSING。 請注意，使用者選取接收器後，逾時計時器就會開始計算。 選取接收器時，使用者動作會逾時，而不會逾時。如果工作階段正在進行中，系統會叫用 INVALID_PARAMETER 錯誤代碼和說明錯誤的相關說明。

工作階段要求

選填

chrome.cast.SessionRequest

值不得為空值。

requestSessionById

靜態

requestSessionById(sessionId)

要求以指定 ID 加入現有工作階段。加入後，工作階段就會傳遞到 chrome.cast.init 設定的 sessionListener。

如果在呼叫這個函式時，系統會得知具有指定 sessionId 的工作階段，就會立即呼叫 sessionListener。否則，一旦找到具有指定 sessionId 的工作階段，就會呼叫 sessionListener。

參數

工作階段 ID

字串

要加入的工作階段 ID。

setCustomReceiver

靜態

setCustomReceivers(接收器、successCallback、errorCallback)

設定自訂接收器清單

參數

接收器

非空值的 chrome.cast.Receiver 陣列

新的清單。

值不得為空值。

成功的回呼

函式()

errorCallback (錯誤呼叫)

function(非空值 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR 和 EXTENSION_MISSRING。
已淘汰
不適用於 Presentation API 的 Cast SDK。

setPageContext

靜態

setPageContext(win)

初始化 iframe 中載入 Cast SDK 的網頁版本。應在 SDK 初始化後呼叫。

參數

勝

視窗

網頁視窗物件。

值不得為空值。

setReceiverDisplayStatus

靜態

setReceiverDisplayStatus(Receiver、successCallback、errorCallback)

設定接收器的名稱和顯示狀態。如要將接收器顯示為閒置，請將 displayStatus 設為空值。

僅適用於「自訂」接收器。如果接收端為 CAST，系統會忽略接收端的 displayStatus；接收端接收器的狀態則是由接收器應用程式更新。

參數

接收器

chrome.cast.Receiver

接收器。

值不得為空值。

成功的回呼

函式()

設定狀態成功時的回呼。

errorCallback (錯誤呼叫)

function(非空值 chrome.cast.Error)

可能的錯誤包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED 和 EXTENSION_MISSING。
已淘汰
不適用於 Presentation API 的 Cast SDK。

未逸出

靜態

un 逸出(逸出) 會傳回字串

用於取消逸出 URI 逸出字串的公用程式方法。舉例來說，接收者友善名稱會以 URI 逸出字串的形式傳回。如有需要，您可以使用這個方法將字串逸出。

參數

逸出

字串

要逸出的字串
傳回

string 未逸出的字串

摘要類型

接收器動作監聽器

靜態

ReceiverActionListener()