命名空間：投放

chrome.cast

namespace   static

這是 chrome.cast 命名空間。

類別

ApiConfig

初始化時保留 API 設定。

CredentialsData

用於識別傳送者憑證的憑證資料。

DialRequest

啟動 DIAL 應用程式的要求。

錯誤

說明 API 傳回的錯誤。通常，用戶端不應建立這些物件。

Image

描述接收器應用程式或媒體項目的圖片。這可以是應用程式圖示、封面圖片或縮圖。

接收端

說明執行應用程式的接收器。通常，用戶端不應建立這些物件。

ReceiverDisplayStatus

使用者在擴充功能 UI 中看到的接收者狀態。僅適用於「自訂」接收器。

SenderApplication

說明傳送者應用程式。通常，用戶端不應建立這些物件。

工作階段

說明目前執行中的 Cast 應用程式狀態。 通常，用戶端不應建立這些物件。

SessionRequest

啟動或連線至工作階段的要求。

逾時

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

數量

裝置或媒體串流的音量。

命名空間

media

列舉

AutoJoinPolicy

靜態

字串

自動加入政策可決定在 API 初始化後，SDK 將傳送端應用程式自動連結至現有工作階段的時機。

值
TAB_AND_ORIGIN_SCOPED	字串 工作階段啟動時，使用相同的應用程式 ID，且位於相同的分頁和網頁來源。
ORIGIN_SCOPED	字串 啟動工作階段時，使用相同的 appId 和相同網頁來源 (無論分頁為何) 時自動連線。
PAGE_SCOPED	字串 沒有自動連線。

技術能力

靜態

字串

接收器裝置支援的功能。

值
VIDEO_OUT	字串 接收器支援視訊輸出功能。
AUDIO_OUT	字串 接收器支援音訊輸出。
VIDEO_IN	字串 接收器支援視訊輸入 (攝影機)。
AUDIO_IN	字串 接收器支援音訊輸入 (麥克風)。
MULTIZONE_GROUP	字串 接收器代表一個多可用區群組。

DefaultActionPolicy

靜態

字串

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

值
CREATE_SESSION	字串 如果 API 初始化時正在投放含有應用程式的分頁，SDK 會停止投放分頁，並自動啟動應用程式。擴充功能彈出式視窗會提示使用者投放應用程式。
CAST_THIS_TAB	字串 初始化 API 後，系統不會自動啟動，即使分頁正在投放也一樣。擴充功能彈出式視窗會提示使用者投放分頁。

DialAppState

靜態

字串

DIAL 應用程式的可能狀態。

值
執行中	字串
已停止	字串
錯誤	字串 不屬於規格範圍，用於表示錯誤。

ErrorCode

靜態

字串

SDK 可能傳回的錯誤。

值
取消	字串 使用者已取消操作。
TIMEOUT	字串 作業逾時。
API_NOT_INITIALIZED	字串 API 未初始化。
INVALID_PARAMETER	字串 作業的參數無效。
EXTENSION_NOT_COMPATIBLE	字串 API 指令碼與已安裝的 Cast 擴充功能不相容。
EXTENSION_MISSING	字串 Cast 擴充功能無法使用。
RECEIVER_UNAVAILABLE	字串 沒有任何接收器與工作階段要求相容。
SESSION_ERROR	字串 無法建立工作階段，或是工作階段無效。
CHANNEL_ERROR	字串 無法傳送給接收者的頻道。
LOAD_MEDIA_FAILED	字串 無法載入媒體。

ReceiverAction

靜態

字串

使用者可以在擴充功能中對接收器執行的動作。這些屬性可用於在投放動作完成 (或失敗) 之前，在傳送者應用程式 UI 中顯示轉場效果。

值
CAST	字串 使用者選取意圖透過傳送者應用程式將內容投放到該接收器的接收器。可能無法得知接收者的確切身分。
停止	字串 使用者要求停止在接收器上執行的工作階段。

ReceiverAvailability

靜態

字串

說明 Cast 接收器的可用性。

值
可用	字串 至少有一個接收器與工作階段要求相容。
無法使用	字串 沒有可用的接收器。

ReceiverType

靜態

字串

值
CAST	字串 投放接收端，例如 Chromecast
撥號	字串 撥號裝置，例如智慧型電視
發起 Hangouts	字串 去晃晃
自訂	字串 用戶端提供的自訂接收器

SenderPlatform

靜態

字串

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

值
Chrome	字串
iOS	字串
ANDROID	字串

SessionStatus

靜態

字串

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

值
連通整合	字串 工作階段已連結至接收器應用程式。
連線中斷	字串 工作階段與接收器應用程式中斷連線。接收器應用程式不一定仍在執行。
已停止	字串 接收器應用程式已停止運作。

VolumeControlType

靜態

字串

說明音量控制的類型。

值
吸引	字串 您可以變更投放裝置音量。
已修正	字串 投放裝置音量固定且無法變更。
材質	字串 主要系統音量控制，例如電視或音訊裝置音量變更。

屬性

AutoJoinPolicy

靜態

字串

自動加入政策可決定在 API 初始化後，SDK 將傳送端應用程式自動連結至現有工作階段的時機。

值
TAB_AND_ORIGIN_SCOPED	字串 工作階段啟動時，使用相同的應用程式 ID，且位於相同的分頁和網頁來源。
ORIGIN_SCOPED	字串 啟動工作階段時，使用相同的 appId 和相同網頁來源 (無論分頁為何) 時自動連線。
PAGE_SCOPED	字串 沒有自動連線。

技術能力

靜態

字串

接收器裝置支援的功能。

值
VIDEO_OUT	字串 接收器支援視訊輸出功能。
AUDIO_OUT	字串 接收器支援音訊輸出。
VIDEO_IN	字串 接收器支援視訊輸入 (攝影機)。
AUDIO_IN	字串 接收器支援音訊輸入 (麥克風)。
MULTIZONE_GROUP	字串 接收器代表一個多可用區群組。

DefaultActionPolicy

靜態

字串

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

值
CREATE_SESSION	字串 如果 API 初始化時正在投放含有應用程式的分頁，SDK 會停止投放分頁，並自動啟動應用程式。擴充功能彈出式視窗會提示使用者投放應用程式。
CAST_THIS_TAB	字串 初始化 API 後，系統不會自動啟動，即使分頁正在投放也一樣。擴充功能彈出式視窗會提示使用者投放分頁。

DialAppState

靜態

字串

DIAL 應用程式的可能狀態。

值
執行中	字串
已停止	字串
錯誤	字串 不屬於規格範圍，用於表示錯誤。

ErrorCode

靜態

字串

SDK 可能傳回的錯誤。

值
取消	字串 使用者已取消操作。
TIMEOUT	字串 作業逾時。
API_NOT_INITIALIZED	字串 API 未初始化。
INVALID_PARAMETER	字串 作業的參數無效。
EXTENSION_NOT_COMPATIBLE	字串 API 指令碼與已安裝的 Cast 擴充功能不相容。
EXTENSION_MISSING	字串 Cast 擴充功能無法使用。
RECEIVER_UNAVAILABLE	字串 沒有任何接收器與工作階段要求相容。
SESSION_ERROR	字串 無法建立工作階段，或是工作階段無效。
CHANNEL_ERROR	字串 無法傳送給接收者的頻道。
LOAD_MEDIA_FAILED	字串 無法載入媒體。

isAvailable

靜態

boolean

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

ReceiverAction

靜態

字串

使用者可以在擴充功能中對接收器執行的動作。這些屬性可用於在投放動作完成 (或失敗) 之前，在傳送者應用程式 UI 中顯示轉場效果。

值
CAST	字串 使用者選取意圖透過傳送者應用程式將內容投放到該接收器的接收器。可能無法得知接收者的確切身分。
停止	字串 使用者要求停止在接收器上執行的工作階段。

ReceiverAvailability

靜態

字串

說明 Cast 接收器的可用性。

值
可用	字串 至少有一個接收器與工作階段要求相容。
無法使用	字串 沒有可用的接收器。

ReceiverType

靜態

字串

值
CAST	字串 投放接收端，例如 Chromecast
撥號	字串 撥號裝置，例如智慧型電視
發起 Hangouts	字串 去晃晃
自訂	字串 用戶端提供的自訂接收器

SenderPlatform

靜態

字串

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

值
Chrome	字串
iOS	字串
ANDROID	字串

SessionStatus

靜態

字串

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

值
連通整合	字串 工作階段已連結至接收器應用程式。
連線中斷	字串 工作階段與接收器應用程式中斷連線。接收器應用程式不一定仍在執行。
已停止	字串 接收器應用程式已停止運作。

逾時

靜態

非空值的 chrome.cast.Timeout

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

版本

常數   靜態

非空值陣列的數字

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

VolumeControlType

靜態

字串

說明音量控制的類型。

值
吸引	字串 您可以變更投放裝置音量。
已修正	字串 投放裝置音量固定且無法變更。
材質	字串 主要系統音量控制，例如電視或音訊裝置音量變更。

方法

addReceiverActionListener

靜態

addReceiverActionListener(listener)

新增事件監聽器函式，當使用者透過 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 和接收器，而且可能多次叫用。

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

參數
apiConfig	chrome.cast.ApiConfig 這個物件含有初始化 API 的參數。 值不得為空值。
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) 可能的錯誤包括 TIMEOUT、INVALID_PARAMETER、EXTENSION_MISSING。

logMessage

靜態

logMessage(message)

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

參數
訊息	字串 要記錄的訊息。

已淘汰

不支援以簡報 API 為基礎的 Cast SDK。

預先快取

靜態

precache(資料)

傳送要求至預先快取資料。連線的工作階段會直接傳送要求，否則會傳送到網路中的所有裝置。

參數
資料或曾存取這類資料的人員	字串 要預先快取的資料。

已淘汰

不支援。

removeReceiverActionListener

靜態

removeReceiverActionListener(listener)

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

參數
事件監聽器	chrome.cast.ReceiverActionListener 要移除的事件監聽器函式。 值不得為空值。

requestSession

靜態

requestSession(successCallback, errorCallback, sessionRequest)

建立或加入接收器應用程式工作階段的要求。根據預設，系統會使用在初始化時傳送至 API 的 SessionRequest；您可以在 sessionRequest 中傳遞不同的工作階段要求，覆寫這個值。

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

參數
successCallback	function(non-null chrome.cast.Session)
errorCallback	function(non-null chrome.cast.Error) 可能的錯誤有 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED、CANCEL、CHANNEL_ERROR、SESSION_ERROR、RECEIVER_UNAVAILABLE 和 EXTENSION_MISSING。請注意，逾時計時器會在使用者選取接收器後啟動。選取接收器時，使用者需要採取的動作，且沒有逾時。如果已在執行工作階段要求，系統會使用 INVALID_PARAMETER 錯誤代碼叫用 errorCallback，並提供錯誤說明。
sessionRequest	選用 chrome.cast.SessionRequest 值不得為空值。

requestSessionById

靜態

requestSessionById(sessionId)

根據指定 ID 加入現有工作階段的要求。加入後，工作階段會傳送給 chrome.cast.initialize 設定的 sessionListener。

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

參數
sessionId	字串 要加入的工作階段 ID。

setCustomReceivers

靜態

setCustomReceivers(receivers, successCallback, errorCallback)

設定自訂接收器清單

參數
接收器	非空值 chrome.cast.Receiver 陣列 新的清單。 值不得為空值。
successCallback	function()
errorCallback	function(non-null chrome.cast.Error) 可能的錯誤包括 TIMEOUT、API_NOT_INITIALIZED、INVALID_PARAMETER、CHANNEL_ERROR 和 EXTENSION_MISSRING。

已淘汰

不支援以簡報 API 為基礎的 Cast SDK。

setPageContext

靜態

setPageContext(win)

為在 iframe 中載入 Cast SDK 的網頁初始化投放功能。 應在 SDK 初始化後呼叫。

參數
勝	視窗 頁面視窗物件。 值不得為空值。

setReceiverDisplayStatus

靜態

setReceiverDisplayStatus(receiver, successCallback, errorCallback)

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

僅適用於「自訂」接收器。如果這個接收端為 CAST，系統會忽略接收器的 displayStatus，而接收器應用程式會更新投放接收端的狀態。

參數
接收者	chrome.cast.Receiver 接收者。 值不得為空值。
successCallback	function() 成功設定狀態時回呼。
errorCallback	function(non-null chrome.cast.Error) 可能的錯誤包括 TIMEOUT、INVALID_PARAMETER、API_NOT_INITIALIZED 和 EXTENSION_MISSING。

已淘汰

不支援以簡報 API 為基礎的 Cast SDK。

unescape

靜態

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

取消逸出 URI 逸出字串的公用程式方法。舉例來說，接收器好記名稱會以 URI 逸出字串的形式傳回。如有需要，請使用這個方法取消逸出該字串。

參數
逸出	字串 要取消逸出的字串

傳回

string 未逸出字串

抽象類型

ReceiverActionListener

靜態

ReceiverActionListener()