クラス: QueueBase

cast.framework.QueueBase

class static

キューの基本実装です。

コンストラクタ

QueueBase

new QueueBase()

Methods

fetchItems

fetchItems(itemId, nextCount, prevCount) returns (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)

指定された itemID を参照として使用して、アイテムのウィンドウを取得します。このメソッドは、多くの場合、送信者のリクエストに起因して、追加のキューアイテムが必要な場合に MediaManager によって呼び出されます。nextCount または prevCount が設定されている場合、fetchItems は参照アイテムよりも前または後のアイテムのみを返します。nextCount と prevCount の両方が設定されている場合、itemId を含むアイテムのウィンドウが返されます。

パラメータ
itemId	数値 参照アイテムの ID です。
nextCount	数値 参照アイテムの後のアイテム数。
prevCount	数値 参照アイテムの前のアイテム数。

戻り値

(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

初期化(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-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-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

onCurrentItemIdChanged(itemId)

現在のアイテムを itemId に設定します。現在再生中のアイテムが変更されたときに、MediaManager によって呼び出されます。

パラメータ
itemId	数値 商品アイテムの一意の ID です。

onItemsInserted

onItemsInserted(items, insertBefore)

このセッションで次のアイテムがレシーバー キューに挿入されたことを示すコールバック。クラウドベースの実装では、この新しい情報に基づいてキューが更新される場合があります。

パラメータ
items	null 以外の cast.framework.messages.QueueItem の配列。 挿入されたアイテム。 値を null にすることはできません。
insertBefore	任意 数値 挿入されたリストの直後にあるアイテムの ID。ID が指定されていない場合、挿入されたリストはキューの末尾に追加されます。

onItemsRemoved

onItemsRemoved(itemIds)

このセッションのレシーバー キューから次の項目が削除されたことを示すコールバック。クラウドベースの実装では、この新しい情報に基づいてキューが更新される場合があります。

パラメータ
itemIds	数値の配列 削除されたアイテムの ID。 値を null にすることはできません。

onItemsReordered

onItemsReordered(items, insertBefore)

次のアイテムが並べ替えられたことを示すコールバック。

パラメータ
items	null 以外の cast.framework.messages.QueueItem の配列。 並べ替えられたアイテムの ID。 値を null にすることはできません。
insertBefore	任意 数値 並べ替えられたリストの直後にあるアイテムの ID。insertBefore が指定されていない場合、並べ替えられたリストがキューの末尾に追加されます。

関連ドキュメント

cast.framework.messages.QueueReorderRequestData#itemIds をご覧ください。

prevItems

prevItems(itemId) returns (nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-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 値でない cast.framework.messages.QueueItem の配列、または null 以外の cast.framework.messages.QueueItem の null 値許容配列の 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 値許容配列を含む非 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)