クラス: 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

(文字列または未定義)

読み込みリクエストでアクティブなトラックが指定されていない場合に、テキスト トラックに使用する言語。

queue

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

カスタムキューの実装。

shakaVariant

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

読み込む Shaka Player のビルド。デバッグビルドを読み込むには、 cast.framework.ShakaVariant.DEBUG に設定します。

shakaVersion

(文字列または未定義)

Shaka のバージョン(MAJOR.MINOR.PATCH または MAJOR.MINOR.PATCH-SUFFIX 形式)。たとえば、「4.15.55」(現在のデフォルト)。

サポートされているバージョンは >=4.15.55 <5.0.0 です。 非推奨ですが、互換性のあるバージョンは >=2.5.6 <4.15.55 です。

注: 最新バージョンでは多くのバグが修正されているため、デフォルトより古い Shaka Player バージョンはおすすめしません。 新しいバージョンを指定すると、デフォルトではまだ利用できない追加の修正や機能を利用できます。ただし、Web Receiver SDK の今後のリリース では、サポートされるバージョンの範囲が変更され、 ここで指定したバージョン以外のバージョンを使用する必要が生じる可能性があります。このフラグは一時的な措置としてのみ使用し、キャスト サポートチームの指示に従ってください。(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 コンテンツのデフォルトではありません。公式リリース前に HLS 用の Shaka Player を選択した場合は、問題が発生した場合はご報告ください。(https://developers.google.com/cast/support)HLS 用の Shaka Player の完全リリース前は、HLS との Shaka Player の互換性について保証いたしかねます。重大な問題が発生した場合は、このフラグをデフォルト設定に戻すことをおすすめします。

versionCode

(数値または未定義)

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