Class: shaka.queue.QueueManager

Constructor

new QueueManager(player)

Parameters:
Name Type Description
player shaka.Player
Implements:
Source:

Members

config_ :shaka.extern.QueueConfiguration

Type:
Source:

currentItemIndex_ :number

Type:
  • number
Source:

eventManager_ :shaka.util.EventManager

Type:
Source:

items_ :Array<shaka.extern.QueueItem>

Type:
Source:

player_ :shaka.Player

Type:
Source:

preloadNext_ :?{item: shaka.extern.QueueItem, preloadManager: ?shaka.media.PreloadManager}

Type:
  • ?{item: shaka.extern.QueueItem, preloadManager: ?shaka.media.PreloadManager}
Source:

preloadPrev_ :?{item: shaka.extern.QueueItem, preloadManager: ?shaka.media.PreloadManager}

Type:
  • ?{item: shaka.extern.QueueItem, preloadManager: ?shaka.media.PreloadManager}
Source:

repeatTimer_ :shaka.util.Timer

Type:
Source:

Methods

addExtraTracks_(itemnon-null) → {Promise}

Adds extra tracks (text, thumbnails, chapters) in parallel
Parameters:
Name Type Description
item shaka.extern.QueueItem
Source:
Returns:
Type
Promise

cleanupPreloadPrev_(currentItemnon-null, previousItemnullable)

Cleans up preloadPrev_ if no longer needed and saves preload of the previous item
Parameters:
Name Type Attributes Description
currentItem shaka.extern.QueueItem
previousItem shaka.extern.QueueItem <nullable>
Source:

configure(config)

Called by the Player to provide an updated configuration any time it changes.
Parameters:
Name Type Description
config shaka.extern.QueueConfiguration
Implements:
Source:

destroy() → {Promise}

Request that this object be destroyed, releasing all resources and shutting down all operations. Returns a Promise which is resolved when destruction is complete. This Promise should never be rejected.
Overrides:
Implements:
Source:
Returns:
Type
Promise

getAssetOrPreloader_(itemnon-null) → {string|shaka.media.PreloadManager}

Determines which asset to use: preloadPrev_, preloadNext_ or manifestUri
Parameters:
Name Type Description
item shaka.extern.QueueItem
Source:
Returns:
Type
string | shaka.media.PreloadManager

getConfiguration() → {shaka.extern.QueueConfiguration}

Returns the current configuration.
Implements:
Source:
Returns:
Type
shaka.extern.QueueConfiguration

getCurrentItem() → {shaka.extern.QueueItem}

Returns the current item.
Implements:
Source:
Returns:
Type
shaka.extern.QueueItem

getCurrentItemIndex() → {number}

Returns the index of the current playing item.
Implements:
Source:
Returns:
Type
number

getItems() → {Array<shaka.extern.QueueItem>}

Returns all items.
Implements:
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>
Implements:
Source:

playCurrentItemAfterPause_(mediaElement)

Handles repeating the current item when paused
Parameters:
Name Type Description
mediaElement HTMLMediaElement
Source:

playItem(itemIndex) → {Promise}

Plays a item number in the queue.
Parameters:
Name Type Description
itemIndex number
Implements:
Source:
Returns:
Type
Promise

removeAllItems() → {Promise}

Remove all items.
Implements:
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
Implements:
Source:

setupPreloadNext_(mediaElement)

Sets up preloading of the next item if applicable
Parameters:
Name Type Description
mediaElement HTMLMediaElement
Source:

setupRepeatOnComplete_(mediaElement)

Sets up repeat behavior on playback completion
Parameters:
Name Type Description
mediaElement HTMLMediaElement
Source: