- Implementations:
- Extends:
- Source:
Extends
Methods
configure(config)
Called by the Player to provide an updated configuration any time it
changes.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
shaka.extern.QueueConfiguration |
- Source:
destroy() → {Promise}
- Overrides:
- Source:
Returns:
- Type
- Promise
getConfiguration() → {shaka.extern.QueueConfiguration}
Returns the current configuration.
- Source:
Returns:
getCurrentItemIndex() → {number}
Returns the index of the current playing item.
- Source:
Returns:
- Type
- number
getItems() → {Array<shaka.extern.QueueItem>}
Returns all items.
- Source:
Returns:
- Type
- Array<shaka.extern.QueueItem>
insertItems(itemsnon-null)
Insert new items in the current queue.
Parameters:
| Name | Type | Description |
|---|---|---|
items |
Array<shaka.extern.QueueItem> |
- Source:
loadFromM3uPlaylist(url, playOnLoadopt) → {Promise}
Fetches an M3U/M3U8 playlist from the given URL using the player's
networking engine, parses it, and inserts the resulting items into the
queue. Supports the extended EXTINF format with tvg-* attributes
commonly found in IPTV playlists (tvg-id, tvg-name, tvg-logo,
tvg-language, tvg-country, tvg-url, group-title).
The parsed tvg-* attribute values are stored in the item's metadata:
- tvg-name → metadata.title (falls back to the display name)
- tvg-logo → metadata.poster
- tvg-id → metadata.tvgId
- tvg-language → metadata.tvgLanguage
- tvg-country → metadata.tvgCountry
- tvg-url → metadata.tvgUrl
- group-title → metadata.groupTitle
- display name → metadata.displayTitle
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
url |
string | ||
playOnLoad |
boolean |
<optional> |
- Source:
Returns:
- Type
- Promise
playItem(itemIndex) → {Promise}
Plays a item number in the queue.
Parameters:
| Name | Type | Description |
|---|---|---|
itemIndex |
number |
- Source:
Returns:
- Type
- Promise
removeAllItems() → {Promise}
Remove all items.
- Source:
Returns:
- Type
- Promise
setCustomPlayer(player)
Set a custom player for preloading, event management and autoplay next.
This is useful when using a CastProxy.
Parameters:
| Name | Type | Description |
|---|---|---|
player |
shaka.Player |
- Source:
Type Definitions
Factory
A factory for creating the queue manager.
Type:
- function(shaka.Player): !shaka.extern.IQueueManager
- Source: