Readonly adaptationThe adaptation API namespace.
Readonly adsThe advertising API namespace.
Readonly bufferThe buffer API namespace.
Readonly drmThe DRM API namespace.
Readonly exportsExports from the player core as a convenience fallback for non-modular code. It is recommended to use ES6 imports instead.
Usage:
import { Player } from 'bitmovin-player';
const player = new Player(...);
player.on(player.exports.Event.Loaded, () => ...);
Recommended approach:
import { Player, Event } from 'bitmovin-player';
const player = new Player(...);
player.on(Event.Loaded, () => ...);
It is recommended to use ES6 imports instead
Readonly lowlatencyThe low latency API namespace.
Readonly manifestThe manifest API namespace.
Readonly subtitlesThe subtitles API namespace.
Readonly versionThe version number of the player.
Readonly vrThe VR API namespace.
Sends custom metadata to a remote receiver app (e.g. Chromecast).
The type of the metadata. Currently only 'CAST' is supported.
The custom data to send to the receiver.
True if it was successful.
v4.0
Removes all existing query parameters as specified in setQueryParameters or query_parameters.
v4.0
Returns the currently used audio track, or null if no track is active.
v4.0
Returns the seconds of already buffered audio data or null if no audio source is loaded.
Use getLevel instead.
Returns the currently selected audio quality. One of the elements of getAvailableAudioQualities.
v7.3.1
Returns an array of all available audio tracks.
v4.0
Returns an array of all available audio qualities the player can adapt between.
v4.0
Returns infos for segments that can be requested by the player
v7.2
Returns an array containing all available video qualities the player can adapt between.
v4.0
Returns the config object of the current player instance.
Optional mergedConfig: booleantrue to return the config expanded with all default values, false to return the user config passed to the player's constructor.
The current user or merged player config.
v4.0
Returns data about the last downloaded audio segment.
v4.0
Returns data about the last downloaded video segment.
v4.0
Returns data about the currently playing audio segment.
v4.0
Returns data about the currently playing video segment.
v4.0
Returns the currently used rendering mode. See PlayerType for details of the valid values.
v4.0
Creates a snapshot of the current video frame. Snapshots cannot be taken from DRM protected content.
Optional type: stringThe type of image snapshot to capture. Allowed values are 'image/jpeg' and 'image/webp'.
Optional quality: numberA number between 0 and 1 indicating the image quality.
v4.0
Gets the source that was loaded via a successfully finished load call or null if no source is loaded
or a load is in progress.
the loaded source or null if no source is loaded
Returns the currently used streaming technology. See StreamType for details of the valid values.
v4.0
Returns an array of objects denoting a player and streaming technology combination. By default, this returns the combinations supported on the current platform (Platform), ordered by descending priority which will be used to play a stream.
Optional mode: SupportedTechnologyModethe mode by which the supported technologies are determined
v4.0
Returns a thumbnail image for a certain time or null if there is no thumbnail available. Requires a configured thumbnails track in thumbnailTrack.
the media time for which the thumbnail should be returned
A thumbnail if a thumbnails track is configured and a thumbnail exists for the specified time, else null
v8.0
Returns the seconds of already buffered video data or null if no video source is loaded.
Use getLevel instead.
Returns the currently selected video quality, if the user manually selected one. In this case it returns one of the elements of getAvailableVideoQualities.
In case the user did not select a video quality it returns auto.
v7.3.1
Returns true if casting to another device (such as a ChromeCast) is available, otherwise false. Please note that this function only returns true after the CastAvailable event has fired.
v5.2
Tests if a particular ViewMode is available for selection with setViewMode.
the view mode to test
true if the tested view mode is available, else false
v8.0
Sets a new video source and returns a promise which resolves to the player.
The source the player should load.
Optional forceTechnology: stringForces the player to use the specified playback and streaming technology. The specified technologies have to be separated by a period (e.g. 'html5.hls'). A list of valid combinations can be retrieved by calling getSupportedTech.
Optional disableSeeking: booleanIf set, seeking will be disabled
v4.0
Removes a handler for a player event. This method was called removeEventHandler in previous
player versions.
The event to remove the handler from
The callback handler to remove
v7.8
Subscribes an event handler to a player event. This method was called addEventHandler in previous
player versions.
The type of event to subscribe to.
The event callback handler that will be called when the event fires.
v7.8
Starts playback or resumes after being paused. No need to call it if the player is setup with autoplay attribute (autoplay). Has no effect if the player is already playing.
Optional issuer: stringThe issuer of the API call that will be passed to events triggered by this call
a Promise which resolves as soon as playback has actually started. This promise can reject if play is prohibited by the browser (a missing user interaction for example)
v4.0
Seeks to the given playback time specified by the parameter time in seconds. Must not be greater than the total duration of the video. Has no effect when watching a live stream as seeking is not possible.
The time to seek to
Optional issuer: stringThe issuer of the API call that will be passed to events triggered by this call
v4.0
Modifies the current aspect ratio of the player. Can be used to override the aspectratio
that is optionally passed during player initialization. Has no effect if the player has also been configured
to have a fixed width and height: in general, no more than two options
among width, height, and aspectratio should be provided to the player.
The desired aspect ratio for the player. It can be a string (e.g. '16:9' or '16/9'), or a number (e.g 1.6 for 16:10).
v8.74
Sets the audio track to the ID specified by trackID. Available tracks can be retrieved with getAvailableAudio.
The ID of the audio track to activate
v4.0
Manually sets the audio stream to a fixed quality, identified by ID. Has to be an ID defined in the MPD or the keyword 'auto'. Auto resets to dynamic switching. A list with valid IDs can be retrieved by calling getAvailableAudioQualities.
The ID of the desired audio quality or 'auto' for dynamic switching
v4.0
Sets authentication data which is sent along with the licensing call. Can be used to add more information for a 3rd party licensing backend. The data be any type or object as needed by the 3rd party licensing backend.
Data which should be sent with the licensing call
v4.2
Sets the level of player log outputs.
Log level, allowed values are "debug", "log", "warn", "error" and "off"
v6.1
Sets a poster image. Will be displayed immediately, even if a video stream is playing.
The URL to the poster image
Flag to set the poster image persistent so it is also displayed during playback (useful for audio-only playback)
v4.3
Adds GET parameters to all request URLs (e.g. manifest, media segments, subtitle files, …). The queryParameters should be an object with key value pairs, where the keys are used as parameter name and the values as parameter values.
The list of query parameter key/value pairs
v4.1
Passes an HTML video element to the player, which should be used in case of Html5 or Native playback. Needs to be called before load.
The HTML video element to use
v5.1
Manually sets the video stream to a fixed quality, identified by ID. Has to be an ID defined in the MPD or the keyword 'auto'. Auto resets to dynamic switching. A list with valid IDs can be retrieved by calling getAvailableVideoQualities.
ID defined in the MPD or 'auto'
v4.0
Sets the player to a particular ViewMode. Will only work if the selected view mode is available and
isViewModeAvailable returns true, else this call will be ignored. If successful, a
ViewModeChanged will be fired.
the view mode to switch the player into
Optional options: ViewModeOptionsadditional optional parameters for view modes
v8.0
Sets the player’s volume in the range of 0 (silent) to 100 (max volume). Unmutes a muted player.
The volume to set between 0 and 100
Optional issuer: stringThe issuer of the API call that will be passed to events triggered by this call
v4.0
Shifts the time to the given offset in seconds from the live edge. Has to be within getMaxTimeShift (which is a negative value) and 0. Only works in live streams. [new in v4.3]: The offset can be positive and is then interpreted as a UNIX timestamp in seconds. The value has to be within the timeShift window as specified by getMaxTimeShift.
The offset to timeshift to
Optional issuer: stringThe issuer of the API call that will be passed to events triggered by this call
v4.0
Bitmovin Player instance members.