Classe: QueueBase

Constructeur

Base de files d'attente

new QueueBase()

Méthodes

fetchItems

fetchItems(itemId, nextCount, prevCount) renvoie (tableau non nul de valeur cast.framework.messages.QueueItem non nulle ou de promesse non nulle contenant un tableau non nul contenant un tableau null.framework.messages.QueueItem non nul).

Récupère une fenêtre d'éléments en utilisant le itemID spécifié. Cette méthode est appelée par MediaManager lorsqu'elle a besoin de davantage d'éléments de file d'attente, souvent issus d'une requête d'expéditeur. Si la valeur nextCount ou prevCount est définie, fetchItems ne renvoie que les éléments situés après l'élément de référence ou avant. Si nextCount et prevCount sont tous deux définis, une fenêtre d'éléments comprenant itemId est renvoyée.

Paramètre

itemId

number (nombre)

ID de l'élément de référence.

nombreSuivant

number (nombre)

Nombre d'éléments après l'élément de référence.

nombre préc.

number (nombre)

Nombre d'éléments avant l'élément de référence.

Retours

(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) returns (cast.framework.messages.QueueData ou Promise non nulle contenant cast.framework.messages.QueueData pouvant être vide)

Initialise la file d'attente avec requestData. Appelée lorsque le destinataire reçoit une nouvelle requête cast.framework.messages.Command.LOAD. Si cette erreur renvoie ou renvoie null, l'implémentation de la file d'attente par défaut crée une file d'attente basée sur queueData.items ou sur l'élément multimédia unique dans les données de requête LOAD.

Paramètre

requestData

cast.framework.messages.LoadRequestData

La valeur ne doit pas être nulle.

Retours

(nullable cast.framework.messages.QueueData or non-null Promise containing nullable cast.framework.messages.QueueData) 

éléments suivants

nextItems(itemId) renvoie (tableau nul pouvant contenir la valeur null.cast.framework.messages.QueueItem non nulle ou contient une promesse non nulle contenant un tableau NULL pouvant être défini sur un élément cast.framework.messages.QueueItem pouvant être vide).

Renvoie tous les éléments dans la file d'attente après itemID. Cette méthode est appelée par MediaManager.

Paramètre

itemId

Facultative

number (nombre)

ID de l'élément de référence.

Retours

(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é par MediaManager lorsqu'il modifie l'élément en cours de lecture

Paramètre

itemId

number (nombre)

Identifiant unique de l'article.

OnItemsInserted

onItemsInserted(items, insertBefore)

Un rappel indiquant que les éléments suivants ont été insérés dans la file d'attente du récepteur dans cette session. Une mise en œuvre dans le cloud peut mettre à jour sa file d'attente en fonction de ces nouvelles informations.

Paramètre

items

Tableau de valeurs cast.framework.messages.QueueItem non nulles

Articles insérés.

La valeur ne doit pas être nulle.

insérerAvant

Facultative

number (nombre)

ID de l'élément situé immédiatement après la liste insérée. Si cet ID n'est pas fourni, la liste insérée a été ajoutée à la fin de la file d'attente.

onItemsRemoved

onItemsRemoved(itemIds) :

Un rappel indiquant que les éléments suivants ont été supprimés de la file d'attente du récepteur dans cette session. Une mise en œuvre dans le cloud peut mettre à jour sa file d'attente en fonction de ces nouvelles informations.

Paramètre

ID articles

Tableau de nombres

Identifiants des articles supprimés.

La valeur ne doit pas être nulle.

onItemsReorder

onItemsReordered(items, insertBefore)

Un rappel indiquant que les articles suivants ont été réorganisés

Paramètre

items

Tableau de valeurs cast.framework.messages.QueueItem non nulles

ID des éléments qui ont été réorganisés.

La valeur ne doit pas être nulle.

insérerAvant

Facultative

number (nombre)

ID de l'élément qui se trouve immédiatement après la liste. Si insertBefore n'est pas fourni, la liste réorganisée est ajoutée à la fin de la file d'attente.

Voir aussi
cast.framework.messages.QueueReorderRequestData#itemIds pour en savoir plus.

PrevItems

prevItems(itemId) renvoie (tableau nul pouvant être vide) cast.framework.messages.QueueItem ou promesse non nulle contenant un tableau nul pouvant contenir la valeur null.cast.framework.messages.QueueItem.

Renvoie tous les articles avant le itemID. Cette méthode est appelée par MediaManager.

Paramètre

itemId

Facultative

number (nombre)

ID de l'élément de référence.

Retours

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem) 

brassage

La fonction shuffle() renvoie (tableau null pouvant être vide de cast.framework.messages.QueueItem non nul ou une promesse non nulle contenant un tableau NULL de valeur cast.framework.messages.QueueItem non nulle).

Cette option permet de lire la file d'attente en mode aléatoire et de renvoyer les nouveaux éléments. Renvoie null si l'opération n'est pas acceptée.

Retours

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem) 

lecture aléatoire

Unshuffle() renvoie (tableau null pouvant être vide de cast.framework.messages.QueueItem non nul ou promesse Nuy contenant un tableau null de cast.framework.messages.QueueItem non nul).

Réorganise la file d'attente et renvoie les nouveaux éléments. Renvoie null si l'opération n'est pas acceptée.

Retours

(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)