An enumeration of all player events.
A list of all player event values.
An enumeration of possible log levels.
A list of all possible log level values.
The VR namespace.
The version number of the player.
The VR API.
Subscribes an event handler to a player event.
The type of event to subscribe to.
The event callback handler that will be called when the event fires.
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.
Adds a new external subtitle/caption track. The track is only added to the available tracks but not activated. If the ID already exists, the existing subtitle/caption track is overwritten with the new one. Call setSubtitle to activate it.
the subtitle to add
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.
Switch player to fullscreen mode. Has no effect if already in fullscreen.
An optional alternative element to be put into fullscreen instead of the default player (container) element (since 7.8).
Enter picture in picture mode.
Exit player fullscreen mode. Has no effect if not in fullscreen.
Exit picture in picture mode.
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 a list of available impression servers.
Returns a list of available license servers.
Returns infos for segments that can be requested by the player
Returns an array of all available subtitle/caption tracks.
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 setup
The current user or merged player config.
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 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 figure element that the player is embedded in, if the player is set up, or null otherwise.
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.
Returns the currently used streaming technology. See StreamType for details of the valid values.
Returns the currently used subtitle/caption track.
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 supported on the current platform. The order in the array is the order which will be used to play a stream.
Returns a thumbnail image for a certain time or null if there is no thumbnail available. Requires a configured thumbnails track in SourceConfig.tracks.
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 current VR playback status.
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.
Returns true while an ad is played back or content playback has been paused for ad playback, false otherwise.
If true, isAd will return true if the content playback has been paused for playback of a pending ad
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 Event.ON_CAST_AVAILABLE 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
Returns true if the player is currently in fullscreen mode.
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 the status of picture in picture mode.
Checks if macOS picture in picture mode is available.
Returns true if the player is currently playing, i.e. has started and is not paused.
Returns true if the player has finished initialization and is ready to use and to handle other API calls.
Returns true if the setup call has already been successfully called.
Returns true if the player is currently stalling due to an empty buffer.
Sets a new video source and returns a promise which resolves to the player. The load call is only available after the ON_READY event has been triggered, or the setup promise did resolve.
A source object as specified in player configuration during setup
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.
The event to remove the handler from
The callback handler to remove
Subscribes an event handler to a player event.
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
Starts preloading the content of the currently loaded source.
Removes a handler for a player event.
The event to remove the handler from
The callback handler to remove
Removes the existing subtitle/caption track with the track ID specified by trackID. If the track is currently active, it will be deactivated and then removed. If no track with the given ID exists, the call will be ignored. To disable an active subtitle track, call setSubtitle with null.
The ID of the subtitle to remove
Schedules an ad for playback.
URL to the ad manifest. The array is used for ad waterfalling: all entries beyond the first are fallbacks if the previous ones did not work.
the type of ad to be played.
Optional options for ad playback.
true if scheduling the ad was successful, false otherwise.
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 number of the last segment that the player is allowed to request. Only working with Segment Template manifests.
The number of the last segment to request
[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
Sets the subtitle track to the ID specified by trackID. A list can be retrieved by calling getAvailableSubtitles. Using null as ID disables subtitles.
The ID if the desired subtitle track or null to disable subtitles
Enables or disables stereo mode for VR content.
true to enable stereo, false to disable
true if stereo mode was successfully set, else false
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’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
Sets up a new player instance with the given configuration, as specified in player configuration documentation. Returns a promise that resolves to the player when setup is finished.
User-supplied configuration of the player
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.
Shows the airplay playback target picker.
Skips the current ad. Has no effect if ad is not skippable or if no ad is played back.
True if skipping the ad was successful.
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.