Skip to content

Interface: AudioPlayerHandle ​

Defined in: audio/types.ts:26

Live getters become null when the audio player is inactive or unmounted.

Extends ​

Properties ​

element ​

readonly element: AudioPlayerElement | null

Defined in: audio/types.ts:27


media ​

readonly media: PlayerMedia | null

Defined in: audio/types.ts:29


store ​

readonly store: AudioPlayerStore | null

Defined in: audio/types.ts:28

Methods ​

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

Inherited from ​

AudioPlayerActions.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

Inherited from ​

AudioPlayerActions.play


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

Inherited from ​

AudioPlayerActions.seek


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

Inherited from ​

AudioPlayerActions.setMuted


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

Inherited from ​

AudioPlayerActions.setPlaybackRate


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

Inherited from ​

AudioPlayerActions.setVolume