cast. framework. messages. QueueLoadRequestData
LOAD-Anfragedaten der Medienereigniswarteschlange
Konstruktor
QueueLoadRequestData
neu QueueLoadRequestData(items)
Parameter |
|
---|---|
items |
Array von cast.framework.messages.QueueItem, das nicht null ist Liste der Warteschlangenelemente. Das Feld „itemId“ der Artikel sollte leer sein. Andernfalls schlägt die Anfrage mit dem Fehler INVALID_PARAMS fehl. Die Sortierung erfolgt (das erste Element wird zuerst wiedergegeben). Der Wert darf nicht null sein. |
- Erweitert
- cast.framework.messages.RequestData
Attribute
currentTime
(Anzahl oder nicht definiert)
Sekunden (seit Beginn des Inhalts), um die Wiedergabe des ersten wiederzugebenden Inhalts zu starten. Wenn dieser Wert angegeben wird, hat er Vorrang vor dem Wert „startTime“, der auf „QueueItem“-Ebene angegeben ist, aber nur beim ersten Abspielen des Elements. Damit wird der übliche Fall abgedeckt, in dem der Nutzer das lokal wiedergegebene Element überträgt, sodass die currentTime nicht dauerhaft auf das Element angewendet wird, wie es bei der startTime von QueueItem der Fall ist. Die Startzeit muss nicht dynamisch zurückgesetzt werden (was möglicherweise nicht möglich ist, wenn das Telefon in den Ruhemodus wechselt).
customData
(Objekt ungleich null oder nicht definiert)
Anwendungsspezifische Daten für diese Anfrage. Damit können Absender und Empfänger das Medienprotokoll einfach erweitern, ohne einen neuen Namespace mit benutzerdefinierten Nachrichten verwenden zu müssen.
- Übernommen von
- cast.framework.messages.RequestData#customData
items
non-null Array von nicht null cast.framework.messages.QueueItem
Array von Warteschlangenelementen. Sortiert ist, d. h., das erste Element wird zuerst abgespielt.
mediaSessionId
(Anzahl oder nicht definiert)
ID der Mediensitzung, auf die sich die Anfrage bezieht.
- Übernommen von
- cast.framework.messages.RequestData#mediaSessionId
repeatMode
(cast.framework.messages.RepeatMode oder nicht definiert)
Das Verhalten der Warteschlange, wenn alle Elemente wiedergegeben wurden.
requestId
Zahl
ID der Anfrage, die zum Korrelieren von Anfrage/Antwort verwendet wird.
- Übernommen von
- cast.framework.messages.RequestData#requestId
sequenceNumber
(Anzahl oder nicht definiert)
Eine Zahl zur Synchronisierung aller Warteschlangenbefehle. Wenn für einen Warteschlangenbefehl angegeben, prüft das SDK, ob die neueste Sequenznummer der Warteschlange mit der Anfrage übereinstimmt. Die aktuelle Sequenznummer wird als Teil der geänderten Nachrichten der ausgehenden Warteschlange angegeben.
- Übernommen von
- cast.framework.messages.RequestData#sequenceNumber
startIndex
(Anzahl oder nicht definiert)
Index des Elements im Element-Array, das das erste currentItem sein muss (das Element, das zuerst wiedergegeben wird). Beachten Sie, dass dies der Index des Arrays (beginnt bei 0) und nicht die itemId ist (wie sie erst beim Erstellen der Warteschlange bekannt ist). Wenn „RepeatMode“ auf REPEAT_OFF gesetzt ist, endet die Wiedergabe, sobald das letzte Element im Array wiedergegeben wird (Elemente vor dem startIndex werden nicht wiedergegeben). Dies kann bei Fortsetzungsszenarien nützlich sein, bei denen der Nutzer bereits die Sender-App verwendet hat und sich in der Mitte für die Übertragung entscheidet. Auf diese Weise muss die Absender-App keine Zuordnung zwischen den Positionen der lokalen und der Remote-Warteschlange vornehmen und speichert keine zusätzliche QUEUE_UPDATE-Anfrage.