Skip to content

Interface: VideoPlayerActions ​

Defined in: video/types.ts:22

Playback, track selection, and presentation actions exposed by a video player.

Extended by ​

Methods ​

exitFullscreen() ​

exitFullscreen(): Promise<void>

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:194

Exit fullscreen mode.

Returns ​

Promise<void>

See ​

https://developer.mozilla.org/en-US/docs/Web/API/Document/exitFullscreen


exitPictureInPicture() ​

exitPictureInPicture(): Promise<void>

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:382

Exit picture-in-picture mode.

Returns ​

Promise<void>

See ​

https://developer.mozilla.org/en-US/docs/Web/API/Document/exitPictureInPicture


pause() ​

pause(): void

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:35

Pause playback. Updates paused immediately.

Returns ​

void

See ​

https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/pause


play() ​

play(): Promise<void>

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:29

Start playback. Updates paused immediately when the media starts.

Returns ​

Promise<void>

See ​

https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/play


requestFullscreen() ​

requestFullscreen(): Promise<void>

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:188

Enter fullscreen mode. Tries container first, falls back to media component.

Returns ​

Promise<void>

See ​

https://developer.mozilla.org/en-US/docs/Web/API/Element/requestFullscreen


requestPictureInPicture() ​

requestPictureInPicture(): Promise<void>

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:376

Enter picture-in-picture mode, exiting fullscreen first. Rejects before metadata is loaded.

Returns ​

Promise<void>

See ​

https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement/requestPictureInPicture


seek() ​

seek(time): Promise<number>

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:102

Seek to a time in seconds. Returns the actual position after seek.

Parameters ​

time ​

number

Returns ​

Promise<number>

See ​

https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/currentTime


selectAudioTrack() ​

selectAudioTrack(id): void

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:261

Select an audio track by id.

Parameters ​

id ​

string

Returns ​

void


selectVideoRendition() ​

selectVideoRendition(id): void

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:247

Select a video rendition by id, or automatic ABR with "auto".

Parameters ​

id ​

string

Returns ​

void


setMuted() ​

setMuted(muted): boolean

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:76

Set the muted state, updating the store immediately. Unmuting at volume 0 restores volume to 0.25. Returns the new muted value.

Parameters ​

muted ​

boolean

Returns ​

boolean

See ​

https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/muted


setPlaybackRate() ​

setPlaybackRate(rate): void

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:229

Set the playback rate.

Parameters ​

rate ​

number

Returns ​

void

See ​

https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/playbackRate


setVolume() ​

setVolume(volume): number

Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:69

Set volume (clamped 0-1). Returns the clamped value.

Parameters ​

volume ​

number

Returns ​

number

See ​

https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/volume