類別：CastReceiverContext

cast. 架構。CastReceiverContext

class static

管理基礎程式庫的載入作業並初始化基礎投放接收器 SDK。

擲回

non-null Error 非透過文件內文建立 MediaElement。如果建立了多個媒體元素，開發人員應將「castMediaElement」類別設為其中其中一個 CAF 接收器。

方法

getInstance

靜態

getInstance() 會傳回 cast.framework.CastReceiverContext

傳回 CastReceiverContext 單例模式例項。

傳回

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, Listener)

設定自訂訊息管道的訊息監聽器。

參數
命名空間	string 命名空間。請注意，有效的命名空間必須加上「urn:x-cast:」字串。
事件監聽器	function(非空值 cast.framework.system.Event)

擲回

Error如果系統尚未就緒，或這個應用程式不支援命名空間，

addEventListener

addEventListener(type, 處理常式)

新增事件監聽器以投放系統事件。

參數
type	cast.framework.system.EventType 值不得為空值。
處理常式	function(非空值 cast.framework.system.Event)

螢幕類型

canDisplayType(mimeType, codecs, width, height, framerate) 會傳回布林值

檢查平台是否支援影片或音訊串流的指定媒體參數。

參數
MIME 類型	string 媒體 MIME 類型。由類型和子類型組成，並以「/」分隔。可以是影片或音訊 MIME 類型。
轉碼器	選用 string 引用字串包含以逗號分隔的格式，其中每個格式都指定串流中的媒體樣本類型。
width	選用 數字 說明串流的水平解析度 (以像素為單位)。
height	選用 數字 說明串流垂直解析度 (以像素為單位)。
影格速率	選用 數字 說明串流的影格速率。

傳回

boolean 可在 Chromecast 上播放串流的內容。

getApplication 資料

getApplicationData() 會傳回 cast.framework.system.ApplicationData

在系統就緒後提供應用程式資訊，否則將為空值。

傳回

nullable cast.framework.system.ApplicationData應用程式資訊。

getDeviceCapabilities

getDeviceCapabilities() 傳回物件

在系統就緒後提供裝置功能資訊，否則將為空值。如果傳回空白物件，則裝置不會公開任何功能資訊。

傳回

nullable Object 裝置功能資訊 (鍵/值組合)。如果系統尚未準備就緒，則會顯示空值。如果平台不會透露任何裝置功能資訊，則可以使用空白物件。

getPlayerManager

getPlayerManager() 會傳回 cast.framework.PlayerManager

取得可控制及監控媒體播放功能的 Player 執行個體。

傳回

non-null cast.framework.PlayerManager 

取得寄件者

get 體驗(senderId) 會傳回 cast.framework.system.send

依照寄件者 ID 取得寄件者

參數
寄件者 ID	string 要傳回的寄件者 ID。

傳回

nullable cast.framework.system.Sender 

取得寄件者

getSENDERs() 會傳回非空值 cast.framework.system.send 的陣列

取得目前連線的寄件者清單。

傳回

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() 會傳回 cast.framework.system.StandbyState

回報投放應用程式的 HDMI 輸入端處於待機狀態。

傳回

non-null cast.framework.system.StandbyState 應用程式的 HDMI 輸入是否處於待機模式。如果無法確定，因為電視不支援 CEC 指令，則傳回的值為 UNKNOWN。

getSystemState

getSystemState() 會傳回 cast.framework.system.SystemState

提供系統狀態的應用程式資訊。

傳回

non-null cast.framework.system.SystemState 系統狀態。

getVisibilityState

getVisibilityState() 傳回 cast.framework.system.VisibilityState

回報投放應用程式是否為 HDMI 啟用輸入端。

傳回

non-null cast.framework.system.VisibilityState應用程式是否為 HDMI 有效輸入。如果無法確定，因為電視不支援 CEC 指令，則傳回的值為 UNKNOWN。

isSystemReady

isSystemReady() 會傳回布林值

應用程式呼叫開始時，系統會傳送就緒事件，指出應用程式資訊已準備就緒，一旦有一位傳送者，應用程式就可以立即傳送訊息。

傳回

boolean 系統是否已準備好處理郵件。

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

開始載入播放器 js。此屬性可在啟動接收器之前，於啟動接收器的初期階段開始載入玩家的 JavaScript 程式碼。如果已載入玩家 (即呼叫開始)，這個函式即為免人工管理。

參數
useLegacyDashSupport	選用 布林值 表示 MPL 應用於 DASH 內容。

移除 CustomMessageListener

removeCustomMessageListener(namespace, Listener)

移除自訂訊息管道的訊息監聽器。

參數
命名空間	string 命名空間。請注意，有效的命名空間必須加上「urn:x-cast:」字串。
事件監聽器	function(cast.framework.system.Event)

擲回

Error如果系統尚未就緒，或這個應用程式不支援命名空間，

移除事件監聽器

removeEventListener(type, 處理常式)

移除事件監聽器以投放系統事件。

參數
type	cast.framework.system.EventType 值不得為空值。
處理常式	function(非空值 cast.framework.system.Event)

傳送自訂訊息

sendCustomMessage(namespace, 寄件者 ID, message)

傳送郵件給特定寄件者。

參數
命名空間	string 命名空間。請注意，有效的命名空間必須加上「urn:x-cast:」字串。
寄件者 ID	(字串或未定義) 使用寄件者 ID 或向所有寄件者播送的未定義寄件者 ID。
訊息	任何類型 訊息。 值不得為空值。

擲回

Error 如果無法準備這則訊息，

傳送意見回饋訊息

sendFeedbackMessage(feedbackMessage)

如果應用程式要新增偵錯狀態資訊，以便登入意見回饋報告，系統應呼叫對這項意見回饋啟動事件來呼叫此函式。該參數會接收「message」參數，該字串代表應用程式想要記錄的偵錯資訊。

參數
意見訊息	string

已淘汰

使用 cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

設定應用程式狀態。當應用程式的狀態變更時，應用程式應呼叫此方法。如果未定義或設為空字串，則根據預設，系統會在應用程式註冊期間建立的應用程式名稱值用於應用程式狀態。

參數
狀態文字	string 狀態文字。

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

設定處理常式，為意見回饋報告提供其他資料。 建立回報的意見回饋之後，系統會呼叫處理常式，且應以字串形式傳回額外資料，或是保證字串。 退貨承諾必須在 5 秒內解決，才能列入報告中。

參數
回饋處理常式	function() 值可以是空值。

setInactivityTimeout

setInactivityTimeout(maxInactivity)

設定接收器閒置逾時。建議您設定呼叫開始且不變更時的最大閒置值。這個 API 僅供開發/偵錯之用。

參數
maxInactivity	數字 關閉無回應連線前的間隔時間 (以秒為單位)。

setLoggerLevel

setLoggerLevel(level)

設定記錄詳細程度。

參數
level	cast.framework.LoggerLevel 記錄層級。 值不得為空值。

開始播放

start(options) 傳回 cast.framework.CastReceiverContext

初始化系統管理工具和媒體管理員，以便接收器應用程式接收來自寄件者的要求。

參數
選項	(非空值的 cast.framework.CastReceiverOptions 或選用的非空值物件)

傳回

non-null cast.framework.CastReceiverContext 

停止

stop()

關機接收器應用程式。