cast. framework. QueueBase
Implémentation de base d'une file d'attente.
Constructeur
QueueBase
nouvelle QueueBase()
Méthodes
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)
Extrait une fenêtre d'éléments en utilisant le itemID
spécifié comme référence. Cette méthode est appelée par MediaManager
lorsqu'elle a besoin de plus d'éléments de file d'attente, souvent issus d'une requête d'expéditeur. Si nextCount
ou prevCount
sont définis, fetchItems
ne renvoie que les éléments situés après ou avant l'élément de référence. Si nextCount
et prevCount
sont tous les deux définis, une fenêtre d'éléments incluant itemId
est renvoyée.
Paramètres |
|
---|---|
itemId |
number ID de l'élément de référence. |
nextCount |
number Nombre d'éléments après l'élément de référence. |
prevCount |
number Nombre d'éléments avant l'élément de référence. |
- Renvoie
-
(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
initialiser(requestData) renvoie une valeur (cast.framework.messages.QueueData ou une promesse non nulle contenant cast.framework.messages.QueueData pouvant avoir une valeur nulle)
Initialise la file d'attente avec requestData
. Appelée lorsque le destinataire reçoit une nouvelle requête cast.framework.messages.Command.LOAD
. Si la valeur renvoyée est null
, l'implémentation par défaut de la mise en file d'attente crée une file d'attente basée sur queueData.items
ou sur le seul élément multimédia dans les données de requête LOAD
.
Paramètres |
|
---|---|
requestData |
cast.framework.messages.LoadRequestData La valeur ne doit pas être nulle. |
- Renvoie
-
(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)
Renvoie tous les éléments de la file d'attente après itemID
. Cet appel est appelé par MediaManager
.
Paramètres |
|
---|---|
itemId |
Facultatif number ID de l'élément de référence. |
- Renvoie
-
(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)
Définit l'élément actuel sur itemId
. Appelée par MediaManager
lorsqu'elle modifie l'élément en cours de lecture.
Paramètres |
|
---|---|
itemId |
number Identifiant unique de l'article. |
onItemsInserted
onItemsInserted(items, insertBefore)
Rappel qui indique que les éléments suivants ont été insérés dans la file d'attente du destinataire au cours de cette session. Une mise en œuvre dans le cloud peut mettre à jour sa file d'attente en fonction de ces nouvelles informations.
Paramètres |
|
---|---|
items |
Tableau de valeurs non nulles cast.framework.messages.QueueItem Articles insérés. La valeur ne doit pas être nulle. |
insertBefore |
Facultatif number ID de l'élément situé juste après la liste insérée. Si l'ID n'est pas fourni, la liste insérée a été ajoutée à la fin de la file d'attente. |
onItemsRemoved
onItemsRemoved(itemIds)
Rappel qui indique que les éléments suivants ont été supprimés de la file d'attente du destinataire dans cette session. Une mise en œuvre dans le cloud peut mettre à jour sa file d'attente en fonction de ces nouvelles informations.
Paramètres |
|
---|---|
itemIds |
Tableau de nombres ID des éléments supprimés La valeur ne doit pas être nulle. |
onItemsReordered
onItemsReordered(items, insertBefore)
Rappel indiquant que les articles suivants ont été réorganisés.
Paramètres |
|
---|---|
items |
Tableau de valeurs non nulles cast.framework.messages.QueueItem ID des articles réorganisés. La valeur ne doit pas être nulle. |
insertBefore |
Facultatif number ID de l'élément situé juste après la liste réorganisée. Si |
- Voir aussi
- cast.framework.messages.QueueReorderRequestData#itemIds pour en savoir plus.
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)
Renvoie tous les éléments antérieurs à itemID
. Cet élément est appelé par MediaManager
.
Paramètres |
|
---|---|
itemId |
Facultatif number ID de l'élément de référence. |
- Renvoie
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
brassage
shuffle() renvoie (tableau de valeurs nulles de cast.framework.messages.QueueItem non nuls ou promesse non nulle contenant un tableau de valeurs nulles de cast.framework.messages.QueueItem non nul)
Cette fonction brasse la file d'attente et renvoie de nouveaux éléments. Renvoie null
si l'opération n'est pas prise en charge.
- Renvoie
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
rétablir
unshuffle() renvoie (tableau de valeurs nulles de cast.framework.messages.QueueItem non nuls ou promesse non nulle contenant un tableau de valeurs nulles de cast.framework.messages.QueueItem non nuls)
Annule la lecture en mode aléatoire de la file d'attente et renvoie de nouveaux éléments. Renvoie null
si l'opération n'est pas prise en charge.
- Renvoie
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)