@codenkay/video-nsgplayer-ui 5.0.0 → 5.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -0
- package/README.md +6 -0
- package/dist/index.cjs +855 -245
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +119 -21
- package/dist/index.d.ts +119 -21
- package/dist/index.js +847 -240
- package/dist/index.js.map +1 -1
- package/dist/player-ui.css +203 -1
- package/package.json +3 -3
- package/styles.css +203 -1
package/dist/index.d.cts
CHANGED
|
@@ -1,6 +1,66 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
|
-
import { CSSProperties, RefObject, ReactNode } from 'react';
|
|
3
|
-
import {
|
|
2
|
+
import { CSSProperties, RefObject, ReactNode, FocusEvent } from 'react';
|
|
3
|
+
import { PlaybackRate, HlsQualityLevel, QualitySelection, PlayerTextTrack, TextTrackSelection, AuthConfig, PlaybackCredentialConfig, mergePlayerConfig, AnalyticsConfig, VideoPlayer, PlayerConfig, PlayerAudioTrack, PlayIconPreset as PlayIconPreset$1 } from '@codenkay/video-nsgplayer-core';
|
|
4
|
+
|
|
5
|
+
declare function formatPlaybackTime(seconds: number): string;
|
|
6
|
+
declare function resolveVisiblePlaybackRates(count: number): PlaybackRate[];
|
|
7
|
+
declare function snapPlaybackRate(rate: number, visible: readonly PlaybackRate[]): PlaybackRate;
|
|
8
|
+
type PlayerOverlayKind = "none" | "play" | "unmute" | "return-video";
|
|
9
|
+
declare function resolvePlayerOverlay(input: {
|
|
10
|
+
showControls: boolean;
|
|
11
|
+
isPlaying: boolean;
|
|
12
|
+
muted: boolean;
|
|
13
|
+
volume: number;
|
|
14
|
+
mediaMode?: "video" | "audio";
|
|
15
|
+
}): PlayerOverlayKind;
|
|
16
|
+
type PlayerZoomLevel = 1 | 1.25 | 1.5 | 2;
|
|
17
|
+
declare const ZOOM_STEPS: PlayerZoomLevel[];
|
|
18
|
+
declare function nextZoom(current: PlayerZoomLevel, direction: 1 | -1): PlayerZoomLevel;
|
|
19
|
+
|
|
20
|
+
type SettingsCaption = {
|
|
21
|
+
language: string;
|
|
22
|
+
label: string;
|
|
23
|
+
generated?: boolean;
|
|
24
|
+
};
|
|
25
|
+
declare function SettingsMenu({ showQuality, qualities, qualitySelection, activeLevel, onQualityChange, showZoom, zoom, onZoomChange, captions, selectedCaption, onCaptionChange, textTracks, selectedTextTrack, onTextTrackChange, captionStatus, }: {
|
|
26
|
+
showQuality: boolean;
|
|
27
|
+
qualities: HlsQualityLevel[];
|
|
28
|
+
qualitySelection: QualitySelection;
|
|
29
|
+
activeLevel: number;
|
|
30
|
+
onQualityChange: (selection: QualitySelection) => void;
|
|
31
|
+
showZoom: boolean;
|
|
32
|
+
zoom: PlayerZoomLevel;
|
|
33
|
+
onZoomChange: (zoom: PlayerZoomLevel) => void;
|
|
34
|
+
captions: SettingsCaption[];
|
|
35
|
+
selectedCaption: string | null;
|
|
36
|
+
onCaptionChange?: (language: string | null) => void;
|
|
37
|
+
textTracks: PlayerTextTrack[];
|
|
38
|
+
selectedTextTrack: TextTrackSelection;
|
|
39
|
+
onTextTrackChange: (selection: TextTrackSelection) => void;
|
|
40
|
+
captionStatus?: string | null;
|
|
41
|
+
}): react.JSX.Element | null;
|
|
42
|
+
|
|
43
|
+
/** Minimal error shape accepted by the player error UI. */
|
|
44
|
+
type PlayerErrorLike = {
|
|
45
|
+
code?: string;
|
|
46
|
+
message?: string;
|
|
47
|
+
/** `StudentLeaseError.activePlatform` for `PLATFORM_IN_USE`. */
|
|
48
|
+
activePlatform?: string;
|
|
49
|
+
};
|
|
50
|
+
type PlayerErrorDisplay = {
|
|
51
|
+
/** `preparing` is informational; the others are blocking errors. */
|
|
52
|
+
kind: "preparing" | "platform-in-use" | "error";
|
|
53
|
+
code?: string;
|
|
54
|
+
message: string;
|
|
55
|
+
};
|
|
56
|
+
declare const PREPARING_MESSAGE = "Live video is preparing. Please retry shortly.";
|
|
57
|
+
declare const GENERIC_ERROR_MESSAGE = "Unable to play this video.";
|
|
58
|
+
/**
|
|
59
|
+
* Map a player or student-lease error to what the UI should show.
|
|
60
|
+
* `PLAYBACK_NOT_READY` is a transient "preparing" notice; `PLATFORM_IN_USE`
|
|
61
|
+
* names the other platform when known.
|
|
62
|
+
*/
|
|
63
|
+
declare function describePlayerError(error: PlayerErrorLike | null | undefined): PlayerErrorDisplay | null;
|
|
4
64
|
|
|
5
65
|
type NsgVideoPlayerWithControlsProps = {
|
|
6
66
|
videoId: string;
|
|
@@ -26,6 +86,25 @@ type NsgVideoPlayerWithControlsProps = {
|
|
|
26
86
|
}) => void;
|
|
27
87
|
/** Optional seek-bar hover preview image URL for a given media time. */
|
|
28
88
|
getSeekPreview?: (time: number) => string | null | undefined;
|
|
89
|
+
poster?: string;
|
|
90
|
+
mediaMode?: "video" | "audio";
|
|
91
|
+
audioAvailable?: boolean;
|
|
92
|
+
onMediaModeChange?: (mode: "video" | "audio") => void;
|
|
93
|
+
sidecarCaptions?: SettingsCaption[];
|
|
94
|
+
selectedSidecar?: string | null;
|
|
95
|
+
onSidecarChange?: (language: string | null) => void;
|
|
96
|
+
captionStatus?: string | null;
|
|
97
|
+
/**
|
|
98
|
+
* Lease-driven watermark text (for example `useStudentLease().watermarkText`).
|
|
99
|
+
* Overrides `config.watermark.text`; the static text is the fallback.
|
|
100
|
+
*/
|
|
101
|
+
watermarkText?: string | null;
|
|
102
|
+
/**
|
|
103
|
+
* Error from outside the player, such as a `StudentLeaseError`
|
|
104
|
+
* (`PLATFORM_IN_USE`, `PLAYBACK_NOT_READY`). Shown when the player itself
|
|
105
|
+
* has no error.
|
|
106
|
+
*/
|
|
107
|
+
leaseError?: PlayerErrorLike | null;
|
|
29
108
|
};
|
|
30
109
|
/**
|
|
31
110
|
* Full player with control chrome (seek, quality, speed, live, zoom, keyboard).
|
|
@@ -40,26 +119,19 @@ type PlayerChromeProps = {
|
|
|
40
119
|
videoSlot: ReactNode;
|
|
41
120
|
className?: string;
|
|
42
121
|
getSeekPreview?: (time: number) => string | null | undefined;
|
|
122
|
+
mediaMode?: "video" | "audio";
|
|
123
|
+
audioAvailable?: boolean;
|
|
124
|
+
onMediaModeChange?: (mode: "video" | "audio") => void;
|
|
125
|
+
sidecarCaptions?: SettingsCaption[];
|
|
126
|
+
selectedSidecar?: string | null;
|
|
127
|
+
onSidecarChange?: (language: string | null) => void;
|
|
128
|
+
captionStatus?: string | null;
|
|
43
129
|
};
|
|
44
130
|
/**
|
|
45
131
|
* Control shell over an already-mounted video (children / videoSlot).
|
|
46
132
|
* Zoom is UI-only via CSS transform.
|
|
47
133
|
*/
|
|
48
|
-
declare function PlayerChrome({ player, config, containerRef, videoSlot, className, getSeekPreview, }: PlayerChromeProps): react.JSX.Element;
|
|
49
|
-
|
|
50
|
-
declare function formatPlaybackTime(seconds: number): string;
|
|
51
|
-
declare function resolveVisiblePlaybackRates(count: number): PlaybackRate[];
|
|
52
|
-
declare function snapPlaybackRate(rate: number, visible: readonly PlaybackRate[]): PlaybackRate;
|
|
53
|
-
type PlayerOverlayKind = "none" | "play" | "unmute";
|
|
54
|
-
declare function resolvePlayerOverlay(input: {
|
|
55
|
-
showControls: boolean;
|
|
56
|
-
isPlaying: boolean;
|
|
57
|
-
muted: boolean;
|
|
58
|
-
volume: number;
|
|
59
|
-
}): PlayerOverlayKind;
|
|
60
|
-
type PlayerZoomLevel = 1 | 1.25 | 1.5 | 2;
|
|
61
|
-
declare const ZOOM_STEPS: PlayerZoomLevel[];
|
|
62
|
-
declare function nextZoom(current: PlayerZoomLevel, direction: 1 | -1): PlayerZoomLevel;
|
|
134
|
+
declare function PlayerChrome({ player, config, containerRef, videoSlot, className, getSeekPreview, mediaMode, audioAvailable, onMediaModeChange, sidecarCaptions, selectedSidecar, onSidecarChange, captionStatus, }: PlayerChromeProps): react.JSX.Element;
|
|
63
135
|
|
|
64
136
|
type PlayerControlBarProps = {
|
|
65
137
|
config: PlayerConfig;
|
|
@@ -92,10 +164,20 @@ type PlayerControlBarProps = {
|
|
|
92
164
|
onTextTrackChange: (selection: TextTrackSelection) => void;
|
|
93
165
|
onAudioTrackChange: (index: number) => void;
|
|
94
166
|
onToggleFullscreen: () => void;
|
|
95
|
-
|
|
96
|
-
onZoomOut: () => void;
|
|
167
|
+
onZoomChange: (zoom: PlayerZoomLevel) => void;
|
|
97
168
|
seekBarRef?: RefObject<HTMLInputElement | null>;
|
|
98
169
|
getSeekPreview?: (time: number) => string | null | undefined;
|
|
170
|
+
mediaMode?: "video" | "audio";
|
|
171
|
+
audioAvailable?: boolean;
|
|
172
|
+
onMediaModeChange?: (mode: "video" | "audio") => void;
|
|
173
|
+
sidecarCaptions?: SettingsCaption[];
|
|
174
|
+
selectedSidecar?: string | null;
|
|
175
|
+
onSidecarChange?: (language: string | null) => void;
|
|
176
|
+
captionStatus?: string | null;
|
|
177
|
+
onPointerEnter?: () => void;
|
|
178
|
+
onPointerLeave?: () => void;
|
|
179
|
+
onFocusCapture?: () => void;
|
|
180
|
+
onBlurCapture?: (event: FocusEvent<HTMLDivElement>) => void;
|
|
99
181
|
};
|
|
100
182
|
declare function PlayerControlBar(props: PlayerControlBarProps): react.JSX.Element;
|
|
101
183
|
|
|
@@ -138,6 +220,7 @@ type UsePlayerControlsResult = {
|
|
|
138
220
|
goToLive: () => boolean;
|
|
139
221
|
zoomIn: () => void;
|
|
140
222
|
zoomOut: () => void;
|
|
223
|
+
setZoom: (level: PlayerZoomLevel) => void;
|
|
141
224
|
};
|
|
142
225
|
declare function usePlayerControls(options: UsePlayerControlsOptions): UsePlayerControlsResult;
|
|
143
226
|
|
|
@@ -180,11 +263,12 @@ declare function LiveBadgeButton({ atLiveEdge, onGoToLive, }: {
|
|
|
180
263
|
onGoToLive: () => boolean;
|
|
181
264
|
}): react.JSX.Element;
|
|
182
265
|
|
|
183
|
-
declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, }: {
|
|
266
|
+
declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, onReturnToVideo, }: {
|
|
184
267
|
kind: PlayerOverlayKind;
|
|
185
268
|
playIconPreset: PlayIconPreset$1;
|
|
186
269
|
onPlay: () => void;
|
|
187
270
|
onEnableAudio: () => void;
|
|
271
|
+
onReturnToVideo?: () => void;
|
|
188
272
|
}): react.JSX.Element | null;
|
|
189
273
|
|
|
190
274
|
type SkipCueDirection = "forward" | "backward";
|
|
@@ -275,4 +359,18 @@ declare function usePlaybackWatermark({ enabled, label, active, durationMs, inte
|
|
|
275
359
|
reducedMotion?: boolean;
|
|
276
360
|
}): PlaybackWatermarkState;
|
|
277
361
|
|
|
278
|
-
|
|
362
|
+
/**
|
|
363
|
+
* Keep the selected sidecar caption language after the media source is
|
|
364
|
+
* renewed or reloaded. Only SDK-owned `<track>` elements are touched
|
|
365
|
+
* (`data-sample-subtitle` / `data-appextech-subtitle`).
|
|
366
|
+
*
|
|
367
|
+
* `language`: a BCP 47 tag to show, `null` to turn SDK tracks off, or
|
|
368
|
+
* `undefined` when the host does not manage sidecar captions (no-op).
|
|
369
|
+
*/
|
|
370
|
+
declare function useRestoreSubtitleSelection({ player, videoRef, language, }: {
|
|
371
|
+
player: VideoPlayer | null;
|
|
372
|
+
videoRef: RefObject<HTMLVideoElement | null>;
|
|
373
|
+
language: string | null | undefined;
|
|
374
|
+
}): void;
|
|
375
|
+
|
|
376
|
+
export { AudioTrackSelector, GENERIC_ERROR_MESSAGE, LiveBadgeButton, NsgVideoPlayerWithControls, type NsgVideoPlayerWithControlsProps, PREPARING_MESSAGE, PlayIconPreset, PlaybackSpeedSelector, type PlaybackWatermarkState, PlayerCenterOverlay, PlayerChrome, type PlayerChromeProps, PlayerControlBar, type PlayerControlBarProps, type PlayerErrorDisplay, type PlayerErrorLike, PlayerMenu, PlayerMenuItem, type PlayerOverlayKind, PlayerSkipCue, type PlayerZoomLevel, QUALITY_PREFERENCE_STORAGE_KEY, QualitySelector, SeekBar, type SettingsCaption, SettingsMenu, type StoredQualityPreference, TextTrackSelector, type UsePlayerControlsOptions, type UsePlayerControlsResult, type WatermarkPosition, ZOOM_STEPS, describePlayerError, formatPlaybackTime, matchQualityPreference, nextZoom, preferenceFromSelection, randomFirstShowDelay, randomWatermarkDelay, randomWatermarkPosition, readQualityPreference, resolvePlayerOverlay, resolveVisiblePlaybackRates, snapPlaybackRate, usePlaybackWatermark, usePlayerControls, useRestoreSubtitleSelection, writeQualityPreference };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,66 @@
|
|
|
1
1
|
import * as react from 'react';
|
|
2
|
-
import { CSSProperties, RefObject, ReactNode } from 'react';
|
|
3
|
-
import {
|
|
2
|
+
import { CSSProperties, RefObject, ReactNode, FocusEvent } from 'react';
|
|
3
|
+
import { PlaybackRate, HlsQualityLevel, QualitySelection, PlayerTextTrack, TextTrackSelection, AuthConfig, PlaybackCredentialConfig, mergePlayerConfig, AnalyticsConfig, VideoPlayer, PlayerConfig, PlayerAudioTrack, PlayIconPreset as PlayIconPreset$1 } from '@codenkay/video-nsgplayer-core';
|
|
4
|
+
|
|
5
|
+
declare function formatPlaybackTime(seconds: number): string;
|
|
6
|
+
declare function resolveVisiblePlaybackRates(count: number): PlaybackRate[];
|
|
7
|
+
declare function snapPlaybackRate(rate: number, visible: readonly PlaybackRate[]): PlaybackRate;
|
|
8
|
+
type PlayerOverlayKind = "none" | "play" | "unmute" | "return-video";
|
|
9
|
+
declare function resolvePlayerOverlay(input: {
|
|
10
|
+
showControls: boolean;
|
|
11
|
+
isPlaying: boolean;
|
|
12
|
+
muted: boolean;
|
|
13
|
+
volume: number;
|
|
14
|
+
mediaMode?: "video" | "audio";
|
|
15
|
+
}): PlayerOverlayKind;
|
|
16
|
+
type PlayerZoomLevel = 1 | 1.25 | 1.5 | 2;
|
|
17
|
+
declare const ZOOM_STEPS: PlayerZoomLevel[];
|
|
18
|
+
declare function nextZoom(current: PlayerZoomLevel, direction: 1 | -1): PlayerZoomLevel;
|
|
19
|
+
|
|
20
|
+
type SettingsCaption = {
|
|
21
|
+
language: string;
|
|
22
|
+
label: string;
|
|
23
|
+
generated?: boolean;
|
|
24
|
+
};
|
|
25
|
+
declare function SettingsMenu({ showQuality, qualities, qualitySelection, activeLevel, onQualityChange, showZoom, zoom, onZoomChange, captions, selectedCaption, onCaptionChange, textTracks, selectedTextTrack, onTextTrackChange, captionStatus, }: {
|
|
26
|
+
showQuality: boolean;
|
|
27
|
+
qualities: HlsQualityLevel[];
|
|
28
|
+
qualitySelection: QualitySelection;
|
|
29
|
+
activeLevel: number;
|
|
30
|
+
onQualityChange: (selection: QualitySelection) => void;
|
|
31
|
+
showZoom: boolean;
|
|
32
|
+
zoom: PlayerZoomLevel;
|
|
33
|
+
onZoomChange: (zoom: PlayerZoomLevel) => void;
|
|
34
|
+
captions: SettingsCaption[];
|
|
35
|
+
selectedCaption: string | null;
|
|
36
|
+
onCaptionChange?: (language: string | null) => void;
|
|
37
|
+
textTracks: PlayerTextTrack[];
|
|
38
|
+
selectedTextTrack: TextTrackSelection;
|
|
39
|
+
onTextTrackChange: (selection: TextTrackSelection) => void;
|
|
40
|
+
captionStatus?: string | null;
|
|
41
|
+
}): react.JSX.Element | null;
|
|
42
|
+
|
|
43
|
+
/** Minimal error shape accepted by the player error UI. */
|
|
44
|
+
type PlayerErrorLike = {
|
|
45
|
+
code?: string;
|
|
46
|
+
message?: string;
|
|
47
|
+
/** `StudentLeaseError.activePlatform` for `PLATFORM_IN_USE`. */
|
|
48
|
+
activePlatform?: string;
|
|
49
|
+
};
|
|
50
|
+
type PlayerErrorDisplay = {
|
|
51
|
+
/** `preparing` is informational; the others are blocking errors. */
|
|
52
|
+
kind: "preparing" | "platform-in-use" | "error";
|
|
53
|
+
code?: string;
|
|
54
|
+
message: string;
|
|
55
|
+
};
|
|
56
|
+
declare const PREPARING_MESSAGE = "Live video is preparing. Please retry shortly.";
|
|
57
|
+
declare const GENERIC_ERROR_MESSAGE = "Unable to play this video.";
|
|
58
|
+
/**
|
|
59
|
+
* Map a player or student-lease error to what the UI should show.
|
|
60
|
+
* `PLAYBACK_NOT_READY` is a transient "preparing" notice; `PLATFORM_IN_USE`
|
|
61
|
+
* names the other platform when known.
|
|
62
|
+
*/
|
|
63
|
+
declare function describePlayerError(error: PlayerErrorLike | null | undefined): PlayerErrorDisplay | null;
|
|
4
64
|
|
|
5
65
|
type NsgVideoPlayerWithControlsProps = {
|
|
6
66
|
videoId: string;
|
|
@@ -26,6 +86,25 @@ type NsgVideoPlayerWithControlsProps = {
|
|
|
26
86
|
}) => void;
|
|
27
87
|
/** Optional seek-bar hover preview image URL for a given media time. */
|
|
28
88
|
getSeekPreview?: (time: number) => string | null | undefined;
|
|
89
|
+
poster?: string;
|
|
90
|
+
mediaMode?: "video" | "audio";
|
|
91
|
+
audioAvailable?: boolean;
|
|
92
|
+
onMediaModeChange?: (mode: "video" | "audio") => void;
|
|
93
|
+
sidecarCaptions?: SettingsCaption[];
|
|
94
|
+
selectedSidecar?: string | null;
|
|
95
|
+
onSidecarChange?: (language: string | null) => void;
|
|
96
|
+
captionStatus?: string | null;
|
|
97
|
+
/**
|
|
98
|
+
* Lease-driven watermark text (for example `useStudentLease().watermarkText`).
|
|
99
|
+
* Overrides `config.watermark.text`; the static text is the fallback.
|
|
100
|
+
*/
|
|
101
|
+
watermarkText?: string | null;
|
|
102
|
+
/**
|
|
103
|
+
* Error from outside the player, such as a `StudentLeaseError`
|
|
104
|
+
* (`PLATFORM_IN_USE`, `PLAYBACK_NOT_READY`). Shown when the player itself
|
|
105
|
+
* has no error.
|
|
106
|
+
*/
|
|
107
|
+
leaseError?: PlayerErrorLike | null;
|
|
29
108
|
};
|
|
30
109
|
/**
|
|
31
110
|
* Full player with control chrome (seek, quality, speed, live, zoom, keyboard).
|
|
@@ -40,26 +119,19 @@ type PlayerChromeProps = {
|
|
|
40
119
|
videoSlot: ReactNode;
|
|
41
120
|
className?: string;
|
|
42
121
|
getSeekPreview?: (time: number) => string | null | undefined;
|
|
122
|
+
mediaMode?: "video" | "audio";
|
|
123
|
+
audioAvailable?: boolean;
|
|
124
|
+
onMediaModeChange?: (mode: "video" | "audio") => void;
|
|
125
|
+
sidecarCaptions?: SettingsCaption[];
|
|
126
|
+
selectedSidecar?: string | null;
|
|
127
|
+
onSidecarChange?: (language: string | null) => void;
|
|
128
|
+
captionStatus?: string | null;
|
|
43
129
|
};
|
|
44
130
|
/**
|
|
45
131
|
* Control shell over an already-mounted video (children / videoSlot).
|
|
46
132
|
* Zoom is UI-only via CSS transform.
|
|
47
133
|
*/
|
|
48
|
-
declare function PlayerChrome({ player, config, containerRef, videoSlot, className, getSeekPreview, }: PlayerChromeProps): react.JSX.Element;
|
|
49
|
-
|
|
50
|
-
declare function formatPlaybackTime(seconds: number): string;
|
|
51
|
-
declare function resolveVisiblePlaybackRates(count: number): PlaybackRate[];
|
|
52
|
-
declare function snapPlaybackRate(rate: number, visible: readonly PlaybackRate[]): PlaybackRate;
|
|
53
|
-
type PlayerOverlayKind = "none" | "play" | "unmute";
|
|
54
|
-
declare function resolvePlayerOverlay(input: {
|
|
55
|
-
showControls: boolean;
|
|
56
|
-
isPlaying: boolean;
|
|
57
|
-
muted: boolean;
|
|
58
|
-
volume: number;
|
|
59
|
-
}): PlayerOverlayKind;
|
|
60
|
-
type PlayerZoomLevel = 1 | 1.25 | 1.5 | 2;
|
|
61
|
-
declare const ZOOM_STEPS: PlayerZoomLevel[];
|
|
62
|
-
declare function nextZoom(current: PlayerZoomLevel, direction: 1 | -1): PlayerZoomLevel;
|
|
134
|
+
declare function PlayerChrome({ player, config, containerRef, videoSlot, className, getSeekPreview, mediaMode, audioAvailable, onMediaModeChange, sidecarCaptions, selectedSidecar, onSidecarChange, captionStatus, }: PlayerChromeProps): react.JSX.Element;
|
|
63
135
|
|
|
64
136
|
type PlayerControlBarProps = {
|
|
65
137
|
config: PlayerConfig;
|
|
@@ -92,10 +164,20 @@ type PlayerControlBarProps = {
|
|
|
92
164
|
onTextTrackChange: (selection: TextTrackSelection) => void;
|
|
93
165
|
onAudioTrackChange: (index: number) => void;
|
|
94
166
|
onToggleFullscreen: () => void;
|
|
95
|
-
|
|
96
|
-
onZoomOut: () => void;
|
|
167
|
+
onZoomChange: (zoom: PlayerZoomLevel) => void;
|
|
97
168
|
seekBarRef?: RefObject<HTMLInputElement | null>;
|
|
98
169
|
getSeekPreview?: (time: number) => string | null | undefined;
|
|
170
|
+
mediaMode?: "video" | "audio";
|
|
171
|
+
audioAvailable?: boolean;
|
|
172
|
+
onMediaModeChange?: (mode: "video" | "audio") => void;
|
|
173
|
+
sidecarCaptions?: SettingsCaption[];
|
|
174
|
+
selectedSidecar?: string | null;
|
|
175
|
+
onSidecarChange?: (language: string | null) => void;
|
|
176
|
+
captionStatus?: string | null;
|
|
177
|
+
onPointerEnter?: () => void;
|
|
178
|
+
onPointerLeave?: () => void;
|
|
179
|
+
onFocusCapture?: () => void;
|
|
180
|
+
onBlurCapture?: (event: FocusEvent<HTMLDivElement>) => void;
|
|
99
181
|
};
|
|
100
182
|
declare function PlayerControlBar(props: PlayerControlBarProps): react.JSX.Element;
|
|
101
183
|
|
|
@@ -138,6 +220,7 @@ type UsePlayerControlsResult = {
|
|
|
138
220
|
goToLive: () => boolean;
|
|
139
221
|
zoomIn: () => void;
|
|
140
222
|
zoomOut: () => void;
|
|
223
|
+
setZoom: (level: PlayerZoomLevel) => void;
|
|
141
224
|
};
|
|
142
225
|
declare function usePlayerControls(options: UsePlayerControlsOptions): UsePlayerControlsResult;
|
|
143
226
|
|
|
@@ -180,11 +263,12 @@ declare function LiveBadgeButton({ atLiveEdge, onGoToLive, }: {
|
|
|
180
263
|
onGoToLive: () => boolean;
|
|
181
264
|
}): react.JSX.Element;
|
|
182
265
|
|
|
183
|
-
declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, }: {
|
|
266
|
+
declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, onReturnToVideo, }: {
|
|
184
267
|
kind: PlayerOverlayKind;
|
|
185
268
|
playIconPreset: PlayIconPreset$1;
|
|
186
269
|
onPlay: () => void;
|
|
187
270
|
onEnableAudio: () => void;
|
|
271
|
+
onReturnToVideo?: () => void;
|
|
188
272
|
}): react.JSX.Element | null;
|
|
189
273
|
|
|
190
274
|
type SkipCueDirection = "forward" | "backward";
|
|
@@ -275,4 +359,18 @@ declare function usePlaybackWatermark({ enabled, label, active, durationMs, inte
|
|
|
275
359
|
reducedMotion?: boolean;
|
|
276
360
|
}): PlaybackWatermarkState;
|
|
277
361
|
|
|
278
|
-
|
|
362
|
+
/**
|
|
363
|
+
* Keep the selected sidecar caption language after the media source is
|
|
364
|
+
* renewed or reloaded. Only SDK-owned `<track>` elements are touched
|
|
365
|
+
* (`data-sample-subtitle` / `data-appextech-subtitle`).
|
|
366
|
+
*
|
|
367
|
+
* `language`: a BCP 47 tag to show, `null` to turn SDK tracks off, or
|
|
368
|
+
* `undefined` when the host does not manage sidecar captions (no-op).
|
|
369
|
+
*/
|
|
370
|
+
declare function useRestoreSubtitleSelection({ player, videoRef, language, }: {
|
|
371
|
+
player: VideoPlayer | null;
|
|
372
|
+
videoRef: RefObject<HTMLVideoElement | null>;
|
|
373
|
+
language: string | null | undefined;
|
|
374
|
+
}): void;
|
|
375
|
+
|
|
376
|
+
export { AudioTrackSelector, GENERIC_ERROR_MESSAGE, LiveBadgeButton, NsgVideoPlayerWithControls, type NsgVideoPlayerWithControlsProps, PREPARING_MESSAGE, PlayIconPreset, PlaybackSpeedSelector, type PlaybackWatermarkState, PlayerCenterOverlay, PlayerChrome, type PlayerChromeProps, PlayerControlBar, type PlayerControlBarProps, type PlayerErrorDisplay, type PlayerErrorLike, PlayerMenu, PlayerMenuItem, type PlayerOverlayKind, PlayerSkipCue, type PlayerZoomLevel, QUALITY_PREFERENCE_STORAGE_KEY, QualitySelector, SeekBar, type SettingsCaption, SettingsMenu, type StoredQualityPreference, TextTrackSelector, type UsePlayerControlsOptions, type UsePlayerControlsResult, type WatermarkPosition, ZOOM_STEPS, describePlayerError, formatPlaybackTime, matchQualityPreference, nextZoom, preferenceFromSelection, randomFirstShowDelay, randomWatermarkDelay, randomWatermarkPosition, readQualityPreference, resolvePlayerOverlay, resolveVisiblePlaybackRates, snapPlaybackRate, usePlaybackWatermark, usePlayerControls, useRestoreSubtitleSelection, writeQualityPreference };
|