@videojs/react 10.0.0-beta.30 → 10.0.0-beta.32

package/docs/reference/hls-audio.md

@@ -30,7 +30,39 @@ export default function BasicUsage() {
 
 ### Props
 
-Accepts the standard React props for a native `<audio>`.
+Accepts the standard React props for a native `<audio>`, plus these Video.js-specific props:
+
+Prop
+
+Type
+
+Default
+
+Details
+
+`disableRemotePlayback`
+
+`boolean`
+
+`false`
+
+`preload`
+
+`'' | 'none' | 'metadata' | 'auto'`
+
+`''`
+
+▸
+
+Description
+
+Preload type (`'none'` / `'metadata'` / `'auto'`).
+
+`src`
+
+`string`
+
+`''`
 
 ### Ref
 

package/docs/reference/hls-background-video.md

@@ -0,0 +1,75 @@
+# HlsBackgroundVideo
+
+HLS background video without controls, audio, captions, or adaptive quality
+
+HlsBackgroundVideo plays an HLS source through the SPF background engine. It is fixed to muted, autoplaying, inline, looped playback and omits controls, audio, text, DRM, and adaptive rendition switching.
+
+See [Add a background video](../how-to/add-a-background-video.md) for layout, poster, accessibility, and source-choice guidance.
+
+## Import
+
+tsx
+
+```
+import { HlsBackgroundVideo } from '@videojs/react/media/hls-background-video';
+```
+
+## Source behavior
+
+`src` takes a complete HLS manifest URL. The engine starts loading when it receives the URL and pins the largest rendition that fits the screen. The ladder may be video-only, but its video renditions must use fMP4/CMAF. This engine does not include MPEG-TS transmuxing or DRM playback.
+
+tsx
+
+```
+<HlsBackgroundVideo
+  src="https://media.example.com/hero.m3u8"
+  crossOrigin="anonymous"
+  onError={handleError}
+/>
+```
+
+There is no `source` object, `preload` mode, or opt-out for muted, autoplay, and loop. Assigning a new `src` restarts playback from scratch.
+
+## API
+
+Member
+
+Platform
+
+Description
+
+`src`
+
+HTML and React
+
+HLS manifest URL
+
+`error`
+
+HTML
+
+Fatal SPF media error for the current source, or `null`
+
+`video`
+
+HTML
+
+Inner native `<video>` element
+
+`onError`
+
+React
+
+Fires on the rendered `<video>` when SPF reports a fatal source error
+
+`ref`
+
+React
+
+Ref to the rendered native `<video>` element
+
+The HTML element also fires an `error` event when `error` becomes fatal. The inner video’s own `error` can remain `null` because SPF, rather than the browser, rejected the source.
+
+## Styling
+
+The component renders a native `<video>`. Set its size, `object-fit`, and `object-position` through `className` or `style`.

package/docs/reference/hls-video.md

@@ -30,7 +30,51 @@ export default function BasicUsage() {
 
 ### Props
 
-Accepts the standard React props for a native `<video>`.
+Accepts the standard React props for a native `<video>`, plus these Video.js-specific props:
+
+Prop
+
+Type
+
+Default
+
+Details
+
+`disableRemotePlayback`
+
+`boolean`
+
+`false`
+
+`preload`
+
+`'' | 'none' | 'metadata' | 'auto'`
+
+`''`
+
+▸
+
+Description
+
+Preload type (`'none'` / `'metadata'` / `'auto'`).
+
+`src`
+
+`string`
+
+`''`
+
+`streamType`
+
+`MediaStreamType`
+
+`"unknown"`
+
+▸
+
+Description
+
+The source's stream type — `'live'`, `'on-demand'`, or `'unknown'` until a media playlist has been parsed. Setting a non-`'unknown'` value pins a user override (detection stops updating it); setting `'unknown'` reverts to the engine's detected value.
 
 ### Ref