Classe: QueueManager

framework.framework.QueueManager

class static.

QueueManager propose plusieurs API de manipulation des files d'attente aux développeurs.

Génère

non-null Error Si le constructeur est utilisé directement. Ce dernier ne doit être accessible qu'en appelant cast.framework.PlayerManager#getQueueManager.

Méthodes

getContainerMetadata

getContainerMetadata() renvoie cast.framework.messages.ContainerMetadata

Obtenir les métadonnées du conteneur

Retours

nullable cast.framework.messages.ContainerMetadata 

getCurrentItem

getCurrentItem() renvoie cast.framework.messages.QueueItem

Renvoie l'élément de file d'attente actuel.

Retours

nullable cast.framework.messages.QueueItem 

getCurrentItemIndex

La fonction getCurrentItemIndex() renvoie le numéro

Renvoie l'index de l'élément de file d'attente actuel.

Retours

number L'index actuel des articles

getItems

getItems() renvoie un tableau de valeurs cast.framework.messages.QueueItem non nulles.

Renvoie les éléments de la file d'attente.

Retours

non-null Array of non-null cast.framework.messages.QueueItem 

insertItems

insertItems(items, insertBefore)

Insère des éléments dans la file d'attente.

Paramètre
items	Tableau de valeurs cast.framework.messages.QueueItem non nulles La valeur ne doit pas être nulle.
insérerAvant	Facultative number (nombre) ID de l'article situé juste après la liste insérée. Si elle n'est pas fournie ou si elle est introuvable, la liste est ajoutée à la fin de la file d'attente.

removeItems

removeItems(itemIds)

Supprime des éléments de la file d'attente.

Paramètre
ID articles	Tableau de nombres Identifiants des articles à réorganiser. La valeur ne doit pas être nulle.

setContainerMetadata

setContainerMetadata(containerMetadata)

Définissez les métadonnées du conteneur.

Paramètre
containerMetadata	cast.framework.messages.ContainerMetadata La valeur peut être nulle.

setQueueStatusLimit

setQueueStatusLimit(limitQueueItemsInStatus) :

Détermine si le nombre d'éléments de la file d'attente doit être limité dans l'état média (la valeur par défaut est "true").

Paramètre
limitQueueItemsInStatus	booléen

updateItems

updateItems(items)

Met à jour les éléments de file d'attente existants par correspondance d'ID d'article.

Paramètre
items	Tableau de valeurs cast.framework.messages.QueueItem non nulles La valeur ne doit pas être nulle.