cast. framework. QueueBase
Cách triển khai cơ sở của hàng đợi.
Hàm dựng
QueueBase
mới QueueBase()
Phương thức
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)
Tìm nạp một cửa sổ các mục bằng cách sử dụng itemID
được chỉ định làm tham chiếu. Phương thức này được MediaManager
gọi khi cần thêm các mục trong hàng đợi, thường xuất phát từ yêu cầu của người gửi. Nếu bạn đặt nextCount
hoặc prevCount
, thì fetchItems
sẽ chỉ trả về các mục sau hoặc trước mục tham chiếu. Nếu bạn đặt cả nextCount
và prevCount
, thì một cửa sổ các mục trong đó có itemId
sẽ được trả về.
Thông số |
|
---|---|
itemId |
number Mã của mục tham chiếu. |
nextCount |
number Số mục sau mục tham chiếu. |
prevCount |
number Số lượng mục trước mục tham chiếu. |
- Trả bóng
-
(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
khởi tạo(requestData) trả về (cast.framework.messages.QueueData hoặc Lời hứa hẹn không có giá trị rỗng chứa cast.framework.messages.QueueData) có giá trị rỗng)
Khởi động hàng đợi bằng requestData
. Được gọi khi trình nhận nhận được một yêu cầu cast.framework.messages.Command.LOAD
mới. Nếu thuộc tính này trả về hoặc phân giải thành null
, thì phương thức triển khai hàng đợi mặc định sẽ tạo một hàng đợi dựa trên queueData.items
hoặc trên một mục nội dung đa phương tiện trong dữ liệu yêu cầu LOAD
.
Thông số |
|
---|---|
requestData |
cast.framework.messages.LoadRequestData Giá trị không được rỗng. |
- Trả bóng
-
(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)
Trả về mọi mục trong hàng đợi theo sau itemID
. Phương thức này do MediaManager
gọi.
Thông số |
|
---|---|
itemId |
Không bắt buộc number Mã của mục tham chiếu. |
- Trả bóng
-
(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)
Đặt mục hiện tại thành itemId
. Được MediaManager
gọi khi thay đổi mục đang phát.
Thông số |
|
---|---|
itemId |
number Mã nhận dạng duy nhất của mục. |
onItemsInserted
onItemsInserted(items, insertBefore)
Lệnh gọi lại cho biết các mục sau đã được chèn vào hàng đợi của trình nhận trong phiên này. Một phương thức triển khai trên đám mây có thể cập nhật hàng đợi dựa trên thông tin mới này.
Thông số |
|
---|---|
items |
Mảng cast.framework.messages.QueueItem không có giá trị null Các mục đã được chèn. Giá trị không được rỗng. |
insertBefore |
Không bắt buộc number Mã nhận dạng của mục nằm ngay sau danh sách được chèn. Nếu bạn không cung cấp mã nhận dạng thì danh sách đã chèn đã được thêm vào cuối danh sách chờ. |
onItemsRemoved
onItemsRemoved(itemIds)
Lệnh gọi lại cho biết các mục sau đã bị xoá khỏi hàng đợi của trình nhận trong phiên này. Một phương thức triển khai trên đám mây có thể cập nhật hàng đợi dựa trên thông tin mới này.
Thông số |
|
---|---|
itemIds |
Mảng số Mã của các mục đã bị xoá. Giá trị không được rỗng. |
onItemsReordered
onItemsReordered(items, insertBefore)
Lệnh gọi lại cho biết các mặt hàng sau đã được sắp xếp lại.
Thông số |
|
---|---|
items |
Mảng cast.framework.messages.QueueItem không có giá trị null Mã của các mục được sắp xếp lại. Giá trị không được rỗng. |
insertBefore |
Không bắt buộc number Mã nhận dạng của mục nằm ngay sau danh sách được sắp xếp lại. Nếu bạn không cung cấp |
- Xem thêm
- cast.framework.messages.QueueReorderRequestData#itemIds để biết thêm thông tin chi tiết.
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)
Trả về tất cả các mục trước itemID
. Phương thức này do MediaManager
gọi.
Thông số |
|
---|---|
itemId |
Không bắt buộc number Mã của mục tham chiếu. |
- Trả bóng
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
phát ngẫu nhiên
ngẫu nhiên() trả về (Mảng không có giá trị rỗng cast.framework.messages.QueueItem hoặc Lời hứa không có giá trị null) chứa Mảng cast.framework.messages.QueueItem có giá trị không rỗng)
Xáo trộn hàng đợi và trả về các mục mới trong hàng đợi. Trả về null
nếu thao tác này không được hỗ trợ.
- Trả bóng
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
tháo gỡ
unshuffle() trả về (Mảng có giá trị rỗng của cast.framework.messages.QueueItem không có giá trị rỗng hoặc Lời hứa không có giá trị rỗng chứa Mảng của cast.framework.messages.QueueItem) có giá trị rỗng)
Huỷ xáo trộn hàng đợi và trả về các mục mới trong hàng đợi. Trả về null
nếu thao tác này không được hỗ trợ.
- Trả bóng
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)