cast. framework. QueueBase
Basisimplementierung einer Warteschlange.
Konstruktor
QueueBase
new QueueBase()
Methoden
fetchItems
fetchItems(itemId, nextCount, prevCount) returns (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)
Ruft ein Fenster mit Elementen unter Verwendung des angegebenen itemID
als Referenz ab. Diese Methode wird von MediaManager
aufgerufen, wenn mehr Warteschlangenelemente benötigt werden, 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 ID des Referenzartikels. |
nextCount |
Zahl Anzahl der Elemente nach dem Referenzelement. |
prevCount |
Zahl Anzahl der Objekte vor dem Referenzelement. |
- Rückgaben
-
(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) gibt Folgendes zurück: cast.framework.messages.QueueData oder non-null Promise, das cast.framework.messages.QueueData enthält, bei dem Nullwerte zulässig sind.
Initialisiert die Warteschlange mit requestData
. Wird aufgerufen, wenn der Empfänger eine neue cast.framework.messages.Command.LOAD
-Anfrage erhält. Wird dabei null
zurückgegeben oder zurückgegeben, erstellt die standardmäßige Warteschlangenimplementierung eine Warteschlange basierend auf queueData.items
oder auf dem einzelnen Medienelement in den LOAD
-Anfragedaten.
Parameter |
|
---|---|
requestData |
cast.framework.messages.LoadRequestData Der Wert darf nicht null sein. |
- Rückgaben
-
(nullable cast.framework.messages.QueueData or non-null Promise containing nullable cast.framework.messages.QueueData)
nextItems
nextItems(itemId) returns (nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
Gibt alle Elemente in der Warteschlange nach itemID
zurück. Dies wird von MediaManager
aufgerufen.
Parameter |
|
---|---|
itemId |
Optional Zahl ID des Referenzartikels. |
- Rückgaben
-
(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 das aktuell wiedergegebene Element geändert wird.
Parameter |
|
---|---|
itemId |
Zahl Die eindeutige ID des Artikels. |
onItemsInserted
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, das nicht null ist Die eingefügten Elemente. Der Wert darf nicht null sein. |
insertBefore |
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 in dieser Sitzung aus der Empfängerwarteschlange entfernt wurden. Eine cloudbasierte Implementierung kann die Warteschlange anhand dieser neuen Informationen aktualisieren.
Parameter |
|
---|---|
itemIds |
Array mit Zahlen Die IDs der entfernten Inhalte 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, das nicht null ist Die IDs der neu angeordneten Elemente. Der Wert darf nicht null sein. |
insertBefore |
Optional Zahl ID des Elements, das sich direkt nach der neu angeordneten Liste befindet. Wenn |
- Weitere Informationen
- cast.framework.messages.QueueReorderRequestData#itemIds.
prevItems
prevItems(itemId) returns (nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
Gibt alle Elemente vor dem itemID
zurück. Dies wird von MediaManager
aufgerufen.
Parameter |
|
---|---|
itemId |
Optional Zahl ID des Referenzartikels. |
- Rückgaben
-
(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: (Nullable Array of Nicht null cast.framework.messages.QueueItem oder Nicht-Null Promise, das ein Array von Nicht-Null cast.framework.messages.QueueItem enthält, bei dem Nullwerte zulässig sind)
Die Wiedergabeliste wird zufällig sortiert und neue Elemente werden zurückgegeben. Gibt null
zurück, wenn der Vorgang nicht unterstützt wird.
- Rückgaben
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)
Zufallsmix aufheben
unshuffle() gibt Folgendes zurück: (Nullable Array of Nicht null cast.framework.messages.QueueItem oder Nicht-null Promise, das ein Array ohne Nullwert cast.framework.messages.QueueItem enthält)
Hebt den Zufallsmix der Warteschlange auf und gibt neue Warteschlangenelemente zurück. Gibt null
zurück, wenn der Vorgang nicht unterstützt wird.
- Rückgaben
-
(nullable Array of non-null cast.framework.messages.QueueItem or non-null Promise containing nullable Array of non-null cast.framework.messages.QueueItem)