@videojs/react 10.0.0-beta.23 → 10.0.0-beta.25

package/docs/reference/feature-audio-track.md

@@ -0,0 +1,60 @@
+# Audio track
+
+Audio track state and actions for the player store
+
+Tracks available audio tracks and selects the enabled track.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`audioTrackList`
+
+`MediaAudioTrack[]`
+
+▸
+
+Description
+
+Audio tracks available for manual track selection.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`selectAudioTrack`
+
+`(value: string) => void`
+
+▸
+
+Description
+
+Select an audio track by menu value.
+
+### Selector
+
+Pass `selectAudioTrack` to [`usePlayer`](./use-player.md) to subscribe to audio track state. Returns `undefined` if the audio track feature is not configured.
+
+AudioTrackInfo.tsx
+
+```
+import { selectAudioTrack, usePlayer } from '@videojs/react';
+
+function AudioTrackInfo() {
+  const audioTrack = usePlayer(selectAudioTrack);
+  if (!audioTrack) return null;
+
+  return <span>{audioTrack.audioTrackList.length} audio tracks</span>;
+}
+```

package/docs/reference/feature-buffer.md

@@ -0,0 +1,54 @@
+# Buffer
+
+Buffered and seekable time range state for the player store
+
+Read-only — tracks buffered and seekable time ranges.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`buffered`
+
+`[number, number][]`
+
+▸
+
+Description
+
+Buffered time ranges as \[start, end\] tuples.
+
+`seekable`
+
+`[number, number][]`
+
+▸
+
+Description
+
+Seekable time ranges as \[start, end\] tuples.
+
+### Selector
+
+Pass `selectBuffer` to [`usePlayer`](./use-player.md) to subscribe to buffer state. Returns `undefined` if the buffer feature is not configured.
+
+BufferBar.tsx
+
+```
+import { selectBuffer, usePlayer } from '@videojs/react';
+
+function BufferBar() {
+  const buffer = usePlayer(selectBuffer);
+  if (!buffer) return null;
+
+  return (
+    <div style={{ width: `${buffer.percentBuffered * 100}%` }} />
+  );
+}
+```

package/docs/reference/feature-controls.md

@@ -0,0 +1,74 @@
+# Controls
+
+User activity and controls visibility state for the player store
+
+Read-only — tracks user activity for showing and hiding controls.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`userActive`
+
+`boolean`
+
+▸
+
+Description
+
+Whether the user has recently interacted with the player.
+
+`controlsVisible`
+
+`boolean`
+
+▸
+
+Description
+
+Whether controls should be visible (userActive || paused).
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`toggleControls`
+
+`() => boolean`
+
+▸
+
+Description
+
+Toggle controls visibility. Returns the new `controlsVisible` value.
+
+### Selector
+
+Pass `selectControls` to [`usePlayer`](./use-player.md) to subscribe to controls state. Returns `undefined` if the controls feature is not configured.
+
+ControlsOverlay.tsx
+
+```
+import { selectControls, usePlayer } from '@videojs/react';
+
+function ControlsOverlay({ children }: { children: React.ReactNode }) {
+  const controls = usePlayer(selectControls);
+  if (!controls) return null;
+
+  return (
+    <div style={{ opacity: controls.visible ? 1 : 0 }}>
+      {children}
+    </div>
+  );
+}
+```

package/docs/reference/feature-error.md

@@ -0,0 +1,65 @@
+# Error
+
+Media error state and actions for the player store
+
+Tracks media errors.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`error`
+
+`null | MediaError`
+
+▸
+
+Description
+
+The current media error, or null if none.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`dismissError`
+
+`() => void`
+
+▸
+
+Description
+
+Dismiss the current error by clearing it.
+
+### Selector
+
+Pass `selectError` to [`usePlayer`](./use-player.md) to subscribe to error state. Returns `undefined` if the error feature is not configured.
+
+ErrorDisplay.tsx
+
+```
+import { selectError, usePlayer } from '@videojs/react';
+
+function ErrorDisplay() {
+  const err = usePlayer(selectError);
+  if (!err?.error) return null;
+
+  return (
+    <div>
+      <p>{err.error.message}</p>
+      <button onClick={err.dismissError}>Dismiss</button>
+    </div>
+  );
+}
+```

package/docs/reference/feature-fullscreen.md

@@ -0,0 +1,111 @@
+# Fullscreen
+
+Fullscreen state and actions for the player store
+
+Controls fullscreen mode. Tries the container element first, falls back to the media element.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`fullscreen`
+
+`boolean`
+
+▸
+
+Description
+
+Whether fullscreen mode is currently active.
+
+`fullscreenAvailability`
+
+`'available' | 'unavailable' | 'unsupported'`
+
+▸
+
+Description
+
+Whether fullscreen can be requested on this platform.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`requestFullscreen`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Enter fullscreen mode. Tries container first, falls back to media element.
+
+`exitFullscreen`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Exit fullscreen mode.
+
+`toggleFullscreen`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Toggle fullscreen mode.
+
+### Selector
+
+Pass `selectFullscreen` to [`usePlayer`](./use-player.md) to subscribe to fullscreen state. Returns `undefined` if the fullscreen feature is not configured.
+
+FullscreenButton.tsx
+
+```
+import { selectFullscreen, usePlayer } from '@videojs/react';
+
+function FullscreenButton() {
+  const fs = usePlayer(selectFullscreen);
+  if (!fs || fs.fullscreenAvailability !== 'available') return null;
+
+  return (
+    <button onClick={fs.toggleFullscreen}>
+      {fs.fullscreen ? 'Exit fullscreen' : 'Fullscreen'}
+    </button>
+  );
+}
+```
+
+### Screen orientation
+
+Add [`features.orientationLock`](./feature-orientation-lock.md) to lock screen orientation while fullscreen is active. Unsupported browsers and rejected lock requests are ignored, so iOS Safari continues to use its normal fullscreen behavior.
+
+By default, the feature locks to `landscape`. Pass a Screen Orientation API type to customize it:
+
+ts
+
+```
+import { createPlayer, features } from '@videojs/react';
+import { videoFeatures } from '@videojs/react/video';
+
+const Player = createPlayer({
+  features: [...videoFeatures, features.orientationLock({ type: 'portrait' })],
+});
+```

package/docs/reference/feature-live.md

@@ -0,0 +1,62 @@
+# Live
+
+Live edge state for the player store
+
+Exposes live-edge state so components can render a “jump to live” button, detect DVR vs. standard live, or hide live-only UI for on-demand sources.
+
+`liveEdgeStart` is the presentation time at which the Live Edge Window begins — playback is “at the live edge” when `currentTime >= liveEdgeStart`. `targetLiveWindow` reports the seekable range size: `0` for standard latency live, `Infinity` for DVR, `NaN` for on-demand or unknown. Both values are `NaN` when the media doesn’t expose live-edge state (anything other than an HLS source today).
+
+The live feature is included by the `liveVideoFeatures` and `liveAudioFeatures` presets; apps that build a custom preset can compose it in directly.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`liveEdgeStart`
+
+`number`
+
+▸
+
+Description
+
+Presentation time marking the start of the Live Edge Window.
+
+Playing at the live edge when `currentTime >= liveEdgeStart`. `NaN` when the stream isn't live or the value is unknown.
+
+`targetLiveWindow`
+
+`number`
+
+▸
+
+Description
+
+Offset representing the seekable range size for live content.
+
+`0` for standard latency live, `Infinity` for DVR, `NaN` for on-demand or unknown.
+
+### Selector
+
+Pass `selectLive` to [`usePlayer`](./use-player.md) to subscribe to live state. Returns `undefined` if the live feature is not configured.
+
+LiveEdgeIndicator.tsx
+
+```
+import { selectLive, selectTime, usePlayer } from '@videojs/react';
+
+function LiveEdgeIndicator() {
+  const live = usePlayer(selectLive);
+  const time = usePlayer(selectTime);
+  if (!live || Number.isNaN(live.targetLiveWindow)) return null;
+
+  const atEdge = time != null && time.currentTime >= live.liveEdgeStart;
+  return <span className="live-indicator">{atEdge ? 'LIVE' : 'BEHIND LIVE'}</span>;
+}
+```

package/docs/reference/feature-orientation-lock.md

@@ -0,0 +1,35 @@
+# Orientation lock
+
+Screen orientation locking while fullscreen is active
+
+Locks screen orientation while fullscreen is active. Add it explicitly to a feature list; it is not included in the default video presets.
+
+## API Reference
+
+### Usage
+
+By default, the feature locks to `landscape`. Pass a Screen Orientation API type to customize it.
+
+player.tsx
+
+```
+import { createPlayer, features } from '@videojs/react';
+import { videoFeatures } from '@videojs/react/video';
+
+export const Player = createPlayer({
+  features: [...videoFeatures, features.orientationLock],
+});
+```
+
+portrait-player.tsx
+
+```
+import { createPlayer, features } from '@videojs/react';
+import { videoFeatures } from '@videojs/react/video';
+
+export const Player = createPlayer({
+  features: [...videoFeatures, features.orientationLock({ type: 'portrait' })],
+});
+```
+
+Unsupported browsers and rejected lock requests are ignored.

package/docs/reference/feature-pip.md

@@ -0,0 +1,94 @@
+# Picture-in-picture
+
+Picture-in-picture state and actions for the player store
+
+Controls picture-in-picture mode.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`pip`
+
+`boolean`
+
+▸
+
+Description
+
+Whether picture-in-picture mode is currently active.
+
+`pipAvailability`
+
+`'available' | 'unavailable' | 'unsupported'`
+
+▸
+
+Description
+
+Whether picture-in-picture can be requested on this platform.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`requestPictureInPicture`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Enter picture-in-picture mode.
+
+`exitPictureInPicture`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Exit picture-in-picture mode.
+
+`togglePictureInPicture`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Toggle picture-in-picture mode.
+
+### Selector
+
+Pass `selectPiP` to [`usePlayer`](./use-player.md) to subscribe to picture-in-picture state. Returns `undefined` if the PiP feature is not configured.
+
+PiPButton.tsx
+
+```
+import { selectPiP, usePlayer } from '@videojs/react';
+
+function PiPButton() {
+  const pip = usePlayer(selectPiP);
+  if (!pip || pip.availability !== 'available') return null;
+
+  return (
+    <button onClick={pip.toggle}>
+      {pip.active ? 'Exit PiP' : 'Picture-in-Picture'}
+    </button>
+  );
+}
+```

package/docs/reference/feature-playback-rate.md

@@ -0,0 +1,70 @@
+# Playback rate
+
+Playback speed state and actions for the player store
+
+Controls speed of playback.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`playbackRates`
+
+`readonly number[]`
+
+▸
+
+Description
+
+Available playback rates.
+
+`playbackRate`
+
+`number`
+
+▸
+
+Description
+
+Current playback rate.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`setPlaybackRate`
+
+`(rate: number) => void`
+
+▸
+
+Description
+
+Set the playback rate.
+
+### Selector
+
+Pass `selectPlaybackRate` to [`usePlayer`](./use-player.md) to subscribe to playback rate state. Returns `undefined` if the playback rate feature is not configured.
+
+RateDisplay.tsx
+
+```
+import { selectPlaybackRate, usePlayer } from '@videojs/react';
+
+function RateDisplay() {
+  const rate = usePlayer(selectPlaybackRate);
+  if (!rate) return null;
+
+  return <span>{rate.playbackRate}x</span>;
+}
+```