cast. framework. QueueManager
QueueManager は、複数のキュー操作 API をデベロッパーに公開します。
- スロー値
-
non-null Error
コンストラクタを直接使用する場合。QueueManager にアクセスするには、cast.framework.PlayerManager#getQueueManager を呼び出します。
Methods
getContainerMetadata
getContainerMetadata() は cast.framework.messages.ContainerMetadata を返す。
コンテナのメタデータを取得します。
- 戻り値
getCurrentItem
getCurrentItem() は cast.framework.messages.QueueItem を返します。
現在のキューアイテムを返します。
- 戻り値
-
nullable cast.framework.messages.QueueItem
getCurrentItemIndex
getCurrentItemIndex() は数値を返す
現在のキュー項目のインデックスを返します。
- 戻り値
-
number
現在のアイテム インデックス
getItems
getItems() は null 以外の cast.framework.messages.QueueItem の配列を返します。
キューの項目を返します。
- 戻り値
-
non-null Array of non-null cast.framework.messages.QueueItem
insertItem
insertItems(items, insertBefore)
アイテムをキューに挿入します。
パラメータ |
|
---|---|
items |
null 以外の cast.framework.messages.QueueItem の配列 値を null にすることはできません。 |
insertBefore |
任意 数値 挿入されたリストの直後に配置されるアイテムの ID。指定されていない場合や見つからない場合は、キューの最後にリストが追加されます。 |
removeItems
removeItems(itemIds)
アイテムをキューから削除します。
パラメータ |
|
---|---|
アイテム ID |
数値の配列 並べ替えるアイテムの ID。 値を null にすることはできません。 |
setContainerMetadata
setContainerMetadata(containerMetadata)
コンテナのメタデータを設定します。
パラメータ |
|
---|---|
containerMetadata |
cast.framework.messages.ContainerMetadata 値は null でもかまいません。 |
setQueueStatusLimit
setQueueStatusLimit(limitQueueItemsInStatus)
メディア ステータスでレポートされるキュー項目の数を制限するかどうかを設定します(デフォルトは true)。
パラメータ |
|
---|---|
limitQueueItemsInStatus |
boolean |
updateItems
updateItems(items)
itemId を一致させることにより、既存のキューアイテムを更新します。
パラメータ |
|
---|---|
items |
null 以外の cast.framework.messages.QueueItem の配列 値を null にすることはできません。 |