cast. framework. QueueBase
Implementação básica de uma fila.
Construtor
QueueBase
novo QueueBase()
Métodos
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)
Busca uma janela de itens usando o itemID
especificado como referência. Esse
método é chamado pelo MediaManager
quando precisa de mais itens da fila, geralmente
provenientes de uma solicitação do remetente. Se nextCount
ou prevCount
forem definidos, fetchItems
somente retornará itens depois ou antes do item de referência. Se nextCount
e prevCount
forem definidos, uma janela de itens
incluindo itemId
será retornada.
Parâmetro |
|
---|---|
itemId |
number ID do item de referência. |
nextCount |
number Número de itens após o item de referência. |
prevCount |
number Número de itens antes do item de referência. |
- Retorna
-
(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
launch(requestData) retorna (cast.framework.messages.QueueData ou promessa não nula contendo cast.framework.messages.QueueData anulável)
Inicializa a fila com requestData
. Chamado quando o receptor recebe uma nova solicitação cast.framework.messages.Command.LOAD
. Se isso retornar ou
for resolvido para null
, a implementação de enfileiramento padrão vai criar uma fila
com base em queueData.items
ou no único item de mídia nos dados da solicitação
LOAD
.
Parâmetro |
|
---|---|
requestData |
cast.framework.messages.LoadRequestData O valor não pode ser nulo. |
- Retorna
-
(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)
Retorna todos os itens na fila após itemID
. Isso é chamado por MediaManager
.
Parâmetro |
|
---|---|
itemId |
Opcional number ID do item de referência. |
- Retorna
-
(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)
Define o item atual como itemId
. Chamado por MediaManager
quando muda o item em reprodução no momento.
Parâmetro |
|
---|---|
itemId |
number O ID exclusivo do item. |
onItemsInserted
onItemsInserted(items, insertBefore)
Um callback que indica que os itens a seguir foram inseridos na fila receptora nesta sessão. Uma implementação baseada na nuvem pode atualizar a fila com base nessas novas informações.
Parâmetro |
|
---|---|
items |
Matriz de cast.framework.messages.QueueItem não nulo Itens que foram inseridos. O valor não pode ser nulo. |
insertBefore |
Opcional number ID do item localizado imediatamente após a lista inserida. Se o ID não for fornecido, a lista inserida será anexada ao final da fila. |
onItemsRemoved
onItemsRemoved(itemIds)
Um callback que indica que os itens a seguir foram removidos da fila do receptor nesta sessão. Uma implementação baseada na nuvem pode atualizar a fila com base nessas novas informações.
Parâmetro |
|
---|---|
itemIds |
Matriz de números Os códigos dos itens que foram removidos O valor não pode ser nulo. |
onItemsReordered
onItemsReordered(items, insertBefore)
Um callback que indica que os itens a seguir foram reordenados.
Parâmetro |
|
---|---|
items |
Matriz de cast.framework.messages.QueueItem não nulo Os códigos dos itens que foram reordenados. O valor não pode ser nulo. |
insertBefore |
Opcional number Código do item localizado imediatamente após a lista reordenada. Se |
- Veja também
- cast.framework.messages.QueueReorderRequestData#itemIds para conferir mais detalhes.
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)
Retorna todos os itens anteriores a itemID
. Isso é chamado por MediaManager
.
Parâmetro |
|
---|---|
itemId |
Opcional number ID do item de referência. |
- Retorna
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
embaralhamento
shuffle() retorna (matriz anulável de cast.framework.messages.QueueItem não nulo ou promessa não nula contendo uma matriz anulável de cast.framework.messages.QueueItem não nulo)
Embaralhe a fila e retorna novos itens. Retornará null
se a
operação não for compatível.
- Retorna
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
desordenar
unshuffle() retorna (Matriz anulável de cast.framework.messages.QueueItem não nulo ou promessa não nula contendo uma matriz anulável de cast.framework.messages.QueueItem não nulo)
Desordena a fila e retorna novos itens. Retornará null
se a
operação não for compatível.
- Retorna
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)