` elements. Add a `className` to style them:
```css
/* Click-through: clicks pass through controls to video beneath */
.controls {
pointer-events: none;
}
.controls-group {
pointer-events: auto;
}
.controls-backdrop {
position: absolute;
inset: 0;
transition: opacity 0.35s;
}
/* Fade transition */
.controls {
transition: opacity 0.25s;
}
.controls:not([data-visible]) {
opacity: 0;
}
.controls-backdrop:not([data-visible]) {
opacity: 0;
}
/* Hide the controls until playback starts */
.controls:not([data-started]),
.controls-backdrop:not([data-started]) {
visibility: hidden;
}
```
## Accessibility
`Controls.Root` renders no element. No ARIA role is applied to `Controls.Content` because it is a layout surface, not a landmark. `Controls.Backdrop` is always hidden from assistive technology. `Controls.Group` automatically receives `role="group"` when an `aria-label` or `aria-labelledby` attribute is provided; otherwise no role is assigned.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { Container, Controls, createPlayer, PlayButton, Time } from '@videojs/react';
import { Video, videoFeatures } from '@videojs/react/video';
const { Player } = createPlayer({ features: videoFeatures });
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.media-container {
position: relative;
}
.media-container video {
width: 100%;
}
.media-controls {
position: absolute;
inset: 0;
display: flex;
align-items: flex-end;
padding: 12px;
pointer-events: none;
transition: opacity 0.25s;
}
.controls-backdrop {
position: absolute;
inset: 0;
pointer-events: none;
background: linear-gradient(to top, rgba(0, 0, 0, 0.45), transparent 45%);
opacity: 1;
transition: opacity 0.35s;
}
.controls-backdrop:not([data-visible]),
.media-controls:not([data-visible]):not(:has(:focus-visible)) {
opacity: 0;
}
.controls-group {
display: flex;
align-items: center;
justify-content: space-between;
width: 100%;
pointer-events: auto;
}
.time {
display: inline-flex;
gap: 4px;
align-items: center;
padding-block: 8px;
padding-inline: 16px;
font-size: 14px;
color: black;
background: rgba(255, 255, 255, 0.75);
border: 1px solid rgba(255, 255, 255, 0.25);
border-radius: 9999px;
backdrop-filter: blur(10px);
}
.button {
padding-block: 8px;
padding-inline: 16px;
font-size: 14px;
color: black;
cursor: pointer;
background: rgba(255, 255, 255, 0.75);
border: 1px solid rgba(255, 255, 255, 0.25);
border-radius: 9999px;
backdrop-filter: blur(10px);
}
```
## API Reference
### Root
Manages controls state and provides it to the compound parts. Does not render an element.
#### Props
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `visibility` | `'auto' \| 'always'` | `'auto'` | Whether controls follow player visibility state or remain visible. |
#### State
State is accessible via the `render`, `className`, and `style` props.
| Property | Type | Description |
| --- | --- | --- |
| `visible` | `boolean` | Whether the controls are visible. |
| `userActive` | `boolean` | Whether the user has recently interacted with the player. |
| `started` | `boolean` | Whether playback has started or the media is trying to autoplay. |
#### Data attributes
| Attribute | Description |
| --- | --- |
| `data-visible` | Present when controls are visible. |
| `data-user-active` | Present when the user has recently interacted. |
| `data-started` | Present when playback has started or the media is trying to autoplay. |
### Backdrop
Presentational layer behind player controls. Renders a `
` with the controls state data attributes so skins can style it without reaching across sibling components.
#### Props
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `className` | `string \| ((state: ControlsState) => string \| undefined)` | — | Class name or function returning class name from state. |
| `render` | `ReactElement \| ((props: HTMLProps, state: ControlsState) => ReactElement \| null)` | — | Render prop for custom element. |
| `style` | `CSSProperties \| ((state: ControlsState) => CSSProperties \| undefined)` | — | Style or function returning style from state. |
#### Data attributes
| Attribute | Description |
| --- | --- |
| `data-visible` | Present when controls are visible. |
| `data-user-active` | Present when the user has recently interacted. |
| `data-started` | Present when playback has started or the media is trying to autoplay. |
### Content
Renders the interactive controls surface.
#### Props
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `className` | `string \| ((state: ControlsState) => string \| undefined)` | — | Class name or function returning class name from state. |
| `render` | `ReactElement \| ((props: HTMLProps, state: ControlsState) => ReactElement \| null)` | — | Render prop for custom element. |
| `style` | `CSSProperties \| ((state: ControlsState) => CSSProperties \| undefined)` | — | Style or function returning style from state. |
#### Data attributes
| Attribute | Description |
| --- | --- |
| `data-visible` | Present when controls are visible. |
| `data-user-active` | Present when the user has recently interacted. |
| `data-started` | Present when playback has started or the media is trying to autoplay. |
### Group
Layout group for related controls; sets `role="group"` when labeled.
#### Props
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `className` | `string \| ((state: ControlsState) => string \| undefined)` | — | Class name or function returning class name from state. |
| `render` | `ReactElement \| ((props: HTMLProps, state: ControlsState) => ReactElement \| null)` | — | Render prop for custom element. |
| `style` | `CSSProperties \| ((state: ControlsState) => CSSProperties \| undefined)` | — | Style or function returning style from state. |
#### Data attributes
| Attribute | Description |
| --- | --- |
| `data-visible` | Present when controls are visible. |
| `data-user-active` | Present when the user has recently interacted. |
| `data-started` | Present when playback has started or the media is trying to autoplay. |
---
# VideoSkin
The video preset's default skin with the modern, frosted look
The default skin of the video preset: the control layout for on-demand video with the modern, frosted look. The preset also provides [NeutralVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-neutral-skin), [CompatVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-compat-skin), and [ScaffoldVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the video preset ships.
## Import
```tsx
import { VideoSkin } from '@videojs/react/video';
import '@videojs/react/video/skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Thumbnail
The skin renders a storyboard preview image while scrubbing the time slider. Pass `renderThumbnail` to replace it with your own image, for example to set `crossOrigin`, `loading`, or `fetchPriority`.
See [Show timeline thumbnail previews](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/thumbnails) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { Video, VideoPlayer, VideoSkin } from '@videojs/react/video';
import '@videojs/react/video/skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-video-skin-basic {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# NeutralVideoSkin
The video preset's visually lighter skin, closer to a classic control bar
The neutral skin of the video preset: the same player and the same controls in a visually lighter design, closer to a classic control bar. The preset also provides [VideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-skin), [CompatVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-compat-skin), and [ScaffoldVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the video preset ships.
## Import
```tsx
import { NeutralVideoSkin } from '@videojs/react/video';
import '@videojs/react/video/neutral-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Thumbnail
The skin renders a storyboard preview image while scrubbing the time slider. Pass `renderThumbnail` to replace it with your own image, for example to set `crossOrigin`, `loading`, or `fetchPriority`.
See [Show timeline thumbnail previews](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/thumbnails) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { NeutralVideoSkin, Video, VideoPlayer } from '@videojs/react/video';
import '@videojs/react/video/neutral-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-video-neutral-skin-basic {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# CompatVideoSkin
The video preset's plain, unbranded skin, a polished step above native controls
The Compat skin of the video preset: the same core controls with plain, unbranded surfaces that avoid newer visual effects such as backdrop blur. It puts large play and seek buttons in the center, fullscreen, picture-in-picture, Cast, and AirPlay in a top corner, and chapter segments and thumbnail previews on its time slider. The preset also provides [VideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-skin), [NeutralVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-neutral-skin), and [ScaffoldVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { CompatVideoSkin } from '@videojs/react/video';
import '@videojs/react/video/compat-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Thumbnail
The skin renders a storyboard preview image while scrubbing the time slider. Pass `renderThumbnail` to replace it with your own image, for example to set `crossOrigin`, `loading`, or `fetchPriority`.
See [Show timeline thumbnail previews](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/thumbnails) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { CompatVideoSkin, Video, VideoPlayer } from '@videojs/react/video';
import '@videojs/react/video/compat-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-video-compat-skin-basic {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# ScaffoldVideoSkin
A video skin with minimal styling for custom skins
The Scaffold skin of the video preset provides functional controls with minimal styling and no transitions. It is a starting point for a custom skin, intended to be restyled before use. Its time slider supports chapter segments and thumbnail previews. The preset also provides [VideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-skin), [NeutralVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-neutral-skin), and [CompatVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/video-compat-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { ScaffoldVideoSkin } from '@videojs/react/video';
import '@videojs/react/video/scaffold-skin.css';
```
## Usage
The skin goes between the player and the media element. It renders its controls around the media.
```tsx
```
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Thumbnail
The skin renders a storyboard preview image while scrubbing the time slider. Pass `renderThumbnail` to replace it with your own image, for example to set `crossOrigin`, `loading`, or `fetchPriority`.
See [Show timeline thumbnail previews](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/thumbnails) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# AudioSkin
The audio preset's default skin with the modern, frosted look
The default skin of the audio preset: the control layout for on-demand audio with the modern, frosted look. The preset also provides [NeutralAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-neutral-skin), [CompatAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-compat-skin), and [ScaffoldAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the audio preset ships.
## Import
```tsx
import { AudioSkin } from '@videojs/react/audio';
import '@videojs/react/audio/skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { Audio, AudioPlayer, AudioSkin } from '@videojs/react/audio';
import '@videojs/react/audio/skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-audio-skin-basic {
width: 100%;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# NeutralAudioSkin
The audio preset's visually lighter skin, closer to a classic control bar
The neutral skin of the audio preset: the same player and the same controls in a visually lighter design, closer to a classic control bar. The preset also provides [AudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-skin), [CompatAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-compat-skin), and [ScaffoldAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the audio preset ships.
## Import
```tsx
import { NeutralAudioSkin } from '@videojs/react/audio';
import '@videojs/react/audio/neutral-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { Audio, AudioPlayer, NeutralAudioSkin } from '@videojs/react/audio';
import '@videojs/react/audio/neutral-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-audio-neutral-skin-basic {
width: 100%;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# CompatAudioSkin
The audio preset's plain, unbranded skin, a polished step above native controls
The Compat skin of the audio preset: the same core controls with plain, unbranded surfaces that avoid newer visual effects such as backdrop blur. Its time slider supports chapter segments and thumbnail previews, and it adds captions and AirPlay buttons that the default audio skin leaves out. The preset also provides [AudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-skin), [NeutralAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-neutral-skin), and [ScaffoldAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { CompatAudioSkin } from '@videojs/react/audio';
import '@videojs/react/audio/compat-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { Audio, AudioPlayer, CompatAudioSkin } from '@videojs/react/audio';
import '@videojs/react/audio/compat-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-audio-compat-skin-basic {
width: 100%;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# ScaffoldAudioSkin
An audio skin with minimal styling for custom skins
The Scaffold skin of the audio preset provides functional controls with minimal styling and no transitions. It is a starting point for a custom skin, intended to be restyled before use. Its time slider supports chapter segments and thumbnail previews. The preset also provides [AudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-skin), [NeutralAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-neutral-skin), and [CompatAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio-compat-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { ScaffoldAudioSkin } from '@videojs/react/audio';
import '@videojs/react/audio/scaffold-skin.css';
```
## Usage
The skin goes between the player and the media element. It renders its controls around the media.
```tsx
```
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# LiveVideoSkin
The live video preset's default skin, which swaps time controls for a Live button
The default skin of the live video preset: the video layout with the time slider and time displays swapped for a Live button. The preset also provides [NeutralLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-neutral-skin), [CompatLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-compat-skin), and [ScaffoldLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the live video preset ships.
## Import
```tsx
import { LiveVideoSkin } from '@videojs/react/live-video';
import '@videojs/react/live-video/skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
This uses the lightweight [HLS video element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/hls-video) because most browsers can’t play HLS streams with a plain `
`. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { LiveVideoPlayer, LiveVideoSkin } from '@videojs/react/live-video';
import { HlsVideo } from '@videojs/react/media/hls-video';
import '@videojs/react/live-video/skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-live-video-skin-basic {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# NeutralLiveVideoSkin
The live video preset's visually lighter skin, closer to a classic control bar
The neutral skin of the live video preset: the same player and the same controls in a visually lighter design, closer to a classic control bar. Like the default skin, it shows a Live button in place of time controls. The preset also provides [LiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-skin), [CompatLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-compat-skin), and [ScaffoldLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the live video preset ships.
## Import
```tsx
import { NeutralLiveVideoSkin } from '@videojs/react/live-video';
import '@videojs/react/live-video/neutral-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
This uses the lightweight [HLS video element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/hls-video) because most browsers can’t play HLS streams with a plain ``. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { LiveVideoPlayer, NeutralLiveVideoSkin } from '@videojs/react/live-video';
import { HlsVideo } from '@videojs/react/media/hls-video';
import '@videojs/react/live-video/neutral-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-live-video-neutral-skin-basic {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# CompatLiveVideoSkin
The live video preset's plain, unbranded skin, a polished step above native controls
The Compat skin of the live video preset: the same core controls with plain, unbranded surfaces that avoid newer visual effects such as backdrop blur. It puts a large play button in the center, fullscreen, picture-in-picture, Cast, and AirPlay in a top corner, and a Live button in place of time controls. The preset also provides [LiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-skin), [NeutralLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-neutral-skin), and [ScaffoldLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { CompatLiveVideoSkin } from '@videojs/react/live-video';
import '@videojs/react/live-video/compat-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
This uses the lightweight [HLS video element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/hls-video) because most browsers can’t play HLS streams with a plain ``. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { CompatLiveVideoSkin, LiveVideoPlayer } from '@videojs/react/live-video';
import { HlsVideo } from '@videojs/react/media/hls-video';
import '@videojs/react/live-video/compat-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-live-video-compat-skin-basic {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# ScaffoldLiveVideoSkin
A live video skin with minimal styling for custom skins
The Scaffold skin of the live video preset provides functional controls with minimal styling and no transitions. It is a starting point for a custom skin, intended to be restyled before use. It shows a Live button in place of time controls. The preset also provides [LiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-skin), [NeutralLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-neutral-skin), and [CompatLiveVideoSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-video-compat-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { ScaffoldLiveVideoSkin } from '@videojs/react/live-video';
import '@videojs/react/live-video/scaffold-skin.css';
```
## Usage
The skin goes between the player and the media element. It renders its controls around the media.
```tsx
```
The examples use the lightweight [HLS video element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/hls-video) because most browsers can’t play HLS streams with a plain ``. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Poster
The skin renders a poster image before playback starts. Pass `renderPoster` to replace it with your own component.
See [Add a poster and loading placeholder](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/poster) for complete examples.
## Controls before playback
Before playback starts, the skin shows only the large center play button. The other controls appear once playback starts or the media begins to autoplay. Set `--media-controls-before-start: visible` to show them from the start. See [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#set-the-skins-styles).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# LiveAudioSkin
The live audio preset's default skin, which swaps time controls for a Live button
The default skin of the live audio preset: the audio layout with the time slider and time displays swapped for a Live button. The preset also provides [NeutralLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-neutral-skin), [CompatLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-compat-skin), and [ScaffoldLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the live audio preset ships.
## Import
```tsx
import { LiveAudioSkin } from '@videojs/react/live-audio';
import '@videojs/react/live-audio/skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
This uses the [Mux audio element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/mux-audio): a plain `` can’t play HLS in most browsers, and this element reports the live playback state the skin’s Live button needs. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { LiveAudioPlayer, LiveAudioSkin } from '@videojs/react/live-audio';
import { MuxAudio } from '@videojs/react/media/mux-audio';
import '@videojs/react/live-audio/skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-live-audio-skin-basic {
width: 100%;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# NeutralLiveAudioSkin
The live audio preset's visually lighter skin, closer to a classic control bar
The neutral skin of the live audio preset: the same player and the same controls in a visually lighter design, closer to a classic control bar. Like the default skin, it shows a Live button in place of time controls. The preset also provides [LiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-skin), [CompatLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-compat-skin), and [ScaffoldLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the live audio preset ships.
## Import
```tsx
import { NeutralLiveAudioSkin } from '@videojs/react/live-audio';
import '@videojs/react/live-audio/neutral-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
This uses the [Mux audio element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/mux-audio): a plain `` can’t play HLS in most browsers, and this element reports the live playback state the skin’s Live button needs. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { LiveAudioPlayer, NeutralLiveAudioSkin } from '@videojs/react/live-audio';
import { MuxAudio } from '@videojs/react/media/mux-audio';
import '@videojs/react/live-audio/neutral-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-live-audio-neutral-skin-basic {
width: 100%;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# CompatLiveAudioSkin
The live audio preset's plain, unbranded skin, a polished step above native controls
The Compat skin of the live audio preset: the same core controls with plain, unbranded surfaces that avoid newer visual effects such as backdrop blur. It shows a Live button in place of time controls and adds captions and AirPlay buttons that the default live audio skin leaves out. The preset also provides [LiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-skin), [NeutralLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-neutral-skin), and [ScaffoldLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-scaffold-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { CompatLiveAudioSkin } from '@videojs/react/live-audio';
import '@videojs/react/live-audio/compat-skin.css';
```
## Anatomy
The skin goes between the player and the media component. It renders its controls around the media.
```tsx
```
This uses the [Mux audio element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/mux-audio): a plain `` can’t play HLS in most browsers, and this element reports the live playback state the skin’s Live button needs. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { CompatLiveAudioSkin, LiveAudioPlayer } from '@videojs/react/live-audio';
import { MuxAudio } from '@videojs/react/media/mux-audio';
import '@videojs/react/live-audio/compat-skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-live-audio-compat-skin-basic {
width: 100%;
}
```
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# ScaffoldLiveAudioSkin
A live audio skin with minimal styling for custom skins
The Scaffold skin of the live audio preset provides functional controls with minimal styling and no transitions. It is a starting point for a custom skin, intended to be restyled before use. It shows a Live button in place of time controls. The preset also provides [LiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-skin), [NeutralLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-neutral-skin), and [CompatLiveAudioSkin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/live-audio-compat-skin). See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins#choose-a-skin) to choose between them and [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins) to install and edit its source.
## Import
```tsx
import { ScaffoldLiveAudioSkin } from '@videojs/react/live-audio';
import '@videojs/react/live-audio/scaffold-skin.css';
```
## Usage
The skin goes between the player and the media element. It renders its controls around the media.
```tsx
```
The examples use the [Mux audio element](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/mux-audio): a plain `` can’t play HLS in most browsers, and this element reports the live playback state the skin’s Live button needs. See [Play live streams](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/live-streams).
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties. For deeper changes, the Video.js registry provides the skin files.
## Own the UI
Packaged skins keep their controls and layout inside Video.js. When you need to add, remove, rearrange, or deeply restyle controls, use Shadcn to add the skin source to your project. Its components, layout, styles, and interactions become local files you can change.
- [Install Video.js with Shadcn](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react#choose-how-to-install): Add editable skin source and build a working React or HTML player
---
# BackgroundVideoSkin
The background preset's chrome-less skin for ambient video
The only skin of the background preset: a chrome-less surface that sizes ambient video with no visible controls. See [Skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins) for how packaged skins work and [Presets](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/presets) for what the background preset ships.
## Import
```tsx
import { BackgroundVideoSkin } from '@videojs/react/background';
import '@videojs/react/background/skin.css';
```
## Anatomy
The skin goes between the player and the media component. It sizes the ambient video and renders no visible controls.
```tsx
```
## Styling
Packaged skins style themselves and expose a small set of public CSS custom properties. Everything else inside the skin is private and may change between releases. [Customize skins](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/customize-skins#style-a-packaged-skin) documents the properties.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { BackgroundVideo, BackgroundVideoPlayer, BackgroundVideoSkin } from '@videojs/react/background';
import '@videojs/react/background/skin.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-background-video-skin-basic {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## Own the UI
Owning the UI means keeping its components, layout, styles, and interactions as local files you can change. The [Shadcn installation guide](https://deploy-preview-9783--vjs10-site.netlify.app/docs/guides/installation/shadcn?framework=react) adds that source for supported skins. The registry does not provide background video skin source because it has no control UI. Follow [Add a background video](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/background-video) to compose the media directly, then add only the UI your use case needs.
---
# Audio
Native audio playback that can provide media to a Video.js player
## Import
Import `Audio` from the audio preset:
```tsx
import { Audio } from '@videojs/react/audio';
```
## Anatomy
```tsx
```
## Use with a player
Place `Audio` anywhere inside an `AudioPlayer`, or inside another Video.js `Player` configured for audio. It becomes that player’s media provider automatically. Outside a player, `Audio` behaves as a standalone native ``.
## Native behavior
Video.js does not replace the native audio API. Use `src` for one URL or add child [`` elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/source) when the browser should choose between candidates. See [Media sources](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/media-sources) when you need an HLS, Mux, Spotify, or other playback adapter.
`Audio` forwards native attributes, event handlers, and children to the underlying ``. See [Refs](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio#refs) for what `ref` and `mediaRef` receive.
See MDN for the complete [`` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/audio), [`HTMLAudioElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAudioElement), and shared [`HTMLMediaElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement) APIs.
## Examples
### Basic Usage
This native audio element uses a child source and browser controls while providing media to the surrounding Video.js player.
**App.tsx**
```tsx
import { Container } from '@videojs/react';
import { Audio, AudioPlayer } from '@videojs/react/audio';
import './BasicUsage.css';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-audio-basic {
display: grid;
width: 100%;
padding: 24px;
background: #e5e7eb;
border-radius: 8px;
place-items: center;
}
.react-audio-basic__media {
width: 100%;
}
```
## API Reference
### Props
Accepts the standard React props for a native ``: `autoPlay`, `controls`, `controlsList`, `crossOrigin`, `loop`, `muted`, `preload`, `src`.
`Audio` also accepts `children` and common element props such as `className` and `style`, plus these Video.js-specific props:
| Prop | Type | Description |
| --- | --- | --- |
| `fallback` | `ReactNode` | Content rendered inside the `` after `children`, which only browsers without media element support show. It isn’t shown when playback fails. Defaults to an “Audio player not working?” link to `https://videojs.org/help`. Pass `null` to render nothing. |
| `mediaRef` | `Ref` | Receives the rendered `HTMLAudioElement`. See [Refs](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/audio#refs). |
### Refs
#### ref
Forwards to the rendered ``, an [`HTMLAudioElement`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLAudioElement) with its complete native property and method API.
```tsx
const ref = useRef(null);
```
#### mediaRef
Receives the same `HTMLAudioElement` as `ref`. Adapter-backed components such as [HlsAudio](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/hls-audio) and [SpotifyAudio](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/reference/components/spotify-audio) hand their playback adapter to `mediaRef` instead, so code that works with several media components can read the playback object from one prop.
```tsx
const mediaRef = useRef(null);
```
### Events
Accepts the standard React media event props: `onAbort`, `onCanPlay`, `onCanPlayThrough`, `onDurationChange`, `onEmptied`, `onEncrypted`, `onEnded`, `onError`, `onLoadedData`, `onLoadedMetadata`, `onLoadStart`, `onPause`, `onPlay`, `onPlaying`, `onProgress`, `onRateChange`, `onSeeked`, `onSeeking`, `onStalled`, `onSuspend`, `onTimeUpdate`, `onVolumeChange`, `onWaiting`.
The native `waitingforkey` event has no React prop. Attach a listener through the ref with `addEventListener`.
---
# BackgroundVideo
Decorative background video element with automatic muting and looping
Decorative background video for a source the browser can play natively. By default it’s muted, looped, and autoplaying.
`BackgroundVideo` renders a native ``. Override the defaults with native React props such as `muted={false}`, `loop={false}`, or `autoPlay={false}`, and size the video with `className` or `style`. Its `ref` and `mediaRef` both resolve to that `HTMLVideoElement`.
An HLS URL only works where the browser has native HLS playback. See [Add a background video](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/background-video) to choose a cross-browser HLS or Mux path and set up layout, poster, and decorative semantics.
## Import
```tsx
import { BackgroundVideo } from '@videojs/react/media/background-video';
```
## Examples
### Basic Usage
**App.tsx**
```tsx
import { BackgroundVideo } from '@videojs/react/media/background-video';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.react-background-video-basic {
position: relative;
width: 100%;
aspect-ratio: 16 / 9;
overflow: hidden;
}
.react-background-video-basic > video {
display: block;
width: 100%;
height: 100%;
object-fit: cover;
}
```
## API
`BackgroundVideo` accepts native `` props. Its `ref` and `mediaRef` both resolve to the rendered `HTMLVideoElement`.
## Styling
`BackgroundVideo` is the native `` element. Set its size, `object-fit`, and `object-position` through `className` or `style`.
---
# CloudflareVideo
Video component that plays Cloudflare Stream videos through the Stream player
[Cloudflare Stream](https://developers.cloudflare.com/stream/) runs in an embedded player. Its own chrome stays hidden by default, so it drops into a [player skin](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/skins) like any other media component; set `controls` to use Cloudflare’s UI instead.
## Import
```bash
pnpm add @videojs/cloudflare-video
```
```tsx
import { CloudflareVideo } from '@videojs/react/media/cloudflare-video';
```
## Load a source
`src` takes a raw 32-character video UID, any `cloudflarestream.com` or `videodelivery.net` URL, or a signed token. Watch, embed, iframe, manifest, and thumbnail URLs all carry the UID in the same position, and a signed token stands in for the UID wherever one appears.
```tsx
```
## Signed playback
For [signed URLs](https://developers.cloudflare.com/stream/viewing-videos/securing-your-stream/), pass the signed token wherever the UID would go: as the whole `src`, or inside a Stream URL. Keep your customer subdomain when your URLs name one. Cloudflare serves signed and access-controlled videos only from `customer-.cloudflarestream.com`, so the element preserves that origin instead of collapsing it onto the shared host.
## Behavior
A few things work differently from a native `` element, because the Stream embed doesn’t expose them:
- The embed owns text tracks: `textTracks` stays empty, and `engine.cloudflare.defaultTextTrack` picks the track to show.
- Picture-in-picture is unavailable, and the player reports it as unsupported.
- Fullscreen targets the iframe, so Cloudflare’s own chrome shows in fullscreen.
- `playsInline` has no effect: the Stream embed always plays inline.
- With `preload="none"`, nothing is fetched from Cloudflare, not the iframe and not the Stream SDK until playback is requested: the embed is built on `play()` and starts playing as it loads. `autoplay` or `controls` builds it at once, since each asks to play or shows the embed’s own play button. Until then the frame is empty, without the service’s thumbnail, so give the player a poster.
## Examples
### Basic Usage
**App.tsx**
```tsx
import { CloudflareVideo } from '@videojs/react/media/cloudflare-video';
export default function BasicUsage() {
return (
);
}
```
**App.css**
```css
.cloudflare-video {
width: 100%;
aspect-ratio: 16 / 9;
}
```
## API Reference
### Props
Accepts these Video.js-specific props:
| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| `autoplay` | `boolean` | `false` | |
| `controls` | `boolean` | `false` | |
| `defaultMuted` | `boolean` | `false` | |
| `loop` | `boolean` | `false` | |
| `muted` | `boolean` | `false` | |
| `playsInline` | `boolean` | `true` | |
| `poster` | `string` | `''` | |
| `preload` | `MediaPreloadType` | `'metadata'` | |
| `source` | `{ src?: string; engine?: CloudflareSourceEngineConfig } \| null` | `null` | Structured source: `src` plus embed parameters under `engine.cloudflare`. Replacing it re-derives `src`. |
| `src` | `string` | `''` | |
### Engine options
#### `source.engine.cloudflare`
Pass [Stream player parameters](https://developers.cloudflare.com/stream/viewing-videos/using-the-stream-player/) under `source.engine.cloudflare`, spelled exactly as Cloudflare spells them, plus anything Cloudflare adds next. They’re serialized onto the embed URL untouched, and the embed reads them once, when its URL is built. [Media Sources](https://deploy-preview-9783--vjs10-site.netlify.app/docs/framework/react/guides/media-sources) covers how engine options fit into a structured source.
`controls`, `autoplay`, `loop`, `muted`, `preload`, and `poster` come from the props of the same name, so they have no `engine.cloudflare` spelling.
```tsx
```
| Option | Type | Description |
| --- | --- | --- |
| `ad-url` | `string \| undefined` | VAST tag to play as a pre-roll ad. Reported through the `stream-ad*` events. |
| `defaultTextTrack` | `string \| undefined` | BCP 47 language of the text track to show by default (`'en'`, `'de'`). |
| `letterboxColor` | `string \| undefined` | Any CSS color for the letterbox bars around a video that does not fill the player. |
| `primaryColor` | `string \| undefined` | Any CSS color for the progress bar and other player accents. |
| `referrerPolicy` | `ReferrerPolicy \| undefined` | `referrerpolicy` for the embed iframe. Not a Cloudflare player parameter. |
| `startTime` | `number \| string \| undefined` | Where playback starts, in seconds or as a time string (`'5m30s'`). |
### Refs
#### `ref`
Forwards to the rendered `