@fishjam-cloud/webrtc-client 0.14.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.
Files changed (83) hide show
  1. package/LICENSE.txt +142 -0
  2. package/README.md +30 -0
  3. package/dist/index.d.mts +761 -0
  4. package/dist/index.mjs +4952 -0
  5. package/dist/protobufs/fishjam/media_events/peer/peer.d.ts +125 -0
  6. package/dist/protobufs/fishjam/media_events/peer/peer.js +1214 -0
  7. package/dist/protobufs/fishjam/media_events/server/server.d.ts +197 -0
  8. package/dist/protobufs/fishjam/media_events/server/server.js +2121 -0
  9. package/dist/protobufs/fishjam/media_events/shared.d.ts +38 -0
  10. package/dist/protobufs/fishjam/media_events/shared.js +152 -0
  11. package/dist/webrtc-client/src/CommandsQueue.d.ts +23 -0
  12. package/dist/webrtc-client/src/CommandsQueue.js +87 -0
  13. package/dist/webrtc-client/src/ConnectionManager.d.ts +16 -0
  14. package/dist/webrtc-client/src/ConnectionManager.js +46 -0
  15. package/dist/webrtc-client/src/bitrate.d.ts +12 -0
  16. package/dist/webrtc-client/src/bitrate.js +15 -0
  17. package/dist/webrtc-client/src/deferred.d.ts +8 -0
  18. package/dist/webrtc-client/src/deferred.js +17 -0
  19. package/dist/webrtc-client/src/index.d.ts +5 -0
  20. package/dist/webrtc-client/src/index.js +3 -0
  21. package/dist/webrtc-client/src/internal.d.ts +27 -0
  22. package/dist/webrtc-client/src/internal.js +18 -0
  23. package/dist/webrtc-client/src/mediaEvent.d.ts +13 -0
  24. package/dist/webrtc-client/src/mediaEvent.js +20 -0
  25. package/dist/webrtc-client/src/tracks/Local.d.ts +49 -0
  26. package/dist/webrtc-client/src/tracks/Local.js +243 -0
  27. package/dist/webrtc-client/src/tracks/LocalTrack.d.ts +61 -0
  28. package/dist/webrtc-client/src/tracks/LocalTrack.js +212 -0
  29. package/dist/webrtc-client/src/tracks/LocalTrackManager.d.ts +39 -0
  30. package/dist/webrtc-client/src/tracks/LocalTrackManager.js +76 -0
  31. package/dist/webrtc-client/src/tracks/Remote.d.ts +32 -0
  32. package/dist/webrtc-client/src/tracks/Remote.js +165 -0
  33. package/dist/webrtc-client/src/tracks/RemoteTrack.d.ts +40 -0
  34. package/dist/webrtc-client/src/tracks/RemoteTrack.js +71 -0
  35. package/dist/webrtc-client/src/tracks/TrackCommon.d.ts +9 -0
  36. package/dist/webrtc-client/src/tracks/TrackCommon.js +1 -0
  37. package/dist/webrtc-client/src/tracks/bandwidth.d.ts +1 -0
  38. package/dist/webrtc-client/src/tracks/bandwidth.js +27 -0
  39. package/dist/webrtc-client/src/tracks/encodings.d.ts +3 -0
  40. package/dist/webrtc-client/src/tracks/encodings.js +11 -0
  41. package/dist/webrtc-client/src/tracks/muteTrackUtils.d.ts +3 -0
  42. package/dist/webrtc-client/src/tracks/muteTrackUtils.js +18 -0
  43. package/dist/webrtc-client/src/tracks/transceivers.d.ts +2 -0
  44. package/dist/webrtc-client/src/tracks/transceivers.js +93 -0
  45. package/dist/webrtc-client/src/types.d.ts +259 -0
  46. package/dist/webrtc-client/src/types.js +1 -0
  47. package/dist/webrtc-client/src/webRTCEndpoint.d.ts +298 -0
  48. package/dist/webrtc-client/src/webRTCEndpoint.js +659 -0
  49. package/dist/webrtc-client/tests/events/bandwidthEstimationEvent.test.d.ts +1 -0
  50. package/dist/webrtc-client/tests/events/bandwidthEstimationEvent.test.js +21 -0
  51. package/dist/webrtc-client/tests/events/connectedEvent.test.d.ts +1 -0
  52. package/dist/webrtc-client/tests/events/connectedEvent.test.js +70 -0
  53. package/dist/webrtc-client/tests/events/encodingSwitchedEvent.test.d.ts +1 -0
  54. package/dist/webrtc-client/tests/events/encodingSwitchedEvent.test.js +60 -0
  55. package/dist/webrtc-client/tests/events/endpointAddedEvent.test.d.ts +1 -0
  56. package/dist/webrtc-client/tests/events/endpointAddedEvent.test.js +57 -0
  57. package/dist/webrtc-client/tests/events/endpointRemovedEvent.test.d.ts +1 -0
  58. package/dist/webrtc-client/tests/events/endpointRemovedEvent.test.js +64 -0
  59. package/dist/webrtc-client/tests/events/endpointUpdatedEvent.test.d.ts +1 -0
  60. package/dist/webrtc-client/tests/events/endpointUpdatedEvent.test.js +78 -0
  61. package/dist/webrtc-client/tests/events/trackAddedEvent.test.d.ts +1 -0
  62. package/dist/webrtc-client/tests/events/trackAddedEvent.test.js +84 -0
  63. package/dist/webrtc-client/tests/events/trackRemovedEvent.test.d.ts +1 -0
  64. package/dist/webrtc-client/tests/events/trackRemovedEvent.test.js +26 -0
  65. package/dist/webrtc-client/tests/events/trackUpdatedEvent.test.d.ts +1 -0
  66. package/dist/webrtc-client/tests/events/trackUpdatedEvent.test.js +77 -0
  67. package/dist/webrtc-client/tests/events/vadNotificationEvent.test.d.ts +1 -0
  68. package/dist/webrtc-client/tests/events/vadNotificationEvent.test.js +42 -0
  69. package/dist/webrtc-client/tests/fixtures.d.ts +27 -0
  70. package/dist/webrtc-client/tests/fixtures.js +172 -0
  71. package/dist/webrtc-client/tests/methods/addTrackMethod.test.d.ts +1 -0
  72. package/dist/webrtc-client/tests/methods/addTrackMethod.test.js +46 -0
  73. package/dist/webrtc-client/tests/methods/cleanUpMethod.test.d.ts +1 -0
  74. package/dist/webrtc-client/tests/methods/cleanUpMethod.test.js +14 -0
  75. package/dist/webrtc-client/tests/methods/connectMethod.test.d.ts +1 -0
  76. package/dist/webrtc-client/tests/methods/connectMethod.test.js +40 -0
  77. package/dist/webrtc-client/tests/methods/disconnectMethod.test.d.ts +1 -0
  78. package/dist/webrtc-client/tests/methods/disconnectMethod.test.js +29 -0
  79. package/dist/webrtc-client/tests/mocks.d.ts +5 -0
  80. package/dist/webrtc-client/tests/mocks.js +80 -0
  81. package/dist/webrtc-client/tests/utils.d.ts +3 -0
  82. package/dist/webrtc-client/tests/utils.js +56 -0
  83. package/package.json +80 -0
@@ -0,0 +1,659 @@
1
+ import { MediaEvent_Connect, MediaEvent_Disconnect, MediaEvent_RenegotiateTracks, MediaEvent_UpdateTrackMetadata, } from '@fishjam-cloud/protobufs/peer';
2
+ import { Candidate } from '@fishjam-cloud/protobufs/shared';
3
+ import EventEmitter from 'events';
4
+ import { v4 as uuidv4 } from 'uuid';
5
+ import { CommandsQueue } from './CommandsQueue';
6
+ import { ConnectionManager } from './ConnectionManager';
7
+ import { Deferred } from './deferred';
8
+ import { deserializeServerMediaEvent, serializePeerMediaEvent } from './mediaEvent';
9
+ import { Local } from './tracks/Local';
10
+ import { LocalTrackManager } from './tracks/LocalTrackManager';
11
+ import { Remote } from './tracks/Remote';
12
+ /**
13
+ * Main class that is responsible for connecting to the RTC Engine, sending and receiving media.
14
+ */
15
+ export class WebRTCEndpoint extends EventEmitter {
16
+ localTrackManager;
17
+ remote;
18
+ local;
19
+ commandsQueue;
20
+ proposedIceServers = [];
21
+ bandwidthEstimation = BigInt(0);
22
+ connectionManager;
23
+ clearConnectionCallbacks = null;
24
+ constructor() {
25
+ super();
26
+ const sendEvent = (mediaEvent) => this.sendMediaEvent(mediaEvent);
27
+ const emit = (events, ...args) => {
28
+ this.emit(events, ...args);
29
+ };
30
+ this.remote = new Remote(emit, sendEvent);
31
+ this.local = new Local(emit, sendEvent);
32
+ this.localTrackManager = new LocalTrackManager(this.local, sendEvent);
33
+ this.commandsQueue = new CommandsQueue(this.localTrackManager);
34
+ }
35
+ /**
36
+ * Tries to connect to the RTC Engine. If user is successfully connected then {@link WebRTCEndpointEvents.connected}
37
+ * will be emitted.
38
+ *
39
+ * @param metadata - Any information that other endpoints will receive in {@link WebRTCEndpointEvents.endpointAdded}
40
+ * after accepting this endpoint
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * let webrtc = new WebRTCEndpoint();
45
+ * webrtc.connect({displayName: "Bob"});
46
+ * ```
47
+ */
48
+ connect = (metadata) => {
49
+ this.local.setEndpointMetadata(metadata);
50
+ const connect = MediaEvent_Connect.create({ metadataJson: JSON.stringify(metadata) });
51
+ this.sendMediaEvent({ connect });
52
+ };
53
+ /**
54
+ * Feeds media event received from RTC Engine to {@link WebRTCEndpoint}.
55
+ * This function should be called whenever some media event from RTC Engine
56
+ * was received and can result in {@link WebRTCEndpoint} generating some other
57
+ * media events.
58
+ *
59
+ * @param mediaEvent - String data received over custom signalling layer.
60
+ *
61
+ * @example
62
+ * This example assumes phoenix channels as signalling layer.
63
+ * As phoenix channels require objects, RTC Engine encapsulates binary data into
64
+ * map with one field that is converted to object with one field on the TS side.
65
+ * ```ts
66
+ * webrtcChannel.on("mediaEvent", (event) => webrtc.receiveMediaEvent(event.data));
67
+ * ```
68
+ */
69
+ receiveMediaEvent = async (mediaEvent) => {
70
+ const deserializedMediaEvent = deserializeServerMediaEvent(mediaEvent);
71
+ if (deserializedMediaEvent.connected) {
72
+ const connectedEvent = deserializedMediaEvent.connected;
73
+ this.proposedIceServers = connectedEvent.iceServers;
74
+ this.local.setLocalEndpointId(connectedEvent.endpointId);
75
+ const localEndpointMetadataJson = connectedEvent.endpointIdToEndpoint[connectedEvent.endpointId]?.metadataJson;
76
+ if (localEndpointMetadataJson) {
77
+ this.local.setEndpointMetadata(JSON.parse(localEndpointMetadataJson));
78
+ }
79
+ const connectedEndpoint = connectedEvent.endpointIdToEndpoint[connectedEvent.endpointId];
80
+ if (connectedEndpoint?.metadataJson) {
81
+ const parsedMetadata = JSON.parse(connectedEndpoint?.metadataJson);
82
+ this.local.setEndpointMetadata(parsedMetadata);
83
+ }
84
+ Object.entries(connectedEvent.endpointIdToEndpoint)
85
+ .filter(([endpointId]) => endpointId !== this.local.getEndpoint().id)
86
+ .forEach(([endpointId, endpoint]) => {
87
+ this.remote.addRemoteEndpoint(endpointId, endpoint.metadataJson, endpoint.trackIdToTrack);
88
+ });
89
+ const remoteEndpoints = Object.values(this.remote.getRemoteEndpoints());
90
+ this.emit('connected', this.local.getEndpoint().id, remoteEndpoints);
91
+ return;
92
+ }
93
+ if (this.getEndpointId())
94
+ await this.handleMediaEvent(deserializedMediaEvent);
95
+ };
96
+ getEndpointId = () => this.local.getEndpoint().id;
97
+ onTrackReady = (event) => {
98
+ const stream = event.streams[0];
99
+ if (!stream)
100
+ throw new Error('Cannot find media stream');
101
+ const mid = event.transceiver.mid;
102
+ const remoteTrack = this.remote.getTrackByMid(mid);
103
+ remoteTrack.setReady(stream, event.track);
104
+ this.emit('trackReady', remoteTrack.trackContext);
105
+ };
106
+ /**
107
+ * Retrieves statistics related to the RTCPeerConnection.
108
+ * These statistics provide insights into the performance and status of the connection.
109
+ *
110
+ * @return {Promise<RTCStatsReport>}
111
+ *
112
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/getStats | MDN Web Docs: RTCPeerConnection.getStats()}
113
+ */
114
+ async getStatistics(selector) {
115
+ return (await this.connectionManager?.getConnection().getStats(selector)) ?? new Map();
116
+ }
117
+ /**
118
+ * Returns a snapshot of currently received remote tracks.
119
+ *
120
+ * @example
121
+ * if (webRTCEndpoint.getRemoteTracks()[trackId]?.simulcastConfig?.enabled) {
122
+ * webRTCEndpoint.setTargetTrackEncoding(trackId, encoding);
123
+ * }
124
+ */
125
+ getRemoteTracks() {
126
+ return this.remote.getRemoteTrackContexts();
127
+ }
128
+ /**
129
+ * Returns a snapshot of currently received remote endpoints.
130
+ */
131
+ getRemoteEndpoints() {
132
+ return this.remote.getRemoteEndpoints();
133
+ }
134
+ getLocalEndpoint() {
135
+ return this.local.getEndpoint();
136
+ }
137
+ getBandwidthEstimation() {
138
+ return this.bandwidthEstimation;
139
+ }
140
+ handleMediaEvent = async (event) => {
141
+ if (event.offerData) {
142
+ await this.onOfferData(event.offerData);
143
+ }
144
+ else if (event.tracksAdded) {
145
+ this.localTrackManager.ongoingRenegotiation = true;
146
+ const { trackIdToTrack, endpointId } = event.tracksAdded;
147
+ if (this.getEndpointId() === endpointId)
148
+ return;
149
+ this.remote.addTracks(endpointId, trackIdToTrack);
150
+ }
151
+ else if (event.tracksRemoved) {
152
+ this.localTrackManager.ongoingRenegotiation = true;
153
+ const { endpointId, trackIds } = event.tracksRemoved;
154
+ if (this.getEndpointId() === endpointId)
155
+ return;
156
+ this.remote.removeTracks(trackIds);
157
+ }
158
+ else if (event.sdpAnswer) {
159
+ this.localTrackManager.ongoingRenegotiation = false;
160
+ await this.onSdpAnswer(event.sdpAnswer);
161
+ this.commandsQueue.processNextCommand();
162
+ }
163
+ else if (event.candidate) {
164
+ await this.onRemoteCandidate(event.candidate);
165
+ }
166
+ else if (event.endpointAdded) {
167
+ const { endpointId, metadataJson } = event.endpointAdded;
168
+ if (endpointId === this.getEndpointId())
169
+ return;
170
+ this.remote.addRemoteEndpoint(endpointId, metadataJson);
171
+ }
172
+ else if (event.endpointRemoved) {
173
+ const { endpointId } = event.endpointRemoved;
174
+ if (endpointId === this.local.getEndpoint().id) {
175
+ this.cleanUp();
176
+ this.emit('disconnected');
177
+ return;
178
+ }
179
+ if (this.getEndpointId() === endpointId)
180
+ return;
181
+ this.remote.removeRemoteEndpoint(endpointId);
182
+ }
183
+ else if (event.endpointUpdated) {
184
+ const { endpointId, metadataJson } = event.endpointUpdated;
185
+ if (this.getEndpointId() === endpointId)
186
+ return;
187
+ this.remote.updateRemoteEndpoint(endpointId, metadataJson);
188
+ }
189
+ else if (event.trackUpdated) {
190
+ const { endpointId, trackId, metadataJson } = event.trackUpdated;
191
+ if (this.getEndpointId() === endpointId)
192
+ return;
193
+ this.remote.updateRemoteTrack(endpointId, trackId, metadataJson);
194
+ }
195
+ else if (event.vadNotification) {
196
+ const { trackId, status } = event.vadNotification;
197
+ this.remote.setRemoteTrackVadStatus(trackId, status);
198
+ }
199
+ else if (event.error) {
200
+ console.warn('signaling error', {
201
+ message: event.error.message,
202
+ });
203
+ this.emit('signalingError', {
204
+ message: event.error.message,
205
+ });
206
+ this.disconnect();
207
+ }
208
+ else if (event.trackVariantSwitched) {
209
+ const { trackId, variant } = event.trackVariantSwitched;
210
+ this.remote.setRemoteTrackEncoding(trackId, variant);
211
+ }
212
+ else if (event.trackVariantEnabled) {
213
+ const { trackId, variant } = event.trackVariantEnabled;
214
+ this.remote.enableRemoteTrackEncoding(trackId, variant);
215
+ }
216
+ else if (event.trackVariantDisabled) {
217
+ const { trackId, variant } = event.trackVariantDisabled;
218
+ this.remote.disableRemoteTrackEncoding(trackId, variant);
219
+ }
220
+ };
221
+ onSdpAnswer = async (data) => {
222
+ this.remote.updateMLineIds(data.midToTrackId);
223
+ this.local.updateMLineIds(data.midToTrackId);
224
+ Object.keys(data.midToTrackId)
225
+ .map((mid) => {
226
+ if (!mid)
227
+ throw new Error('TrackId is not defined');
228
+ return mid;
229
+ })
230
+ .map((mid) => this.local.getTrackByMidOrNull(mid))
231
+ .filter((localTrack) => localTrack !== null)
232
+ .forEach((localTrack) => {
233
+ const trackContext = localTrack.trackContext;
234
+ trackContext.negotiationStatus = 'done';
235
+ if (trackContext.pendingMetadataUpdate) {
236
+ const updateTrackMetadata = MediaEvent_UpdateTrackMetadata.create({
237
+ trackId: localTrack.id,
238
+ metadataJson: JSON.stringify(trackContext.metadata),
239
+ });
240
+ this.sendMediaEvent({ updateTrackMetadata });
241
+ }
242
+ trackContext.pendingMetadataUpdate = false;
243
+ });
244
+ if (!this.connectionManager)
245
+ throw new Error(`There is no active RTCPeerConnection`);
246
+ // probably there is no need to reassign it on every onAnswer
247
+ this.connectionManager.setOnTrackReady((event) => {
248
+ this.onTrackReady(event);
249
+ });
250
+ try {
251
+ await this.connectionManager.setRemoteDescription({ sdp: data.sdp, type: 'answer' });
252
+ }
253
+ catch (err) {
254
+ console.error(err);
255
+ }
256
+ };
257
+ /**
258
+ * Adds track that will be sent to the RTC Engine.
259
+ * @param track - Audio or video track e.g. from your microphone or camera.
260
+ * @param trackMetadata - Any information about this track that other endpoints will
261
+ * receive in {@link WebRTCEndpointEvents.endpointAdded}. E.g. this can source of the track - whether it's
262
+ * screensharing, webcam or some other media device.
263
+ * @param simulcastConfig - Simulcast configuration. By default simulcast is disabled.
264
+ * For more information refer to {@link SimulcastConfig}.
265
+ * @param maxBandwidth - maximal bandwidth this track can use.
266
+ * Defaults to 0 which is unlimited.
267
+ * This option has no effect for simulcast and audio tracks.
268
+ * For simulcast tracks use `{@link WebRTCEndpoint.setTrackBandwidth}.
269
+ * @returns {string} Returns id of added track
270
+ * @example
271
+ * ```ts
272
+ * let localStream: MediaStream = new MediaStream();
273
+ * try {
274
+ * localAudioStream = await navigator.mediaDevices.getUserMedia(
275
+ * AUDIO_CONSTRAINTS
276
+ * );
277
+ * localAudioStream
278
+ * .getTracks()
279
+ * .forEach((track) => localStream.addTrack(track));
280
+ * } catch (error) {
281
+ * console.error("Couldn't get microphone permission:", error);
282
+ * }
283
+ *
284
+ * try {
285
+ * localVideoStream = await navigator.mediaDevices.getUserMedia(
286
+ * VIDEO_CONSTRAINTS
287
+ * );
288
+ * localVideoStream
289
+ * .getTracks()
290
+ * .forEach((track) => localStream.addTrack(track));
291
+ * } catch (error) {
292
+ * console.error("Couldn't get camera permission:", error);
293
+ * }
294
+ *
295
+ * localStream
296
+ * .getTracks()
297
+ * .forEach((track) => webrtc.addTrack(track, localStream));
298
+ * ```
299
+ */
300
+ async addTrack(track, trackMetadata, simulcastConfig = {
301
+ enabled: false,
302
+ enabledVariants: [],
303
+ disabledVariants: [],
304
+ }, maxBandwidth = 0) {
305
+ const resolutionNotifier = new Deferred();
306
+ const trackId = this.getTrackId(uuidv4());
307
+ const stream = new MediaStream();
308
+ try {
309
+ stream.addTrack(track);
310
+ this.commandsQueue.pushCommand({
311
+ handler: async () => this.localTrackManager.addTrackHandler(trackId, track, stream, trackMetadata, simulcastConfig, maxBandwidth),
312
+ parse: () => this.localTrackManager.parseAddTrack(track, simulcastConfig, maxBandwidth),
313
+ resolve: 'after-renegotiation',
314
+ resolutionNotifier,
315
+ });
316
+ }
317
+ catch (error) {
318
+ resolutionNotifier.reject(error);
319
+ }
320
+ await resolutionNotifier.promise;
321
+ this.emit('localTrackAdded', {
322
+ trackId,
323
+ track,
324
+ stream,
325
+ trackMetadata,
326
+ simulcastConfig,
327
+ maxBandwidth,
328
+ });
329
+ return trackId;
330
+ }
331
+ /**
332
+ * Replaces a track that is being sent to the RTC Engine.
333
+ * @param trackId - Audio or video track.
334
+ * @param {string} trackId - Id of audio or video track to replace.
335
+ * @param {MediaStreamTrack} newTrack
336
+ * @returns {Promise<boolean>} success
337
+ * @example
338
+ * ```ts
339
+ * // setup camera
340
+ * let localStream: MediaStream = new MediaStream();
341
+ * try {
342
+ * localVideoStream = await navigator.mediaDevices.getUserMedia(
343
+ * VIDEO_CONSTRAINTS
344
+ * );
345
+ * localVideoStream
346
+ * .getTracks()
347
+ * .forEach((track) => localStream.addTrack(track));
348
+ * } catch (error) {
349
+ * console.error("Couldn't get camera permission:", error);
350
+ * }
351
+ * let oldTrackId;
352
+ * localStream
353
+ * .getTracks()
354
+ * .forEach((track) => trackId = webrtc.addTrack(track, localStream));
355
+ *
356
+ * // change camera
357
+ * const oldTrack = localStream.getVideoTracks()[0];
358
+ * let videoDeviceId = "abcd-1234";
359
+ * navigator.mediaDevices.getUserMedia({
360
+ * video: {
361
+ * ...(VIDEO_CONSTRAINTS as {}),
362
+ * deviceId: {
363
+ * exact: videoDeviceId,
364
+ * },
365
+ * }
366
+ * })
367
+ * .then((stream) => {
368
+ * let videoTrack = stream.getVideoTracks()[0];
369
+ * webrtc.replaceTrack(oldTrackId, videoTrack);
370
+ * })
371
+ * .catch((error) => {
372
+ * console.error('Error switching camera', error);
373
+ * })
374
+ * ```
375
+ */
376
+ async replaceTrack(trackId, newTrack) {
377
+ const resolutionNotifier = new Deferred();
378
+ this.commandsQueue.pushCommand({
379
+ handler: () => this.localTrackManager.replaceTrackHandler(this, trackId, newTrack),
380
+ resolutionNotifier,
381
+ resolve: 'on-handler-resolve',
382
+ });
383
+ return resolutionNotifier.promise.then(() => {
384
+ this.emit('localTrackReplaced', { trackId, track: newTrack });
385
+ });
386
+ }
387
+ /**
388
+ * Updates maximum bandwidth for the track identified by trackId.
389
+ * This value directly translates to quality of the stream and, in case of video, to the amount of RTP packets being sent.
390
+ * In case trackId points at the simulcast track bandwidth is split between all of the variant streams proportionally to their resolution.
391
+ *
392
+ * @param {string} trackId
393
+ * @param {BandwidthLimit} bandwidth in kbps
394
+ * @returns {Promise<boolean>} success
395
+ */
396
+ setTrackBandwidth(trackId, bandwidth) {
397
+ if (!this.connectionManager)
398
+ throw new Error(`There is no active RTCPeerConnection`);
399
+ return this.local.setTrackBandwidth(trackId, bandwidth);
400
+ }
401
+ /**
402
+ * Updates maximum bandwidth for the given simulcast encoding of the given track.
403
+ *
404
+ * @param {string} trackId - id of the track
405
+ * @param {string} rid - rid of the encoding
406
+ * @param {BandwidthLimit} bandwidth - desired max bandwidth used by the encoding (in kbps)
407
+ * @returns
408
+ */
409
+ async setEncodingBandwidth(trackId, rid, bandwidth) {
410
+ if (!this.connectionManager)
411
+ throw new Error(`There is no active RTCPeerConnection`);
412
+ return await this.local.setEncodingBandwidth(trackId, rid, bandwidth);
413
+ }
414
+ /**
415
+ * Removes a track from connection that was sent to the RTC Engine.
416
+ * @param {string} trackId - Id of audio or video track to remove.
417
+ * @example
418
+ * ```ts
419
+ * // setup camera
420
+ * let localStream: MediaStream = new MediaStream();
421
+ * try {
422
+ * localVideoStream = await navigator.mediaDevices.getUserMedia(
423
+ * VIDEO_CONSTRAINTS
424
+ * );
425
+ * localVideoStream
426
+ * .getTracks()
427
+ * .forEach((track) => localStream.addTrack(track));
428
+ * } catch (error) {
429
+ * console.error("Couldn't get camera permission:", error);
430
+ * }
431
+ *
432
+ * let trackId
433
+ * localStream
434
+ * .getTracks()
435
+ * .forEach((track) => trackId = webrtc.addTrack(track, localStream));
436
+ *
437
+ * // remove track
438
+ * webrtc.removeTrack(trackId)
439
+ * ```
440
+ */
441
+ async removeTrack(trackId) {
442
+ const resolutionNotifier = new Deferred();
443
+ this.commandsQueue.pushCommand({
444
+ handler: async () => this.localTrackManager.removeTrackHandler(trackId),
445
+ resolutionNotifier,
446
+ resolve: 'after-renegotiation',
447
+ });
448
+ await resolutionNotifier.promise;
449
+ this.emit('localTrackRemoved', {
450
+ trackId,
451
+ });
452
+ }
453
+ /**
454
+ * Sets track variant that server should send to the client library.
455
+ *
456
+ * The variant will be sent whenever it is available.
457
+ * If chosen variant is temporarily unavailable, some other variant
458
+ * will be sent until the chosen variant becomes active again.
459
+ *
460
+ * @param {string} trackId - id of track
461
+ * @param {Encoding} variant - variant to receive
462
+ * @example
463
+ * ```ts
464
+ * webrtc.setTargetTrackEncoding(incomingTrackCtx.trackId, "l")
465
+ * ```
466
+ */
467
+ setTargetTrackEncoding(trackId, variant) {
468
+ this.remote.setTargetRemoteTrackEncoding(trackId, variant);
469
+ }
470
+ /**
471
+ * Enables track encoding so that it will be sent to the server.
472
+ * @param {string} trackId - id of track
473
+ * @param {Encoding} encoding - encoding that will be enabled
474
+ * @example
475
+ * ```ts
476
+ * const trackId = webrtc.addTrack(track, stream, {}, {enabled: true, activeEncodings: ["l", "m", "h"]});
477
+ * webrtc.disableTrackEncoding(trackId, "l");
478
+ * // wait some time
479
+ * webrtc.enableTrackEncoding(trackId, "l");
480
+ * ```
481
+ */
482
+ enableTrackEncoding = async (trackId, encoding) => {
483
+ await this.local.enableLocalTrackEncoding(trackId, encoding);
484
+ };
485
+ /**
486
+ * Disables track encoding so that it will be no longer sent to the server.
487
+ * @param {string} trackId - id of track
488
+ * @param {Encoding} encoding - encoding that will be disabled
489
+ * @example
490
+ * ```ts
491
+ * const trackId = webrtc.addTrack(track, stream, {}, {enabled: true, activeEncodings: ["l", "m", "h"]});
492
+ * webrtc.disableTrackEncoding(trackId, "l");
493
+ * ```
494
+ */
495
+ disableTrackEncoding = async (trackId, encoding) => {
496
+ await this.local.disableLocalTrackEncoding(trackId, encoding);
497
+ };
498
+ /**
499
+ * Updates the metadata for the current endpoint.
500
+ * @param metadata - Data about this endpoint that other endpoints will receive upon being added.
501
+ *
502
+ * If the metadata is different from what is already tracked in the room, the optional
503
+ * event `endpointUpdated` will be emitted for other endpoint in the room.
504
+ */
505
+ updateEndpointMetadata = (metadata) => {
506
+ this.local.updateEndpointMetadata(metadata);
507
+ };
508
+ /**
509
+ * Updates the metadata for a specific track.
510
+ * @param trackId - trackId (generated in addTrack) of audio or video track.
511
+ * @param trackMetadata - Data about this track that other endpoint will receive upon being added.
512
+ *
513
+ * If the metadata is different from what is already tracked in the room, the optional
514
+ * event `trackUpdated` will be emitted for other endpoints in the room.
515
+ */
516
+ updateTrackMetadata = (trackId, trackMetadata) => {
517
+ this.local.updateLocalTrackMetadata(trackId, trackMetadata);
518
+ };
519
+ /**
520
+ * Disconnects from the room. This function should be called when user disconnects from the room
521
+ * in a clean way e.g. by clicking a dedicated, custom button `disconnect`.
522
+ * As a result there will be generated one more media event that should be
523
+ * sent to the RTC Engine. Thanks to it each other endpoint will be notified
524
+ * that endpoint was removed in {@link WebRTCEndpointEvents.endpointRemoved},
525
+ */
526
+ disconnect = () => {
527
+ const disconnect = MediaEvent_Disconnect.create();
528
+ this.sendMediaEvent({ disconnect });
529
+ this.emit('disconnectRequested', {});
530
+ this.cleanUp();
531
+ };
532
+ /**
533
+ * Cleans up {@link WebRTCEndpoint} instance.
534
+ */
535
+ cleanUp = () => {
536
+ if (this.connectionManager) {
537
+ this.clearConnectionCallbacks?.();
538
+ this.connectionManager?.getConnection().close();
539
+ this.commandsQueue.cleanUp();
540
+ this.localTrackManager.cleanUp();
541
+ }
542
+ this.connectionManager = undefined;
543
+ };
544
+ getTrackId(uuid) {
545
+ return `${this.getEndpointId()}:${uuid}`;
546
+ }
547
+ sendMediaEvent = (mediaEvent) => {
548
+ this.emit('sendMediaEvent', serializePeerMediaEvent(mediaEvent));
549
+ };
550
+ async createAndSendOffer() {
551
+ const connection = this.connectionManager;
552
+ if (!connection)
553
+ return;
554
+ try {
555
+ this.localTrackManager.updateSenders();
556
+ const offer = await connection.getConnection().createOffer();
557
+ if (!this.connectionManager) {
558
+ console.warn('RTCPeerConnection stopped or restarted');
559
+ return;
560
+ }
561
+ await connection.getConnection().setLocalDescription(offer);
562
+ if (!this.connectionManager) {
563
+ console.warn('RTCPeerConnection stopped or restarted');
564
+ return;
565
+ }
566
+ const sdpOffer = this.local.createSdpOfferEvent(offer);
567
+ this.sendMediaEvent({ sdpOffer });
568
+ this.local.setLocalTrackStatusToOffered();
569
+ }
570
+ catch (error) {
571
+ console.error(error);
572
+ }
573
+ }
574
+ onOfferData = async (offerData) => {
575
+ const connectionManager = this.connectionManager ?? this.createNewConnection();
576
+ if (offerData.tracksTypes) {
577
+ connectionManager.addTransceiversIfNeeded(offerData.tracksTypes);
578
+ }
579
+ await this.createAndSendOffer();
580
+ };
581
+ setupConnectionListeners = (connection) => {
582
+ const onIceCandidate = (event) => this.onLocalCandidate(event);
583
+ const onIceCandidateError = (event) => this.onIceCandidateError(event);
584
+ const onConnectionStateChange = (event) => this.onConnectionStateChange(event);
585
+ const onIceConnectionStateChange = (event) => this.onIceConnectionStateChange(event);
586
+ this.clearConnectionCallbacks = () => {
587
+ connection.removeEventListener('icecandidate', onIceCandidate);
588
+ connection.removeEventListener('icecandidateerror', onIceCandidateError);
589
+ connection.removeEventListener('connectionstatechange', onConnectionStateChange);
590
+ connection.removeEventListener('iceconnectionstatechange', onIceConnectionStateChange);
591
+ };
592
+ connection.addEventListener('icecandidate', onIceCandidate);
593
+ connection.addEventListener('icecandidateerror', onIceCandidateError);
594
+ connection.addEventListener('connectionstatechange', onConnectionStateChange);
595
+ connection.addEventListener('iceconnectionstatechange', onIceConnectionStateChange);
596
+ };
597
+ createNewConnection = () => {
598
+ const connectionManager = new ConnectionManager(this.proposedIceServers);
599
+ this.localTrackManager.updateConnection(connectionManager);
600
+ this.local.updateConnection(connectionManager);
601
+ this.setupConnectionListeners(connectionManager.getConnection());
602
+ this.commandsQueue.initConnection(connectionManager);
603
+ this.local.addAllTracksToConnection();
604
+ this.connectionManager = connectionManager;
605
+ return connectionManager;
606
+ };
607
+ onRemoteCandidate = async (candidate) => {
608
+ try {
609
+ const iceCandidate = new RTCIceCandidate(candidate);
610
+ if (!this.connectionManager) {
611
+ throw new Error('Received new remote candidate but RTCConnection is undefined');
612
+ }
613
+ await this.connectionManager.addIceCandidate(iceCandidate);
614
+ }
615
+ catch (error) {
616
+ console.error(error);
617
+ }
618
+ };
619
+ onLocalCandidate = (event) => {
620
+ if (!event.candidate)
621
+ return;
622
+ const candidate = Candidate.create({
623
+ candidate: event.candidate.candidate,
624
+ sdpMLineIndex: event.candidate.sdpMLineIndex ?? undefined,
625
+ sdpMid: event.candidate.sdpMid ?? undefined,
626
+ usernameFragment: event.candidate.usernameFragment ?? undefined,
627
+ });
628
+ this.sendMediaEvent({ candidate });
629
+ };
630
+ onIceCandidateError = (event) => {
631
+ console.warn(event);
632
+ };
633
+ onConnectionStateChange = (event) => {
634
+ switch (this.localTrackManager.connection?.getConnection().connectionState) {
635
+ case 'failed':
636
+ this.emit('connectionError', {
637
+ message: 'RTCPeerConnection failed',
638
+ event,
639
+ });
640
+ break;
641
+ }
642
+ };
643
+ onIceConnectionStateChange = (event) => {
644
+ switch (this.localTrackManager.connection?.getConnection().iceConnectionState) {
645
+ case 'disconnected':
646
+ console.warn('ICE connection: disconnected');
647
+ // Requesting renegotiation on ICE connection state failed fixes RTCPeerConnection
648
+ // when the user changes their WiFi network.
649
+ this.sendMediaEvent({ renegotiateTracks: MediaEvent_RenegotiateTracks.create() });
650
+ break;
651
+ case 'failed':
652
+ this.emit('connectionError', {
653
+ message: 'ICE connection failed',
654
+ event,
655
+ });
656
+ break;
657
+ }
658
+ };
659
+ }
@@ -0,0 +1,21 @@
1
+ // import { WebRTCEndpoint } from '../../src';
2
+ // import { endpointId, trackId } from '../fixtures';
3
+ // import { setupRoom } from '../utils';
4
+ // import { expect, it } from 'vitest';
5
+ // TODO Add the test back once the bandwidth estimation event is implemented
6
+ // it('Change existing track bandwidth estimation', () =>
7
+ // new Promise((done) => {
8
+ // // Given
9
+ // const webRTCEndpoint = new WebRTCEndpoint();
10
+ // setupRoom(webRTCEndpoint, endpointId, trackId);
11
+ // const bandwidthEstimationEvent = createBandwidthEstimationEvent();
12
+ // webRTCEndpoint.on('bandwidthEstimationChanged', (estimation) => {
13
+ // // Then
14
+ // expect(estimation).toBe(bandwidthEstimationEvent.data.data.estimation);
15
+ // done('');
16
+ // });
17
+ // // When
18
+ // webRTCEndpoint.receiveMediaEvent(JSON.stringify(bandwidthEstimationEvent));
19
+ // }));
20
+ import { describe } from 'vitest';
21
+ describe.skip('Skipping bandwidth estimation, not yet implemented in Fishjam', () => { });