@videojs/react 10.0.0-beta.24 → 10.0.0-beta.26

package/docs/reference/google-cast.md

@@ -0,0 +1,69 @@
+# GoogleCast
+
+Options for the Google Cast component that configures the receiver and load request
+
+Adds Google Cast support to the player’s media. It renders nothing — place it inside the player as a sibling of the media element, and pair it with a [CastButton](./cast-button.md). See [Google Cast](../concepts/cast.md) for how casting works.
+
+## Anatomy
+
+tsx
+
+```
+import { GoogleCast } from '@videojs/react/media/google-cast';
+
+<GoogleCast />
+```
+
+## Options
+
+Prop
+
+Type
+
+Description
+
+`receiver`
+
+`string`
+
+Cast receiver application ID. Defaults to Google’s Default Media Receiver (`CC1AD845`)
+
+`src`
+
+`string`
+
+Source URL loaded on the receiver. Defaults to the source the browser is playing
+
+`contentType`
+
+`string`
+
+MIME type of the Cast source. When unset, the receiver infers it from the URL
+
+`streamType`
+
+`'on-demand' | 'live'`
+
+Stream type reported to the receiver. Falls back to the player’s stream type
+
+`customData`
+
+`object`
+
+Custom data sent to the receiver with each load request
+
+When the Cast `src` is an HLS playlist, Video.js detects the segment format and sets the receiver’s `hlsSegmentFormat` and `hlsVideoSegmentFormat` load-request fields. The Default Media Receiver plays HLS natively, so no extra receiver setup is needed.
+
+## See also
+
+[
+
+Google Cast
+
+How casting works
+
+](../concepts/cast.md)
+
+[CastButton component reference](./cast-button.md)
+
+[Remote Playback feature reference](./feature-remote-playback.md)

package/docs/reference/has-registered-locale.md

@@ -0,0 +1,47 @@
+# hasRegisteredLocale
+
+Check whether an exact locale tag exists in the global i18n registry
+
+`hasRegisteredLocale` returns whether a normalized locale tag has an explicit registry layer from [`registerI18n`](./register-i18n.md). It does **not** indicate whether a lazy built-in pack exists. Only registry entries count.
+
+ts
+
+```
+import { hasRegisteredLocale, registerI18n } from '@videojs/react/i18n';
+
+hasRegisteredLocale('fr'); // false until registered
+registerI18n('fr', { buttons: { play: 'Lecture' } });
+hasRegisteredLocale('fr'); // true
+```
+
+## API Reference
+
+### Parameters
+
+Parameter
+
+Type
+
+Default
+
+Details
+
+`locale*`
+
+`string & object | 'ar' | 'az' | 'bs' ...`
+
+`—`
+
+▸
+
+Description
+
+BCP 47 tag to test.
+
+Type
+
+`string & object | 'ar' | 'az' | 'bs' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fr' | 'gd' | 'gl' | 'he' | 'hi' | 'hr' | 'hu' | 'it' | 'ja' | 'ko' | 'lv' | 'mr' | 'nb' | 'nl' | 'nn' | 'ne' | 'oc' | 'pl' | 'pt-BR' | 'pt-PT' | 'ro' | 'ru' | 'sk' | 'sl' | 'sr' | 'sv' | 'te' | 'th' | 'tr' | 'uk' | 'vi' | 'zh-CN' | 'zh-TW'`
+
+### Return Value
+
+`boolean`

package/docs/reference/hlsjs-video.md

@@ -0,0 +1,91 @@
+# HlsJsVideo
+
+HLS video element powered by hls.js for adaptive bitrate streaming
+
+HLS video element powered by [hls.js](https://github.com/video-dev/hls.js/) for adaptive bitrate streaming. It’s the recommended choice for HLS playback: full feature support across every browser. For alternatives, see [NativeHlsVideo](/docs/framework/html/reference/native-hls-video/) (browser-native HLS) or [SimpleHlsVideo](/docs/framework/html/reference/simple-hls-video/) (lightweight HLS).
+
+## Examples
+
+### Basic Usage
+
+App.tsx
+
+App.css
+
+```
+import { HlsJsVideo } from '@videojs/react/media/hlsjs-video';
+
+export default function BasicUsage() {
+  return <HlsJsVideo className="hlsjs-video" src="https://stream.mux.com/BV3YZtogl89mg9VcNBhhnHm02Y34zI1nlMuMQfAbl3dM.m3u8" autoPlay muted playsInline loop />;
+}
+```
+```
+.hlsjs-video {
+  width: 100%;
+  aspect-ratio: 16 / 9;
+}
+```
+
+## API Reference
+
+### Props
+
+Accepts the standard React props for a native `<video>`, plus these Video.js-specific props:
+
+Prop
+
+Type
+
+Default
+
+Details
+
+`config`
+
+`HlsMediaConfig`
+
+`{}`
+
+▸
+
+Description
+
+Playback configuration: a preferred playback path, an explicit content type, and options forwarded to hls.js. Reassigning reloads the engine when an engine-relevant option changes.
+
+`preload`
+
+`PreloadType`
+
+`'metadata'`
+
+▸
+
+Description
+
+Preload type (`'none'` / `'metadata'` / `'auto'`).
+
+`src`
+
+`string`
+
+`''`
+
+`streamType`
+
+`StreamType`
+
+`'unknown'`
+
+▸
+
+Description
+
+Current stream type (`'on-demand'` / `'live'` / `'unknown'`).
+
+### Ref
+
+Forwards its ref to the rendered `<video>`. The ref is an [HTMLVideoElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLVideoElement) and exposes its complete native property and method API.
+
+### Events
+
+Handle standard media events with React event props such as `onPlay` and `onTimeUpdate`. For native events without a React prop, attach a listener through the ref with `addEventListener`.

package/docs/reference/i18n-provider.md

@@ -0,0 +1,25 @@
+# I18nProvider
+
+React provider that resolves locale and supplies a typed translator to descendants
+
+`I18nProvider` resolves the active locale, lazy-loads built-in packs, merges registry and provider layers, and exposes a translator through context. Wrap it around a player or custom controls that should translate.
+
+Wrap custom controls or force a locale explicitly:
+
+tsx
+
+```
+import { I18nProvider } from '@videojs/react/i18n';
+
+<I18nProvider locale="de" translations={{ buttons: { play: 'Abspielen' } }}>
+  <MyControls />
+</I18nProvider>
+```
+
+Omit `locale` to inherit the nearest `lang` attribute (via `langRootRef` or `<html lang>`). English is the fallback when no non-English locale is active or no translation layer supplies a string. See [Internationalization](../concepts/i18n.md) for merge priority, browser translation fallback, and SSR guidance.
+
+## API Reference
+
+### Return Value
+
+`unknown`