クラス: QueueLoadRequestData

コンストラクタ

QueueLoadRequestData

new QueueLoadRequestData(items)

パラメータ

items

null 以外の cast.framework.messages.QueueItem の配列。

キュー内のアイテムのリスト。 アイテムの itemId フィールドは空にする必要があります。空でない場合、リクエストは INVALID_PARAMS エラーで失敗します。並べ替えられます(最初の要素が最初に再生されます)。

値を null にすることはできません。

拡張
cast.framework.messages.RequestData

プロパティ

currentTime

(数値または未定義)

再生される最初のアイテムの再生を開始する秒数(コンテンツの先頭から)。 指定した場合、この値は QueueItem レベルで指定された startTime 値よりも優先されます。ただし、これはアイテムの初回再生時のみ可能です。これは、ユーザーがローカルで再生していたアイテムをキャストして、QueueItem startTime のように currentTime がアイテムに永続的に適用されない場合の一般的なケースです。これにより、startTime を動的にリセットする必要がなくなります(スマートフォンがスリープ状態になった場合はリセットできない可能性があります)。

customData

(非 null オブジェクトまたは未定義)

このリクエストのアプリケーション固有のデータ。これにより、センダーとレシーバーは、カスタム メッセージで新しい名前空間を使用する必要なく、メディア プロトコルを簡単に拡張できます。

継承元
cast.framework.messages.RequestData#customData

items

null 以外の cast.framework.messages.QueueItem の配列。

キュー内のアイテムの配列。並べ替えられます(最初の要素が最初に再生されます)。

mediaSessionId

(数値または未定義)

リクエストが適用されるメディア セッションの ID。

継承元
cast.framework.messages.RequestData#mediaSessionId

repeatMode

cast.framework.messages.RepeatMode または未定義)

すべてのアイテムが再生されたときのキューの動作。

requestId

数値

リクエストの ID。リクエストとレスポンスの関連付けに使用されます。

継承元
cast.framework.messages.RequestData#requestId

sequenceNumber

(数値または未定義)

すべてのキューコマンドを同期するための数値。 キューコマンドで指定すると、SDK はキューの最新のシーケンス番号がリクエストと一致することを確認します。 現在のシーケンス番号は、送信キュー変更メッセージの一部として提供されます。

継承元
cast.framework.messages.RequestData#sequenceNumber

startIndex

(数値または未定義)

items 配列内のアイテムのインデックス。最初の currentItem(最初に再生されるアイテム)でなければなりません。これは配列のインデックス(0 から開始)であり、itemId ではありません(キューが作成されるまではわからないため)。repeatMode を REPEAT_OFF に設定した場合、配列内の最後のアイテムが再生された時点で再生が終了します(startIndex より前の要素は再生されません)。これは、ユーザーがすでに送信側アプリを使用していて、途中でキャストすることを決めた続行のシナリオに対して有用です。これにより、送信側アプリはローカルとリモートのキュー位置をマッピングする必要がなくなり、追加の QUEUE_UPDATE リクエストを 1 つ減らすことができます。