Generate UUID in case the user-defined nativeId is empty.
Optionalconfig: PlayerConfigOptionalanalyticsThe AnalyticsApi for interactions regarding the Player's analytics.
undefined if the player was created without analytics support.
The BufferApi for interactions regarding the buffer.
Optional ReadonlyconfigThe configuration object used to initialize this instance.
Whether the native Player object has been disposed.
Whether the native Player object has been created.
ReadonlynativeOptionally user-defined string id for the native instance, or UUIDv4.
OptionalsourceCurrently active source, or null if none is active.
Checks the possibility to play the media at specified playback speed.
The playback speed to check.
true if it's possible to play the media at the specified playback speed, otherwise false. On Android it always returns undefined.
Stops casting the current video. Has no effect if Player.isCasting is false.
Destroys the native Player and releases all of its allocated resources.
The currently selected audio track or null.
An array containing AudioTrack objects for all available audio tracks.
An array containing SubtitleTrack objects for all available subtitle tracks.
Returns an array containing all available video qualities the player can adapt between.
An array containing all available video qualities the player can adapt between.
The time mode to specify: an absolute UNIX timestamp ('absolute') or relative time ('relative').
The current playback time in seconds.
For VoD streams the returned time ranges between 0 and the duration of the asset.
For live streams it can be specified if an absolute UNIX timestamp or a value relative to the playback start should be returned.
The total duration in seconds of the current video or INFINITY if it’s a live stream.
The limit in seconds for time shifting. This value is either negative or 0 and it is always 0 if the active Source is not a live stream or no sources are loaded.
The player's current playback speed.
setPlaybackSpeed for details on which values playback speed can assume.
The currently selected SubtitleTrack or null.
The time in seconds for which to retrieve the thumbnail.
a Thumbnail for the specified playback time for the currently active source if available. Supported thumbnail formats are:
WebVtt configured via SourceConfig.thumbnailTrack, on all supported platformsImage Media Playlist in the multivariant playlist, Android-onlyImage Adaptation Set as specified in DASH-IF IOP, Android-only
If a WebVtt thumbnail track is provided, any potential in-manifest thumbnails are ignored on Android.The current time shift of the live stream in seconds. This value is always 0 if the active Source is not a live stream or no sources are loaded.
Returns the currently selected video quality.
The currently selected video quality.
The player's current volume level.
Allocates the native Player instance and its resources natively.
Whether casting to a cast-compatible remote device is available. CastAvailableEvent signals when casting becomes available.
true if the displayed video is a live stream.
true if the player is muted.
true if the player has started playback but it's currently paused.
true if the player is currently playing, i.e. has started and is not paused.
Loads a new Source from sourceConfig into the player.
Loads the downloaded content from OfflineContentManager into the player.
Optionaloptions: OfflineSourceOptionsMutes the player if an audio track is available. Has no effect if the player is already muted.
Pauses the video if it is playing. Has no effect if the player is already paused.
Starts or resumes playback after being paused. Has no effect if the player is already playing.
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 since
seeking is not possible.
The time to seek to in seconds.
Sets the audio track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableAudioTracks.
The AudioTrack.identifier to be set.
Sets the upper bitrate boundary for video qualities. All qualities with a bitrate that is higher than this threshold will not be eligible for automatic quality selection.
Can be set to null for no limitation.
Sets the playback speed of the player. Fast forward, slow motion and reverse playback are supported.
The playback speed to set.
Platform: iOS, tvOS
0 and 1.1.0 and -1, and fast reverse is used by values less than -1. iOS and tvOS only.1. No PlaybackFinishedEvent will be
emitted in this case.Sets the subtitle track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableSubtitles.
OptionaltrackIdentifier: stringThe SubtitleTrack.identifier to be set.
Sets the video quality.
value obtained from VideoQuality's id property, which can be obtained via Player.getAvailableVideoQualities() to select a specific quality. To use automatic quality selection, 'auto' can be passed here.
Sets the player's volume between 0 (silent) and 100 (max volume).
The volume level to set.
Shifts the time to the given offset in seconds from the live edge. The resulting offset has to be within the
timeShift window as specified by maxTimeShift (which is a negative value) and 0. When the provided offset is
positive, it will be interpreted as a UNIX timestamp in seconds and converted to fit into the timeShift window.
When the provided offset is negative, but lower than maxTimeShift, then it will be clamped to maxTimeShift.
Has no effect for VoD.
Has no effect if no sources are loaded.
Target offset from the live edge in seconds.
Unloads all Sources from the player.
Unmutes the player if it is muted. Has no effect if the player is already unmuted.
Loads, controls and renders audio and video content represented through Sources. A player instance can be created via the usePlayer hook and will idle until one or more Sources are loaded. Once Player.load or Player.loadSource is called, the player becomes active and initiates necessary downloads to start playback of the loaded source(s).
Can be attached to PlayerView component in order to use Bitmovin's Player Web UI.
See
PlayerView