cast. framework. CastReceiverOptions
投放接收端內容選項。 所有屬性皆為選填。
建構函式
CastReceiverOptions
new CastReceiverOptions()
屬性
adBreakPreloadTime
(數字或未定義)
應提前預先載入個別廣告插播內容的時間長度 (以秒為單位)。這樣一來,您就不會過早預先載入廣告插播,導致廣告指標混淆。如未提供,系統會使用 5 秒的預設值。
customNamespaces
具有非空值的 cast.framework.system.MessageType 屬性的非空值物件
自訂訊息命名空間及其類型的對應。自訂訊息命名空間必須在應用程式啟動前初始化,因此必須在接收器選項中提供。(如未在此提供,預設訊息類型為 JSON)。
disableIdleTimeout
(布林值或未定義)
如果為 true,當主動播放停止後,接收器進入閒置狀態時,就不會關閉。這項屬性僅適用於非媒體應用程式。
enforceSupportedCommands
布林值
如果為 true,任何不在 supportedCommands 對應中的媒體指令都會產生錯誤。cast.framework.messages.ErrorReason 會設為 NOT_SUPPORTED。預設值為 false,允許執行媒體指令,而不檢查對應。
localSenderId
(字串或未定義)
用於本機要求的寄件者 ID。預設值為「local」。
maxInactivity
(數字或未定義)
關閉閒置傳送端連線前的時間長度上限 (以秒為單位)。設定這個值可啟用心跳訊息,讓連線保持運作。用於偵測無回應的傳送端,速度比一般 TCP 超時更快。最小值為 5 秒;系統不會強制設定上限,但通常要過幾分鐘,平台 TCP 逾時才會生效。預設值為 10 秒。
mediaElement
(非空值的 HTMLMediaElement 或未定義)
用於播放內容的媒體元素。預設行為是使用網頁中找到的第一個媒體元素。
playbackConfig
(非空值的 cast.framework.PlaybackConfig 或未定義)
含有自訂參數的播放設定。
playWatchedBreak
(布林值或未定義)
如果為 true,即使已觀看過,系統仍會播放用戶端縫合的插斷。
preferredPlaybackRate
(數字或未定義)
如果載入要求中未指定播放速率,則使用此速率。允許範圍為 0.5 至 2,1 為正常速度。
preferredTextLanguage
(字串或未定義)
如果載入要求未指定有效軌,則用於文字軌的語言。
佇列
(非空值的 cast.framework.QueueBase 或未定義)
自訂佇列實作。
shakaVariant
(非空值的 cast.framework.ShakaVariant 或未定義)
應載入哪個版本的 Shaka Player。設為 cast.framework.ShakaVariant.DEBUG 即可載入偵錯版本。
shakaVersion
(字串或未定義)
Shaka 版本,格式為 MAJOR.MINOR.PATCH 或 MAJOR.MINOR.PATCH-SUFFIX,例如「4.15.12」(目前的預設值)。
支援的版本為 >=4.15.12 <5.0.0。 已淘汰但仍相容的版本為 >=2.5.6 <4.15.12。
注意:不建議使用舊於預設版本的 Shaka Player,因為最新版本已修正許多錯誤。您可以在這裡指定較新版本,選擇啟用預設尚未提供的其他修正或功能。不過請注意,日後發布的 Web 接收器 SDK 可能會變更支援的版本範圍,並強制使用您在此指定的版本以外的版本。這個旗標僅應做為暫時措施,且須在 Cast 支援團隊的指導下使用。(https://developers.google.com/cast/support) 使用時請自行承擔風險。
skipMplLoad
(布林值或未定義)
如果為 true,接收器就不會載入 MPL 播放器。
skipPlayersLoad
(布林值或未定義)
如果為 true,接收器就不會載入 MPL 或 Shaka 播放器程式庫。相當於將 skipMplLoad 和 skipShakaLoad 都設為 true。
skipShakaLoad
(布林值或未定義)
如果設為 true,接收器會禁止載入 Shaka 播放器。
statusText
(字串或未定義)
代表申請狀態的文字。且應符合國際化規則,因為傳送者應用程式可能會顯示這項資訊。
supportedCommands
(數字或未定義)
應用程式支援的媒體指令位元遮罩。系統一律必須支援 LOAD、PLAY、STOP、GET_STATUS。如未提供這個值,系統會假設也支援 PAUSE、SEEK、STREAM_VOLUME、STREAM_MUTE、EDIT_TRACKS 和 PLAYBACK_RATE。
uiConfig
(非空值的 cast.framework.ui.UiConfig 或未定義)
使用者介面設定。
useLegacyDashSupport
(布林值或未定義)
如果 true,請使用 MPL 處理 DASH 內容。
useShakaForHls
(布林值或未定義)
如果是 true,請使用 Shaka Player 播放 HLS 內容。預設為 false。
注意:Shaka Player 並非 HLS 內容的預設播放器,因為仍有部分功能尚未推出,且我們希望確保 Shaka Player 效能良好,並與 HLS 接收器廣泛相容,再將其設為預設播放器。如果您在正式發布前選擇使用 Shaka Player 播放 HLS,請回報遇到的任何問題。(https://developers.google.com/cast/support) 在全面推出適用於 HLS 的 Shaka Player 前,我們無法保證 Shaka Player 與 HLS 相容,如果遇到重大問題,我們可能會建議您將這個標記還原為預設設定。
versionCode
(數字或未定義)
做為內部版本號碼的整數,代表接收器版本。收集指標時,這組號碼只會用於區分接收器版本。每次發布時都應遞增,且在回溯時仍應繫結至該版本。