クラス: QueueInsertRequestData

コンストラクタ

QueueInsertRequestData

new QueueInsertRequestData(items)

パラメータ

items

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

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

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

拡張
cast.framework.messages.RequestData

プロパティ

currentItemId

(数値または未定義)

挿入後の現在のメディア アイテムの ID(指定しない場合、currentItem 値は挿入前と同じになります)。

currentItemIndex

(数値または未定義)

現在の新しいメディア アイテムのインデックス(0 から始まる items 配列からの相対名)。挿入されたアイテムには、現在のアイテム ID ではなくインデックス(QUEUE_LOAD の startIndex に類似)を使用します。これは、アイテムが挿入されるまで itemId が不明であるためです。指定しない場合、currentItem の値は挿入前と同じになります(currentItemId が指定されていない場合)。このパラメータを使用すると、アイテムの挿入と再生の一般的なユースケースをアトミックにできます。

currentTime

(数値または未定義)

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

customData

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

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

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

insertBefore

(数値または未定義)

挿入されたリストの直後に配置されるアイテムの ID。 ID が見つからない場合、または ID を指定しない場合、既存のリストの末尾にリストが追加されます。

items

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

キュー内のアイテムのリスト。アイテムの itemId フィールドは空にする必要があります。並べ替えられます(最初の要素が最初に再生されます)。

mediaSessionId

(数値または未定義)

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

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

requestId

数値

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

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

sequenceNumber

(数値または未定義)

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

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