類別：CastReceiverContext

cast.架構。CastReceiverContext

class   static

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

擲回

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

方法

getInstance

靜態

getInstance() returns cast.framework.CastReceiverContext

傳回 CastReceiverContext 單例模式執行個體。

傳回

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

為自訂訊息管道設定訊息監聽器。一個命名空間可以使用多個事件監聽器。

參數
命名空間	字串 命名空間。請注意，有效命名空間的前置字串須為「urn:x-cast:」。
事件監聽器	function(non-null cast.framework.system.Message)

擲回

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

addEventListener

addEventListener(type, handler)

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

參數
類型	cast.framework.system.EventType 值不得為空值。
處理常式	function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) returns boolean

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

參數
mimeType	字串 媒體 MIME 類型。當中包含類型和子類型，並以「/」分隔。這可以是影片或音訊 MIME 類型。
轉碼器	選用 字串 加引號的字串內含以半形逗號分隔的格式清單，其中每個格式都會指定串流中的媒體樣本類型。
width	選用 號碼 說明以像素為單位的串流水平解析度。
height	選用 號碼 說明以像素為單位的串流垂直解析度。
畫面更新率	選用 號碼 說明串流的影格速率。

傳回

boolean如果串流可以透過 Chromecast 播放，

getApplicationData

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 

getSender

getSender(senderId) 會傳回 cast.framework.system.Sender

依寄件者 ID 取得寄件者

參數
senderId	字串 要傳回的寄件者 ID。

傳回

nullable cast.framework.system.Sender 

getSenders

getSenders() 會傳回非空值的 cast.framework.system.Sender 陣列

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

傳回

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() returns 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。這可用來在呼叫開始之前，在啟動接收端的早期階段載入玩家 js 程式碼。如果播放器已載入 (已開始呼叫)，則此函式為免人工管理。

參數
useLegacyDashSupport	選用 boolean 表示 DASH 內容應使用 MPL。

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

移除先前使用 CastReceiverContext#addCustomMessageListener 註冊的訊息事件監聽器。

參數
命名空間	字串 命名空間。請注意，有效命名空間的前置字串須為「urn:x-cast:」。
事件監聽器	function(non-null cast.framework.system.Message) 要取消註冊的訊息監聽器函式。

擲回

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

removeEventListener

removeEventListener(type, handler)

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

參數
類型	cast.framework.system.EventType 值不得為空值。
處理常式	function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

傳送訊息給特定寄件者。

參數
命名空間	字串 命名空間。請注意，有效命名空間的前置字串須為「urn:x-cast:」。
senderId	(字串或未定義) 傳送者 ID，或未定義向所有傳送者播送。
資料或曾存取這類資料的人員	任何類型 訊息酬載。 值不得為空值。

擲回

Error：準備郵件時發生錯誤。

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

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

參數
feedbackMessage	字串

已淘汰

使用 cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

設定應用程式狀態。應用程式應在狀態變更時呼叫此內容。如未定義或設為空白字串，根據預設，在應用程式註冊期間建立的「應用程式名稱」值會用於應用程式狀態。

參數
statusText	字串 狀態文字。

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

設定處理常式，為意見回饋報告提供額外資料。建立回報的意見回饋之後，系統會呼叫處理常式，該處理常式應會將額外資料以字串或字串承諾的形式傳回。退貨承諾通常會在 5 秒內解決，以便將相關資訊納入報告中。

參數
feedbackHandler	function() 值可以是空值。

setInactivityTimeout

setInactivityTimeout(maxInactivity)

設定接收方閒置逾時。建議在呼叫 Start 時設定閒置時間上限，且不要變更該值。這個 API 僅供開發/偵錯用途。

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

setLoggerLevel

setLoggerLevel(level)

設定記錄詳細程度等級。

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

start

start(options) 傳回 cast.framework.CastReceiverContext

初始化系統管理員和媒體管理工具，讓接收者應用程式可以接收寄件者提出的要求。

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

傳回

non-null cast.framework.CastReceiverContext 

轉機 1 次

stop()

關閉接收器應用程式。