ReferencePresets
Live audio preset
The live audio preset — a player, feature bundle, skins, and media for live audio streams
@videojs/react/live-audio is the preset for live audio streams. It bundles LiveAudioPlayer, the liveAudioFeatures bundle it is configured with, four skins that swap the time slider and time displays for a Live button, and the Audio media component. See Presets for how presets fit together and Live streams for playing a live source.
Import
Each skin has its own stylesheet. Import @videojs/react/live-audio/neutral-skin.css, compat-skin.css, or scaffold-skin.css instead when you use NeutralLiveAudioSkin, CompatLiveAudioSkin, or ScaffoldLiveAudioSkin.
Usage
Live streams are usually HLS, so this example plays through an HLS media component instead of the preset’s native audio.
Player
LiveAudioPlayer is a Player created by createPlayer with liveAudioFeatures. It provides the player store to its descendants and renders no DOM element of its own.
LiveAudioPlayerProps types its props:
title and poster come from the metadata feature.
The preset also exports a usePlayer hook typed to liveAudioFeatures. Use it from any component inside LiveAudioPlayer; see usePlayer.
Feature bundle
liveAudioFeatures is the array of features the player is configured with. It is the audio preset’s audioFeatures without playback rate, plus the live feature:
Its type, LiveAudioFeatures, is the tuple of those features in order. Import it from the package root:
To add or remove a feature, pass your own array to createPlayer. The skins expect the features they render controls for.
Skins
- LiveAudioSkin — the default skin, which swaps the time controls for a Live button.
- NeutralLiveAudioSkin — the visually lighter variant, closer to a classic control bar.
- CompatLiveAudioSkin — the plain, unbranded variant that avoids newer visual effects, so it looks consistent across browsers.
- ScaffoldLiveAudioSkin — the minimally styled variant of Compat, a foundation for your own design.
See Choose a skin to compare them.
Media
The preset exports Audio, the same component as the audio preset, which renders a native <audio>. Most browsers need a streaming media component to play a live source, such as HlsAudio for HLS.
Exports
@videojs/react/live-audio exports:
Stylesheets: @videojs/react/live-audio/skin.css, @videojs/react/live-audio/neutral-skin.css, @videojs/react/live-audio/compat-skin.css, and @videojs/react/live-audio/scaffold-skin.css.