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

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
Implementations:
Source:

start(uri, networkingEnginenon-null, filterPeriod, onError, onEvent) → (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.
networkingEngine shaka.net.NetworkingEngine The networking engine to use for network requests.
filterPeriod function(shakaExtern.Period) A callback to be invoked on all new Periods so that they can be filtered.
onError function(!shaka.util.Error) A callback to be invoked on errors.
onEvent function(!Event) A callback to be invoked to dispatch events to the application.
Implementations:
Source:
Returns:
Type
Promise.<shakaExtern.Manifest>

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.
Implementations:
Source:
Returns:
Type
Promise

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:
Source: