Interface: VideoPlayerState
Defined in: video/types.ts:17
Readonly playback snapshot from the upstream video player store.
Properties
activeVideoRendition
activeVideoRendition:
MediaVideoRendition|null
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:245
Video rendition currently playing, including when automatic ABR is selected.
audioTrackList
audioTrackList:
MediaAudioTrack[]
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:259
Audio tracks available for manual track selection.
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
chaptersCues
chaptersCues:
MediaTextCue[]
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:323
Cues from the first kind="chapters" track, with cue ends clamped to a finite media duration.
controlsVisible
controlsVisible:
boolean
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:200
Whether controls should be visible.
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
fullscreenAvailability
fullscreenAvailability:
MediaFeatureAvailability
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:182
Whether fullscreen can be requested on this platform.
See
https://developer.mozilla.org/en-US/docs/Web/API/Document/fullscreenEnabled
isFullscreen
isFullscreen:
boolean
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:176
Whether fullscreen mode is currently active.
See
https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API
isPictureInPicture
isPictureInPicture:
boolean
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:364
Whether picture-in-picture mode is currently active.
See
https://developer.mozilla.org/en-US/docs/Web/API/Picture-in-Picture_API
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
pictureInPictureAvailability
pictureInPictureAvailability:
MediaFeatureAvailability
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:370
Whether picture-in-picture can be requested on this platform.
See
https://developer.mozilla.org/en-US/docs/Web/API/Document/pictureInPictureEnabled
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
readonlyplaybackRates: readonlynumber[]
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
readonlyposter: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
remotePlaybackAvailability
remotePlaybackAvailability:
MediaFeatureAvailability
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:350
Whether remote playback can be requested on this platform.
See
https://developer.mozilla.org/en-US/docs/Web/API/RemotePlayback
remotePlaybackState
remotePlaybackState:
RemotePlaybackConnectionState
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:344
Current remote playback connection state.
See
https://developer.mozilla.org/en-US/docs/Web/API/RemotePlayback/state
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).
subtitlesShowing
subtitlesShowing:
boolean
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:313
Whether a captions/subtitles track is showing.
textTrackList
textTrackList:
MediaTextTrack<TextTrackKind>[]
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:311
All text tracks available on the media component.
thumbnailsTrack
thumbnailsTrack:
MediaThumbnailsTrack|null
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:325
The first thumbnails track, or null when there is none.
title
readonlytitle: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
userActive
userActive:
boolean
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:198
Whether the user has recently interacted with the player.
videoRenditionList
videoRenditionList:
MediaVideoRendition[]
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:243
Video renditions available for manual quality selection.
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
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
promptRemotePlayback()
promptRemotePlayback():
Promise<void>
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:356
Prompt the user to pick a remote playback device. Exits fullscreen first when connecting.
Returns
Promise<void>
See
https://developer.mozilla.org/en-US/docs/Web/API/RemotePlayback/prompt
requestControlsLock()
requestControlsLock(): () =>
void
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:207
Keep controls visible during a sustained interaction.
The returned function releases the lock. Multiple concurrent locks are supported and each release function is idempotent.
Returns
() => void
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
selectSubtitlesTrack()
selectSubtitlesTrack(
id):void
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:321
Show the captions/subtitles track with id, or turn captions/subtitles off with null.
Parameters
id
string | null
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
toggleControls()
toggleControls(
forceShow?):boolean
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:209
Toggle controls visibility, or force it with forceShow. Returns the new controlsVisible value.
Parameters
forceShow?
boolean
Returns
boolean
toggleSubtitles()
toggleSubtitles(
forceShow?):boolean
Defined in: ../node_modules/.pnpm/@videojs+media@10.0.1/node_modules/@videojs/media/dist/dev/core/state.d.ts:319
Toggle captions/subtitles visibility. Showing enables one caption/subtitle track. A track already showing stays selected. Otherwise, selection prefers the last track shown, then a track matching the browser language, then the first available track. Returns whether a track is showing.
Parameters
forceShow?
boolean
Returns
boolean