cast. framework. CastReceiverOptions
キャスト レシーバーのコンテキスト オプション。 すべてのプロパティは省略可能です。
コンストラクタ
CastReceiverOptions
new CastReceiverOptions()
プロパティ
adBreakPreloadTime
(数値または未定義)
個別の広告ブレークのコンテンツをプリロードするタイミング(秒単位)。これにより、ミッドロール挿入点を過度に前もってプリロードして、広告指標を混乱させることを回避できます。指定しない場合、デフォルトの 5 秒が使用されます。
customNamespaces
null 以外の cast.framework.system.MessageType プロパティを持つ null 以外のオブジェクト
カスタム メッセージの名前空間とそのタイプのマップ。カスタム メッセージの名前空間は、アプリケーションの起動前に初期化する必要があるため、レシーバー オプションで指定する必要があります。(ここで指定しない場合、デフォルトのメッセージ タイプは JSON です)。
disableIdleTimeout
(ブール値または未定義)
true の場合、アクティブな再生が停止した後にアイドル状態になったときに、レシーバーが閉じられないようにします。このプロパティは、メディアアプリ以外のアプリにのみ使用してください。
enforceSupportedCommands
ブール値
true の場合、supportedCommands マップにないメディア コマンドはエラーを生成します。cast.framework.messages.ErrorReason が NOT_SUPPORTED に設定されます。デフォルト値は false です。この場合、マップをチェックせずにメディア コマンドを実行できます。
localSenderId
(文字列または未定義)
ローカル リクエストに使用される送信者 ID。デフォルト値は「local」です。
maxInactivity
(数値または未定義)
アイドル状態の送信側接続を閉じるまでの最大時間(秒)。この値を設定すると、接続を維持するためのハートビート メッセージが有効になります。一般的な TCP タイムアウトよりも早く、応答しない送信者を検出するために使用されます。最小値は 5 秒です。上限は適用されませんが、通常、プラットフォームの TCP タイムアウトが有効になるまでに数分かかります。デフォルト値は 10 秒です。
mediaElement
(null 以外の HTMLMediaElement または未定義)
コンテンツを再生するメディア要素。デフォルトの動作では、ページ内で最初に見つかったメディア要素が使用されます。
playbackConfig
(null 以外の cast.framework.PlaybackConfig または未定義)
カスタム パラメータを使用した再生構成。
playWatchedBreak
(ブール値または未定義)
true の場合、クライアント側で挿入されたブレークは、すでに視聴されていても再生されます。
preferredPlaybackRate
(数値または未定義)
読み込みリクエストで指定されていない場合に使用する再生速度。許容範囲は 0.5 ~ 2 で、1 が通常の速度です。
preferredTextLanguage
(文字列または未定義)
読み込みリクエストでアクティブなトラックが指定されていない場合に、テキスト トラックに使用する言語。
キュー
(null 以外の cast.framework.QueueBase または未定義)
カスタムキューの実装。
shakaVariant
(null 以外の cast.framework.ShakaVariant または未定義)
読み込む Shaka Player のビルド。デバッグビルドを読み込むには、cast.framework.ShakaVariant.DEBUG に設定します。
shakaVersion
(文字列または未定義)
MAJOR.MINOR.PATCH または MAJOR.MINOR.PATCH-SUFFIX 形式の Shaka バージョン(例: 「4.15.56」(現在のデフォルト))。
サポートされているバージョンは 4.15.56 以上 6.0.0 未満です。非推奨ですが、互換性のあるバージョンは 2.5.6 以上 4.15.56 未満です。
注: デフォルトより古いバージョンの Shaka Player はおすすめしません。最新バージョンでは多くのバグが修正されています。新しいバージョンをここで指定すると、デフォルトではまだ利用できない追加の修正や機能を有効にできます。ただし、ウェブ レシーバー 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、再生速度 もサポートされていると見なされます。
uiConfig
(null 以外の cast.framework.ui.UiConfig または未定義)
UI の構成。
useLegacyDashSupport
(ブール値または未定義)
true の場合は、DASH コンテンツに MPL を使用します。
useShakaForHls
(ブール値または未定義)
true の場合、HLS コンテンツに Shaka Player を使用します。デフォルトは false です。
注: Shaka Player は、まだ一部の機能が不足しているため、HLS コンテンツのデフォルトにはなっていません。また、デフォルトにする前に、パフォーマンスが高く、HLS レシーバーとの幅広い互換性があることを確認する必要があるためです。正式リリース前に HLS 向け Shaka Player を有効にした場合は、問題が発生した際に報告していただくようお願いいたします。 (https://developers.google.com/cast/support)HLS 向け Shaka Player の完全リリース前は、HLS 向け Shaka Player の互換性は保証されません。重大な問題が発生した場合は、このフラグをデフォルト設定に戻すことをおすすめします。
versionCode
(数値または未定義)
レシーバーのバージョンを表す内部バージョン番号として使用される整数。この番号は、指標を収集するときにレシーバーのリリースを区別するためにのみ使用されます。リリースごとにインクリメントされ、ロールバックが発生した場合でもそのリリースにバインドされたままにする必要があります。