類別:QueueBase

建構函式

佇列基礎

新的 QueueBase()

方法

擷取項目

fetchItems(itemId, nextCount, prevCount) return (非空值 cast.framework.messages.QueueItem 或包含非空值 cast.framework.messages.QueueItem 的非空值陣列)

以指定的 itemID 做為參照項目視窗。如果 MediaManager 需要更多佇列項目 (通常是來自某個寄件者要求),就會呼叫這個方法。如果同時設定了 nextCountprevCountfetchItems 只會傳回參照項目前後的項目。如果同時設定了 nextCountprevCount,系統會傳回包含 itemId 的項目視窗。

參數

項目編號

數字

參考項目的 ID。

下一個計數

數字

參照項目後方的項目數。

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 或包含空值的 cast.framework.messages.QueueData 的非空值承諾)

使用 requestData 初始化佇列。當接收端收到新的 cast.framework.messages.Command.LOAD 要求時呼叫。如果這個方法傳回或解析為 null,預設的佇列實作功能將根據 queueData.itemsLOAD 要求資料中的單一媒體項目來建立佇列。

參數

requestData (要求資料)

cast.framework.messages.LoadRequestData

值不得為空值。

傳回

(nullable cast.framework.messages.QueueData or non-null Promise containing nullable cast.framework.messages.QueueData) 

下一個項目

nextItems(itemId) 會傳回 (可為非空值 cast.framework.messages.QueueItem 的非空值陣列,或包含非空值 cast.framework.messages.QueueItem 的空值空值陣列)

傳回佇列在 itemID 之後的所有項目。這會由 MediaManager 呼叫。

參數

項目編號

選用

數字

參考項目的 ID。

傳回

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem) 

onCurrentItemId 已變更

onCurrentItemIdChanged(itemId)

將目前項目設為 itemId。當 MediaManager 變更目前播放的項目時呼叫。

參數

項目編號

數字

商品的專屬 ID。

已插入 onItems

onItemsInserted(items, insertBefore)

這個回呼指出此項目已在此工作階段中插入接收器佇列。雲端式實作可能會根據這項新資訊更新佇列。

參數

items

非空值 cast.framework.messages.QueueItem 的陣列

插入的項目。

值不得為空值。

插入前

選用

數字

插入清單之後,該項目的 ID。如未提供 ID,插入的清單會新增至佇列結尾。

onItems 已移除

onItemsRemoved(itemIds)

這個回呼指出下列項目已從這個工作階段的接收器佇列中移除。雲端式實作可能會根據這項新資訊更新佇列。

參數

項目編號

數字陣列

已移除項目的 ID。

值不得為空值。

已訂購的 onItems

onItemsReordered(items, insertBefore)

表示下列項目已重新排序的回呼。

參數

items

非空值 cast.framework.messages.QueueItem 的陣列

已重新排序之項目的 ID。

值不得為空值。

插入前

選用

數字

已重新排序的清單之後立即出現的項目 ID。如未提供 insertBefore,重新排序的清單將會附加至佇列結尾。

另請參閱
cast.framework.messages.QueueReorderRequestData#itemIds

prevItems

prevItems(itemId) 會傳回 (可為非空值 cast.framework.messages.QueueItem 的非空值陣列,或包含非空值 cast.framework.messages.QueueItem 的空值空值陣列)

傳回 itemID 之前的所有項目。這會由 MediaManager 呼叫。

參數

項目編號

選用

數字

參考項目的 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() 會傳回 (可為非空值的 cast.framework.messages.QueueItem 或不可為空值的 Promise,包含非空值 cast.framework.messages.QueueItem) 的陣列。

隨機播放佇列,並傳回新的佇列項目。如果作業不受支援,則傳回 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() 會傳回 (可為非空值 cast.framework.messages.QueueItem,或包含非空值 cast.framework.messages.QueueItem 的空值空值陣列) 的可為空值陣列。

重組佇列,並傳回新的佇列項目。如果作業不受支援,則傳回 null

傳回

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)