Interface: VideoPlayerEvents
Defined in: types/Events.ts:6
Properties
onAudioBecomingNoisy()
onAudioBecomingNoisy: () => void;
Defined in: types/Events.ts:11
Called when the audio becomes noisy.
Returns
void
Platform
Android
onAudioFocusChange()
onAudioFocusChange: (hasAudioFocus) => void;
Defined in: types/Events.ts:17
Called when the audio focus changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
hasAudioFocus | boolean | Whether the audio has focus. |
Returns
void
Platform
Android
onBandwidthUpdate()
onBandwidthUpdate: (data) => void;
Defined in: types/Events.ts:21
Called when the bandwidth of the video changes.
Parameters
| Parameter | Type |
|---|---|
data | BandwidthData |
Returns
void
onBuffer()
onBuffer: (buffering) => void;
Defined in: types/Events.ts:26
Called when the video is buffering.
Parameters
| Parameter | Type | Description |
|---|---|---|
buffering | boolean | Whether the video is buffering. |
Returns
void
onControlsVisibleChange()
onControlsVisibleChange: (visible) => void;
Defined in: types/Events.ts:31
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
onEnd()
onEnd: () => void;
Defined in: types/Events.ts:35
Called when the video ends.
Returns
void
onExternalPlaybackChange()
onExternalPlaybackChange: (externalPlaybackActive) => void;
Defined in: types/Events.ts:41
Called when the external playback state changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
externalPlaybackActive | boolean | Whether the external playback is active. |
Returns
void
Platform
iOS
onLoad()
onLoad: (data) => void;
Defined in: types/Events.ts:46
Called when the video is loaded.
Parameters
| Parameter | Type |
|---|---|
data | onLoadData |
Returns
void
Note
onLoadStart -> initialize the player -> onLoad
onLoadStart()
onLoadStart: (data) => void;
Defined in: types/Events.ts:51
Called when the video starts loading.
Parameters
| Parameter | Type |
|---|---|
data | onLoadStartData |
Returns
void
Note
onLoadStart -> initialize the player -> onLoad
onPlaybackRateChange()
onPlaybackRateChange: (rate) => void;
Defined in: types/Events.ts:59
Called when the player playback rate changes.
Parameters
| Parameter | Type |
|---|---|
rate | number |
Returns
void
onPlaybackStateChange()
onPlaybackStateChange: (data) => void;
Defined in: types/Events.ts:55
Called when the player playback state changes.
Parameters
| Parameter | Type |
|---|---|
data | onPlaybackStateChangeData |
Returns
void
onProgress()
onProgress: (data) => void;
Defined in: types/Events.ts:63
Called when the player progress changes.
Parameters
| Parameter | Type |
|---|---|
data | onProgressData |
Returns
void
onReadyToDisplay()
onReadyToDisplay: () => void;
Defined in: types/Events.ts:67
Called when the video is ready to display.
Returns
void
onSeek()
onSeek: (seekTime) => void;
Defined in: types/Events.ts:71
Called when the player seeks.
Parameters
| Parameter | Type |
|---|---|
seekTime | number |
Returns
void
onStatusChange()
onStatusChange: (status) => void;
Defined in: types/Events.ts:92
Called when the player status changes.
Parameters
| Parameter | Type |
|---|---|
status | VideoPlayerStatus |
Returns
void
onTextTrackDataChanged()
onTextTrackDataChanged: (texts) => void;
Defined in: types/Events.ts:79
Called when the text track (currently displayed subtitle) data changes.
Parameters
| Parameter | Type |
|---|---|
texts | string[] |
Returns
void
onTimedMetadata()
onTimedMetadata: (metadata) => void;
Defined in: types/Events.ts:75
Called when player receives timed metadata.
Parameters
| Parameter | Type |
|---|---|
metadata | TimedMetadata |
Returns
void
onTrackChange()
onTrackChange: (track) => void;
Defined in: types/Events.ts:84
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
onVolumeChange()
onVolumeChange: (data) => void;
Defined in: types/Events.ts:88
Called when the volume of the player changes.
Parameters
| Parameter | Type |
|---|---|
data | onVolumeChangeData |
Returns
void