@videojs/html 10.0.0-beta.23 → 10.0.0-beta.24

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 [`PlayerController`](./player-controller.md) to subscribe to playback rate state. Returns `undefined` if the playback rate feature is not configured.
+
+rate-display.ts
+
+```
+import { createPlayer, MediaElement, selectPlaybackRate } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class RateDisplay extends MediaElement {
+  readonly #rate = new PlayerController(this, context, selectPlaybackRate);
+}
+```

package/docs/reference/feature-playback.md

@@ -0,0 +1,110 @@
+# Playback
+
+Play/pause state and actions for the player store
+
+Controls play/pause state and tracks whether playback has started or is stalled.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`paused`
+
+`boolean`
+
+▸
+
+Description
+
+Whether playback is paused.
+
+`ended`
+
+`boolean`
+
+▸
+
+Description
+
+Whether playback has reached the end.
+
+`started`
+
+`boolean`
+
+▸
+
+Description
+
+Whether playback has started (played or seeked).
+
+`waiting`
+
+`boolean`
+
+▸
+
+Description
+
+Whether playback is stalled waiting for data.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`play`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Start playback.
+
+`pause`
+
+`() => void`
+
+▸
+
+Description
+
+Pause playback.
+
+`togglePaused`
+
+`() => boolean`
+
+▸
+
+Description
+
+Toggle play/pause. Returns `true` if playback started.
+
+### Selector
+
+Pass `selectPlayback` to [`PlayerController`](./player-controller.md) to subscribe to playback state. Returns `undefined` if the playback feature is not configured.
+
+play-button.ts
+
+```
+import { createPlayer, MediaElement, selectPlayback } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class PlayButton extends MediaElement {
+  readonly #playback = new PlayerController(this, context, selectPlayback);
+}
+```

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

@@ -0,0 +1,70 @@
+# Remote Playback
+
+Remote playback state and actions for the player store
+
+Controls remote playback to devices like Chromecast. Exits fullscreen before initiating a remote playback session.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`remotePlaybackState`
+
+`'disconnected' | 'connecting' | 'connected'`
+
+▸
+
+Description
+
+Current remote playback connection state.
+
+`remotePlaybackAvailability`
+
+`'available' | 'unavailable' | 'unsupported'`
+
+▸
+
+Description
+
+Whether remote playback can be requested on this platform.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`toggleRemotePlayback`
+
+`() => Promise<void>`
+
+▸
+
+Description
+
+Toggle the remote playback connection.
+
+### Selector
+
+Pass `selectRemotePlayback` to [`PlayerController`](./player-controller.md) to subscribe to remote playback state. Returns `undefined` if the remote playback feature is not configured.
+
+cast-button.ts
+
+```
+import { createPlayer, MediaElement, selectRemotePlayback } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class CastButton extends MediaElement {
+  readonly #remotePlayback = new PlayerController(this, context, selectRemotePlayback);
+}
+```

package/docs/reference/feature-source.md

@@ -0,0 +1,70 @@
+# Source
+
+Media source state and actions for the player store
+
+Tracks the current media source and readiness.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`source`
+
+`null | string`
+
+▸
+
+Description
+
+Current media source URL (null if none).
+
+`canPlay`
+
+`boolean`
+
+▸
+
+Description
+
+Whether enough data is loaded to begin playback.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`loadSource`
+
+`(src: string) => string`
+
+▸
+
+Description
+
+Load a new media source. Returns the new source URL.
+
+### Selector
+
+Pass `selectSource` to [`PlayerController`](./player-controller.md) to subscribe to source state. Returns `undefined` if the source feature is not configured.
+
+source-info.ts
+
+```
+import { createPlayer, MediaElement, selectSource } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class SourceInfo extends MediaElement {
+  readonly #source = new PlayerController(this, context, selectSource);
+}
+```

package/docs/reference/feature-stream-type.md

@@ -0,0 +1,46 @@
+# Stream type
+
+Stream delivery type (live / on-demand) state for the player store
+
+Tracks the current stream delivery type so components can toggle live-specific UI (a live indicator, “jump to live edge” affordance, hiding the time display, etc.).
+
+When the media exposes its own `streamType` (e.g. HLS sources derive it from the manifest), the feature syncs on `streamtypechange`. For plain media elements without that capability, it falls back to duration-based detection: an infinite `duration` reports `'live'`, a finite positive `duration` reports `'on-demand'`, and anything else reports `'unknown'`.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`streamType`
+
+`'on-demand' | 'live' | 'unknown'`
+
+▸
+
+Description
+
+Current stream delivery type.
+
+Components use this to toggle live-specific UI (e.g. a live indicator, a "jump to live edge" affordance, or hiding the time display).
+
+### Selector
+
+Pass `selectStreamType` to [`PlayerController`](./player-controller.md) to subscribe to stream type state. Returns `undefined` if the stream type feature is not configured.
+
+live-indicator.ts
+
+```
+import { createPlayer, MediaElement, selectStreamType } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class LiveIndicator extends MediaElement {
+  readonly #stream = new PlayerController(this, context, selectStreamType);
+}
+```

package/docs/reference/feature-text-tracks.md

@@ -0,0 +1,100 @@
+# Text tracks
+
+Subtitles, captions, and chapter track state for the player store
+
+Manages subtitles, captions, chapters, and thumbnail tracks.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`chaptersCues`
+
+`MediaTextCue[]`
+
+▸
+
+Description
+
+Cues from the first `kind="chapters"` track.
+
+`thumbnailCues`
+
+`MediaTextCue[]`
+
+▸
+
+Description
+
+Cues from the first `kind="metadata" label="thumbnails"` track.
+
+`thumbnailTrackSrc`
+
+`null | string`
+
+▸
+
+Description
+
+The `<track>` element's `src` for resolving relative cue text URLs.
+
+`textTrackList`
+
+`MediaTextTrack<TextTrackKind>[]`
+
+▸
+
+Description
+
+All text tracks available on the media element.
+
+`subtitlesShowing`
+
+`boolean`
+
+▸
+
+Description
+
+Whether captions/subtitles are currently enabled.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`toggleSubtitles`
+
+`(forceShow: boolean) => boolean`
+
+▸
+
+Description
+
+Toggle captions/subtitles visibility. Returns the new enabled value.
+
+### Selector
+
+Pass `selectTextTracks` to [`PlayerController`](./player-controller.md) to subscribe to text track state. Returns `undefined` if the text tracks feature is not configured.
+
+captions-button.ts
+
+```
+import { createPlayer, MediaElement, selectTextTracks } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class CaptionsButton extends MediaElement {
+  readonly #textTracks = new PlayerController(this, context, selectTextTracks);
+}
+```

package/docs/reference/feature-time.md

@@ -0,0 +1,80 @@
+# Time
+
+Playback position and duration state for the player store
+
+Tracks playback position and duration.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`currentTime`
+
+`number`
+
+▸
+
+Description
+
+Current playback position in seconds.
+
+`duration`
+
+`number`
+
+▸
+
+Description
+
+Total duration in seconds (0 if unknown).
+
+`seeking`
+
+`boolean`
+
+▸
+
+Description
+
+Whether a seek operation is in progress.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`seek`
+
+`(time: number) => Promise<number>`
+
+▸
+
+Description
+
+Seek to a time in seconds. Returns the actual position after seek.
+
+### Selector
+
+Pass `selectTime` to [`PlayerController`](./player-controller.md) to subscribe to time state. Returns `undefined` if the time feature is not configured.
+
+time-display.ts
+
+```
+import { createPlayer, MediaElement, selectTime } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class TimeDisplay extends MediaElement {
+  readonly #time = new PlayerController(this, context, selectTime);
+}
+```

package/docs/reference/feature-volume.md

@@ -0,0 +1,90 @@
+# Volume
+
+Volume level and mute state for the player store
+
+Controls volume level and mute state.
+
+## API Reference
+
+### State
+
+Property
+
+Type
+
+Details
+
+`volume`
+
+`number`
+
+▸
+
+Description
+
+Volume level from 0 (silent) to 1 (max).
+
+`muted`
+
+`boolean`
+
+▸
+
+Description
+
+Whether audio is muted.
+
+`volumeAvailability`
+
+`'available' | 'unavailable' | 'unsupported'`
+
+▸
+
+Description
+
+Whether volume can be programmatically set on this platform.
+
+### Actions
+
+Action
+
+Type
+
+Details
+
+`setVolume`
+
+`(volume: number) => number`
+
+▸
+
+Description
+
+Set volume (clamped 0-1). Returns the clamped value.
+
+`toggleMuted`
+
+`() => boolean`
+
+▸
+
+Description
+
+Toggle mute state. Returns the new muted value.
+
+### Selector
+
+Pass `selectVolume` to [`PlayerController`](./player-controller.md) to subscribe to volume state. Returns `undefined` if the volume feature is not configured.
+
+volume-slider.ts
+
+```
+import { createPlayer, MediaElement, selectVolume } from '@videojs/html';
+import { videoFeatures } from '@videojs/html/video';
+
+const { PlayerController, context } = createPlayer({ features: videoFeatures });
+
+class VolumeSlider extends MediaElement {
+  readonly #volume = new PlayerController(this, context, selectVolume);
+}
+```