Class Player

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 load 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

Hierarchy

default<PlayerConfig>
- Player

Constructors

constructor

new Player(config?): Player
Generate UUID in case the user-defined nativeId is empty.
Parameters
- Optional config: PlayerConfig
Returns Player
Inherited from NativeInstance<PlayerConfig>.constructor
- Defined in nativeInstance.ts:38

Properties

`Optional` analytics

analytics?: AnalyticsApi = undefined

The AnalyticsApi for interactions regarding the Player's analytics.

undefined if the player was created without analytics support.

buffer

buffer: BufferApi = ...

The BufferApi for interactions regarding the buffer.

`Optional` `Readonly` config

config?: PlayerConfig

The configuration object used to initialize this instance.

isDestroyed

isDestroyed: boolean = false

Whether the native Player object has been disposed.

isInitialized

isInitialized: boolean = false

Whether the native Player object has been created.

`Readonly` nativeId

nativeId: string

Optionally user-defined string id for the native instance, or UUIDv4.

`Optional` source

source?: Source

Currently active source, or null if none is active.

Methods

canPlayAtPlaybackSpeed

canPlayAtPlaybackSpeed(playbackSpeed): Promise<undefined | boolean>
Checks the possibility to play the media at specified playback speed.
Parameters
- playbackSpeed: number
  The playback speed to check.
Returns Promise<undefined | boolean>
true if it's possible to play the media at the specified playback speed, otherwise false. On Android it always returns undefined.

Platform
iOS, tvOS
- Defined in player.ts:462

castStop

castStop(): void
Stops casting the current video. Has no effect if isCasting is false.

Returns void
Platform
iOS, Android
- Defined in player.ts:408

castVideo

castVideo(): void
Initiates casting the current video to a cast-compatible remote device. The user has to choose to which device it should be sent.

Returns void
Platform
iOS, Android
- Defined in player.ts:399

destroy

destroy(): void
Destroys the native Player and releases all of its allocated resources.

Returns void
Overrides NativeInstance.destroy
- Defined in player.ts:72

getAudioTrack

getAudioTrack(): Promise<null | AudioTrack>
Returns Promise<null | AudioTrack>
The currently selected audio track or null.
- Defined in player.ts:267

getAvailableAudioTracks

getAvailableAudioTracks(): Promise<AudioTrack[]>
Returns Promise<AudioTrack[]>
An array containing AudioTrack objects for all available audio tracks.
- Defined in player.ts:274

getAvailableSubtitles

getAvailableSubtitles(): Promise<SubtitleTrack[]>
Returns Promise<SubtitleTrack[]>
An array containing SubtitleTrack objects for all available subtitle tracks.
- Defined in player.ts:295

getAvailableVideoQualities

getAvailableVideoQualities(): Promise<VideoQuality[]>
Returns an array containing all available video qualities the player can adapt between.

Returns Promise<VideoQuality[]>
An array containing all available video qualities the player can adapt between.
- Defined in player.ts:424

getCurrentTime

getCurrentTime(mode?): Promise<number>
Parameters
- mode: "relative" | "absolute" = 'absolute'
  The time mode to specify: an absolute UNIX timestamp ('absolute') or relative time ('relative').
Returns Promise<number>
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.
- Defined in player.ts:195

getDuration

getDuration(): Promise<number>
Returns Promise<number>
The total duration in seconds of the current video or INFINITY if it’s a live stream.
- Defined in player.ts:204

getMaxTimeShift

getMaxTimeShift(): Promise<number>
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.

Returns Promise<number>
- Defined in player.ts:348

getPlaybackSpeed

getPlaybackSpeed(): Promise<number>
Returns Promise<number>
The player's current playback speed.

See
setPlaybackSpeed for details on which values playback speed can assume.
- Defined in player.ts:452

getSubtitleTrack

getSubtitleTrack(): Promise<null | SubtitleTrack>
Returns Promise<null | SubtitleTrack>
The currently selected subtitle track or null.
- Defined in player.ts:288

getThumbnail

getThumbnail(time): Promise<null | Thumbnail>
Parameters
- time: number
Returns Promise<null | 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 platforms
- HLS Image Media Playlist in the multivariant playlist, Android-only
- DASH Image 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.
- Defined in player.ts:370

getTimeShift

getTimeShift(): Promise<number>
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 Promise<number>
- Defined in player.ts:340

getVideoQuality

getVideoQuality(): Promise<VideoQuality>
Returns the currently selected video quality.

Returns Promise<VideoQuality>
The currently selected video quality.
- Defined in player.ts:416

getVolume

getVolume(): Promise<number>
Returns Promise<number>
The player's current volume level.
- Defined in player.ts:181

initialize

initialize(): void
Allocates the native Player instance and its resources natively.

Returns void
Overrides NativeInstance.initialize
- Defined in player.ts:52

isAd

isAd(): Promise<boolean>
Returns Promise<boolean>
true while an ad is being played back or when main content playback has been paused for ad playback.

Platform
iOS, Android
- Defined in player.ts:332

isAirPlayActive

isAirPlayActive(): Promise<boolean>
Returns Promise<boolean>
true when media is played externally using AirPlay.

Remarks
Only available for iOS devices.
- Defined in player.ts:240

isAirPlayAvailable

isAirPlayAvailable(): Promise<boolean>
Returns Promise<boolean>
true when AirPlay is available.

Remarks
Only available for iOS devices.
- Defined in player.ts:254

isCastAvailable

isCastAvailable(): Promise<boolean>
Whether casting to a cast-compatible remote device is available. CastAvailableEvent signals when casting becomes available.

Returns Promise<boolean>
Platform
iOS, Android
- Defined in player.ts:380

isCasting

isCasting(): Promise<boolean>
Whether video is currently being casted to a remote device and not played locally.

Returns Promise<boolean>
Platform
iOS, Android
- Defined in player.ts:389

isLive

isLive(): Promise<boolean>
Returns Promise<boolean>
true if the displayed video is a live stream.
- Defined in player.ts:232

isMuted

isMuted(): Promise<boolean>
Returns Promise<boolean>
true if the player is muted.
- Defined in player.ts:211

isPaused

isPaused(): Promise<boolean>
Returns Promise<boolean>
true if the player has started playback but it's currently paused.
- Defined in player.ts:225

isPlaying

isPlaying(): Promise<boolean>
Returns Promise<boolean>
true if the player is currently playing, i.e. has started and is not paused.
- Defined in player.ts:218

load

load(sourceConfig): void
Loads a new Source from sourceConfig into the player.
Parameters
- sourceConfig: SourceConfig
Returns void
- Defined in player.ts:83

loadOfflineContent

loadOfflineContent(offlineContentManager, options?): void
Loads the downloaded content from OfflineContentManager into the player.
Parameters
- offlineContentManager: OfflineContentManager
- Optional options: OfflineSourceOptions
Returns void
- Defined in player.ts:90

loadSource

loadSource(source): void
Loads the given Source into the player.
Parameters
- source: Source
Returns void
- Defined in player.ts:104

mute

mute(): void
Mutes the player if an audio track is available. Has no effect if the player is already muted.

Returns void
- Defined in player.ts:158

pause

pause(): void
Pauses the video if it is playing. Has no effect if the player is already paused.

Returns void
- Defined in player.ts:127

play

play(): void
Starts or resumes playback after being paused. Has no effect if the player is already playing.

Returns void
- Defined in player.ts:120

scheduleAd

scheduleAd(adItem): void
Dynamically schedules the adItem for playback. Has no effect if there is no active playback session.
Parameters
- adItem: AdItem
  Ad to be scheduled for playback.
Returns void
Platform
iOS, Android
- Defined in player.ts:314

seek

seek(time): void
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.
Parameters
- time: number
  The time to seek to in seconds.
Returns void
- Defined in player.ts:138

setAudioTrack

setAudioTrack(trackIdentifier): Promise<void>
Sets the audio track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableAudioTracks.
Parameters
- trackIdentifier: string
Returns Promise<void>
- Defined in player.ts:281

setMaxSelectableBitrate

setMaxSelectableBitrate(bitrate): void
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.
Parameters
- bitrate: null | number
Returns void
- Defined in player.ts:358

setPlaybackSpeed

setPlaybackSpeed(playbackSpeed): void
Sets the playback speed of the player. Fast forward, slow motion and reverse playback are supported.
Parameters
- playbackSpeed: number
  The playback speed to set.
Returns void
Note
- Slow motion is indicated by values between 0 and 1.
- Fast forward by values greater than 1.
- Slow reverse is used by values between 0 and -1, and fast reverse is used by values less than -1. iOS and tvOS only.
Note
Negative values are ignored during Casting and on Android.

Note
During reverse playback the playback will continue until the beginning of the active source is reached. When reaching the beginning of the source, playback will be paused and the playback speed will be reset to its default value of 1. No PlaybackFinishedEvent will be emitted in this case.
- Defined in player.ts:444

setSubtitleTrack

setSubtitleTrack(trackIdentifier?): Promise<void>
Sets the subtitle track to the ID specified by trackIdentifier. A list can be retrieved by calling getAvailableSubtitles.
Parameters
- Optional trackIdentifier: string
Returns Promise<void>
- Defined in player.ts:302

setVolume

setVolume(volume): void
Sets the player's volume between 0 (silent) and 100 (max volume).
Parameters
- volume: number
  The volume level to set.
Returns void
- Defined in player.ts:174

skipAd

skipAd(): void
Skips the current ad. Has no effect if the current ad is not skippable or if no ad is being played back.

Returns void
Platform
iOS, Android
- Defined in player.ts:324

timeShift

timeShift(offset): void
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.
Parameters
- offset: number
Returns void
- Defined in player.ts:151

unload

unload(): void
Unloads all Sources from the player.

Returns void
- Defined in player.ts:113

unmute

unmute(): void
Unmutes the player if it is muted. Has no effect if the player is already unmuted.

Returns void
- Defined in player.ts:165

Class Player

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional config: PlayerConfig

Returns Player

Properties

Optional analytics

buffer

Optional Readonly config

isDestroyed

isInitialized

Readonly nativeId

Optional source

Methods

canPlayAtPlaybackSpeed

Parameters

playbackSpeed: number

Returns Promise<undefined | boolean>

Platform

castStop

Returns void

Platform

castVideo

Returns void

Platform

destroy

Returns void

getAudioTrack

Returns Promise<null | AudioTrack>

getAvailableAudioTracks

Returns Promise<AudioTrack[]>

getAvailableSubtitles

Returns Promise<SubtitleTrack[]>

getAvailableVideoQualities

Returns Promise<VideoQuality[]>

getCurrentTime

Parameters

mode: "relative" | "absolute" = 'absolute'

Returns Promise<number>

getDuration

Returns Promise<number>

getMaxTimeShift

Returns Promise<number>

getPlaybackSpeed

Returns Promise<number>

See

getSubtitleTrack

Returns Promise<null | SubtitleTrack>

getThumbnail

Parameters

time: number

Returns Promise<null | Thumbnail>

getTimeShift

Returns Promise<number>

getVideoQuality

Returns Promise<VideoQuality>

getVolume

Returns Promise<number>

initialize

Returns void

isAd

Returns Promise<boolean>

Platform

isAirPlayActive

Returns Promise<boolean>

Remarks

isAirPlayAvailable

Returns Promise<boolean>

Remarks

isCastAvailable

Returns Promise<boolean>

Platform

isCasting

`Optional` config: PlayerConfig

`Optional` analytics

`Optional` `Readonly` config

`Readonly` nativeId

`Optional` source

`Optional` options: OfflineSourceOptions

`Optional` trackIdentifier: string