@livedigital/client 2.37.0 → 2.37.1

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.
Files changed (52) hide show
  1. package/dist/node_modules/mediasoup-client/src/Consumer.d.ts +114 -0
  2. package/dist/node_modules/mediasoup-client/src/DataConsumer.d.ts +93 -0
  3. package/dist/node_modules/mediasoup-client/src/DataProducer.d.ts +97 -0
  4. package/dist/node_modules/mediasoup-client/src/EnhancedEventEmitter.d.ts +7 -0
  5. package/dist/node_modules/mediasoup-client/src/Logger.d.ts +10 -0
  6. package/dist/node_modules/mediasoup-client/src/Producer.d.ts +151 -0
  7. package/dist/node_modules/mediasoup-client/src/RtpParameters.d.ts +305 -0
  8. package/dist/node_modules/mediasoup-client/src/SctpParameters.d.ts +67 -0
  9. package/dist/node_modules/mediasoup-client/src/Transport.d.ts +212 -0
  10. package/dist/node_modules/mediasoup-client/src/errors.d.ts +12 -0
  11. package/dist/node_modules/mediasoup-client/src/handlers/HandlerInterface.d.ts +84 -0
  12. package/dist/node_modules/mediasoup-client/src/ortc.d.ts +122 -0
  13. package/dist/node_modules/mediasoup-client/src/utils.d.ts +8 -0
  14. package/dist/{EnhancedEventEmitter.d.ts → src/EnhancedEventEmitter.d.ts} +0 -0
  15. package/dist/{constants → src/constants}/common.d.ts +0 -0
  16. package/dist/{constants → src/constants}/events.d.ts +0 -0
  17. package/dist/{constants → src/constants}/simulcastEncodings.d.ts +0 -0
  18. package/dist/{constants → src/constants}/videoConstrains.d.ts +0 -0
  19. package/dist/{engine → src/engine}/DefaultEngineDependenciesFactory.d.ts +0 -0
  20. package/dist/{engine → src/engine}/Logger.d.ts +0 -0
  21. package/dist/{engine → src/engine}/Peer.d.ts +0 -0
  22. package/dist/{engine → src/engine}/PeerConsumer.d.ts +0 -0
  23. package/dist/{engine → src/engine}/PeerProducer.d.ts +0 -0
  24. package/dist/{engine → src/engine}/handlers/ChannelEventHandler.d.ts +0 -0
  25. package/dist/{engine → src/engine}/handlers/MediaSoupEventHandler.d.ts +0 -0
  26. package/dist/{engine → src/engine}/index.d.ts +0 -0
  27. package/dist/{engine → src/engine}/media/index.d.ts +0 -0
  28. package/dist/{engine → src/engine}/media/tracks/AudioTrack.d.ts +0 -0
  29. package/dist/{engine → src/engine}/media/tracks/BaseTrack.d.ts +0 -0
  30. package/dist/{engine → src/engine}/media/tracks/MediaStreamTrackManager.d.ts +0 -0
  31. package/dist/{engine → src/engine}/media/tracks/PeerTrack.d.ts +0 -0
  32. package/dist/{engine → src/engine}/media/tracks/TrackWithCodecOptions.d.ts +0 -0
  33. package/dist/{engine → src/engine}/media/tracks/TrackWithEncodings.d.ts +0 -0
  34. package/dist/{engine → src/engine}/media/tracks/VideoTrack.d.ts +0 -0
  35. package/dist/{engine → src/engine}/network/LoadBalancerClient.d.ts +0 -0
  36. package/dist/{engine → src/engine}/network/Socket.d.ts +0 -0
  37. package/dist/{engine → src/engine}/network/index.d.ts +0 -0
  38. package/dist/{engine → src/engine}/system/index.d.ts +0 -0
  39. package/dist/{errors → src/errors}/LivedigitalSDKError.d.ts +0 -0
  40. package/dist/{errors → src/errors}/UnsupportedError.d.ts +0 -0
  41. package/dist/{helpers → src/helpers}/appDataValidator.d.ts +0 -0
  42. package/dist/{helpers → src/helpers}/datetime.d.ts +0 -0
  43. package/dist/{helpers → src/helpers}/filterStatsCodecs.d.ts +0 -0
  44. package/dist/{helpers → src/helpers}/retry.d.ts +0 -0
  45. package/dist/{index.d.ts → src/index.d.ts} +0 -0
  46. package/dist/{types → src/types}/common.d.ts +3 -0
  47. package/dist/{types → src/types}/engine.d.ts +0 -0
  48. package/dist/{types → src/types}/network.d.ts +0 -0
  49. package/package.json +3 -3
  50. package/src/engine/media/tracks/BaseTrack.ts +2 -1
  51. package/src/engine/media/tracks/PeerTrack.ts +1 -1
  52. package/src/types/common.ts +3 -0
@@ -0,0 +1,114 @@
1
+ import { EnhancedEventEmitter } from './EnhancedEventEmitter';
2
+ import { RtpParameters } from './RtpParameters';
3
+ export declare type ConsumerOptions = {
4
+ id?: string;
5
+ producerId?: string;
6
+ kind?: 'audio' | 'video';
7
+ rtpParameters: RtpParameters;
8
+ appData?: any;
9
+ };
10
+ export declare class Consumer extends EnhancedEventEmitter {
11
+ private readonly _id;
12
+ private readonly _localId;
13
+ private readonly _producerId;
14
+ private _closed;
15
+ private readonly _rtpReceiver?;
16
+ private readonly _track;
17
+ private readonly _rtpParameters;
18
+ private _paused;
19
+ private readonly _appData;
20
+ protected readonly _observer: EnhancedEventEmitter;
21
+ /**
22
+ * @emits transportclose
23
+ * @emits trackended
24
+ * @emits @getstats
25
+ * @emits @close
26
+ * @emits @pause
27
+ * @emits @resume
28
+ */
29
+ constructor({ id, localId, producerId, rtpReceiver, track, rtpParameters, appData }: {
30
+ id: string;
31
+ localId: string;
32
+ producerId: string;
33
+ rtpReceiver?: RTCRtpReceiver;
34
+ track: MediaStreamTrack;
35
+ rtpParameters: RtpParameters;
36
+ appData: any;
37
+ });
38
+ /**
39
+ * Consumer id.
40
+ */
41
+ get id(): string;
42
+ /**
43
+ * Local id.
44
+ */
45
+ get localId(): string;
46
+ /**
47
+ * Associated Producer id.
48
+ */
49
+ get producerId(): string;
50
+ /**
51
+ * Whether the Consumer is closed.
52
+ */
53
+ get closed(): boolean;
54
+ /**
55
+ * Media kind.
56
+ */
57
+ get kind(): string;
58
+ /**
59
+ * Associated RTCRtpReceiver.
60
+ */
61
+ get rtpReceiver(): RTCRtpReceiver | undefined;
62
+ /**
63
+ * The associated track.
64
+ */
65
+ get track(): MediaStreamTrack;
66
+ /**
67
+ * RTP parameters.
68
+ */
69
+ get rtpParameters(): RtpParameters;
70
+ /**
71
+ * Whether the Consumer is paused.
72
+ */
73
+ get paused(): boolean;
74
+ /**
75
+ * App custom data.
76
+ */
77
+ get appData(): any;
78
+ /**
79
+ * Invalid setter.
80
+ */
81
+ set appData(appData: any);
82
+ /**
83
+ * Observer.
84
+ *
85
+ * @emits close
86
+ * @emits pause
87
+ * @emits resume
88
+ * @emits trackended
89
+ */
90
+ get observer(): EnhancedEventEmitter;
91
+ /**
92
+ * Closes the Consumer.
93
+ */
94
+ close(): void;
95
+ /**
96
+ * Transport was closed.
97
+ */
98
+ transportClosed(): void;
99
+ /**
100
+ * Get associated RTCRtpReceiver stats.
101
+ */
102
+ getStats(): Promise<RTCStatsReport>;
103
+ /**
104
+ * Pauses receiving media.
105
+ */
106
+ pause(): void;
107
+ /**
108
+ * Resumes receiving media.
109
+ */
110
+ resume(): void;
111
+ private _onTrackEnded;
112
+ private _handleTrack;
113
+ private _destroyTrack;
114
+ }
@@ -0,0 +1,93 @@
1
+ import { EnhancedEventEmitter } from './EnhancedEventEmitter';
2
+ import { SctpStreamParameters } from './SctpParameters';
3
+ export declare type DataConsumerOptions = {
4
+ id?: string;
5
+ dataProducerId?: string;
6
+ sctpStreamParameters: SctpStreamParameters;
7
+ label?: string;
8
+ protocol?: string;
9
+ appData?: any;
10
+ };
11
+ export declare class DataConsumer extends EnhancedEventEmitter {
12
+ private readonly _id;
13
+ private readonly _dataProducerId;
14
+ private readonly _dataChannel;
15
+ private _closed;
16
+ private readonly _sctpStreamParameters;
17
+ private readonly _appData;
18
+ protected readonly _observer: EnhancedEventEmitter;
19
+ /**
20
+ * @emits transportclose
21
+ * @emits open
22
+ * @emits error - (error: Error)
23
+ * @emits close
24
+ * @emits message - (message: any)
25
+ * @emits @close
26
+ */
27
+ constructor({ id, dataProducerId, dataChannel, sctpStreamParameters, appData }: {
28
+ id: string;
29
+ dataProducerId: string;
30
+ dataChannel: RTCDataChannel;
31
+ sctpStreamParameters: SctpStreamParameters;
32
+ appData: any;
33
+ });
34
+ /**
35
+ * DataConsumer id.
36
+ */
37
+ get id(): string;
38
+ /**
39
+ * Associated DataProducer id.
40
+ */
41
+ get dataProducerId(): string;
42
+ /**
43
+ * Whether the DataConsumer is closed.
44
+ */
45
+ get closed(): boolean;
46
+ /**
47
+ * SCTP stream parameters.
48
+ */
49
+ get sctpStreamParameters(): SctpStreamParameters;
50
+ /**
51
+ * DataChannel readyState.
52
+ */
53
+ get readyState(): RTCDataChannelState;
54
+ /**
55
+ * DataChannel label.
56
+ */
57
+ get label(): string;
58
+ /**
59
+ * DataChannel protocol.
60
+ */
61
+ get protocol(): string;
62
+ /**
63
+ * DataChannel binaryType.
64
+ */
65
+ get binaryType(): BinaryType;
66
+ /**
67
+ * Set DataChannel binaryType.
68
+ */
69
+ set binaryType(binaryType: BinaryType);
70
+ /**
71
+ * App custom data.
72
+ */
73
+ get appData(): any;
74
+ /**
75
+ * Invalid setter.
76
+ */
77
+ set appData(appData: any);
78
+ /**
79
+ * Observer.
80
+ *
81
+ * @emits close
82
+ */
83
+ get observer(): EnhancedEventEmitter;
84
+ /**
85
+ * Closes the DataConsumer.
86
+ */
87
+ close(): void;
88
+ /**
89
+ * Transport was closed.
90
+ */
91
+ transportClosed(): void;
92
+ private _handleDataChannel;
93
+ }
@@ -0,0 +1,97 @@
1
+ import { EnhancedEventEmitter } from './EnhancedEventEmitter';
2
+ import { SctpStreamParameters } from './SctpParameters';
3
+ export declare type DataProducerOptions = {
4
+ ordered?: boolean;
5
+ maxPacketLifeTime?: number;
6
+ maxRetransmits?: number;
7
+ label?: string;
8
+ protocol?: string;
9
+ appData?: any;
10
+ };
11
+ export declare class DataProducer extends EnhancedEventEmitter {
12
+ private readonly _id;
13
+ private readonly _dataChannel;
14
+ private _closed;
15
+ private readonly _sctpStreamParameters;
16
+ private readonly _appData;
17
+ protected readonly _observer: EnhancedEventEmitter;
18
+ /**
19
+ * @emits transportclose
20
+ * @emits open
21
+ * @emits error - (error: Error)
22
+ * @emits close
23
+ * @emits bufferedamountlow
24
+ * @emits @close
25
+ */
26
+ constructor({ id, dataChannel, sctpStreamParameters, appData }: {
27
+ id: string;
28
+ dataChannel: RTCDataChannel;
29
+ sctpStreamParameters: SctpStreamParameters;
30
+ appData: any;
31
+ });
32
+ /**
33
+ * DataProducer id.
34
+ */
35
+ get id(): string;
36
+ /**
37
+ * Whether the DataProducer is closed.
38
+ */
39
+ get closed(): boolean;
40
+ /**
41
+ * SCTP stream parameters.
42
+ */
43
+ get sctpStreamParameters(): SctpStreamParameters;
44
+ /**
45
+ * DataChannel readyState.
46
+ */
47
+ get readyState(): RTCDataChannelState;
48
+ /**
49
+ * DataChannel label.
50
+ */
51
+ get label(): string;
52
+ /**
53
+ * DataChannel protocol.
54
+ */
55
+ get protocol(): string;
56
+ /**
57
+ * DataChannel bufferedAmount.
58
+ */
59
+ get bufferedAmount(): number;
60
+ /**
61
+ * DataChannel bufferedAmountLowThreshold.
62
+ */
63
+ get bufferedAmountLowThreshold(): number;
64
+ /**
65
+ * Set DataChannel bufferedAmountLowThreshold.
66
+ */
67
+ set bufferedAmountLowThreshold(bufferedAmountLowThreshold: number);
68
+ /**
69
+ * App custom data.
70
+ */
71
+ get appData(): any;
72
+ /**
73
+ * Invalid setter.
74
+ */
75
+ set appData(appData: any);
76
+ /**
77
+ * Observer.
78
+ *
79
+ * @emits close
80
+ */
81
+ get observer(): EnhancedEventEmitter;
82
+ /**
83
+ * Closes the DataProducer.
84
+ */
85
+ close(): void;
86
+ /**
87
+ * Transport was closed.
88
+ */
89
+ transportClosed(): void;
90
+ /**
91
+ * Send a message.
92
+ *
93
+ * @param {String|Blob|ArrayBuffer|ArrayBufferView} data.
94
+ */
95
+ send(data: any): void;
96
+ private _handleDataChannel;
97
+ }
@@ -0,0 +1,7 @@
1
+ /// <reference types="node" />
2
+ import { EventEmitter } from 'events';
3
+ export declare class EnhancedEventEmitter extends EventEmitter {
4
+ constructor();
5
+ safeEmit(event: string, ...args: any[]): boolean;
6
+ safeEmitAsPromise(event: string, ...args: any[]): Promise<any>;
7
+ }
@@ -0,0 +1,10 @@
1
+ import debug from 'debug';
2
+ export declare class Logger {
3
+ private readonly _debug;
4
+ private readonly _warn;
5
+ private readonly _error;
6
+ constructor(prefix?: string);
7
+ get debug(): debug.Debugger;
8
+ get warn(): debug.Debugger;
9
+ get error(): debug.Debugger;
10
+ }
@@ -0,0 +1,151 @@
1
+ import { EnhancedEventEmitter } from './EnhancedEventEmitter';
2
+ import { RtpCodecCapability, RtpParameters, RtpEncodingParameters } from './RtpParameters';
3
+ export declare type ProducerOptions = {
4
+ track?: MediaStreamTrack;
5
+ encodings?: RtpEncodingParameters[];
6
+ codecOptions?: ProducerCodecOptions;
7
+ codec?: RtpCodecCapability;
8
+ stopTracks?: boolean;
9
+ disableTrackOnPause?: boolean;
10
+ zeroRtpOnPause?: boolean;
11
+ appData?: any;
12
+ };
13
+ export declare type ProducerCodecOptions = {
14
+ opusStereo?: boolean;
15
+ opusFec?: boolean;
16
+ opusDtx?: boolean;
17
+ opusMaxPlaybackRate?: number;
18
+ opusMaxAverageBitrate?: number;
19
+ opusPtime?: number;
20
+ videoGoogleStartBitrate?: number;
21
+ videoGoogleMaxBitrate?: number;
22
+ videoGoogleMinBitrate?: number;
23
+ };
24
+ export declare class Producer extends EnhancedEventEmitter {
25
+ private readonly _id;
26
+ private readonly _localId;
27
+ private _closed;
28
+ private readonly _rtpSender?;
29
+ private _track;
30
+ private readonly _kind;
31
+ private readonly _rtpParameters;
32
+ private _paused;
33
+ private _maxSpatialLayer;
34
+ private _stopTracks;
35
+ private _disableTrackOnPause;
36
+ private _zeroRtpOnPause;
37
+ private readonly _appData;
38
+ protected readonly _observer: EnhancedEventEmitter;
39
+ /**
40
+ * @emits transportclose
41
+ * @emits trackended
42
+ * @emits @replacetrack - (track: MediaStreamTrack | null)
43
+ * @emits @setmaxspatiallayer - (spatialLayer: string)
44
+ * @emits @setrtpencodingparameters - (params: any)
45
+ * @emits @getstats
46
+ * @emits @close
47
+ */
48
+ constructor({ id, localId, rtpSender, track, rtpParameters, stopTracks, disableTrackOnPause, zeroRtpOnPause, appData }: {
49
+ id: string;
50
+ localId: string;
51
+ rtpSender?: RTCRtpSender;
52
+ track: MediaStreamTrack;
53
+ rtpParameters: RtpParameters;
54
+ stopTracks: boolean;
55
+ disableTrackOnPause: boolean;
56
+ zeroRtpOnPause: boolean;
57
+ appData: any;
58
+ });
59
+ /**
60
+ * Producer id.
61
+ */
62
+ get id(): string;
63
+ /**
64
+ * Local id.
65
+ */
66
+ get localId(): string;
67
+ /**
68
+ * Whether the Producer is closed.
69
+ */
70
+ get closed(): boolean;
71
+ /**
72
+ * Media kind.
73
+ */
74
+ get kind(): string;
75
+ /**
76
+ * Associated RTCRtpSender.
77
+ */
78
+ get rtpSender(): RTCRtpSender | undefined;
79
+ /**
80
+ * The associated track.
81
+ */
82
+ get track(): MediaStreamTrack | null;
83
+ /**
84
+ * RTP parameters.
85
+ */
86
+ get rtpParameters(): RtpParameters;
87
+ /**
88
+ * Whether the Producer is paused.
89
+ */
90
+ get paused(): boolean;
91
+ /**
92
+ * Max spatial layer.
93
+ *
94
+ * @type {Number | undefined}
95
+ */
96
+ get maxSpatialLayer(): number | undefined;
97
+ /**
98
+ * App custom data.
99
+ */
100
+ get appData(): any;
101
+ /**
102
+ * Invalid setter.
103
+ */
104
+ set appData(appData: any);
105
+ /**
106
+ * Observer.
107
+ *
108
+ * @emits close
109
+ * @emits pause
110
+ * @emits resume
111
+ * @emits trackended
112
+ */
113
+ get observer(): EnhancedEventEmitter;
114
+ /**
115
+ * Closes the Producer.
116
+ */
117
+ close(): void;
118
+ /**
119
+ * Transport was closed.
120
+ */
121
+ transportClosed(): void;
122
+ /**
123
+ * Get associated RTCRtpSender stats.
124
+ */
125
+ getStats(): Promise<RTCStatsReport>;
126
+ /**
127
+ * Pauses sending media.
128
+ */
129
+ pause(): void;
130
+ /**
131
+ * Resumes sending media.
132
+ */
133
+ resume(): void;
134
+ /**
135
+ * Replaces the current track with a new one or null.
136
+ */
137
+ replaceTrack({ track }: {
138
+ track: MediaStreamTrack | null;
139
+ }): Promise<void>;
140
+ /**
141
+ * Sets the video max spatial layer to be sent.
142
+ */
143
+ setMaxSpatialLayer(spatialLayer: number): Promise<void>;
144
+ /**
145
+ * Sets the DSCP value.
146
+ */
147
+ setRtpEncodingParameters(params: RTCRtpEncodingParameters): Promise<void>;
148
+ private _onTrackEnded;
149
+ private _handleTrack;
150
+ private _destroyTrack;
151
+ }