cast. framework. 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
需要更多队列项(通常源自发送者请求)时,它会调用此方法。如果设置了 nextCount
或 prevCount
,fetchItems
将仅返回引用项之后或之前的项。如果同时设置了 nextCount
和 prevCount
,则返回包含 itemId
的项目窗口。
参数 |
|
---|---|
itemId |
number 参考文件的 ID。 |
nextCount |
number 参考项后面的项数。 |
prevCount |
number 参考项前面的项数。 |
- 返回
-
(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-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
返回 itemID
之后队列中的所有项。此方法由 MediaManager
调用。
参数 |
|
---|---|
itemId |
可选 number 参考文件的 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 |
number 商品的唯一 ID。 |
onItemsInserted
onItemsInserted(items, insertBefore)
一个回调,用于指示以下项已在此会话的接收器队列中插入。云端实现可能会根据这些新信息更新其队列。
参数 |
|
---|---|
items |
非 null cast.framework.messages.QueueItem 数组 已插入的项。 值不能为 null。 |
insertBefore |
可选 number 紧挨着插入列表之后的项的 ID。如果未提供 ID,则插入的列表会附加到队列末尾。 |
onItemsRemoved
onItemsRemoved(itemIds)
一个回调,用于指示以下项已从此会话的接收器队列中移除。云端实现可能会根据这些新信息更新其队列。
参数 |
|
---|---|
itemIds |
数字数组 已移除的项的 ID。 值不能为 null。 |
onItemsReordered
onItemsReordered(items, insertBefore)
指示以下项已重新排序的回调。
参数 |
|
---|---|
items |
非 null cast.framework.messages.QueueItem 数组 重新排序的项的 ID。 值不能为 null。 |
insertBefore |
可选 number 位于重新排序列表之后的项的 ID。如果未提供 |
- 另请参阅
- 如需了解详情,请使用 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 |
可选 number 参考文件的 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 的非 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 的非 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)