Classe: QueueLoadRequestData

Constructeur

QueueLoadRequestData

new QueueLoadRequestData(items)

Paramètres

items

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

Liste des éléments de la file d'attente. Le champ "itemId" des articles doit être vide, sans quoi la requête échouera et générera une erreur INVALID_PARAMS. Il est trié (le premier élément est lu en premier).

La valeur ne doit pas être nulle.

Extensions
cast.framework.messages.RequestData

Propriétés

currentTime

(nombre ou non défini)

Secondes (depuis le début du contenu) pendant lesquelles la lecture du premier élément à lire est lancée. Si cette valeur est définie, elle prévaut sur la valeur startTime fournie au niveau de QueueItem, mais uniquement la première fois que l'élément est lu. Cela permet de couvrir le cas courant où l'utilisateur caste l'élément en cours de lecture localement, afin que la valeur "currentTime" ne s'applique pas de manière permanente à l'élément, contrairement à la valeur startTime de QueueItem. Cela évite de devoir réinitialiser le startTime de manière dynamique (ce qui peut être impossible si le téléphone est en veille).

customData

(objet non nul ou non défini)

Données spécifiques à l'application pour cette requête. Elle permet à l'expéditeur et au destinataire d'étendre facilement le protocole multimédia sans avoir à utiliser un nouvel espace de noms avec des messages personnalisés.

Hérité de
cast.framework.messages.RequestData#customData

items

Tableau non nul de cast.framework.messages.QueueItem non nul

Tableau des éléments de la file d'attente. Il est trié (le premier élément est lu en premier).

mediaSessionId

(nombre ou non défini)

ID de la session multimédia à laquelle la requête s'applique.

Hérité de
cast.framework.messages.RequestData#mediaSessionId

repeatMode

(cast.framework.messages.RepeatMode ou non défini)

Comportement de la file d'attente lorsque tous les éléments ont été lus.

requestId

number

Identifiant de la requête, utilisé pour corréler la requête/la réponse.

Hérité de
cast.framework.messages.RequestData#requestId

sequenceNumber

(nombre ou non défini)

Nombre permettant de synchroniser toutes les commandes de file d'attente. S'il est fourni pour une commande de file d'attente, le SDK vérifie que le dernier numéro de séquence de la file d'attente correspond à la requête. Le paramètre "SequenceNumber" actuel est fourni dans les messages sortants de modification de la file d'attente.

Hérité de
cast.framework.messages.RequestData#sequenceNumber

startIndex

(nombre ou non défini)

Index de l'élément du tableau "items" qui doit être le premier "currentItem" (l'élément qui sera lu en premier). Notez qu'il s'agit de l'index du tableau (commence à 0), et non de l'itemId (car il n'est pas connu avant la création de la file d'attente). Si le mode de répétition est défini sur REPEAT_OFF, la lecture s'arrête lorsque le dernier élément du tableau est lu (les éléments situés avant la valeur startIndex ne sont pas lus). Cela peut être utile pour les scénarios dans lesquels l'utilisateur utilisait déjà l'application émettrice et décide de caster du contenu au milieu. De cette manière, l'application émettrice n'a pas besoin de mapper les positions de la file d'attente locale et distante, ni d'enregistrer une requête QUEUE_UPDATE supplémentaire.