Skip to content

Interface: AudioPlayerState ​

Defined in: audio/types.ts:12

Readonly playback snapshot from the upstream audio player store.

Properties ​

buffered ​

buffered: [number, number][]

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

Buffered time ranges as [start, end] tuples.

See ​

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


canPlay ​

canPlay: boolean

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

Whether enough data is loaded to begin playback.

See ​

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


currentSrc ​

currentSrc: string

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

Current media source URL (empty string if none).

See ​

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


currentTime ​

currentTime: number

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

Current playback position in seconds.

See ​

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


duration ​

duration: number

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

Total duration in seconds (0 if unknown).

See ​

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


ended ​

ended: boolean

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

Whether playback has reached the end.

See ​

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


error ​

error: ErrorLike | null

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

The current media error, or null if none.

See ​

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


muted ​

muted: boolean

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

Whether audio is muted.

See ​

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


mutedAvailability ​

mutedAvailability: MediaFeatureAvailability

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

Whether the media can be muted. Separate from volumeAvailability because the two come apart: an embed can take a mute command while offering no way to set a level, and iOS Safari refuses a volume write on media that mutes perfectly well.

See ​

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


paused ​

paused: boolean

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

Whether playback is paused.

See ​

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


playbackRate ​

playbackRate: number

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

Current playback rate.

See ​

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


playbackRates ​

readonly playbackRates: readonly number[]

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

Available playback rates.

See ​

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


poster ​

readonly poster: string

Defined in: ../node_modules/.pnpm/@videojs+core@10.0.1_@videojs+element@10.0.1_react@19.3.1/node_modules/@videojs/core/dist/dev/dom/store/features/metadata.d.ts:25


seekable ​

seekable: [number, number][]

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

Seekable time ranges as [start, end] tuples.

See ​

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


seeking ​

seeking: boolean

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

Whether a seek operation is in progress.

See ​

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


started ​

started: boolean

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

Whether playback has started (played or seeked).


title ​

readonly title: string

Defined in: ../node_modules/.pnpm/@videojs+core@10.0.1_@videojs+element@10.0.1_react@19.3.1/node_modules/@videojs/core/dist/dev/dom/store/features/metadata.d.ts:24


volume ​

volume: number

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

Volume level from 0 (silent) to 1 (max).

See ​

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


volumeAvailability ​

volumeAvailability: MediaFeatureAvailability

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

Whether volume can be programmatically set on this platform.

See ​

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


waiting ​

waiting: boolean

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

Whether playback is stalled waiting for data.

See ​

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

Methods ​

dismissError() ​

dismissError(): void

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

Dismiss the current error by clearing it.

Returns ​

void


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


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


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