cast. framework. messages。 QueueInsertRequestData
メディア イベント キューの INSERT リクエスト データ。
コンストラクタ
QueueInsertRequestData
新しい QueueInsertRequestData(items)
パラメータ |
|
---|---|
items |
null 以外の cast.framework.messages.QueueItem の配列 キュー アイテムのリスト。商品アイテムの itemId フィールドは空にする必要があります。指定しない場合、リクエストは INVALID_PARAMS エラーで失敗します。並べ替えられます(最初の要素が最初に再生されます)。 値を null にすることはできません。 |
プロパティ
currentItemId
(数値または未定義)
挿入後の現在のメディア アイテムの ID(指定しない場合、currentItem の値は挿入前と同じになります)。
currentItemIndex
(数値または未定義)
新しい現在のメディア アイテムのインデックス(0 から始まる items 配列に対する相対パス)。挿入されたアイテムについては、現在のアイテムが挿入されるまでインデックスを使用します(QUEUE_LOAD の startIndex に似ています)。また、現在のアイテムが挿入されるまで itemId が不明なため、現在のアイテム ID は使用しません。指定しない場合、currentItem の値は挿入前と同じ値になります(currentItemId が指定されている場合を除く)。このパラメータにより、アイテムの挿入と再生の一般的なユースケースをアトミックにすることができます。
currentTime
(数値または未定義)
現在のアイテムの再生を開始するコンテンツ開始からの秒数。指定した場合、QueueItem レベルで指定した startTime 値よりも優先されますが、これはアイテムを初めて再生したときのみです。これは、QueueItem startTime と同様に、currentTime がアイテムに恒久的に適用されるのではなく、ユーザーがアイテムの中央に移動する場合をカバーする一般的なケースを想定しています。startTime を動的にリセットする必要はありません(スマートフォンがスリープ状態になった場合はリセットできない可能性があります)。
カスタムデータ
(null 以外のオブジェクトや未定義)
このリクエストのアプリケーション固有のデータ。これによって、送信者と受信者は、カスタム メッセージで新しい名前空間を使用することなく、メディア プロトコルを簡単に拡張できます。
insertBefore
(数値または未定義)
挿入されたリストの直後に配置されるアイテムの ID。 ID が見つからない場合、または指定しない場合は、既存のリストの末尾にリストが追加されます。
items
非 null の cast.framework.messages.QueueItem の配列
キュー アイテムのリスト。アイテムの itemId フィールドは空にする必要があります。並べ替えられます(最初の要素が最初に再生されます)。
mediaSessionId
(数値または未定義)
リクエストが適用されるメディア セッションの ID。
requestId
数値
リクエストの ID。リクエスト/レスポンスを関連付けるために使用されます。
シーケンス番号
(数値または未定義)
すべてのキューコマンドを同期する番号。キューコマンドに指定されている場合、SDK はキューの最新シーケンス番号がリクエストと一致することを確認します。現在のシーケンス番号は、送信キューの変更メッセージの一部として提供されます。