類別:CastReceiverOptions

建構函式

CastReceiverOptions

new CastReceiverOptions()

屬性

自訂命名空間

具備非空值 cast.framework.system.MessageType 屬性的非空值物件

自訂訊息命名空間及其類型的對應。自訂訊息命名空間必須在應用程式啟動前完成初始化,才能在接收器選項中提供。(如果此處未提供預設訊息類型,則 JSON 為 JSON)。

停用 ID 逾時

(布林值或未定義)

如為 true,則當接收器在播放中停止後,閒置時將關閉。這個屬性只能用於非媒體應用程式。

強制執行支援指令

常數

布林值

如為 true,任何在 SupportCommands 對應以外的媒體指令都會產生錯誤。cast.framework.messages.ErrorReason 將設為 NOT_SUPPORTED。預設值為 False,可在不查看地圖的情況下執行媒體指令。

本機寄件者 ID

(字串或未定義)

本機要求使用的寄件者 ID。預設值為「local」。

maxInactivity

(數字或不定義)

關閉閒置傳送者連線前的最長時間 (以秒為單位)。設定這個值可讓活動訊號訊息保持連線狀態。用於比一般 TCP 逾時更快偵測無回應的寄件者。最小值為 5 秒,並且沒有強制執行上限,但通常會在平台 TCP 逾時生效前數分鐘。預設值為 10 秒。

媒體元素

(非空值的 HTMLMediaElement 或未定義)

用於播放內容的媒體元素。預設行為是使用網頁上的第一個媒體元素。

播放設定

(非空值的 cast.framework.playConfig 或未定義)

含有自訂參數的播放設定。

playWatchedBreak

(布林值或未定義)

如果為 True,即使先前已觀看過用戶端拼接畫面,也會進行用戶端拼接。

偏好的播放速率

(數字或不定義)

在載入要求中未指定的播放速率。允許的範圍介於 0.5 至 2 之間,其中 1 為正常速度。

偏好的文字語言

(字串或未定義)

載入要求未指定有效音軌時,用於文字追蹤的語言。

待播清單

(非空值的 cast.framework.QueueBase 或未定義)

自訂佇列實作。

shakaVersion

(字串或未定義)

採用 MAJOR.MINOR.PATCH 格式的 Shaka 版本,例如「3.2.11」(目前預設值)。

支持的版本是 >=3.2.11 <5.0.0。已淘汰但仍然相容的版本為 >=2.5.6 <3.2.11。

注意:我們不建議使用舊版本的 Shaka Player 版本,因為最新版本已修正許多錯誤。您可以在這裡指定較新的版本,選擇啟用其他預設尚未提供的修正或功能。但請注意,後續的 Web Receiver SDK 版本可能會變更支援的版本範圍,並強制使用此處指定的版本。這個標記僅應做為臨時措施,且應由 Cast 支援團隊提供指引。(https://developers.google.com/cast/support) 您必須自行承擔風險。

略過 MplLoad

(布林值或未定義)

如果為 true,則禁止接收器載入 MPL 播放器。

skipPlayersLoad

(布林值或未定義)

如果為 true,則禁止接收器載入 MPL 或 Shaka 播放器程式庫。等同於將 skipMplLoad 和 skipShakaLoad 設定為 true 。

skipShakaLoad

(布林值或未定義)

如果為 true,則禁止接收器載入 Shaka 播放器。

狀態文字

(字串或未定義)

代表應用程式狀態的文字。應該符合國際化規則,因為寄件者應用程式可能會顯示該規則。

支援的指令

(數字或不定義)

應用程式支援的媒體指令位元遮罩。一律必須支援 LOAD、PLAY、STOP、GET_STATUS。如未提供這個值,系統會一併支援 PAUSE、SEEK、STREAM_VOLUME、STREAM_MUTE、EDIT_TRACKS 和 PLAYBACK_RATE。

另請參閱
cast.framework.messages.Command

使用者介面設定

(非空值的 cast.framework.ui.UiConfig 或未定義)

UI 設定。

useLegacyDashSupport

(布林值或未定義)

如為 true,請為 DASH 內容使用 MPL。

useShakaForHls

(布林值或未定義)

如果為 true,請使用 Shaka Player 處理 HLS 內容。預設為 false

注意:Sakaka Player 並非 HLS 內容的預設功能,因為仍缺少部分功能,且我們希望在將其設為預設之前,確保其能與 HLS 接收器維持良好效能並廣泛相容。如果您在正式發布前加入 Shaka Player 至 HLS,我們會請您回報您遇到的任何問題。(https://developers.google.com/cast/support) 在 HLS 推出 Shaka Player 之前,我們不保證 Shaka Player 與 HLS 相容,因此如果遇到非基本問題,建議您將這個標記還原為預設設定。

版本代碼

(數字或不定義)

一個整數,用來代表接收器版本的內部版本號碼。這項數據只會用來收集指標,藉此區分接收器版本。這個值應隨著每個版本遞增,且在復原時仍可與該版本保持繫結。