cast.
キューのベース実装。
コンストラクタ
キューベース
新しい QueueBase()
Methods
fetchItems
fetchItems(itemId, nextCount, prevCount)は、null（非 null の cast.framework.messages.QueueItem の配列、または null 以外の cast.framework.messages.QueueItem の null 以外の配列を含む）を返します。
指定された itemID をリファレンスとしてアイテムのウィンドウを取得します。このメソッドは、より多くのキューアイテムが必要な場合に MediaManager によって呼び出されます（多くの場合、送信者のリクエストに起因）。nextCount または prevCount が設定されている場合、fetchItems は参照アイテムより前または前のアイテムのみを返します。nextCount と prevCount を両方とも設定した場合は、itemId を含むアイテムのウィンドウが返されます。
パラメータ |
|
|---|---|
|
itemId |
数値 参照項目の ID。 |
|
NextCount |
数値 参照項目の後の項目数。 |
|
予測数 |
数値 参照項目の前の項目数。 |
- 戻り値
-
(non-null Array of non-null cast.framework.messages.QueueItem or non-null Promise containing non-null Array of non-null cast.framework.messages.QueueItem)
initialize
initialize(requestData) は、cast.framework.messages.QueueData または null 値許容の cast.framework.messages.QueueData を含む null 以外の Promise を返します。
requestData を使用してキューを初期化します。受信者が新しい cast.framework.messages.Command.LOAD リクエストを受け取ったときに呼び出されます。これが null に返されるか、解決された場合、デフォルトのキュー実装では、queueData.items または LOAD リクエスト データの単一のメディア アイテムに基づいてキューが作成されます。
パラメータ |
|
|---|---|
|
requestData |
cast.framework.messages.LoadRequestData 値を null にすることはできません。 |
- 戻り値
-
(nullable cast.framework.messages.QueueData or non-null Promise containing nullable cast.framework.messages.QueueData)
nextItems
nextItems(itemId) returns (nullable Array of non-nullcast.framework.messages.QueueItem または null 値非許容の配列 cast.framework.messages.QueueItem
itemID 以降のキューにあるすべてのアイテムを返します。これは MediaManager によって呼び出されます。
パラメータ |
|
|---|---|
|
itemId |
任意 数値 参照項目の ID。 |
- 戻り値
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
onCurrentItemIdChanged（現在のアイテム ID の変更）
onCurrentItemIdChanged(itemId)
現在のアイテムを itemId に設定します。現在再生中のアイテムが変更されたときに MediaManager によって呼び出されます。
パラメータ |
|
|---|---|
|
itemId |
数値 アイテムの一意の ID。 |
onItemsInserted
onItemsInserted(items, insertBefore)
このセッションのレシーバー キューに次の項目が挿入されたことを示すコールバック。クラウドベースの実装では、この新しい情報に基づいてキューが更新される可能性があります。
パラメータ |
|
|---|---|
|
items |
null 以外の cast.framework.messages.QueueItem の配列 挿入されたアイテム。 値を null にすることはできません。 |
|
insertBefore |
任意 数値 挿入されたリストの直後に配置されたアイテムの ID。ID が指定されていない場合、挿入されたリストがキューの末尾に追加されます。 |
onItemsRemoved
onItemsRemoved(itemIds)
このセッションでレシーバー キューから次の項目が削除されたことを示すコールバック。クラウドベースの実装では、この新しい情報に基づいてキューが更新される可能性があります。
パラメータ |
|
|---|---|
|
アイテム ID |
数値の配列 削除されたアイテムの ID。 値を null にすることはできません。 |
onItemsReordered（アイテムの並べ替え）
onItemsReordered(items, insertBefore)
次のアイテムが並べ替えられたことを示すコールバック。
パラメータ |
|
|---|---|
|
items |
null 以外の cast.framework.messages.QueueItem の配列 並べ替えられたアイテムの ID。 値を null にすることはできません。 |
|
insertBefore |
任意 数値 並べ替えたリストの直後にあるアイテムの ID。 |
- 関連ドキュメント
- 詳しくは、cast.framework.messages.QueueReorderRequestData#itemIds をご覧ください。
前のアイテム
prevItems(itemId) return (nullable Array of non-nullcast.framework.messages.QueueItem または null 値非許容の Array of Null cast.framework.messages.QueueItem
itemID より前のすべてのアイテムを返します。これは MediaManager によって呼び出されます。
パラメータ |
|
|---|---|
|
itemId |
任意 数値 参照項目の ID。 |
- 戻り値
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
シャッフル
shuffle() から返される null 以外の null（cast.framework.messages.QueueItem または null 以外の cast.framework.messages.QueueItem の null 許容配列を含む Promise）
キューをシャッフルして、新しいキュー アイテムを返します。オペレーションがサポートされていない場合は、null を返します。
- 戻り値
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
シャッフルを解除
unshuffle() は null 以外の cast.framework.messages.QueueItem の null 値許容配列、または null ではない cast.framework.messages.QueueItem の null 値許容配列を含む Promise）
キューのシャッフルを解除し、新しいキュー アイテムを返します。オペレーションがサポートされていない場合は、null を返します。
- 戻り値
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)