Interface: shakaExtern.ManifestParser

Parses media manifests and handles manifest updates. Given a URI where the initial manifest is found, a parser will request the manifest, parse it, and return the resulting Manifest object. If the manifest requires updates (e.g. for live media), the parser will use background timers to update the same Manifest object.
Implementations:
Source:

Methods

(export) configure(config)

Called by the Player to provide an updated configuration any time the configuration changes. Will be called at least once before start().
Parameters:
Name Type Description
config shakaExtern.ManifestConfiguration
Source:

(export) onExpirationUpdated(sessionId, expiration)

Tells the parser that the expiration time of an EME session has changed. Implementing this is optional.
Parameters:
Name Type Description
sessionId string
expiration number
Source:

(export) start(uri, playerInterface) → (non-null) {Promise.<shakaExtern.Manifest>}

Parses the given manifest data into a Manifest object and starts any background timers that are needed. This will only be called once.
Parameters:
Name Type Description
uri string The URI of the manifest.
playerInterface shakaExtern.ManifestParser.PlayerInterface Contains the interface to the Player.
Source:
Returns:
Type
Promise.<shakaExtern.Manifest>

(export) stop() → (non-null) {Promise}

Stops any background timers and frees any objects held by this instance. This will only be called after a successful call to start. This will only be called once.
Source:
Returns:
Type
Promise

(export) update()

Tells the parser to do a manual manifest update. Implementing this is optional and is only called when 'emsg' boxes are present.
Source:

Type Definitions

Factory

A factory for creating the manifest parser. This will be called with 'new'. This function is registered with shaka.media.ManifestParser to create parser instances.
Type:
  • function(new:shakaExtern.ManifestParser)
Source:

PlayerInterface

Defines the interface of the Player to the manifest parser. This defines fields and callback methods that the parser will use to interact with the Player. The callback methods do not need to be called as member functions (i.e. they can be called as "free" functions).
Type:
Properties:
Name Type Description
networkingEngine shaka.net.NetworkingEngine The networking engine to use for network requests.
filterNewPeriod function Should be called on a new Period so that it can be filtered.
filterAllPeriods function Should be called on all Periods so that they can be filtered.
onTimelineRegionAdded function Should be called when a new timeline region is added.
onEvent function Should be called to raise events.
onError function Should be called when an error occurs.
Source: