cast. framework. CastReceiverContext
管理基礎程式庫的載入作業,並初始化基礎投放接收器 SDK。
- 擲回
-
non-null Error
如未在文件內文中建立 MediaElement,如果建立了多個媒體元素,開發人員應將「castMediaElement」類別設為其中一個,CAF 接收器將使用其中一個。
方法
getInstance
getInstance() 傳回 cast.framework.CastReceiverContext
傳回 CastReceiverContext 單例模式執行個體。
- 傳回
-
non-null cast.framework.CastReceiverContext
新增自訂訊息監聽器
addCustomMessageListener(命名空間、監聽器)
設定自訂訊息管道的訊息監聽器。
參數 |
|
---|---|
命名空間 |
字串 命名空間。請注意,有效的命名空間前面必須加上「urn:x-cast:」字串。 |
事件監聽器 |
function(非空值 cast.framework.system.Event) |
- 擲回
-
Error
如果系統尚未準備就緒,或這個應用程式不支援命名空間,
addEventListener
addEventListener(type, 處理常式)
新增監聽器以投放系統事件。
參數 |
|
---|---|
類型 |
cast.framework.system.EventType 值不得為空值。 |
處理常式 |
function(非空值 cast.framework.system.Event) |
顯示類型
canDisplayType(mimeType, codecs, width, height, framerate) 會傳回布林值
檢查平台是否支援指定的影片或音訊串流媒體參數。
參數 |
|
---|---|
MIME 類型 |
字串 媒體 MIME 類型。當中包含類型和「/」分隔的子類型。可以是影片或音訊 MIME 類型。 |
轉碼器 |
選填 字串 quoted-string 包含以逗號分隔的格式清單,每個格式都會指定串流中的媒體範例類型。 |
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
getsend
getsend(senderId) 會傳回 cast.framework.system.寄件者
按寄件者 ID 取得寄件者
參數 |
|
---|---|
傳送者 ID |
字串 要傳回的傳送者 ID。 |
- 傳回
-
nullable cast.framework.system.Sender
取得寄件者
getsends() 傳回非空值的 cast.framework.system.寄件者 陣列
取得目前連線的寄件者清單。
- 傳回
-
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。此函式可用於在開始啟動接收器之前,開始載入玩家 js 程式碼。如果玩家已載入 (呼叫開始) 這個函式,則這個函式會不需要人工管理。
參數 |
|
---|---|
使用舊版 DashSupport |
選填 布林值 表示應用於 DASH 內容使用 MPL。 |
移除自訂訊息監聽器
removeCustomMessageListener(命名空間、監聽器)
移除自訂訊息管道的訊息監聽器。
參數 |
|
---|---|
命名空間 |
字串 命名空間。請注意,有效的命名空間前面必須加上「urn:x-cast:」字串。 |
事件監聽器 |
function(非空值 cast.framework.system.Event) |
- 擲回
-
Error
如果系統尚未準備就緒,或這個應用程式不支援命名空間,
移除事件監聽器
removeEventListener(類型, 處理常式)
移除監聽器以投放系統事件。
參數 |
|
---|---|
類型 |
cast.framework.system.EventType 值不得為空值。 |
處理常式 |
function(非空值 cast.framework.system.Event) |
傳送自訂訊息
sendCustomMessage(namespace、sendId、message)
將郵件傳送給特定寄件者。
參數 |
|
---|---|
命名空間 |
字串 命名空間。請注意,有效的命名空間前面必須加上「urn:x-cast:」字串。 |
傳送者 ID |
(字串或未定義) 從 2022 傳送到所有傳送者,或是向所有寄件者傳送的廣播 ID。 |
訊息 |
任何類型 訊息 值不得為空值。 |
- 擲回
-
Error
準備訊息時發生錯誤。
sendFeedbackMessage
sendFeedbackMessage(feedbackMessage)
如果應用程式新增偵錯狀態資訊,以在意見回饋報告中記錄意見回饋,就應呼叫這個函式回應事件。它使用參數「message」字串,代表應用程式要記錄的偵錯資訊。
參數 |
|
---|---|
意見回饋訊息 |
字串 |
- 已淘汰
- 使用 cast.framework.CastReceiverContext#setfeedbackHandler
set 應用程式狀態
setApplicationState(statusText)
設定應用程式狀態。應用程式應於狀態改變時呼叫此方法。如果未定義或設為空白字串,根據預設,在應用程式註冊期間建立的應用程式名稱值會用於應用程式狀態。
參數 |
|
---|---|
狀態文字 |
字串 狀態文字。 |
setfeedbackHandler
setfeedbackHandler(feedbackHandler)
設定處理常式,為意見回饋報告提供更多資料。建立意見回饋時,系統會呼叫處理常式,而且應以額外字串或字串保證傳回額外資料。退貨承諾事項必須在 5 秒內解決,才能納入報表。
參數 |
|
---|---|
feedbackHandler |
函式() 值可以是空值。 |
setInactivityTimeout
setInactivityTimeout(maxInactivity)
設定接收器的閒置逾時。建議您在呼叫 Start 時設定閒置的最大值,不要進行變更。這個 API 只是用於開發/偵錯。
參數 |
|
---|---|
最高活動量 |
號碼 間隔時間 (以秒為單位),再關閉無回應連線。 |
setLoggerLevel
setLoggerLevel(level)
設定記錄詳細程度。
參數 |
|
---|---|
level |
記錄層級。 值不得為空值。 |
開始播放
start(options) 會傳回 cast.framework.CastReceiverContext
初始化系統管理員和媒體管理員,讓接收端應用程式能接收來自寄件者的要求。
參數 |
|
---|---|
選項 |
(非空值的 cast.framework.CastReceiverOptions 或選擇性的非空值物件) |
- 傳回
-
non-null cast.framework.CastReceiverContext
停止
Stop()
關機接收端應用程式。