The advertising API namespace.
The buffer API namespace.
Exports 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, () => ...);The low latency API namespace.
The subtitles API namespace.
The version number of the player.
The 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.
Initiates casting the current video to a Cast-compatible device. The user has to choose the target device.
Removes all existing query parameters as specified in setQueryParameters or TweaksConfig.query_parameters.
Unloads the player and removes all inserted HTML elements and event handlers.
Promise resolves when the player has cleaned up all its event handlers & resources
Returns the currently used audio track.
Returns the seconds of already buffered audio data or null if no audio source is loaded.
Returns the currently selected audio quality. One of the elements of getAvailableAudioQualities.
Returns an array of all available audio tracks.
Returns an array of all available audio qualities the player can adapt between.
Returns infos for segments that can be requested by the player
Returns an array containing all available video qualities the player can adapt between.
Returns the currently buffered time ranges of the video element.
Returns the config object of the current player instance.
true 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.
Returns the html element that the player is embedded in, which has been provided in the player constructor.
Returns the current playback time in seconds of the video.
Returns data about the last downloaded audio segment.
Returns data about the last downloaded video segment.
Returns the total number of dropped video frames since playback started.
Returns the total duration in seconds of the current video or {@code Infinity} if it’s a live stream.
Returns the used DASH or HLS manifest file.
Previous player versions (v4.2-v7.0) returned an object for DASH and a string for HLS, this has been corrected in v7.1.
Returns the limit in seconds for time shift. Is either negative or 0 and applicable to live streams only.
Returns data about the currently playing audio segment.
Returns the current playback speed of the player. 1 is the default playback speed, values between 0 and 1 refer to slow motion and values greater than 1 refer to fast forward. Values less or equal zero are ignored.
Returns data about the currently playing video segment.
Returns the currently used rendering mode. See PlayerType for details of the valid values.
Returns the time range that is currently valid for seeking.
Creates a snapshot of the current video frame. Snapshots cannot be taken from DRM protected content and the Flash fallback.
The type of image snapshot to capture. Allowed values are 'image/jpeg' and 'image/webp'.
A number between 0 and 1 indicating the image quality.
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.
Tests and retrieves a list of all supported DRM systems in the current user agent.
A Promise that resolves to an array of strings with the supported DRM systems after fulfillment. Should never be rejected.
Returns an array of objects denoting a player and streaming technology combination. By default, this returns the combinations supported on the current platform (SupportedTechnologyMode.Platform), ordered by descending priority which will be used to play a stream.
the mode by which the supported technologies are determined
Returns a thumbnail image for a certain time or null if there is no thumbnail available. Requires a configured thumbnails track in SourceConfig.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
Returns the current time shift offset to the live edge in seconds. Only applicable to live streams.
Returns the stalled time in seconds since playback started.
Returns the seconds of already buffered video data or null if no video source is loaded.
Returns the used HTML5 video element or the Flash object if the fallback is used.
The HTML5 video element or the Flash object which is used by the player
Returns the currently selected video quality. One of the elements of getAvailableVideoQualities.
Returns the player’s volume between 0 (silent) and 100 (max volume).
Returns true if the video has ended.
Checks if Apple Airplay is enabled.
Checks if Apple AirPlay support is available.
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 PlayerEvent.CastAvailable event has fired.
Returns true if the video is currently casted to a device and not played in the browser, or false if the video is played locally.
Checks if a DRM system is supported in the current user agent.
A KeySystem string to test against
Resolves with the DRM system string if it is supported, or rejects with an error message if not
Return true if the displayed video is a live stream.
Returns true if the player has been muted.
Returns true if the player has started playback but is currently paused.
Returns true if the player is currently playing, i.e. has started and is not paused.
Returns true if the player is currently stalling due to an empty buffer.
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
Sets a new video source and returns a promise which resolves to the player.
The source the player should load.
Forces 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 retrieved by calling getSupportedTech.
If set, seeking will be disabled
Mutes the player if an audio track is available. Has no effect if the player is already muted.
The issuer of the API call that will be passed to events triggered by this call
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
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.
Pauses the video if it is playing. Has no effect if the player is already paused.
The issuer of the API call that will be passed to events triggered by this call
Starts playback or resumes after being paused. No need to call it if the player is setup with autoplay attribute (PlaybackConfig.autoplay). Has no effect if the player is already playing.
The 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)
Starts preloading the content of the currently loaded source.
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
The issuer of the API call that will be passed to events triggered by this call
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
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
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
Sets the level of player log outputs.
Log level, allowed values are "debug", "log", "warn", "error" and "off"
[HTML5 only] Sets the playback speed of the player. Fast forward as well as slow motion is supported. Slow motion is used by values between 0 and 1, fast forward by values greater than 1.
A playback speed factor greater than 0
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)
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
Passes an HTML video element to the player, which should be used in case of non-Flash playback. Needs to be called before load. Has no effect if the Flash fallback is selected.
The HTML video element to use
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'
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
PlayerEvent.ViewModeChanged will be fired.
the view mode to switch the player into
additional optional parameters for view modes
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
The issuer of the API call that will be passed to events triggered by this call
Shows the airplay playback target picker.
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
The issuer of the API call that will be passed to events triggered by this call
Unloads the current video source.
Unmutes the player if muted.
The issuer of the API call that will be passed to events triggered by this call
Generated using TypeDoc
Bitmovin Player instance members.