cast. framework. CastReceiverOptions
キャスト レシーバーのコンテキスト オプション。 すべてのプロパティは省略可能です。
コンストラクタ
CastReceiverOptions
新しい CastReceiverOptions()
プロパティ
customNamespaces
null 以外の cast.framework.system.MessageType プロパティを持つ非 null オブジェクト
カスタム メッセージの名前空間とそのタイプのマップ。カスタム メッセージの名前空間は、アプリの起動前に初期化する必要があるため、レシーバー オプションで指定する必要があります。 (ここで指定されていない場合、デフォルトのメッセージ タイプは JSON です)。
disableIdleTimeout
(ブール値または未定義)
true の場合、アクティブな再生が停止した後、レシーバがアイドル状態になってもレシーバは閉じられません。このプロパティはメディア以外のアプリでのみ使用してください。
enforceSupportedCommands
boolean
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 または未定義)
カスタムキューの実装。
shakaVersion
(文字列または未定義)
MAJOR.MINOR.PATCH 形式の Shaka バージョン。例: 「4.3.4」(現在のデフォルト)。
サポートされているバージョンは 3.3.16 以上 <5.0.0 です。非推奨になりましたが、引き続き互換性のあるバージョンは 2.5.6 <3.3.16.
注: 最新バージョンでは多くのバグが修正されているため、デフォルトより古いバージョンの Shaka Player はおすすめしません。新しいバージョンを指定すると、デフォルトではまだ利用できない追加の修正や機能をオプトインできます。ただし、Web Receiver 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 もサポートされるとみなされます。
- 関連ドキュメント
- cast.framework.messages.Command
uiConfig
(非 null cast.framework.ui.UiConfig または未定義)
UI 構成。
useLegacyDashSupport
(ブール値または未定義)
true
の場合、DASH コンテンツに MPL を使用します。
useShakaForHls
(ブール値または未定義)
true
の場合、HLS コンテンツには Shaka Player を使用します。デフォルトは false
です。
注: Shaka Player は HLS コンテンツのデフォルトではありません。まだ機能が不足しているためです。デフォルトに設定する前に、HLS レシーバーのパフォーマンスと幅広い互換性を確認したいからです。正式リリース前に Shaka Player for HLS にオプトインした場合は、問題が発生した場合はご報告ください。(https://developers.google.com/cast/support)Shaka Player for HLS の完全リリースに先立ち、Google は Shaka Player の HLS の互換性を保証しません。重要な問題が発生した場合は、このフラグをデフォルト設定に戻すことをおすすめします。
versionCode
(数値または未定義)
レシーバのバージョンを表す内部バージョン番号として使用される整数。この番号は、指標を収集する際にレシーバーのリリースを区別するためにのみ使用されます。リリースごとに増分し、ロールバックの際にそのリリースにバインドする必要があります。