Interface: AllPlayerEvents

Defined in: types/Events.ts:96

Extends

• VideoPlayerEvents

Properties

onAudioBecomingNoisy()

onAudioBecomingNoisy: () => void;

Defined in: types/Events.ts:12

Called when the audio becomes noisy.

Returns

void

Platform

Android

Inherited from

VideoPlayerEvents.onAudioBecomingNoisy

---

onAudioFocusChange()

onAudioFocusChange: (hasAudioFocus) => void;

Defined in: types/Events.ts:18

Called when the audio focus changes.

Parameters

Parameter	Type	Description
hasAudioFocus	boolean	Whether the audio has focus.

Returns

void

Platform

Android

Inherited from

VideoPlayerEvents.onAudioFocusChange

---

onBandwidthUpdate()

onBandwidthUpdate: (data) => void;

Defined in: types/Events.ts:22

Called when the bandwidth of the video changes.

Parameters

Parameter	Type
data	BandwidthData

Returns

void

Inherited from

VideoPlayerEvents.onBandwidthUpdate

---

onBuffer()

onBuffer: (buffering) => void;

Defined in: types/Events.ts:27

Called when the video is buffering.

Parameters

Parameter	Type	Description
buffering	boolean	Whether the video is buffering.

Returns

void

Inherited from

VideoPlayerEvents.onBuffer

---

onControlsVisibleChange()

onControlsVisibleChange: (visible) => void;

Defined in: types/Events.ts:32

Called when the video view's controls visibility changes.

Parameters

Parameter	Type	Description
visible	boolean	Whether the video view's controls are visible.

Returns

void

Inherited from

VideoPlayerEvents.onControlsVisibleChange

---

onEnd()

onEnd: () => void;

Defined in: types/Events.ts:36

Called when the video ends.

Returns

void

Inherited from

VideoPlayerEvents.onEnd

---

onError()

onError: (error) => void;

Defined in: types/Events.ts:97

Parameters

Parameter	Type
error	VideoRuntimeError

Returns

void

---

onExternalPlaybackChange()

onExternalPlaybackChange: (externalPlaybackActive) => void;

Defined in: types/Events.ts:42

Called when the external playback state changes.

Parameters

Parameter	Type	Description
externalPlaybackActive	boolean	Whether the external playback is active.

Returns

void

Platform

iOS

Inherited from

VideoPlayerEvents.onExternalPlaybackChange

---

onLoad()

onLoad: (data) => void;

Defined in: types/Events.ts:47

Called when the video is loaded.

Parameters

Parameter	Type
data	onLoadData

Returns

void

Note

onLoadStart -> initialize the player -> onLoad

Inherited from

VideoPlayerEvents.onLoad

---

onLoadStart()

onLoadStart: (data) => void;

Defined in: types/Events.ts:52

Called when the video starts loading.

Parameters

Parameter	Type
data	onLoadStartData

Returns

void

Note

onLoadStart -> initialize the player -> onLoad

Inherited from

VideoPlayerEvents.onLoadStart

---

onPlaybackRateChange()

onPlaybackRateChange: (rate) => void;

Defined in: types/Events.ts:60

Called when the player playback rate changes.

Parameters

Parameter	Type
rate	number

Returns

void

Inherited from

VideoPlayerEvents.onPlaybackRateChange

---

onPlaybackStateChange()

onPlaybackStateChange: (data) => void;

Defined in: types/Events.ts:56

Called when the player playback state changes.

Parameters

Parameter	Type
data	onPlaybackStateChangeData

Returns

void

Inherited from

VideoPlayerEvents.onPlaybackStateChange

---

onProgress()

onProgress: (data) => void;

Defined in: types/Events.ts:64

Called when the player progress changes.

Parameters

Parameter	Type
data	onProgressData

Returns

void

Inherited from

VideoPlayerEvents.onProgress

---

onReadyToDisplay()

onReadyToDisplay: () => void;

Defined in: types/Events.ts:68

Called when the video is ready to display.

Returns

void

Inherited from

VideoPlayerEvents.onReadyToDisplay

---

onSeek()

onSeek: (seekTime) => void;

Defined in: types/Events.ts:72

Called when the player seeks.

Parameters

Parameter	Type
seekTime	number

Returns

void

Inherited from

VideoPlayerEvents.onSeek

---

onStatusChange()

onStatusChange: (status) => void;

Defined in: types/Events.ts:93

Called when the player status changes.

Parameters

Parameter	Type
status	VideoPlayerStatus

Returns

void

Inherited from

VideoPlayerEvents.onStatusChange

---

onTextTrackDataChanged()

onTextTrackDataChanged: (texts) => void;

Defined in: types/Events.ts:80

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

Parameters

Parameter	Type
texts	string[]

Returns

void

Inherited from

VideoPlayerEvents.onTextTrackDataChanged

---

onTimedMetadata()

onTimedMetadata: (metadata) => void;

Defined in: types/Events.ts:76

Called when player receives timed metadata.

Parameters

Parameter	Type
metadata	TimedMetadata

Returns

void

Inherited from

VideoPlayerEvents.onTimedMetadata

---

onTrackChange()

onTrackChange: (track) => void;

Defined in: types/Events.ts:85

Called when the selected text track changes.

Parameters

Parameter	Type	Description
track	null | TextTrack	The newly selected text track, or null if no track is selected

Returns

void

Inherited from

VideoPlayerEvents.onTrackChange

---

onVolumeChange()

onVolumeChange: (data) => void;

Defined in: types/Events.ts:89

Called when the volume of the player changes.

Parameters

Parameter	Type
data	onVolumeChangeData

Returns

void

Inherited from

VideoPlayerEvents.onVolumeChange