@codenkay/video-nsgplayer-ui 4.0.0 → 5.1.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/dist/index.d.cts CHANGED
@@ -1,6 +1,44 @@
1
1
  import * as react from 'react';
2
- import { CSSProperties, RefObject, ReactNode } from 'react';
3
- import { AuthConfig, PlaybackCredentialConfig, mergePlayerConfig, AnalyticsConfig, VideoPlayer, PlayerConfig, PlaybackRate, HlsQualityLevel, QualitySelection, PlayerTextTrack, TextTrackSelection, PlayerAudioTrack, PlayIconPreset as PlayIconPreset$1 } from '@codenkay/video-nsgplayer-core';
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;
4
42
 
5
43
  type NsgVideoPlayerWithControlsProps = {
6
44
  videoId: string;
@@ -26,6 +64,14 @@ type NsgVideoPlayerWithControlsProps = {
26
64
  }) => void;
27
65
  /** Optional seek-bar hover preview image URL for a given media time. */
28
66
  getSeekPreview?: (time: number) => string | null | undefined;
67
+ poster?: string;
68
+ mediaMode?: "video" | "audio";
69
+ audioAvailable?: boolean;
70
+ onMediaModeChange?: (mode: "video" | "audio") => void;
71
+ sidecarCaptions?: SettingsCaption[];
72
+ selectedSidecar?: string | null;
73
+ onSidecarChange?: (language: string | null) => void;
74
+ captionStatus?: string | null;
29
75
  };
30
76
  /**
31
77
  * Full player with control chrome (seek, quality, speed, live, zoom, keyboard).
@@ -40,26 +86,19 @@ type PlayerChromeProps = {
40
86
  videoSlot: ReactNode;
41
87
  className?: string;
42
88
  getSeekPreview?: (time: number) => string | null | undefined;
89
+ mediaMode?: "video" | "audio";
90
+ audioAvailable?: boolean;
91
+ onMediaModeChange?: (mode: "video" | "audio") => void;
92
+ sidecarCaptions?: SettingsCaption[];
93
+ selectedSidecar?: string | null;
94
+ onSidecarChange?: (language: string | null) => void;
95
+ captionStatus?: string | null;
43
96
  };
44
97
  /**
45
98
  * Control shell over an already-mounted video (children / videoSlot).
46
99
  * Zoom is UI-only via CSS transform.
47
100
  */
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;
101
+ declare function PlayerChrome({ player, config, containerRef, videoSlot, className, getSeekPreview, mediaMode, audioAvailable, onMediaModeChange, sidecarCaptions, selectedSidecar, onSidecarChange, captionStatus, }: PlayerChromeProps): react.JSX.Element;
63
102
 
64
103
  type PlayerControlBarProps = {
65
104
  config: PlayerConfig;
@@ -92,10 +131,20 @@ type PlayerControlBarProps = {
92
131
  onTextTrackChange: (selection: TextTrackSelection) => void;
93
132
  onAudioTrackChange: (index: number) => void;
94
133
  onToggleFullscreen: () => void;
95
- onZoomIn: () => void;
96
- onZoomOut: () => void;
134
+ onZoomChange: (zoom: PlayerZoomLevel) => void;
97
135
  seekBarRef?: RefObject<HTMLInputElement | null>;
98
136
  getSeekPreview?: (time: number) => string | null | undefined;
137
+ mediaMode?: "video" | "audio";
138
+ audioAvailable?: boolean;
139
+ onMediaModeChange?: (mode: "video" | "audio") => void;
140
+ sidecarCaptions?: SettingsCaption[];
141
+ selectedSidecar?: string | null;
142
+ onSidecarChange?: (language: string | null) => void;
143
+ captionStatus?: string | null;
144
+ onPointerEnter?: () => void;
145
+ onPointerLeave?: () => void;
146
+ onFocusCapture?: () => void;
147
+ onBlurCapture?: (event: FocusEvent<HTMLDivElement>) => void;
99
148
  };
100
149
  declare function PlayerControlBar(props: PlayerControlBarProps): react.JSX.Element;
101
150
 
@@ -138,6 +187,7 @@ type UsePlayerControlsResult = {
138
187
  goToLive: () => boolean;
139
188
  zoomIn: () => void;
140
189
  zoomOut: () => void;
190
+ setZoom: (level: PlayerZoomLevel) => void;
141
191
  };
142
192
  declare function usePlayerControls(options: UsePlayerControlsOptions): UsePlayerControlsResult;
143
193
 
@@ -180,11 +230,12 @@ declare function LiveBadgeButton({ atLiveEdge, onGoToLive, }: {
180
230
  onGoToLive: () => boolean;
181
231
  }): react.JSX.Element;
182
232
 
183
- declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, }: {
233
+ declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, onReturnToVideo, }: {
184
234
  kind: PlayerOverlayKind;
185
235
  playIconPreset: PlayIconPreset$1;
186
236
  onPlay: () => void;
187
237
  onEnableAudio: () => void;
238
+ onReturnToVideo?: () => void;
188
239
  }): react.JSX.Element | null;
189
240
 
190
241
  type SkipCueDirection = "forward" | "backward";
@@ -275,4 +326,4 @@ declare function usePlaybackWatermark({ enabled, label, active, durationMs, inte
275
326
  reducedMotion?: boolean;
276
327
  }): PlaybackWatermarkState;
277
328
 
278
- export { AudioTrackSelector, LiveBadgeButton, NsgVideoPlayerWithControls, type NsgVideoPlayerWithControlsProps, PlayIconPreset, PlaybackSpeedSelector, type PlaybackWatermarkState, PlayerCenterOverlay, PlayerChrome, type PlayerChromeProps, PlayerControlBar, type PlayerControlBarProps, PlayerMenu, PlayerMenuItem, type PlayerOverlayKind, PlayerSkipCue, type PlayerZoomLevel, QUALITY_PREFERENCE_STORAGE_KEY, QualitySelector, SeekBar, type StoredQualityPreference, TextTrackSelector, type UsePlayerControlsOptions, type UsePlayerControlsResult, type WatermarkPosition, ZOOM_STEPS, formatPlaybackTime, matchQualityPreference, nextZoom, preferenceFromSelection, randomFirstShowDelay, randomWatermarkDelay, randomWatermarkPosition, readQualityPreference, resolvePlayerOverlay, resolveVisiblePlaybackRates, snapPlaybackRate, usePlaybackWatermark, usePlayerControls, writeQualityPreference };
329
+ export { AudioTrackSelector, LiveBadgeButton, NsgVideoPlayerWithControls, type NsgVideoPlayerWithControlsProps, PlayIconPreset, PlaybackSpeedSelector, type PlaybackWatermarkState, PlayerCenterOverlay, PlayerChrome, type PlayerChromeProps, PlayerControlBar, type PlayerControlBarProps, 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, formatPlaybackTime, matchQualityPreference, nextZoom, preferenceFromSelection, randomFirstShowDelay, randomWatermarkDelay, randomWatermarkPosition, readQualityPreference, resolvePlayerOverlay, resolveVisiblePlaybackRates, snapPlaybackRate, usePlaybackWatermark, usePlayerControls, writeQualityPreference };
package/dist/index.d.ts CHANGED
@@ -1,6 +1,44 @@
1
1
  import * as react from 'react';
2
- import { CSSProperties, RefObject, ReactNode } from 'react';
3
- import { AuthConfig, PlaybackCredentialConfig, mergePlayerConfig, AnalyticsConfig, VideoPlayer, PlayerConfig, PlaybackRate, HlsQualityLevel, QualitySelection, PlayerTextTrack, TextTrackSelection, PlayerAudioTrack, PlayIconPreset as PlayIconPreset$1 } from '@codenkay/video-nsgplayer-core';
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;
4
42
 
5
43
  type NsgVideoPlayerWithControlsProps = {
6
44
  videoId: string;
@@ -26,6 +64,14 @@ type NsgVideoPlayerWithControlsProps = {
26
64
  }) => void;
27
65
  /** Optional seek-bar hover preview image URL for a given media time. */
28
66
  getSeekPreview?: (time: number) => string | null | undefined;
67
+ poster?: string;
68
+ mediaMode?: "video" | "audio";
69
+ audioAvailable?: boolean;
70
+ onMediaModeChange?: (mode: "video" | "audio") => void;
71
+ sidecarCaptions?: SettingsCaption[];
72
+ selectedSidecar?: string | null;
73
+ onSidecarChange?: (language: string | null) => void;
74
+ captionStatus?: string | null;
29
75
  };
30
76
  /**
31
77
  * Full player with control chrome (seek, quality, speed, live, zoom, keyboard).
@@ -40,26 +86,19 @@ type PlayerChromeProps = {
40
86
  videoSlot: ReactNode;
41
87
  className?: string;
42
88
  getSeekPreview?: (time: number) => string | null | undefined;
89
+ mediaMode?: "video" | "audio";
90
+ audioAvailable?: boolean;
91
+ onMediaModeChange?: (mode: "video" | "audio") => void;
92
+ sidecarCaptions?: SettingsCaption[];
93
+ selectedSidecar?: string | null;
94
+ onSidecarChange?: (language: string | null) => void;
95
+ captionStatus?: string | null;
43
96
  };
44
97
  /**
45
98
  * Control shell over an already-mounted video (children / videoSlot).
46
99
  * Zoom is UI-only via CSS transform.
47
100
  */
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;
101
+ declare function PlayerChrome({ player, config, containerRef, videoSlot, className, getSeekPreview, mediaMode, audioAvailable, onMediaModeChange, sidecarCaptions, selectedSidecar, onSidecarChange, captionStatus, }: PlayerChromeProps): react.JSX.Element;
63
102
 
64
103
  type PlayerControlBarProps = {
65
104
  config: PlayerConfig;
@@ -92,10 +131,20 @@ type PlayerControlBarProps = {
92
131
  onTextTrackChange: (selection: TextTrackSelection) => void;
93
132
  onAudioTrackChange: (index: number) => void;
94
133
  onToggleFullscreen: () => void;
95
- onZoomIn: () => void;
96
- onZoomOut: () => void;
134
+ onZoomChange: (zoom: PlayerZoomLevel) => void;
97
135
  seekBarRef?: RefObject<HTMLInputElement | null>;
98
136
  getSeekPreview?: (time: number) => string | null | undefined;
137
+ mediaMode?: "video" | "audio";
138
+ audioAvailable?: boolean;
139
+ onMediaModeChange?: (mode: "video" | "audio") => void;
140
+ sidecarCaptions?: SettingsCaption[];
141
+ selectedSidecar?: string | null;
142
+ onSidecarChange?: (language: string | null) => void;
143
+ captionStatus?: string | null;
144
+ onPointerEnter?: () => void;
145
+ onPointerLeave?: () => void;
146
+ onFocusCapture?: () => void;
147
+ onBlurCapture?: (event: FocusEvent<HTMLDivElement>) => void;
99
148
  };
100
149
  declare function PlayerControlBar(props: PlayerControlBarProps): react.JSX.Element;
101
150
 
@@ -138,6 +187,7 @@ type UsePlayerControlsResult = {
138
187
  goToLive: () => boolean;
139
188
  zoomIn: () => void;
140
189
  zoomOut: () => void;
190
+ setZoom: (level: PlayerZoomLevel) => void;
141
191
  };
142
192
  declare function usePlayerControls(options: UsePlayerControlsOptions): UsePlayerControlsResult;
143
193
 
@@ -180,11 +230,12 @@ declare function LiveBadgeButton({ atLiveEdge, onGoToLive, }: {
180
230
  onGoToLive: () => boolean;
181
231
  }): react.JSX.Element;
182
232
 
183
- declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, }: {
233
+ declare function PlayerCenterOverlay({ kind, playIconPreset, onPlay, onEnableAudio, onReturnToVideo, }: {
184
234
  kind: PlayerOverlayKind;
185
235
  playIconPreset: PlayIconPreset$1;
186
236
  onPlay: () => void;
187
237
  onEnableAudio: () => void;
238
+ onReturnToVideo?: () => void;
188
239
  }): react.JSX.Element | null;
189
240
 
190
241
  type SkipCueDirection = "forward" | "backward";
@@ -275,4 +326,4 @@ declare function usePlaybackWatermark({ enabled, label, active, durationMs, inte
275
326
  reducedMotion?: boolean;
276
327
  }): PlaybackWatermarkState;
277
328
 
278
- export { AudioTrackSelector, LiveBadgeButton, NsgVideoPlayerWithControls, type NsgVideoPlayerWithControlsProps, PlayIconPreset, PlaybackSpeedSelector, type PlaybackWatermarkState, PlayerCenterOverlay, PlayerChrome, type PlayerChromeProps, PlayerControlBar, type PlayerControlBarProps, PlayerMenu, PlayerMenuItem, type PlayerOverlayKind, PlayerSkipCue, type PlayerZoomLevel, QUALITY_PREFERENCE_STORAGE_KEY, QualitySelector, SeekBar, type StoredQualityPreference, TextTrackSelector, type UsePlayerControlsOptions, type UsePlayerControlsResult, type WatermarkPosition, ZOOM_STEPS, formatPlaybackTime, matchQualityPreference, nextZoom, preferenceFromSelection, randomFirstShowDelay, randomWatermarkDelay, randomWatermarkPosition, readQualityPreference, resolvePlayerOverlay, resolveVisiblePlaybackRates, snapPlaybackRate, usePlaybackWatermark, usePlayerControls, writeQualityPreference };
329
+ export { AudioTrackSelector, LiveBadgeButton, NsgVideoPlayerWithControls, type NsgVideoPlayerWithControlsProps, PlayIconPreset, PlaybackSpeedSelector, type PlaybackWatermarkState, PlayerCenterOverlay, PlayerChrome, type PlayerChromeProps, PlayerControlBar, type PlayerControlBarProps, 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, formatPlaybackTime, matchQualityPreference, nextZoom, preferenceFromSelection, randomFirstShowDelay, randomWatermarkDelay, randomWatermarkPosition, readQualityPreference, resolvePlayerOverlay, resolveVisiblePlaybackRates, snapPlaybackRate, usePlaybackWatermark, usePlayerControls, writeQualityPreference };