cast. framework: QueueBase
Basisimplementierung einer Warteschlange.
Konstruktor
Warteschlangenbasis
new QueueBase()
Methoden
Abrufelemente
fetchItems(itemId, nextCount, prevCount) returns (non-null Array of non-null cast.framework.messages.QueueItem or non-null Promise with non-null Array of non-null cast.framework.messages.QueueItem)
Ruft ein Fenster mit Elementen ab, bei denen die angegebene itemID
als Referenz verwendet wird. Diese Methode wird von MediaManager
aufgerufen, wenn mehr Warteschlangenelemente erforderlich sind, die häufig auf eine Absenderanfrage zurückzuführen sind. Wenn entweder nextCount
oder prevCount
festgelegt ist, gibt fetchItems
nur Elemente nach oder vor dem Referenzelement zurück. Wenn sowohl nextCount
als auch prevCount
festgelegt sind, wird ein Fenster mit Elementen einschließlich itemId
zurückgegeben.
Parameter |
|
---|---|
itemId |
Zahl Die ID des Referenzelements. |
nächste Zählung |
Zahl Anzahl der Artikel nach dem Referenzelement. |
Vorherige Anzahl |
Zahl Anzahl der Artikel vor dem Referenzelement. |
- Gibt Folgendes zurück:
-
(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
initial(requestData) returns (cast.framework.messages.QueueData oder Nicht-Null-Promise mit nullable cast.framework.messages.QueueData)
Initialisiert die Warteschlange mit requestData
. Wird aufgerufen, wenn der Empfänger eine neue cast.framework.messages.Command.LOAD
-Anfrage erhält. Wenn dies null
zurückgibt oder aufgelöst wird, erstellt die Standard-Warteschlangenimplementierung eine Warteschlange basierend auf queueData.items
oder auf dem einzelnen Mediaelement in den LOAD
-Anfragedaten.
Parameter |
|
---|---|
Anfragedaten |
cast.framework.messages.LoadRequestData Der Wert darf nicht null sein. |
- Gibt Folgendes zurück:
-
(nullable cast.framework.messages.QueueData or non-null Promise containing nullable cast.framework.messages.QueueData)
nächste Elemente
nextItems(itemId) returns (nullable Array von Nicht-Null-cast.framework.messages.QueueItem oder Nicht-Null-Promise mit nullable-Array von Nicht-Null-cast.framework.messages.QueueItem)
Gibt alle Elemente in der Warteschlange nach itemID
zurück. Dies wird von MediaManager
aufgerufen.
Parameter |
|
---|---|
itemId |
Optional Zahl Die ID des Referenzelements. |
- Gibt Folgendes zurück:
-
(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)
Legt das aktuelle Element auf itemId
fest. Wird von MediaManager
aufgerufen, wenn sich das gerade wiedergegebene Element ändert.
Parameter |
|
---|---|
itemId |
Zahl Die eindeutige ID für den Artikel. |
onItemsInsert-Element
onItemsInserted(items, insertBefore)
Ein Callback, der angibt, dass die folgenden Elemente in die Empfängerwarteschlange in dieser Sitzung eingefügt wurden. Eine cloudbasierte Implementierung kann die Warteschlange anhand dieser neuen Informationen aktualisieren.
Parameter |
|
---|---|
items |
Array von cast.framework.messages.QueueItem, der nicht null ist Die eingefügten Elemente. Der Wert darf nicht null sein. |
Vorher einfügen |
Optional Zahl ID des Elements, das sich direkt nach der eingefügten Liste befand. Wenn die ID nicht angegeben ist, wurde die eingefügte Liste an das Ende der Warteschlange angehängt. |
onItemsRemoved
onItemsRemoved(itemIds)
Ein Callback, der angibt, dass die folgenden Elemente aus der Empfängerwarteschlange in dieser Sitzung entfernt wurden. Eine cloudbasierte Implementierung kann die Warteschlange anhand dieser neuen Informationen aktualisieren.
Parameter |
|
---|---|
Artikel-IDs |
Array von Zahlen Die IDs der entfernten Elemente. Der Wert darf nicht null sein. |
onItemsReordered
onItemsReordered(items, insertBefore)
Ein Callback, der angibt, dass die folgenden Elemente neu angeordnet wurden.
Parameter |
|
---|---|
items |
Array von cast.framework.messages.QueueItem, der nicht null ist Die IDs der neu angeordneten Artikel. Der Wert darf nicht null sein. |
Vorher einfügen |
Optional Zahl ID des Elements, das sich direkt nach der neu angeordneten Liste befindet. Wenn |
- Weitere Informationen
- cast.framework.messages.QueueReorderRequestData#itemIds für weitere Informationen.
Vorherige Artikel
prevItems(itemId) gibt Folgendes zurück (nullable Array von Nicht-Null-cast.framework.messages.QueueItem oder Nicht-Null-Promise mit nullable-Array von Nicht-Null-cast.framework.messages.QueueItem)
Gibt alle Elemente vor dem itemID
zurück. Dies wird von MediaManager
aufgerufen.
Parameter |
|
---|---|
itemId |
Optional Zahl Die ID des Referenzelements. |
- Gibt Folgendes zurück:
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
Shuffle
Shuffle() gibt Folgendes zurück (Null-Array von Nicht-Null-cast.framework.messages.QueueItem oder Nicht-Null-Promise mit einem Nullwert-Array von Nicht-Null-cast.framework.messages.QueueItem)
Zufallsmix der Warteschlange und Rückgabe neuer Warteschlangenelemente. Gibt null
zurück, wenn der Vorgang nicht unterstützt wird.
- Gibt Folgendes zurück:
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
Zufallsmix wiedergeben
unshuffle() gibt zurück (Nullable-Array von Nicht-Null-cast.framework.messages.QueueItem oder Nicht-Null-Promise mit nullable-Array von Nicht-Null-cast.framework.messages.QueueItem)
mischt die Warteschlange und gibt neue Elemente in der Warteschlange zurück Gibt null
zurück, wenn der Vorgang nicht unterstützt wird.
- Gibt Folgendes zurück:
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)