Version: v7 Alpha

Class: VideoPlayer

Extends

VideoPlayerEvents

Implements

VideoPlayerBase

Constructors

Constructor

new VideoPlayer(source): VideoPlayer;

Defined in: VideoPlayer.ts:25

Parameters

Parameter	Type
`source`	\| `VideoSource` \| `VideoConfig` \| `VideoPlayerSource`

Returns

VideoPlayer

Overrides

VideoPlayerEvents.constructor

Properties

onError()?

optional onError: (error) => void = undefined;

Defined in: VideoPlayer.ts:23

Parameters

Parameter	Type
`error`	`VideoRuntimeError`

Returns

void

Accessors

currentTime

Get Signature

get currentTime(): number;

Defined in: VideoPlayer.ts:106

The duration of the video in seconds (1.0 = 1 sec). Returns NaN if the duration is not available.

Returns

number

Set Signature

set currentTime(value): void;

Defined in: VideoPlayer.ts:110

The duration of the video in seconds (1.0 = 1 sec). Returns NaN if the duration is not available.

Parameters

Parameter	Type
`value`	`number`

Returns

void

Implementation of

VideoPlayerBase.currentTime

duration

Get Signature

get duration(): number;

Defined in: VideoPlayer.ts:92

The current time of the video in seconds (1.0 = 1 sec). Returns NaN if the current time is not available.

Returns

number

Implementation of

VideoPlayerBase.duration

ignoreSilentSwitchMode

Get Signature

get ignoreSilentSwitchMode(): IgnoreSilentSwitchMode;

Defined in: VideoPlayer.ts:151

Controls the silent switch mode of the player.

Note

This is only supported on iOS.

auto - uses default behavior for player.
ignore - ignore the silent switch.
obey - obey the silent switch.

Returns

IgnoreSilentSwitchMode

Set Signature

set ignoreSilentSwitchMode(value): void;

Defined in: VideoPlayer.ts:155

Controls the silent switch mode of the player.

Note

This is only supported on iOS.

auto - uses default behavior for player.
ignore - ignore the silent switch.
obey - obey the silent switch.

Parameters

Parameter	Type
`value`	`IgnoreSilentSwitchMode`

Returns

void

Implementation of

VideoPlayerBase.ignoreSilentSwitchMode

isPlaying

Get Signature

get isPlaying(): boolean;

Defined in: VideoPlayer.ts:184

Whether the player is playing.

Note

This is a read-only property.

Note

To pause/resume the player, you need to use play and pause methods.

Returns

boolean

Implementation of

VideoPlayerBase.isPlaying

loop

Get Signature

get loop(): boolean;

Defined in: VideoPlayer.ts:124

Whether the player is looped.

Returns

boolean

Set Signature

set loop(value): void;

Defined in: VideoPlayer.ts:128

Whether the player is looped.

Parameters

Parameter	Type
`value`	`boolean`

Returns

void

Implementation of

VideoPlayerBase.loop

mixAudioMode

Get Signature

get mixAudioMode(): MixAudioMode;

Defined in: VideoPlayer.ts:142

Controls the audio mixing mode of the player.

mixWithOthers - Mix with other players.
doNotMix - Do not mix with other players.
duckOthers - Duck other players.
auto - uses default behavior for player.

default is auto.

Returns

MixAudioMode

Set Signature

set mixAudioMode(value): void;

Defined in: VideoPlayer.ts:146

Controls the audio mixing mode of the player.

mixWithOthers - Mix with other players.
doNotMix - Do not mix with other players.
duckOthers - Duck other players.
auto - uses default behavior for player.

default is auto.

Parameters

Parameter	Type
`value`	`MixAudioMode`

Returns

void

Implementation of

VideoPlayerBase.mixAudioMode

muted

Get Signature

get muted(): boolean;

Defined in: VideoPlayer.ts:115

Whether the player is muted.

Returns

boolean

Set Signature

set muted(value): void;

Defined in: VideoPlayer.ts:119

Whether the player is muted.

Parameters

Parameter	Type
`value`	`boolean`

Returns

void

Implementation of

VideoPlayerBase.muted

onAudioBecomingNoisy

Get Signature

get onAudioBecomingNoisy(): () => void;

Defined in: VideoPlayerEvents.ts:58

Called when the audio becomes noisy.

Platform

Android

Returns

(): void;

Returns

void

Set Signature

set onAudioBecomingNoisy(value): void;

Defined in: VideoPlayerEvents.ts:52

Called when the audio becomes noisy.

Platform

Android

Parameters

Parameter	Type
`value`	() => `void`

Returns

void

Inherited from

VideoPlayerEvents.onAudioBecomingNoisy

onAudioFocusChange

Get Signature

get onAudioFocusChange(): (hasAudioFocus) => void;

Defined in: VideoPlayerEvents.ts:68

Called when the audio focus changes.

Platform

Android

Returns

(hasAudioFocus): void;

Parameters

Parameter	Type
`hasAudioFocus`	`boolean`

Returns

void

Set Signature

set onAudioFocusChange(value): void;

Defined in: VideoPlayerEvents.ts:62

Called when the audio focus changes.

Platform

Android

Parameters

Parameter	Type
`value`	(`hasAudioFocus`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onAudioFocusChange

onBandwidthUpdate

Get Signature

get onBandwidthUpdate(): (data) => void;

Defined in: VideoPlayerEvents.ts:78

Called when the bandwidth of the video changes.

Returns

(data): void;

Parameters

Parameter	Type
`data`	`BandwidthData`

Returns

void

Set Signature

set onBandwidthUpdate(value): void;

Defined in: VideoPlayerEvents.ts:72

Called when the bandwidth of the video changes.

Parameters

Parameter	Type
`value`	(`data`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onBandwidthUpdate

onBuffer

Get Signature

get onBuffer(): (buffering) => void;

Defined in: VideoPlayerEvents.ts:86

Called when the video is buffering.

Returns

(buffering): void;

Parameters

Parameter	Type
`buffering`	`boolean`

Returns

void

Set Signature

set onBuffer(value): void;

Defined in: VideoPlayerEvents.ts:82

Called when the video is buffering.

Parameters

Parameter	Type
`value`	(`buffering`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onBuffer

onControlsVisibleChange

Get Signature

get onControlsVisibleChange(): (visible) => void;

Defined in: VideoPlayerEvents.ts:96

Called when the video view's controls visibility changes.

Returns

(visible): void;

Parameters

Parameter	Type
`visible`	`boolean`

Returns

void

Set Signature

set onControlsVisibleChange(value): void;

Defined in: VideoPlayerEvents.ts:90

Called when the video view's controls visibility changes.

Parameters

Parameter	Type
`value`	(`visible`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onControlsVisibleChange

onEnd

Get Signature

get onEnd(): () => void;

Defined in: VideoPlayerEvents.ts:104

Called when the video ends.

Returns

(): void;

Returns

void

Set Signature

set onEnd(value): void;

Defined in: VideoPlayerEvents.ts:100

Called when the video ends.

Parameters

Parameter	Type
`value`	() => `void`

Returns

void

Inherited from

VideoPlayerEvents.onEnd

onExternalPlaybackChange

Get Signature

get onExternalPlaybackChange(): (externalPlaybackActive) => void;

Defined in: VideoPlayerEvents.ts:114

Called when the external playback state changes.

Platform

iOS

Returns

(externalPlaybackActive): void;

Parameters

Parameter	Type
`externalPlaybackActive`	`boolean`

Returns

void

Set Signature

set onExternalPlaybackChange(value): void;

Defined in: VideoPlayerEvents.ts:108

Called when the external playback state changes.

Platform

iOS

Parameters

Parameter	Type
`value`	(`externalPlaybackActive`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onExternalPlaybackChange

onLoad

Get Signature

get onLoad(): (data) => void;

Defined in: VideoPlayerEvents.ts:122

Called when the video is loaded.

Note

onLoadStart -> initialize the player -> onLoad

Returns

(data): void;

Parameters

Parameter	Type
`data`	`onLoadData`

Returns

void

Set Signature

set onLoad(value): void;

Defined in: VideoPlayerEvents.ts:118

Called when the video is loaded.

Note

onLoadStart -> initialize the player -> onLoad

Parameters

Parameter	Type
`value`	(`data`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onLoad

onLoadStart

Get Signature

get onLoadStart(): (data) => void;

Defined in: VideoPlayerEvents.ts:130

Called when the video starts loading.

Note

onLoadStart -> initialize the player -> onLoad

Returns

(data): void;

Parameters

Parameter	Type
`data`	`onLoadStartData`

Returns

void

Set Signature

set onLoadStart(value): void;

Defined in: VideoPlayerEvents.ts:126

Called when the video starts loading.

Note

onLoadStart -> initialize the player -> onLoad

Parameters

Parameter	Type
`value`	(`data`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onLoadStart

onPlaybackRateChange

Get Signature

get onPlaybackRateChange(): (rate) => void;

Defined in: VideoPlayerEvents.ts:150

Called when the player playback rate changes.

Returns

(rate): void;

Parameters

Parameter	Type
`rate`	`number`

Returns

void

Set Signature

set onPlaybackRateChange(value): void;

Defined in: VideoPlayerEvents.ts:144

Called when the player playback rate changes.

Parameters

Parameter	Type
`value`	(`rate`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onPlaybackRateChange

onPlaybackStateChange

Get Signature

get onPlaybackStateChange(): (data) => void;

Defined in: VideoPlayerEvents.ts:140

Called when the player playback state changes.

Returns

(data): void;

Parameters

Parameter	Type
`data`	`onPlaybackStateChangeData`

Returns

void

Set Signature

set onPlaybackStateChange(value): void;

Defined in: VideoPlayerEvents.ts:134

Called when the player playback state changes.

Parameters

Parameter	Type
`value`	(`data`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onPlaybackStateChange

onProgress

Get Signature

get onProgress(): (data) => void;

Defined in: VideoPlayerEvents.ts:158

Called when the player progress changes.

Returns

(data): void;

Parameters

Parameter	Type
`data`	`onProgressData`

Returns

void

Set Signature

set onProgress(value): void;

Defined in: VideoPlayerEvents.ts:154

Called when the player progress changes.

Parameters

Parameter	Type
`value`	(`data`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onProgress

onReadyToDisplay

Get Signature

get onReadyToDisplay(): () => void;

Defined in: VideoPlayerEvents.ts:166

Called when the video is ready to display.

Returns

(): void;

Returns

void

Set Signature

set onReadyToDisplay(value): void;

Defined in: VideoPlayerEvents.ts:162

Called when the video is ready to display.

Parameters

Parameter	Type
`value`	() => `void`

Returns

void

Inherited from

VideoPlayerEvents.onReadyToDisplay

onSeek

Get Signature

get onSeek(): (seekTime) => void;

Defined in: VideoPlayerEvents.ts:174

Called when the player seeks.

Returns

(seekTime): void;

Parameters

Parameter	Type
`seekTime`	`number`

Returns

void

Set Signature

set onSeek(value): void;

Defined in: VideoPlayerEvents.ts:170

Called when the player seeks.

Parameters

Parameter	Type
`value`	(`seekTime`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onSeek

onStatusChange

Get Signature

get onStatusChange(): (status) => void;

Defined in: VideoPlayerEvents.ts:182

Called when the player status changes.

Returns

(status): void;

Parameters

Parameter	Type
`status`	`VideoPlayerStatus`

Returns

void

Set Signature

set onStatusChange(value): void;

Defined in: VideoPlayerEvents.ts:178

Called when the player status changes.

Parameters

Parameter	Type
`value`	(`status`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onStatusChange

onTextTrackDataChanged

Get Signature

get onTextTrackDataChanged(): (texts) => void;

Defined in: VideoPlayerEvents.ts:200

Called when the text track (currently displayed subtitle) data changes.

Returns

(texts): void;

Parameters

Parameter	Type
`texts`	`string`[]

Returns

void

Set Signature

set onTextTrackDataChanged(value): void;

Defined in: VideoPlayerEvents.ts:194

Called when the text track (currently displayed subtitle) data changes.

Parameters

Parameter	Type
`value`	(`texts`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onTextTrackDataChanged

onTimedMetadata

Get Signature

get onTimedMetadata(): (metadata) => void;

Defined in: VideoPlayerEvents.ts:190

Called when player receives timed metadata.

Returns

(metadata): void;

Parameters

Parameter	Type
`metadata`	`TimedMetadata`

Returns

void

Set Signature

set onTimedMetadata(value): void;

Defined in: VideoPlayerEvents.ts:186

Called when player receives timed metadata.

Parameters

Parameter	Type
`value`	(`metadata`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onTimedMetadata

onTrackChange

Get Signature

get onTrackChange(): (track) => void;

Defined in: VideoPlayerEvents.ts:208

Called when the selected text track changes.

Returns

(track): void;

Parameters

Parameter	Type
`track`	`null` \| `TextTrack`

Returns

void

Set Signature

set onTrackChange(value): void;

Defined in: VideoPlayerEvents.ts:204

Called when the selected text track changes.

Parameters

Parameter	Type
`value`	(`track`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onTrackChange

onVolumeChange

Get Signature

get onVolumeChange(): (data) => void;

Defined in: VideoPlayerEvents.ts:216

Called when the volume of the player changes.

Returns

(data): void;

Parameters

Parameter	Type
`data`	`onVolumeChangeData`

Returns

void

Set Signature

set onVolumeChange(value): void;

Defined in: VideoPlayerEvents.ts:212

Called when the volume of the player changes.

Parameters

Parameter	Type
`value`	(`data`) => `void`

Returns

void

Inherited from

VideoPlayerEvents.onVolumeChange

playInBackground

Get Signature

get playInBackground(): boolean;

Defined in: VideoPlayer.ts:166

Whether the player should play in background.

true - play in background.
false - pause in background (default).

Note

this can override playWhenInactive.

Returns

boolean

Set Signature

set playInBackground(value): void;

Defined in: VideoPlayer.ts:170

Whether the player should play in background.

true - play in background.
false - pause in background (default).

Note

this can override playWhenInactive.

Parameters

Parameter	Type
`value`	`boolean`

Returns

void

Implementation of

VideoPlayerBase.playInBackground

playWhenInactive

Get Signature

get playWhenInactive(): boolean;

Defined in: VideoPlayer.ts:175

Whether the player should play when the app is inactive (user opened control center).

true - play when the app is inactive.
false - pause when the app is inactive (default).

Note

this can be overridden by playInBackground.

Note

This is only supported on iOS.

Returns

boolean

Set Signature

set playWhenInactive(value): void;

Defined in: VideoPlayer.ts:179

Whether the player should play when the app is inactive (user opened control center).

true - play when the app is inactive.
false - pause when the app is inactive (default).

Note

this can be overridden by playInBackground.

Note

This is only supported on iOS.

Parameters

Parameter	Type
`value`	`boolean`

Returns

void

Implementation of

VideoPlayerBase.playWhenInactive

rate

Get Signature

get rate(): number;

Defined in: VideoPlayer.ts:133

Controls the speed at which the player should play.

Note

if rate is = 0, it will pause video.

Returns

number

Set Signature

set rate(value): void;

Defined in: VideoPlayer.ts:137

Controls the speed at which the player should play.

Note

if rate is = 0, it will pause video.

Parameters

Parameter	Type
`value`	`number`

Returns

void

Implementation of

VideoPlayerBase.rate

selectedTrack

Get Signature

get selectedTrack(): undefined | TextTrack;

Defined in: VideoPlayer.ts:267

Get the currently selected text track.

Returns

undefined | TextTrack

The currently selected text track, or undefined if none is selected

Implementation of

VideoPlayerBase.selectedTrack

source

Get Signature

get source(): VideoPlayerSource;

Defined in: VideoPlayer.ts:82

The source of the video. Source is immutable. To change the source, you need to call replaceSourceAsync method. see VideoPlayerSourceBase

Returns

VideoPlayerSource

Implementation of

VideoPlayerBase.source

status

Get Signature

get status(): VideoPlayerStatus;

Defined in: VideoPlayer.ts:87

The status of the player.

Returns

VideoPlayerStatus

Implementation of

VideoPlayerBase.status

volume

Get Signature

get volume(): number;

Defined in: VideoPlayer.ts:97

The volume of the video (0.0 = 0%, 1.0 = 100%).

Note

If the player is muted, the volume will be 0.0.

Returns

number

Set Signature

set volume(value): void;

Defined in: VideoPlayer.ts:101

The volume of the video (0.0 = 0%, 1.0 = 100%).

Note

If the player is muted, the volume will be 0.0.

Parameters

Parameter	Type
`value`	`number`

Returns

void

Implementation of

VideoPlayerBase.volume

Methods

clearAllEvents()

clearAllEvents(): void;

Defined in: VideoPlayerEvents.ts:36

Clears all events from the event emitter.

Returns

void

Inherited from

VideoPlayerEvents.clearAllEvents

clearEvent()

clearEvent(event): void;

Defined in: VideoPlayerEvents.ts:46

Clears a specific event from the event emitter.

Parameters

Parameter	Type	Description
`event`	keyof `VideoPlayerEvents`	The name of the event to clear.

Returns

void

Inherited from

VideoPlayerEvents.clearEvent

getAvailableTextTracks()

getAvailableTextTracks(): TextTrack[];

Defined in: VideoPlayer.ts:249

Get all available text tracks for the current source.

Returns

TextTrack[]

Array of available text tracks

Implementation of

VideoPlayerBase.getAvailableTextTracks

pause()

pause(): void;

Defined in: VideoPlayer.ts:212

Pause playback of player.

Returns

void

Implementation of

VideoPlayerBase.pause

play()

play(): void;

Defined in: VideoPlayer.ts:204

Start playback of player.

Returns

void

Implementation of

VideoPlayerBase.play

preload()

preload(): Promise<void>;

Defined in: VideoPlayer.ts:188

Preload the video. This is useful to avoid delay when the user plays the video. Preloading too many videos can lead to memory issues or performance issues.

Returns

Promise<void>

Implementation of

VideoPlayerBase.preload

release()

release(): void;

Defined in: VideoPlayer.ts:200

Releases the player's native resources and releases native state. After calling this method, the player is no longer usable. Accessing any properties or methods of the player after calling this method will throw an error. If you want to clean player resource use replaceSourceAsync with null instead.

Returns

void

replaceSourceAsync()

replaceSourceAsync(source): Promise<void>;

Defined in: VideoPlayer.ts:236

Replace the current source of the player.

Parameters

Parameter	Type	Description
`source`	\| `null` \| `VideoSource` \| `VideoConfig`	The new source of the video.

Returns

Promise<void>

Note

If you want to clear the source, you can pass null. see VideoPlayerSourceBase

Implementation of

VideoPlayerBase.replaceSourceAsync

seekBy()

seekBy(time): void;

Defined in: VideoPlayer.ts:220

Seek by given time. If the time is negative, it will seek backward. time will be clamped if it is out of range (0 ~ duration).

Parameters

Parameter	Type	Description
`time`	`number`	The time to seek from current time in seconds.

Returns

void

Implementation of

VideoPlayerBase.seekBy

seekTo()

seekTo(time): void;

Defined in: VideoPlayer.ts:228

Seek to a specific time in the video.

Parameters

Parameter	Type	Description
`time`	`number`	The time to seek to in seconds.

Returns

void

Note

This have same effect as currentTime setter.

Note

time will be clamped if it is out of range (0 ~ duration).

Implementation of

VideoPlayerBase.seekTo

selectTextTrack()

selectTextTrack(textTrack): void;

Defined in: VideoPlayer.ts:258

Select a text track to display.

Parameters

Parameter	Type	Description
`textTrack`	`null` \| `TextTrack`	Text track to select, or null to unselect current track

Returns

void

Implementation of

VideoPlayerBase.selectTextTrack

NOOP()

static NOOP(): void;

Defined in: VideoPlayerEvents.ts:50

Returns

void

Inherited from

VideoPlayerEvents.NOOP

We are TheWidlarzGroupPremium support →

Extends​

Implements​

Constructors​

Constructor​

Parameters​

Returns​

Overrides​

Properties​

onError()?​

Parameters​

Returns​

Accessors​

currentTime​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Implementation of​

duration​

Get Signature​

Returns​

Implementation of​

ignoreSilentSwitchMode​

Get Signature​

Note​

Returns​

Set Signature​

Note​

Parameters​

Returns​

Implementation of​

isPlaying​

Get Signature​

Note​

Note​

Returns​

Implementation of​

loop​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Implementation of​

mixAudioMode​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Implementation of​

muted​

Get Signature​

Returns​

Set Signature​

Parameters​

Returns​

Implementation of​

onAudioBecomingNoisy​

Get Signature​

Platform​

Returns​

Returns​

Set Signature​

Platform​

Parameters​

Returns​

Inherited from​

onAudioFocusChange​

Get Signature​

Platform​

Returns​

Parameters​

Returns​

Set Signature​

Platform​

Parameters​

Returns​

Inherited from​

Extends

Implements

Constructors

Constructor

Parameters

Returns

Overrides

Properties

onError()?

Parameters

Returns

Accessors

currentTime

Get Signature

Returns

Set Signature

Parameters

Returns

Implementation of

duration

Get Signature

Returns

Implementation of

ignoreSilentSwitchMode

Get Signature

Note

Returns

Set Signature

Note

Parameters

Returns

Implementation of

isPlaying

Get Signature

Note

Note

Returns

Implementation of

loop

Get Signature

Returns

Set Signature

Parameters

Returns

Implementation of

mixAudioMode

Get Signature

Returns

Set Signature

Parameters

Returns

Implementation of

muted

Get Signature

Returns

Set Signature

Parameters

Returns

Implementation of

onAudioBecomingNoisy

Get Signature

Platform

Returns

Returns

Set Signature

Platform

Parameters

Returns

Inherited from

onAudioFocusChange

Get Signature

Platform

Returns

Parameters

Returns

Set Signature

Platform

Parameters

Returns

Inherited from