cast. framework. messages. QueueLoadRequestData
LOAD-Anfragedaten der Warteschlange für Medienereignisse.
Konstruktor
QueueLoadRequestData
new QueueLoadRequestData(items)
Parameter |
|
---|---|
items |
Array von cast.framework.messages.QueueItem, der nicht null ist Liste der Warteschlangenelemente. Das „itemId“-Feld der Elemente sollte leer sein. Andernfalls schlägt die Anfrage mit dem Fehler INVALID_PARAMS fehl. Sie wird sortiert (das erste Element wird zuerst abgespielt). Der Wert darf nicht null sein. |
- Erweitert
- cast.framework.messages.RequestData
Attribute
currentTime (Aktuelle Uhrzeit)
(Zahl oder nicht definiert)
Sekunden (seit Beginn des Inhalts), um die Wiedergabe des ersten Elements zu starten. Wenn dieser Wert angegeben wird, hat er Vorrang vor dem Wert für „startTime“, der auf QueueItem-Ebene angegeben ist, aber nur bei der ersten Wiedergabe des Elements. Damit wird der häufige Fall abgedeckt, dass der Nutzer das lokal übertragene Element umwandelt, sodass die currentTime nicht wie die QueueItem-Startzeit dauerhaft auf das Element angewendet wird. Dadurch wird vermieden, dass die Startzeit dynamisch zurückgesetzt wird. Dies ist möglicherweise nicht möglich, wenn das Smartphone in den Ruhemodus wechselt.
CustomData
(nicht null oder nicht definiert)
Anwendungsspezifische Daten für diese Anfrage. Dadurch können Absender und Empfänger das Medienprotokoll ganz einfach erweitern, ohne einen neuen Namespace mit benutzerdefinierten Nachrichten verwenden zu müssen.
- Übernommen von
- cast.framework.messages.RequestData#customData
items
Nicht-null-Array von cast.framework.messages.QueueItem
Array von Warteschlangenelementen. Sie wird sortiert (das erste Element wird zuerst abgespielt).
mediaSessionId (Mediensitzungs-ID)
(Zahl oder nicht definiert)
ID der Mediensitzung, für die die Anfrage gilt.
- Übernommen von
- cast.framework.messages.RequestData#mediaSessionId
Wiederholungsmodus
(cast.framework.messages.RepeatMode oder nicht definiert)
Das Verhalten der Warteschlange, wenn alle Elemente abgespielt wurden.
requestId
Zahl
ID der Anfrage, die zum Korrelieren von Anfrage/Antwort verwendet wird.
- Übernommen von
- cast.framework.messages.RequestData#requestId
Sequenznummer
(Zahl oder nicht definiert)
Eine Zahl zum Synchronisieren aller Warteschlangenbefehle. Wenn für einen Warteschlangenbefehl eine Option angegeben wird, prüft das SDK die letzte Sequenznummer der Warteschlange. Die aktuellesequenzNumber wird als Teil der geänderten Nachrichten der Warteschlange angegeben.
- Übernommen von
- cast.framework.messages.RequestData#sequenceNumber
startIndex (Startindex)
(Zahl oder nicht definiert)
Der Index des Elements im Array für Elemente, das das erste currentItem sein muss (das Element, das zuerst abgespielt wird). Dies ist der Index des Arrays (beginnt bei 0) und nicht die „itemId“, da dieser erst nach der Erstellung der Warteschlange bekannt ist. Wenn „RepeatMode“ auf „REPEAT_OFF“ gesetzt ist, endet die Wiedergabe, wenn das letzte Element im Array wiedergegeben wird (Elemente vor dem startIndex werden nicht abgespielt). Dies kann bei Fortsetzungsszenarien nützlich sein, bei denen der Nutzer bereits die Absender-App verwendet hat und sich in der Mitte für die Übertragung entscheidet. So muss die Absender-App nicht zwischen den Positionen der lokalen und der Remote-Warteschlange zugeordnet werden oder eine zusätzliche QUEUE_UPDATE-Anfrage speichern.