類別:QueueBase

建構函式

QueueBase

new QueueBase()

方法

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 會呼叫此方法。如果設定 nextCountprevCountfetchItems 只會傳回參照項目之後或之前的項目。如果同時設定了 nextCountprevCount,系統會傳回包含 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

Initial(requestData) 會傳回 (cast.framework.messages.QueueData) 或非空值 Promise,其中包含可為空值的 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

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

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

已插入的項目。

值不得為空值。

insertBefore

選用

號碼

位於插入清單後方的項目 ID。如未提供 ID,插入的清單會附加到佇列尾端。

onItemsRemoved

onItemsRemoved(itemIds)

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

參數

itemIds

數字陣列

已移除項目的 ID。

值不得為空值。

onItemsReordered

onItemsReordered(items, insertBefore)

指出已重新排序下列項目的回呼。

參數

items

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

重新排序的項目 ID。

值不得為空值。

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() 傳回 (空值的陣列非空值 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;或非空值 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)