cast. framework. CastReceiverContext
管理基礎程式庫的載入作業,並初始化基礎 Cast 接收端 SDK。
- 擲回
-
non-null Error如果 MediaElement 不是在文件內文中建立。如果建立多個媒體元素,開發人員應將「castMediaElement」類別設為 CAF 接收端會使用的其中一個元素。
方法
getInstance
getInstance() 會傳回 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 值不得為空值。 |
|
handler |
function(non-null cast.framework.system.Event) |
canDisplayType
canDisplayType(mimeType, codecs, width, height, framerate) returns boolean
檢查平台是否支援指定的影片或音訊串流媒體參數。
參數 |
|
|---|---|
|
mimeType |
字串 媒體 MIME 類型。由類型和子類型組成,兩者以「/」分隔。可以是影片或音訊 MIME 類型。 |
|
轉碼器 |
選用 字串 引號字串包含以逗號分隔的清單,其中每種格式都會指定串流中存在的媒體樣本類型。 |
|
寬度 |
選用 數字 說明串流的水平解析度 (以像素為單位)。 |
|
高度 |
選用 數字 說明串流的垂直解析度 (以像素為單位)。 |
|
framerate |
選用 數字 說明串流的影格率。 |
- 傳回
-
boolean:串流是否可在 Chromecast 上播放。
getApplicationData
getApplicationData() 會傳回 cast.framework.system.ApplicationData
系統準備就緒後,提供應用程式資訊,否則會是空值。
- 傳回
-
nullable cast.framework.system.ApplicationData應用程式資訊,如果系統尚未就緒,則為空值。
getDeviceCapabilities
getDeviceCapabilities() 會傳回 cast.framework.system.DeviceCapabilitiesObj
系統準備就緒後,提供裝置功能資訊,否則會是空值。如果傳回空白物件,表示裝置不會公開任何功能資訊。
- 傳回
-
nullable cast.framework.system.DeviceCapabilitiesObj裝置功能資訊 (鍵/值組合)。如果系統尚未準備就緒,則會是空值。如果平台未公開任何裝置功能資訊,則可能為空白物件。
getDeviceInformation
getDeviceInformation() 會傳回 cast.framework.system.DeviceInformationObj
系統準備就緒後,提供與功能無關的裝置識別資訊,否則會是「null」。如果傳回空白物件,表示裝置不會公開任何這類資訊。
- 傳回
-
nullable cast.framework.system.DeviceInformationObj裝置資訊 (鍵/值組合)。如果系統尚未準備就緒,則會傳回空值。如果平台未公開這項資訊,則可能為空白物件。
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() returns Array of non-null 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() 會傳回 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() returns boolean
應用程式呼叫啟動時,系統會傳送就緒事件,表示應用程式資訊已就緒,且應用程式可在傳送者連線後立即傳送訊息。
- 傳回
-
boolean系統是否已準備好處理訊息。
loadPlayerLibraries
loadPlayerLibraries(useLegacyDashSupport)
開始載入播放器 JS。這可用於在呼叫 start 之前,在啟動接收器的早期階段開始載入播放器 js 程式碼。如果播放器已載入 (已呼叫 start),這個函式就不會執行任何操作。
參數 |
|
|---|---|
|
useLegacyDashSupport |
選用 布林值 指出應將 MPL 用於 DASH 內容。 |
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 值不得為空值。 |
|
handler |
function(non-null cast.framework.system.Event) |
sendCustomMessage
sendCustomMessage(namespace, senderId, data)
傳送訊息給特定寄件者。
參數 |
|
|---|---|
|
命名空間 |
字串 命名空間。請注意,有效的命名空間必須加上「urn:x-cast:」字串前置字元。 |
|
senderId |
(字串或未定義) senderId,或未定義 (廣播給所有傳送者)。 |
|
資料 |
任何類型 訊息酬載。 值不得為空值。 |
- 擲回
-
Error:準備訊息時發生錯誤。
sendFeedbackMessage
sendFeedbackMessage(feedbackMessage)
如果應用程式將偵錯狀態資訊新增至意見回饋報告中的記錄,則應呼叫此函式以回應 feedbackstarted 事件。這個方法會接收「message」參數,該參數是代表應用程式要記錄的偵錯資訊的字串。
參數 |
|
|---|---|
|
feedbackMessage |
字串 |
- 已淘汰
- 使用 cast.framework.CastReceiverContext#setFeedbackHandler
setApplicationState
setApplicationState(statusText)
設定應用程式狀態。應用程式應在狀態變更時呼叫此方法。如果未定義或設為空白字串,系統預設會使用應用程式註冊期間建立的應用程式名稱值,做為應用程式狀態。
參數 |
|
|---|---|
|
statusText |
字串 狀態文字。 |
setFeedbackHandler
setFeedbackHandler(feedbackHandler)
設定處理常式,為意見回饋報告提供額外資料。 系統會在建立意見回饋報告時呼叫處理常式,並應以字串或字串 Promise 的形式傳回額外資料。傳回的 Promise 應在 5 秒內解析,才能納入報表。
參數 |
|
|---|---|
|
feedbackHandler |
function() 值可能為空值。 |
setInactivityTimeout
setInactivityTimeout(maxInactivity)
設定接收端閒置逾時時間。建議您在呼叫 Start 時設定閒置時間上限值,且不要變更。這個 API 僅供開發/偵錯之用。
參數 |
|
|---|---|
|
maxInactivity |
數字 關閉無回應連線前的間隔時間 (以秒為單位)。 |
setLoggerLevel
setLoggerLevel(level)
設定記錄詳細程度。
參數 |
|
|---|---|
|
等級 |
記錄層級。 值不得為空值。 |
start
start(options) 會傳回 cast.framework.CastReceiverContext
初始化系統管理員和媒體管理員,讓接收端應用程式可以接收傳送端的要求。
參數 |
|
|---|---|
|
選項 |
*(非空值 cast.framework.CastReceiverOptions 或選用的非空值物件) |
- 傳回
-
non-null cast.framework.CastReceiverContext
停止
stop(closeReason)
關閉接收端應用程式。
參數 |
|
|---|---|
|
closeReason |
選用 cast.framework.common.CloseReason 選用的關閉原因,指出接收端應用程式停止的原因。如未提供,架構會根據最近的媒體播放器事件推論原因,或改用 APP_REQUEST。傳遞下列其中一個數值:
值不得為空值。 |