oddysee-react 0.1.0 → 0.2.0-canary.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,4 +1,162 @@
1
- import { Track, PlayerError, QualityLevel, PlayerConfig, SourceOptions, PlayerEvent, HLSAudioPlayerInterface, PlayerState } from '@hls-audio-player/core';
1
+ import { ChangeEvent, PointerEvent, MouseEvent, TouchEvent } from 'react';
2
+
3
+ interface PlayerConfig {
4
+ network?: {
5
+ headers?: Record<string, string>;
6
+ timeout?: number;
7
+ retryCount?: number;
8
+ };
9
+ audio?: {
10
+ crossfade?: boolean;
11
+ normalization?: boolean;
12
+ preload?: boolean;
13
+ volume?: number;
14
+ };
15
+ playback?: {
16
+ autoPlay?: boolean;
17
+ startTime?: number;
18
+ };
19
+ }
20
+ interface SourceOptions {
21
+ headers?: Record<string, string>;
22
+ startTime?: number;
23
+ [key: string]: any;
24
+ }
25
+ interface Track {
26
+ id: string;
27
+ title?: string;
28
+ url: string;
29
+ duration?: number;
30
+ currentTime: number;
31
+ }
32
+ interface PlayerState {
33
+ track: Track | null;
34
+ currentTime: number;
35
+ duration: number | null;
36
+ volume: number;
37
+ loading: boolean;
38
+ error: PlayerError | null;
39
+ readyState: number;
40
+ isPlaying: boolean;
41
+ }
42
+ interface QualityLevel {
43
+ id: number;
44
+ name: string;
45
+ bitrate: number;
46
+ audioCodec?: string;
47
+ }
48
+ type PlayerEvent = 'play' | 'pause' | 'track-end' | 'error' | 'quality-change' | 'playlist-ready' | 'loadedmetadata' | 'timeupdate' | 'loading' | 'canplay';
49
+ interface PlayerEventMap$1 {
50
+ play: void;
51
+ pause: void;
52
+ 'track-end': Track | null;
53
+ error: PlayerError;
54
+ 'quality-change': QualityLevel;
55
+ 'playlist-ready': void;
56
+ loadedmetadata: Track | null;
57
+ timeupdate: {
58
+ currentTime: number;
59
+ duration: number | null;
60
+ };
61
+ loading: void;
62
+ canplay: void;
63
+ }
64
+ interface PlayerError {
65
+ code: 'NETWORK_ERROR' | 'MEDIA_ERROR' | 'PLAYBACK_ERROR' | 'FORMAT_NOT_SUPPORTED' | 'UNKNOWN_ERROR';
66
+ message: string;
67
+ details?: any;
68
+ }
69
+
70
+ interface HLSAudioPlayerInterface {
71
+ setSource(url: string, options?: SourceOptions): Promise<HLSAudioPlayer>;
72
+ getCurrentTrack(): Track | null;
73
+ on<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
74
+ off<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
75
+ play(): HLSAudioPlayer;
76
+ playAsync(): Promise<HLSAudioPlayer>;
77
+ pause(): HLSAudioPlayer;
78
+ setVolume(volume: number): HLSAudioPlayer;
79
+ beginSeek(): void;
80
+ updateSeek(time: number): void;
81
+ commitSeek(): void;
82
+ retry(count?: number, interval?: number): void;
83
+ getState(): PlayerState;
84
+ getAudioElement(): HTMLAudioElement;
85
+ loading: boolean;
86
+ readyState: number;
87
+ error: PlayerError | null;
88
+ destroy(): void;
89
+ }
90
+ declare class HLSAudioPlayer implements HLSAudioPlayerInterface {
91
+ private hls;
92
+ private audioElement;
93
+ private config;
94
+ private eventListeners;
95
+ private currentTrack?;
96
+ private _loading;
97
+ private _error;
98
+ private _isPlaying;
99
+ private isSeeking;
100
+ private seekPreviewTime;
101
+ private retryCount;
102
+ private retryInterval;
103
+ get loading(): boolean;
104
+ get readyState(): number;
105
+ get error(): PlayerError | null;
106
+ get isPlaying(): boolean;
107
+ constructor(config?: PlayerConfig);
108
+ beginSeek(): void;
109
+ updateSeek(time: number): void;
110
+ commitSeek(): Promise<void>;
111
+ retry(count?: number, interval?: number): void;
112
+ private mapConfigToHLS;
113
+ private setupHlsEvents;
114
+ private setupAudioEvents;
115
+ private updateCurrentTrack;
116
+ private mapHlsError;
117
+ /**
118
+ * sets source of the player
119
+ * @param url
120
+ * @param options
121
+ * @returns
122
+ */
123
+ setSource(url: string, options?: SourceOptions): Promise<HLSAudioPlayer>;
124
+ /**
125
+ * plays current source/track
126
+ * @returns
127
+ */
128
+ play(): HLSAudioPlayer;
129
+ /**
130
+ * Plays the current source/track and returns a Promise so callers can
131
+ * await or chain then/catch (e.g. to handle autoplay errors explicitly).
132
+ */
133
+ playAsync(): Promise<HLSAudioPlayer>;
134
+ /**
135
+ * Pauses the current source/track
136
+ * @returns
137
+ */
138
+ pause(): HLSAudioPlayer;
139
+ setVolume(volume: number): HLSAudioPlayer;
140
+ /**
141
+ * Gets the current value of the volume
142
+ * @returns
143
+ */
144
+ getVolume(): number;
145
+ /**
146
+ *
147
+ * gets the whole state of the player
148
+ */
149
+ getState(): PlayerState;
150
+ getAudioElement(): HTMLAudioElement;
151
+ getQualityLevels(): QualityLevel[];
152
+ setQuality(quality: number | string): void;
153
+ private getQualityName;
154
+ getCurrentTrack(): Track | null;
155
+ on<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
156
+ off<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
157
+ private emit;
158
+ destroy(): void;
159
+ }
2
160
 
3
161
  type PlayerEventMap = {
4
162
  play: void;
@@ -35,6 +193,27 @@ interface UseHlsAudioPlayerResult {
35
193
  loading: boolean;
36
194
  error: PlayerError | null;
37
195
  readyState: number;
196
+ scrub: {
197
+ isScrubbing: boolean;
198
+ displayTime: number;
199
+ begin: () => void;
200
+ update: (time: number) => void;
201
+ commit: (time?: number) => void;
202
+ };
203
+ seekBar: {
204
+ isScrubbing: boolean;
205
+ displayTime: number;
206
+ onChange: (event: ChangeEvent<HTMLInputElement>) => void;
207
+ onPointerDown: () => void;
208
+ onPointerUp: (event: PointerEvent<HTMLInputElement>) => void;
209
+ onPointerCancel: () => void;
210
+ onMouseDown: () => void;
211
+ onMouseUp: (event: MouseEvent<HTMLInputElement>) => void;
212
+ onTouchStart: () => void;
213
+ onTouchEnd: (event: TouchEvent<HTMLInputElement>) => void;
214
+ onFocus: () => void;
215
+ onBlur: () => void;
216
+ };
38
217
  controls: {
39
218
  setSource: (url: string, options?: SourceOptions) => Promise<HLSAudioPlayerInterface | null>;
40
219
  play: () => void;
@@ -42,6 +221,10 @@ interface UseHlsAudioPlayerResult {
42
221
  pause: () => void;
43
222
  setVolume: (volume: number) => void;
44
223
  setCurrentTime: (time: number) => void;
224
+ beginSeek: () => void;
225
+ updateSeek: (time: number) => void;
226
+ commitSeek: () => void;
227
+ retry: (count?: number, interval?: number) => void;
45
228
  };
46
229
  }
47
230
  declare function useHlsAudioPlayer(options?: UseHlsAudioPlayerOptions): UseHlsAudioPlayerResult;
package/dist/index.d.ts CHANGED
@@ -1,4 +1,162 @@
1
- import { Track, PlayerError, QualityLevel, PlayerConfig, SourceOptions, PlayerEvent, HLSAudioPlayerInterface, PlayerState } from '@hls-audio-player/core';
1
+ import { ChangeEvent, PointerEvent, MouseEvent, TouchEvent } from 'react';
2
+
3
+ interface PlayerConfig {
4
+ network?: {
5
+ headers?: Record<string, string>;
6
+ timeout?: number;
7
+ retryCount?: number;
8
+ };
9
+ audio?: {
10
+ crossfade?: boolean;
11
+ normalization?: boolean;
12
+ preload?: boolean;
13
+ volume?: number;
14
+ };
15
+ playback?: {
16
+ autoPlay?: boolean;
17
+ startTime?: number;
18
+ };
19
+ }
20
+ interface SourceOptions {
21
+ headers?: Record<string, string>;
22
+ startTime?: number;
23
+ [key: string]: any;
24
+ }
25
+ interface Track {
26
+ id: string;
27
+ title?: string;
28
+ url: string;
29
+ duration?: number;
30
+ currentTime: number;
31
+ }
32
+ interface PlayerState {
33
+ track: Track | null;
34
+ currentTime: number;
35
+ duration: number | null;
36
+ volume: number;
37
+ loading: boolean;
38
+ error: PlayerError | null;
39
+ readyState: number;
40
+ isPlaying: boolean;
41
+ }
42
+ interface QualityLevel {
43
+ id: number;
44
+ name: string;
45
+ bitrate: number;
46
+ audioCodec?: string;
47
+ }
48
+ type PlayerEvent = 'play' | 'pause' | 'track-end' | 'error' | 'quality-change' | 'playlist-ready' | 'loadedmetadata' | 'timeupdate' | 'loading' | 'canplay';
49
+ interface PlayerEventMap$1 {
50
+ play: void;
51
+ pause: void;
52
+ 'track-end': Track | null;
53
+ error: PlayerError;
54
+ 'quality-change': QualityLevel;
55
+ 'playlist-ready': void;
56
+ loadedmetadata: Track | null;
57
+ timeupdate: {
58
+ currentTime: number;
59
+ duration: number | null;
60
+ };
61
+ loading: void;
62
+ canplay: void;
63
+ }
64
+ interface PlayerError {
65
+ code: 'NETWORK_ERROR' | 'MEDIA_ERROR' | 'PLAYBACK_ERROR' | 'FORMAT_NOT_SUPPORTED' | 'UNKNOWN_ERROR';
66
+ message: string;
67
+ details?: any;
68
+ }
69
+
70
+ interface HLSAudioPlayerInterface {
71
+ setSource(url: string, options?: SourceOptions): Promise<HLSAudioPlayer>;
72
+ getCurrentTrack(): Track | null;
73
+ on<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
74
+ off<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
75
+ play(): HLSAudioPlayer;
76
+ playAsync(): Promise<HLSAudioPlayer>;
77
+ pause(): HLSAudioPlayer;
78
+ setVolume(volume: number): HLSAudioPlayer;
79
+ beginSeek(): void;
80
+ updateSeek(time: number): void;
81
+ commitSeek(): void;
82
+ retry(count?: number, interval?: number): void;
83
+ getState(): PlayerState;
84
+ getAudioElement(): HTMLAudioElement;
85
+ loading: boolean;
86
+ readyState: number;
87
+ error: PlayerError | null;
88
+ destroy(): void;
89
+ }
90
+ declare class HLSAudioPlayer implements HLSAudioPlayerInterface {
91
+ private hls;
92
+ private audioElement;
93
+ private config;
94
+ private eventListeners;
95
+ private currentTrack?;
96
+ private _loading;
97
+ private _error;
98
+ private _isPlaying;
99
+ private isSeeking;
100
+ private seekPreviewTime;
101
+ private retryCount;
102
+ private retryInterval;
103
+ get loading(): boolean;
104
+ get readyState(): number;
105
+ get error(): PlayerError | null;
106
+ get isPlaying(): boolean;
107
+ constructor(config?: PlayerConfig);
108
+ beginSeek(): void;
109
+ updateSeek(time: number): void;
110
+ commitSeek(): Promise<void>;
111
+ retry(count?: number, interval?: number): void;
112
+ private mapConfigToHLS;
113
+ private setupHlsEvents;
114
+ private setupAudioEvents;
115
+ private updateCurrentTrack;
116
+ private mapHlsError;
117
+ /**
118
+ * sets source of the player
119
+ * @param url
120
+ * @param options
121
+ * @returns
122
+ */
123
+ setSource(url: string, options?: SourceOptions): Promise<HLSAudioPlayer>;
124
+ /**
125
+ * plays current source/track
126
+ * @returns
127
+ */
128
+ play(): HLSAudioPlayer;
129
+ /**
130
+ * Plays the current source/track and returns a Promise so callers can
131
+ * await or chain then/catch (e.g. to handle autoplay errors explicitly).
132
+ */
133
+ playAsync(): Promise<HLSAudioPlayer>;
134
+ /**
135
+ * Pauses the current source/track
136
+ * @returns
137
+ */
138
+ pause(): HLSAudioPlayer;
139
+ setVolume(volume: number): HLSAudioPlayer;
140
+ /**
141
+ * Gets the current value of the volume
142
+ * @returns
143
+ */
144
+ getVolume(): number;
145
+ /**
146
+ *
147
+ * gets the whole state of the player
148
+ */
149
+ getState(): PlayerState;
150
+ getAudioElement(): HTMLAudioElement;
151
+ getQualityLevels(): QualityLevel[];
152
+ setQuality(quality: number | string): void;
153
+ private getQualityName;
154
+ getCurrentTrack(): Track | null;
155
+ on<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
156
+ off<K extends PlayerEvent>(event: K, callback: (data: PlayerEventMap$1[K]) => void): void;
157
+ private emit;
158
+ destroy(): void;
159
+ }
2
160
 
3
161
  type PlayerEventMap = {
4
162
  play: void;
@@ -35,6 +193,27 @@ interface UseHlsAudioPlayerResult {
35
193
  loading: boolean;
36
194
  error: PlayerError | null;
37
195
  readyState: number;
196
+ scrub: {
197
+ isScrubbing: boolean;
198
+ displayTime: number;
199
+ begin: () => void;
200
+ update: (time: number) => void;
201
+ commit: (time?: number) => void;
202
+ };
203
+ seekBar: {
204
+ isScrubbing: boolean;
205
+ displayTime: number;
206
+ onChange: (event: ChangeEvent<HTMLInputElement>) => void;
207
+ onPointerDown: () => void;
208
+ onPointerUp: (event: PointerEvent<HTMLInputElement>) => void;
209
+ onPointerCancel: () => void;
210
+ onMouseDown: () => void;
211
+ onMouseUp: (event: MouseEvent<HTMLInputElement>) => void;
212
+ onTouchStart: () => void;
213
+ onTouchEnd: (event: TouchEvent<HTMLInputElement>) => void;
214
+ onFocus: () => void;
215
+ onBlur: () => void;
216
+ };
38
217
  controls: {
39
218
  setSource: (url: string, options?: SourceOptions) => Promise<HLSAudioPlayerInterface | null>;
40
219
  play: () => void;
@@ -42,6 +221,10 @@ interface UseHlsAudioPlayerResult {
42
221
  pause: () => void;
43
222
  setVolume: (volume: number) => void;
44
223
  setCurrentTime: (time: number) => void;
224
+ beginSeek: () => void;
225
+ updateSeek: (time: number) => void;
226
+ commitSeek: () => void;
227
+ retry: (count?: number, interval?: number) => void;
45
228
  };
46
229
  }
47
230
  declare function useHlsAudioPlayer(options?: UseHlsAudioPlayerOptions): UseHlsAudioPlayerResult;