# Video.js v10 — React API (complete)
> Every React API page in one file (about 40k tokens). Index with descriptions: https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/llms.txt
---
# createPlayer
Factory function that creates a typed Player component and hooks
## Import
```tsx
import { createPlayer } from "@videojs/react";
import { videoFeatures } from "@videojs/react/video";
```
`createPlayer` is the entry point for setting up a Video.js player in React. It accepts a configuration object with a `features` array and returns hooks and components for building a player.
The hook is typed according to the provided features, giving you full type safety for state selectors and actions.
```tsx
import { Container, createPlayer } from '@videojs/react';
import { videoFeatures } from '@videojs/react/video';
const { Player, usePlayer, useMedia } = createPlayer({
features: videoFeatures,
});
// Container is imported independently from createPlayer.
```
## Examples
### Basic Usage
**App.tsx**
```tsx
import { Container, createPlayer } from '@videojs/react';
import { Video, videoFeatures } from '@videojs/react/video';
const { Player, usePlayer } = createPlayer({
features: videoFeatures,
});
function Controls() {
const store = usePlayer();
const paused = usePlayer((s) => s.paused);
return (
);
}
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.media-container {
position: relative;
}
.media-container video {
width: 100%;
}
.controls {
position: absolute;
bottom: 10px;
left: 10px;
}
.button {
padding-block: 8px;
padding-inline: 20px;
color: black;
cursor: pointer;
background: rgba(255, 255, 255, 0.7);
border: 1px solid rgba(255, 255, 255, 0.3);
border-radius: 9999px;
backdrop-filter: blur(10px);
}
```
## API Reference
### Video
`createPlayer(config): CreatePlayerResult`
Create a player instance with a typed Player component and hooks.
#### Parameters
| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| `config` (required) | `{ features: [PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, typeof metadataFeature]; displayName?: string }` | — | Player configuration with features and optional display name. |
#### Return Value
| Property | Type | Description |
| --- | --- | --- |
| `Player` | `FC>>` | Provides a new player store to its descendants without adding a layout element. |
| `usePlayer` | `{ (): VideoPlayerStore; (selector: ((state: VideoPlayerStore['state']) => R)): R }` | Accesses the configured store, or subscribes to a selected value from it. |
| `useMedia` | `(() => Media \| null)` | Returns the media currently attached beneath the generated Player, or `null` before attachment. |
### Audio
`createPlayer(config): CreatePlayerResult`
Create a player for audio media.
#### Parameters
| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| `config` (required) | `{ features: [PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, PlayerFeature, typeof metadataFeature]; displayName?: string }` | — | Player configuration with features and optional display name. |
#### Return Value
| Property | Type | Description |
| --- | --- | --- |
| `Player` | `FC>>` | Provides a new player store to its descendants without adding a layout element. |
| `usePlayer` | `{ (): AudioPlayerStore; (selector: ((state: AudioPlayerStore['state']) => R)): R }` | Accesses the configured store, or subscribes to a selected value from it. |
| `useMedia` | `(() => Media \| null)` | Returns the media currently attached beneath the generated Player, or `null` before attachment. |
### Generic
`createPlayer(config): CreatePlayerResult>`
Create a player with custom features.
#### Parameters
| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| `config` (required) | `{ features: Features; displayName?: string }` | — | Player configuration with features and optional display name. |
#### Return Value
| Property | Type | Description |
| --- | --- | --- |
| `Player` | `FC>>>` | Provides a new player store to its descendants without adding a layout element. |
| `usePlayer` | `{ (): PlayerStore; (selector: ((state: PlayerStore['state']) => R)): R }` | Accesses the configured store, or subscribes to a selected value from it. |
| `useMedia` | `(() => Media \| null)` | Returns the media currently attached beneath the generated Player, or `null` before attachment. |
---
# usePlayer
Hook to access the player store from within a Player
## Import
```tsx
import { usePlayer } from "@videojs/react";
```
The `usePlayer` hook returned by [`createPlayer`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/create-player) gives you access to the player store from any component within its `Player`. It’s typed to the features you passed to `createPlayer`, and has two overloads — without arguments for direct store access, or with a selector for reactive state subscriptions.
```tsx
const { Player, usePlayer } = createPlayer({ features: videoFeatures });
```
The pair works exactly like React Context: [`Player`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/components/player) is the Provider, and `usePlayer` is its `useContext`-style consumer, so the calling component must render inside `Player`. You can still read state anywhere: `Player` renders no DOM of its own, so lift it above every component that needs player state, the way you’d lift any Provider.
`usePlayer` is also available as a standalone import (`import { usePlayer } from '@videojs/react'`), but the standalone version returns an untyped `UnknownStore`. Pass a premade selector to recover typing:
```tsx
import { usePlayer, selectPlayback } from '@videojs/react';
usePlayer(); // UnknownStore (state: unknown)
usePlayer(selectPlayback); // MediaPlaybackState | undefined
```
## Examples
### Store Access
Call `usePlayer()` without arguments to get the store instance. Use this for imperative actions like play, pause, and volume changes. The component does not re-render on state changes.
**App.tsx**
```tsx
import { Container, createPlayer } from '@videojs/react';
import { Video, videoFeatures } from '@videojs/react/video';
const { Player, usePlayer } = createPlayer({
features: videoFeatures,
});
function Controls() {
const store = usePlayer();
return (
);
}
export default function StoreAccess() {
return (
);
}
```
**App.css**
```css
.media-container {
position: relative;
}
.media-container video {
width: 100%;
}
.controls {
display: flex;
gap: 6px;
padding: 12px;
background: rgba(0, 0, 0, 0.05);
border-top: 1px solid rgba(0, 0, 0, 0.1);
}
.controls button {
padding: 4px 12px;
font-size: 0.8125rem;
color: #111827;
cursor: pointer;
background: white;
border: 1px solid #ccc;
border-radius: 6px;
}
```
### Selector Subscription
Pass a selector function to subscribe to specific state. The component re-renders when the selected value changes, using shallow equality by default.
**App.tsx**
```tsx
import { Container, createPlayer } from '@videojs/react';
import { Video, videoFeatures } from '@videojs/react/video';
const { Player, usePlayer } = createPlayer({
features: videoFeatures,
});
function StateDisplay() {
const state = usePlayer((s) => ({
paused: s.paused,
currentTime: s.currentTime,
duration: s.duration,
}));
return (
);
}
export default function Selector() {
return (
);
}
```
**App.css**
```css
.media-container {
position: relative;
}
.media-container video {
width: 100%;
}
.panel {
display: flex;
gap: 16px;
padding: 12px;
margin: 0;
font-size: 0.8125rem;
background: rgba(0, 0, 0, 0.05);
border-top: 1px solid rgba(0, 0, 0, 0.1);
}
.panel div {
display: flex;
gap: 8px;
}
.panel dt {
color: #6b7280;
}
.panel dd {
margin: 0;
font-variant-numeric: tabular-nums;
}
```
## API Reference
### Without Selector
`usePlayer(): UnknownStore`
Access the player store from within a Player.
This standalone hook has no knowledge of your configured features, so it returns an untyped `UnknownStore` whose state properties are typed as `unknown`. For typed access, use the `usePlayer` returned by `createPlayer()`, or pass a premade selector to recover the type from its return value.
#### Return Value
| Property | Type |
| --- | --- |
| `$state` | `{ current: Readonly; subscribe(callback: (() => void), options?: SubscribeOptions): (() => void) }` |
| `target` | `unknown \| null` |
| `destroyed` | `boolean` |
| `state` | `Record` |
| `attach` | `((target: unknown) => (() => void))` |
| `destroy` | `(() => void)` |
| `subscribe` | `((callback: StateChange, options?: SubscribeOptions) => (() => void))` |
### With Selector
`usePlayer(selector): R`
Select a value from the player store. Re-renders when the selected value changes.
The selector receives `UnknownState`, so an inline selector returns `unknown`. Pass a premade selector (e.g. `selectPlayback`) to get a typed result.
#### Parameters
| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| `selector` (required) | `((state: UnknownState) => R)` | — | Derives a value from the player store state. |
#### Return Value
`R`
---
# useOptionalPlayer
Hook to access or select Player state when a Player is available
## Import
```tsx
import { useOptionalPlayer } from "@videojs/react";
```
## Usage
Without a selector, the hook returns the player store or `undefined` outside `Player`.
```tsx
const store = useOptionalPlayer();
```
With a selector, it subscribes while a player is available and returns the selected value. The selector is not called outside `Player`.
```tsx
import { selectPlayback, useOptionalPlayer } from "@videojs/react";
const playback = useOptionalPlayer(selectPlayback);
```
Use `usePlayer` when the component requires a surrounding player.
## API Reference
### Without Selector
`useOptionalPlayer(): UnknownStore | undefined`
Returns the player store when available, or `undefined` outside a Player.
#### Return Value
| Property | Type |
| --- | --- |
| `$state` | `{ current: Readonly; subscribe(callback: (() => void), options?: SubscribeOptions): (() => void) }` |
| `target` | `unknown \| null` |
| `destroyed` | `boolean` |
| `state` | `Record` |
| `attach` | `((target: unknown) => (() => void))` |
| `destroy` | `(() => void)` |
| `subscribe` | `((callback: StateChange, options?: SubscribeOptions) => (() => void))` |
### With Selector
`useOptionalPlayer(selector): R | undefined`
Selects a player value when available, or returns `undefined` outside a Player.
#### Parameters
| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| `selector` (required) | `((state: UnknownState) => R)` | — | Derives a value from the player store state. |
#### Return Value
`R | undefined`
---
# useContainer
Hook to access the media container from the nearest Player
`useContainer` returns the `MediaContainer` registered with the nearest `Player`. It returns `null` until the container mounts, or whenever that player has no registered container.
## Import
```tsx
import { useContainer } from "@videojs/react";
```
## Usage
Call `useContainer` from a component rendered inside `Player`:
**ContainerStatus.tsx**
```tsx
import { useContainer } from "@videojs/react";
export function ContainerStatus() {
const container = useContainer();
return ;
}
```
Calling this hook outside `Player` throws because it reads through `usePlayerContext`. If a component can also work outside a player, use [`useOptionalContainer`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/use-optional-container) instead.
`useContainer` reads the registered container. [`useContainerAttach`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/use-container-attach) returns the setter used to register a custom container and is only needed when replacing the built-in `Container`.
## API Reference
`useContainer(): MediaContainer | null`
### Return Value
`MediaContainer | null`
---
# useOptionalContainer
Hook to access a Player container when one is available
## Import
```tsx
import { useOptionalContainer } from "@videojs/react";
```
## Usage
Use the optional hook when a component can work both inside and outside `Player`.
```tsx
function ContainerAwareStatus() {
const container = useOptionalContainer();
return ;
}
```
It returns `null` outside `Player`, before its container mounts, or when the player has no registered container. Use `useContainer` when a missing Player should be treated as an error.
## API Reference
`useOptionalContainer(): MediaContainer | null`
### Return Value
`MediaContainer | null`
---
# useContainerAttach
Hook to register a custom container element with the player context
## Import
```tsx
import { useContainerAttach } from "@videojs/react";
```
`useContainerAttach` returns a setter function for registering a DOM element as the player’s container. The built-in `Container` uses this internally; you only need it when building a custom container element.
**CustomContainer.tsx**
```tsx
import { useContainerAttach } from "@videojs/react";
function CustomContainer({ children }: { children: React.ReactNode }) {
const setContainer = useContainerAttach();
return
{children}
;
}
```
## Who needs this
You only need `useContainerAttach` if you’re replacing the built-in `Container` with a custom element. For example, if you’re building a container with custom fullscreen behavior or a non-standard layout boundary.
For standard player layouts, use the built-in `Container`.
## Safe outside Player
Returns `undefined` when called outside `Player`. Passing `undefined` to `ref` is harmless in React. Check the return value if your component needs to know whether it’s inside a player.
## API Reference
`useContainerAttach(): Dispatch> | undefined`
### Return Value
| Type |
| --- |
| `Dispatch> \| undefined` |
---
# Player store
Every state field and action on the player store, grouped by the feature that adds it
The player store combines the state and actions of every feature the player includes. A field or action exists only when its feature is included. This page lists the whole store; each feature’s reference page adds its selector and examples.
## Access
[`usePlayer`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/use-player) returns the store without a selector and the selected state with one. State fields and actions are properties of the store.
```tsx
const store = usePlayer();
const paused = usePlayer((s) => s.paused);
store.play();
```
Each feature also exports a selector, such as `selectPlayback`, that returns its state and actions, or `undefined` when the player doesn’t include the feature. See [`createSelector`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/create-selector) to write your own.
## State and actions
Each feature links to the same entry on its reference page.
| Name | Type | Feature | Description |
| --- | --- | --- | --- |
| `paused` | `boolean` | [`playbackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback#playback-state-paused) | Whether playback is paused. |
| `ended` | `boolean` | [`playbackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback#playback-state-ended) | Whether playback has reached the end. |
| `started` | `boolean` | [`playbackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback#playback-state-started) | Whether playback has started (played or seeked). |
| `waiting` | `boolean` | [`playbackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback#playback-state-waiting) | Whether playback is stalled waiting for data. |
| `play` | `() => Promise` | [`playbackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback#playback-action-play) | Start playback. Updates `paused` immediately when the media starts. |
| `pause` | `() => void` | [`playbackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback#playback-action-pause) | Pause playback. Updates `paused` immediately. |
| `currentTime` | `number` | [`timeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-time#time-state-currentTime) | Current playback position in seconds. |
| `duration` | `number` | [`timeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-time#time-state-duration) | Total duration in seconds (0 if unknown). |
| `seeking` | `boolean` | [`timeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-time#time-state-seeking) | Whether a seek operation is in progress. |
| `seek` | `(time: number) => Promise` | [`timeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-time#time-action-seek) | Seek to a time in seconds. Returns the actual position after seek. |
| `volume` | `number` | [`volumeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-volume#volume-state-volume) | Volume level from 0 (silent) to 1 (max). |
| `muted` | `boolean` | [`volumeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-volume#volume-state-muted) | Whether audio is muted. |
| `volumeAvailability` | `'available' \| 'unavailable' \| 'unsupported'` | [`volumeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-volume#volume-state-volumeAvailability) | Whether volume can be programmatically set on this platform. |
| `mutedAvailability` | `'available' \| 'unavailable' \| 'unsupported'` | [`volumeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-volume#volume-state-mutedAvailability) | 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. |
| `setVolume` | `(volume: number) => number` | [`volumeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-volume#volume-action-setVolume) | Set volume (clamped 0-1). Returns the clamped value. |
| `setMuted` | `(muted: boolean) => boolean` | [`volumeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-volume#volume-action-setMuted) | Set the muted state, updating the store immediately. Unmuting at volume 0 restores volume to 0.25. Returns the new muted value. |
| `isFullscreen` | `boolean` | [`fullscreenFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-fullscreen#fullscreen-state-isFullscreen) | Whether fullscreen mode is currently active. |
| `fullscreenAvailability` | `'available' \| 'unavailable' \| 'unsupported'` | [`fullscreenFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-fullscreen#fullscreen-state-fullscreenAvailability) | Whether fullscreen can be requested on this platform. |
| `requestFullscreen` | `() => Promise` | [`fullscreenFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-fullscreen#fullscreen-action-requestFullscreen) | Enter fullscreen mode. Tries container first, falls back to media element. |
| `exitFullscreen` | `() => Promise` | [`fullscreenFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-fullscreen#fullscreen-action-exitFullscreen) | Exit fullscreen mode. |
| `userActive` | `boolean` | [`controlsFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-controls#controls-state-userActive) | Whether the user has recently interacted with the player. |
| `controlsVisible` | `boolean` | [`controlsFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-controls#controls-state-controlsVisible) | Whether controls should be visible. |
| `requestControlsLock` | `() => (() => void)` | [`controlsFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-controls#controls-action-requestControlsLock) | Keep controls visible during a sustained interaction. The returned function releases the lock. Multiple concurrent locks are supported and each release function is idempotent. |
| `toggleControls` | `(forceShow?: boolean) => boolean` | [`controlsFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-controls#controls-action-toggleControls) | Toggle controls visibility, or force it with `forceShow`. Returns the new `controlsVisible` value. |
| `buffered` | `[number, number][]` | [`bufferFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-buffer#buffer-state-buffered) | Buffered time ranges as \[start, end\] tuples. |
| `seekable` | `[number, number][]` | [`bufferFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-buffer#buffer-state-seekable) | Seekable time ranges as \[start, end\] tuples. |
| `textTrackList` | `MediaTextTrack[]` | [`textTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-text-tracks#textTrack-state-textTrackList) | All text tracks available on the media element. |
| `subtitlesShowing` | `boolean` | [`textTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-text-tracks#textTrack-state-subtitlesShowing) | Whether a captions/subtitles track is showing. |
| `chaptersCues` | `MediaTextCue[]` | [`textTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-text-tracks#textTrack-state-chaptersCues) | Cues from the first `kind="chapters"` track, with cue ends clamped to a finite media duration. |
| `thumbnailsTrack` | `{ cues: MediaTextCue[]; src: string \| null; crossOrigin: 'anonymous' \| 'use-credentials' \| null } \| null` | [`textTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-text-tracks#textTrack-state-thumbnailsTrack) | The first thumbnails track, or `null` when there is none. |
| `toggleSubtitles` | `(forceShow?: boolean) => boolean` | [`textTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-text-tracks#textTrack-action-toggleSubtitles) | 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. |
| `selectSubtitlesTrack` | `(id: string \| null) => void` | [`textTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-text-tracks#textTrack-action-selectSubtitlesTrack) | Show the captions/subtitles track with `id`, or turn captions/subtitles off with `null`. |
| `playbackRates` | `readonly number[]` | [`playbackRateFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback-rate#playbackRate-state-playbackRates) | Available playback rates. |
| `playbackRate` | `number` | [`playbackRateFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback-rate#playbackRate-state-playbackRate) | Current playback rate. |
| `setPlaybackRate` | `(rate: number) => void` | [`playbackRateFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback-rate#playbackRate-action-setPlaybackRate) | Set the playback rate. |
| `isPictureInPicture` | `boolean` | [`pipFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-pip#pip-state-isPictureInPicture) | Whether picture-in-picture mode is currently active. |
| `pictureInPictureAvailability` | `'available' \| 'unavailable' \| 'unsupported'` | [`pipFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-pip#pip-state-pictureInPictureAvailability) | Whether picture-in-picture can be requested on this platform. |
| `requestPictureInPicture` | `() => Promise` | [`pipFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-pip#pip-action-requestPictureInPicture) | Enter picture-in-picture mode, exiting fullscreen first. Rejects before metadata is loaded. |
| `exitPictureInPicture` | `() => Promise` | [`pipFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-pip#pip-action-exitPictureInPicture) | Exit picture-in-picture mode. |
| `error` | `{ code: number; message: string } \| null` | [`errorFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-error#error-state-error) | The current media error, or null if none. |
| `dismissError` | `() => void` | [`errorFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-error#error-action-dismissError) | Dismiss the current error by clearing it. |
| `title` | `string` | [`metadataFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-metadata#metadata-state-title) | The resolved content title. Set it through the player, not through the store. |
| `poster` | `string` | [`metadataFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-metadata#metadata-state-poster) | The resolved poster URL, independent of the media element's own `poster`. Set it through the player, not through the store. |
| `currentSrc` | `string` | [`sourceFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-source#source-state-currentSrc) | Current media source URL (empty string if none). |
| `canPlay` | `boolean` | [`sourceFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-source#source-state-canPlay) | Whether enough data is loaded to begin playback. |
| `videoRenditionList` | `MediaVideoRendition[]` | [`qualityFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-quality#quality-state-videoRenditionList) | Video renditions available for manual quality selection. |
| `activeVideoRendition` | `{ id: string; width?: number; height?: number; bitrate?: number; frameRate?: number; codec?: string; selected: boolean } \| null` | [`qualityFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-quality#quality-state-activeVideoRendition) | Video rendition currently playing, including when automatic ABR is selected. |
| `selectVideoRendition` | `(id: string) => void` | [`qualityFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-quality#quality-action-selectVideoRendition) | Select a video rendition by `id`, or automatic ABR with `"auto"`. |
| `audioTrackList` | `MediaAudioTrack[]` | [`audioTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-audio-track#audioTrack-state-audioTrackList) | Audio tracks available for manual track selection. |
| `selectAudioTrack` | `(id: string) => void` | [`audioTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-audio-track#audioTrack-action-selectAudioTrack) | Select an audio track by `id`. |
| `remotePlaybackState` | `'disconnected' \| 'connecting' \| 'connected'` | [`remotePlaybackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-remote-playback#remotePlayback-state-remotePlaybackState) | Current remote playback connection state. |
| `remotePlaybackAvailability` | `'available' \| 'unavailable' \| 'unsupported'` | [`remotePlaybackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-remote-playback#remotePlayback-state-remotePlaybackAvailability) | Whether remote playback can be requested on this platform. |
| `promptRemotePlayback` | `() => Promise` | [`remotePlaybackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-remote-playback#remotePlayback-action-promptRemotePlayback) | Prompt the user to pick a remote playback device. Exits fullscreen first when connecting. |
| `liveEdgeStart` | `number` | [`liveFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-live#live-state-liveEdgeStart) | Playback time where the live edge begins. Playback is live when `currentTime >= liveEdgeStart`. `NaN` when the stream is not live or the value is unknown. |
| `targetLiveWindow` | `number` | [`liveFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-live#live-state-targetLiveWindow) | Describes the kind of live window available. This value is not a duration. `0` for a sliding live window, `Infinity` for a live event with playback history, and `NaN` for on-demand or unknown. |
| `streamType` | `'on-demand' \| 'live' \| 'unknown'` | [`streamTypeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-stream-type#streamType-state-streamType) | Current stream delivery type. Components use this to show live-specific UI (for example, a live indicator or a "jump to live edge" button) or hide the time display. |
| `orientationLockType` | `'any' \| 'landscape' \| 'landscape-primary' \| 'landscape-secondary' \| 'natural' \| 'portrait' \| 'portrait-primary' \| 'portrait-secondary'` | [`orientationLockFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-orientation-lock#orientationLock-state-orientationLockType) | Screen orientation type locked while fullscreen is active. |
| `setOrientationLockType` | `(value: 'any' \| 'landscape' \| 'landscape-primary' \| 'landscape-secondary' \| 'natural' \| 'portrait' \| 'portrait-primary' \| 'portrait-secondary' \| null \| undefined) => void` | [`orientationLockFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-orientation-lock#orientationLock-action-setOrientationLockType) | Sets the locked orientation type. A missing value, including an empty one, restores the default. |
## Features by preset
Each column is a preset's feature bundle. A feature no bundle includes is opt-in: add it to your [`createPlayer`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/create-player) features yourself.
| Feature | `videoFeatures` | `audioFeatures` | `liveAudioFeatures` | `liveVideoFeatures` |
| --- | --- | --- | --- | --- |
| [`playbackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback) | ✓ | ✓ | ✓ | ✓ |
| [`timeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-time) | ✓ | ✓ | ✓ | ✓ |
| [`volumeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-volume) | ✓ | ✓ | ✓ | ✓ |
| [`fullscreenFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-fullscreen) | ✓ | – | – | ✓ |
| [`controlsFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-controls) | ✓ | – | – | ✓ |
| [`bufferFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-buffer) | ✓ | ✓ | ✓ | ✓ |
| [`textTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-text-tracks) | ✓ | – | – | ✓ |
| [`playbackRateFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback-rate) | ✓ | ✓ | – | – |
| [`pipFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-pip) | ✓ | – | – | ✓ |
| [`errorFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-error) | ✓ | ✓ | ✓ | ✓ |
| [`metadataFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-metadata) | ✓ | ✓ | ✓ | ✓ |
| [`sourceFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-source) | ✓ | ✓ | ✓ | ✓ |
| [`qualityFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-quality) | ✓ | – | – | – |
| [`audioTrackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-audio-track) | ✓ | – | – | – |
| [`remotePlaybackFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-remote-playback) | ✓ | – | – | ✓ |
| [`liveFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-live) | – | – | ✓ | ✓ |
| [`streamTypeFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-stream-type) | – | – | – | – |
| [`orientationLockFeature`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-orientation-lock) | – | – | – | – |
---
# createSelector
Create a type-safe selector for a store slice's state
## Import
```ts
import { createSelector } from "@videojs/store";
```
`createSelector` is also re-exported from `@videojs/react` and `@videojs/html`.
`createSelector` creates a type-safe selector function for a given slice. The returned selector extracts that slice’s state from the full store state, or returns `undefined` if the slice is not configured.
The built-in selectors ([`selectPlayback`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-playback), [`selectBuffer`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/feature-buffer), etc.) are all created with `createSelector`. Use it to create selectors for custom slices.
**my-custom-selector.ts**
```ts
import { createSelector } from '@videojs/store';
import { myCustomSlice } from './my-custom-slice';
const selectCustom = createSelector(myCustomSlice);
// Use with usePlayer (React) or PlayerController (HTML)
const state = selectCustom(store.state);
```
Pass selectors to [`usePlayer`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/use-player) or [`useStore`](https://deploy-preview-3021--vjs10-site.netlify.app/docs/framework/react/reference/api/use-store) for reactive subscriptions.
## API Reference
`createSelector(slice): Selector