クラス: CastReceiverOptions

コンストラクタ

CastReceiverOptions

新しい CastReceiverOptions()

プロパティ

customNamespace

null 以外のオブジェクト(cast.framework.system.MessageType プロパティ)

カスタム メッセージの名前空間とそのタイプのマップ。カスタム メッセージの名前空間は、アプリケーションの起動前に初期化する必要があります。そのため、受信者のオプションで指定する必要があります。(ここに指定しない場合、デフォルトのメッセージ タイプは JSON です)。

disableIdleTimeout

(ブール値または未定義)

true の場合、アクティブな再生が停止した後にレシーバがアイドル状態になったときに、レシーバが閉じないようにします。このプロパティは、メディア以外のアプリにのみ使用してください。

applySupportedCommands

定数

ブール値

true の場合、supportedCommands マップにないメディア コマンドはエラーになります。cast.framework.messages.ErrorReason は NOT_SUPPORTED に設定されます。デフォルト値は false です。この場合、マップを確認せずにメディア コマンドを実行できます。

localSenderId

(文字列または未定義)

ローカル リクエストに使用される送信者 ID。デフォルト値は 'local' です。

最大非アクティブ

(number または 未定義)

アイドル状態の送信者接続を終了するまでの時間(秒)。この値を設定すると、接続を維持するハートビート メッセージが有効になります。応答しない送信者を標準的な TCP タイムアウトよりも速く検出するために使用されます。最小値は 5 秒です。上限は適用されませんが、プラットフォームの TCP タイムアウトが有効になるまでに通常は数分かかります。デフォルト値は 10 秒です。

mediaElement

(null 以外の HTMLMediaElement または未定義)

コンテンツの再生に使用するメディア要素。デフォルトの動作では、ページで最初に見つかったメディア要素が使用されます。

playConfig

(null 以外の cast.framework.PlaybackConfig または未定義)

カスタム パラメータを含む再生設定。

playWatchedBreak

(ブール値または未定義)

true の場合、クライアント結合のブレークは再生済みの場合でも再生されます。

PreferredPlaybackRate

(number または 未定義)

読み込みリクエストで指定されていない場合に使用する再生速度。許容範囲は 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

(文字列または未定義)

申請状況を表すテキスト。国際化ルール(送信者のアプリケーションによって表示される場合がある)を満たしている必要があります。

サポートされているコマンド

(number または 未定義)

アプリがサポートするメディア コマンドのビットマスク。LOAD、PLAY、STOP、GET_STATUS を常にサポートする必要があります。この値が指定されていない場合、PAUSE、SEEK、STREAM_VOLUME、STREAM_MUTE、EDIT_TRACKS、PLAYBACK_RATE もサポートされていると見なされます。

関連ドキュメント
cast.framework.messages.Command

UI

(null 以外の cast.framework.ui.UiConfig または未定義)

UI 構成。

useLegacyDashSupport

(ブール値または未定義)

true の場合は、MPL を DASH コンテンツに使用します。

#useShakaForHls

(ブール値または未定義)

true の場合、HLS コンテンツの再生に Shaka Player を使用します。デフォルトは false です。

注: Shaka Player は、まだ機能が欠落しており、HLS レシーバーをデフォルトにする前にパフォーマンスと HLS レシーバーとの幅広い互換性を確保するために、HLS コンテンツのデフォルトではありません。公式リリース前に HLS 用の Shaka Player にオプトインした場合は、発生した問題について報告してください。 (https://developers.google.com/cast/support)HLS 用の Shaka Player の完全なリリース前に、HLS に対する Shaka Player の互換性について保証されません。重大な問題が発生した場合は、このフラグをデフォルト設定に戻すことをおすすめします。

versionCode

(number または 未定義)

レシーバのバージョンを表す内部バージョン番号として使用される整数。この数値は、指標を収集する際にレシーバー リリースを区別するためにのみ使用されます。リリースのたびに増分し、ロールバックが発生した場合もそのリリースにバインドする必要があります。