@dtelecom/livekit-client 1.12.4 → 1.12.6

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 (159) hide show
  1. package/README.md +3 -39
  2. package/dist/livekit-client.e2ee.worker.js +1 -1
  3. package/dist/livekit-client.e2ee.worker.js.map +1 -1
  4. package/dist/livekit-client.e2ee.worker.mjs +301 -389
  5. package/dist/livekit-client.e2ee.worker.mjs.map +1 -1
  6. package/dist/livekit-client.esm.mjs +15291 -13060
  7. package/dist/livekit-client.esm.mjs.map +1 -1
  8. package/dist/livekit-client.umd.js +1 -1
  9. package/dist/livekit-client.umd.js.map +1 -1
  10. package/dist/src/api/SignalClient.d.ts +2 -2
  11. package/dist/src/api/SignalClient.d.ts.map +1 -1
  12. package/dist/src/connectionHelper/ConnectionCheck.d.ts +2 -3
  13. package/dist/src/connectionHelper/ConnectionCheck.d.ts.map +1 -1
  14. package/dist/src/connectionHelper/checks/Checker.d.ts +2 -3
  15. package/dist/src/connectionHelper/checks/Checker.d.ts.map +1 -1
  16. package/dist/src/connectionHelper/checks/webrtc.d.ts.map +1 -1
  17. package/dist/src/connectionHelper/checks/websocket.d.ts.map +1 -1
  18. package/dist/src/e2ee/E2eeManager.d.ts +2 -4
  19. package/dist/src/e2ee/E2eeManager.d.ts.map +1 -1
  20. package/dist/src/e2ee/KeyProvider.d.ts +2 -4
  21. package/dist/src/e2ee/KeyProvider.d.ts.map +1 -1
  22. package/dist/src/e2ee/constants.d.ts +0 -1
  23. package/dist/src/e2ee/constants.d.ts.map +1 -1
  24. package/dist/src/e2ee/types.d.ts +0 -1
  25. package/dist/src/e2ee/types.d.ts.map +1 -1
  26. package/dist/src/e2ee/worker/FrameCryptor.d.ts +2 -4
  27. package/dist/src/e2ee/worker/FrameCryptor.d.ts.map +1 -1
  28. package/dist/src/e2ee/worker/ParticipantKeyHandler.d.ts +3 -14
  29. package/dist/src/e2ee/worker/ParticipantKeyHandler.d.ts.map +1 -1
  30. package/dist/src/index.d.ts +1 -1
  31. package/dist/src/index.d.ts.map +1 -1
  32. package/dist/src/proto/google/protobuf/timestamp.d.ts +146 -0
  33. package/dist/src/proto/google/protobuf/timestamp.d.ts.map +1 -0
  34. package/dist/src/proto/livekit_models.d.ts +2399 -0
  35. package/dist/src/proto/livekit_models.d.ts.map +1 -0
  36. package/dist/src/proto/livekit_rtc.d.ts +14352 -0
  37. package/dist/src/proto/livekit_rtc.d.ts.map +1 -0
  38. package/dist/src/room/PCTransport.d.ts +1 -2
  39. package/dist/src/room/PCTransport.d.ts.map +1 -1
  40. package/dist/src/room/RTCEngine.d.ts +5 -9
  41. package/dist/src/room/RTCEngine.d.ts.map +1 -1
  42. package/dist/src/room/RegionUrlProvider.d.ts +1 -4
  43. package/dist/src/room/RegionUrlProvider.d.ts.map +1 -1
  44. package/dist/src/room/Room.d.ts +11 -15
  45. package/dist/src/room/Room.d.ts.map +1 -1
  46. package/dist/src/room/participant/LocalParticipant.d.ts +2 -2
  47. package/dist/src/room/participant/LocalParticipant.d.ts.map +1 -1
  48. package/dist/src/room/participant/Participant.d.ts +3 -5
  49. package/dist/src/room/participant/Participant.d.ts.map +1 -1
  50. package/dist/src/room/participant/ParticipantTrackPermission.d.ts +1 -1
  51. package/dist/src/room/participant/ParticipantTrackPermission.d.ts.map +1 -1
  52. package/dist/src/room/participant/RemoteParticipant.d.ts +3 -2
  53. package/dist/src/room/participant/RemoteParticipant.d.ts.map +1 -1
  54. package/dist/src/room/timers.d.ts +4 -5
  55. package/dist/src/room/timers.d.ts.map +1 -1
  56. package/dist/src/room/track/LocalTrackPublication.d.ts +1 -1
  57. package/dist/src/room/track/LocalTrackPublication.d.ts.map +1 -1
  58. package/dist/src/room/track/LocalVideoTrack.d.ts +2 -2
  59. package/dist/src/room/track/LocalVideoTrack.d.ts.map +1 -1
  60. package/dist/src/room/track/RemoteTrackPublication.d.ts +1 -1
  61. package/dist/src/room/track/RemoteTrackPublication.d.ts.map +1 -1
  62. package/dist/src/room/track/Track.d.ts +4 -6
  63. package/dist/src/room/track/Track.d.ts.map +1 -1
  64. package/dist/src/room/track/TrackPublication.d.ts +5 -7
  65. package/dist/src/room/track/TrackPublication.d.ts.map +1 -1
  66. package/dist/src/room/track/create.d.ts.map +1 -1
  67. package/dist/src/room/track/options.d.ts +0 -7
  68. package/dist/src/room/track/options.d.ts.map +1 -1
  69. package/dist/src/room/track/utils.d.ts +1 -5
  70. package/dist/src/room/track/utils.d.ts.map +1 -1
  71. package/dist/src/room/utils.d.ts +1 -3
  72. package/dist/src/room/utils.d.ts.map +1 -1
  73. package/dist/src/test/mocks.d.ts +4 -4
  74. package/dist/src/test/mocks.d.ts.map +1 -1
  75. package/dist/ts4.2/src/api/SignalClient.d.ts +2 -2
  76. package/dist/ts4.2/src/connectionHelper/ConnectionCheck.d.ts +2 -3
  77. package/dist/ts4.2/src/connectionHelper/checks/Checker.d.ts +2 -3
  78. package/dist/ts4.2/src/e2ee/E2eeManager.d.ts +2 -4
  79. package/dist/ts4.2/src/e2ee/KeyProvider.d.ts +2 -4
  80. package/dist/ts4.2/src/e2ee/constants.d.ts +0 -1
  81. package/dist/ts4.2/src/e2ee/types.d.ts +0 -1
  82. package/dist/ts4.2/src/e2ee/worker/FrameCryptor.d.ts +2 -4
  83. package/dist/ts4.2/src/e2ee/worker/ParticipantKeyHandler.d.ts +3 -14
  84. package/dist/ts4.2/src/index.d.ts +1 -1
  85. package/dist/ts4.2/src/proto/google/protobuf/timestamp.d.ts +150 -0
  86. package/dist/ts4.2/src/proto/livekit_models.d.ts +2659 -0
  87. package/dist/ts4.2/src/proto/livekit_rtc.d.ts +15764 -0
  88. package/dist/ts4.2/src/room/PCTransport.d.ts +1 -2
  89. package/dist/ts4.2/src/room/RTCEngine.d.ts +5 -9
  90. package/dist/ts4.2/src/room/RegionUrlProvider.d.ts +1 -4
  91. package/dist/ts4.2/src/room/Room.d.ts +11 -15
  92. package/dist/ts4.2/src/room/participant/LocalParticipant.d.ts +2 -2
  93. package/dist/ts4.2/src/room/participant/Participant.d.ts +3 -5
  94. package/dist/ts4.2/src/room/participant/ParticipantTrackPermission.d.ts +1 -1
  95. package/dist/ts4.2/src/room/participant/RemoteParticipant.d.ts +3 -2
  96. package/dist/ts4.2/src/room/timers.d.ts +4 -5
  97. package/dist/ts4.2/src/room/track/LocalTrackPublication.d.ts +1 -1
  98. package/dist/ts4.2/src/room/track/LocalVideoTrack.d.ts +2 -2
  99. package/dist/ts4.2/src/room/track/RemoteTrackPublication.d.ts +1 -1
  100. package/dist/ts4.2/src/room/track/Track.d.ts +4 -6
  101. package/dist/ts4.2/src/room/track/TrackPublication.d.ts +5 -7
  102. package/dist/ts4.2/src/room/track/options.d.ts +0 -7
  103. package/dist/ts4.2/src/room/track/utils.d.ts +1 -5
  104. package/dist/ts4.2/src/room/utils.d.ts +1 -3
  105. package/dist/ts4.2/src/test/mocks.d.ts +4 -4
  106. package/package.json +11 -11
  107. package/src/api/SignalClient.ts +101 -104
  108. package/src/connectionHelper/ConnectionCheck.ts +2 -3
  109. package/src/connectionHelper/checks/Checker.ts +3 -3
  110. package/src/connectionHelper/checks/webrtc.ts +2 -66
  111. package/src/connectionHelper/checks/websocket.ts +0 -4
  112. package/src/e2ee/E2eeManager.ts +3 -4
  113. package/src/e2ee/KeyProvider.ts +2 -3
  114. package/src/e2ee/constants.ts +0 -4
  115. package/src/e2ee/types.ts +0 -1
  116. package/src/e2ee/worker/FrameCryptor.test.ts +3 -1
  117. package/src/e2ee/worker/FrameCryptor.ts +5 -5
  118. package/src/e2ee/worker/ParticipantKeyHandler.ts +6 -37
  119. package/src/e2ee/worker/e2ee.worker.ts +1 -1
  120. package/src/index.ts +1 -1
  121. package/src/proto/google/protobuf/timestamp.ts +230 -0
  122. package/src/proto/livekit_models.ts +4006 -0
  123. package/src/proto/livekit_rtc.ts +4672 -0
  124. package/src/room/PCTransport.ts +1 -1
  125. package/src/room/RTCEngine.ts +18 -24
  126. package/src/room/RegionUrlProvider.ts +2 -11
  127. package/src/room/Room.test.ts +0 -1
  128. package/src/room/Room.ts +79 -158
  129. package/src/room/participant/LocalParticipant.ts +59 -43
  130. package/src/room/participant/Participant.ts +4 -6
  131. package/src/room/participant/ParticipantTrackPermission.ts +3 -3
  132. package/src/room/participant/RemoteParticipant.ts +6 -5
  133. package/src/room/participant/publishUtils.test.ts +0 -1
  134. package/src/room/track/LocalTrackPublication.ts +1 -1
  135. package/src/room/track/LocalVideoTrack.test.ts +1 -2
  136. package/src/room/track/LocalVideoTrack.ts +22 -22
  137. package/src/room/track/RemoteTrackPublication.ts +7 -12
  138. package/src/room/track/RemoteVideoTrack.test.ts +4 -5
  139. package/src/room/track/Track.ts +6 -9
  140. package/src/room/track/TrackPublication.ts +5 -7
  141. package/src/room/track/create.ts +17 -9
  142. package/src/room/track/facingMode.test.ts +0 -1
  143. package/src/room/track/options.ts +0 -6
  144. package/src/room/track/utils.test.ts +0 -1
  145. package/src/room/track/utils.ts +2 -44
  146. package/src/room/utils.ts +4 -20
  147. package/src/test/mocks.ts +5 -7
  148. package/src/utils/AsyncQueue.test.ts +0 -1
  149. package/src/utils/browserParser.test.ts +3 -33
  150. package/src/utils/browserParser.ts +1 -1
  151. package/dist/src/proto/livekit_models_pb.d.ts +0 -1264
  152. package/dist/src/proto/livekit_models_pb.d.ts.map +0 -1
  153. package/dist/src/proto/livekit_rtc_pb.d.ts +0 -1373
  154. package/dist/src/proto/livekit_rtc_pb.d.ts.map +0 -1
  155. package/dist/ts4.2/src/proto/livekit_models_pb.d.ts +0 -1264
  156. package/dist/ts4.2/src/proto/livekit_rtc_pb.d.ts +0 -1373
  157. package/src/proto/livekit_models_pb.ts +0 -2096
  158. package/src/proto/livekit_rtc_pb.ts +0 -2332
  159. package/src/room/utils.test.ts +0 -16
@@ -1,4 +1,3 @@
1
- import { protoInt64 } from '@bufbuild/protobuf';
2
1
  import log from '../logger';
3
2
  import {
4
3
  ClientInfo,
@@ -8,14 +7,12 @@ import {
8
7
  Room,
9
8
  SpeakerInfo,
10
9
  VideoLayer,
11
- } from '../proto/livekit_models_pb';
10
+ } from '../proto/livekit_models';
12
11
  import {
13
12
  AddTrackRequest,
14
13
  ConnectionQualityUpdate,
15
14
  JoinResponse,
16
15
  LeaveRequest,
17
- MuteTrackRequest,
18
- Ping,
19
16
  ReconnectResponse,
20
17
  SessionDescription,
21
18
  SignalRequest,
@@ -24,22 +21,18 @@ import {
24
21
  SimulateScenario,
25
22
  StreamStateUpdate,
26
23
  SubscribedQualityUpdate,
27
- SubscriptionPermission,
28
24
  SubscriptionPermissionUpdate,
29
25
  SubscriptionResponse,
30
26
  SyncState,
31
27
  TrackPermission,
32
28
  TrackPublishedResponse,
33
29
  TrackUnpublishedResponse,
34
- TrickleRequest,
35
- UpdateParticipantMetadata,
36
30
  UpdateSubscription,
37
31
  UpdateTrackSettings,
38
- UpdateVideoLayers,
39
- } from '../proto/livekit_rtc_pb';
32
+ } from '../proto/livekit_rtc';
40
33
  import { ConnectionError, ConnectionErrorReason } from '../room/errors';
41
34
  import CriticalTimers from '../room/timers';
42
- import { Mutex, getClientInfo, isReactNative, sleep, toWebsocketUrl } from '../room/utils';
35
+ import { Mutex, getClientInfo, isReactNative, sleep } from '../room/utils';
43
36
  import { AsyncQueue } from '../utils/AsyncQueue';
44
37
 
45
38
  // internal options
@@ -72,7 +65,7 @@ export interface SignalOptions {
72
65
 
73
66
  type SignalMessage = SignalRequest['message'];
74
67
 
75
- type SignalKind = NonNullable<SignalMessage>['case'];
68
+ type SignalKind = NonNullable<SignalMessage>['$case'];
76
69
 
77
70
  const passThroughQueueSignals: Array<SignalKind> = [
78
71
  'syncState',
@@ -84,7 +77,7 @@ const passThroughQueueSignals: Array<SignalKind> = [
84
77
  ];
85
78
 
86
79
  function canPassThroughQueue(req: SignalMessage): boolean {
87
- const canPass = passThroughQueueSignals.indexOf(req!.case) >= 0;
80
+ const canPass = passThroughQueueSignals.indexOf(req!.$case) >= 0;
88
81
  log.trace('request allowed to bypass queue:', { canPass, req });
89
82
  return canPass;
90
83
  }
@@ -213,7 +206,9 @@ export class SignalClient {
213
206
  abortSignal?: AbortSignal,
214
207
  ): Promise<JoinResponse | ReconnectResponse | void> {
215
208
  this.connectOptions = opts;
216
- url = toWebsocketUrl(url);
209
+ if (url.startsWith('http')) {
210
+ url = url.replace('http', 'ws');
211
+ }
217
212
  // strip trailing slash
218
213
  url = url.replace(/\/$/, '');
219
214
  url += '/rtc';
@@ -273,9 +268,9 @@ export class SignalClient {
273
268
  let resp: SignalResponse;
274
269
  if (typeof ev.data === 'string') {
275
270
  const json = JSON.parse(ev.data);
276
- resp = SignalResponse.fromJson(json);
271
+ resp = SignalResponse.fromJSON(json);
277
272
  } else if (ev.data instanceof ArrayBuffer) {
278
- resp = SignalResponse.fromBinary(new Uint8Array(ev.data));
273
+ resp = SignalResponse.decode(new Uint8Array(ev.data));
279
274
  } else {
280
275
  log.error(`could not decode websocket message: ${typeof ev.data}`);
281
276
  return;
@@ -284,11 +279,11 @@ export class SignalClient {
284
279
  if (!this.isConnected) {
285
280
  let shouldProcessMessage = false;
286
281
  // handle join message only
287
- if (resp.message?.case === 'join') {
282
+ if (resp.message?.$case === 'join') {
288
283
  this.isConnected = true;
289
284
  abortSignal?.removeEventListener('abort', abortHandler);
290
- this.pingTimeoutDuration = resp.message.value.pingTimeout;
291
- this.pingIntervalDuration = resp.message.value.pingInterval;
285
+ this.pingTimeoutDuration = resp.message.join.pingTimeout;
286
+ this.pingIntervalDuration = resp.message.join.pingInterval;
292
287
 
293
288
  if (this.pingTimeoutDuration && this.pingTimeoutDuration > 0) {
294
289
  log.debug('ping config', {
@@ -297,14 +292,14 @@ export class SignalClient {
297
292
  });
298
293
  this.startPingInterval();
299
294
  }
300
- resolve(resp.message.value);
295
+ resolve(resp.message.join);
301
296
  } else if (opts.reconnect) {
302
297
  // in reconnecting, any message received means signal reconnected
303
298
  this.isConnected = true;
304
299
  abortSignal?.removeEventListener('abort', abortHandler);
305
300
  this.startPingInterval();
306
- if (resp.message?.case === 'reconnect') {
307
- resolve(resp.message?.value);
301
+ if (resp.message?.$case === 'reconnect') {
302
+ resolve(resp.message?.reconnect);
308
303
  } else {
309
304
  resolve();
310
305
  shouldProcessMessage = true;
@@ -313,7 +308,7 @@ export class SignalClient {
313
308
  // non-reconnect case, should receive join response first
314
309
  reject(
315
310
  new ConnectionError(
316
- `did not receive join response, got ${resp.message?.case} instead`,
311
+ `did not receive join response, got ${resp.message?.$case} instead`,
317
312
  ),
318
313
  );
319
314
  }
@@ -387,8 +382,8 @@ export class SignalClient {
387
382
  sendOffer(offer: RTCSessionDescriptionInit) {
388
383
  log.debug('sending offer', offer);
389
384
  this.sendRequest({
390
- case: 'offer',
391
- value: toProtoSessionDescription(offer),
385
+ $case: 'offer',
386
+ offer: toProtoSessionDescription(offer),
392
387
  });
393
388
  }
394
389
 
@@ -396,94 +391,94 @@ export class SignalClient {
396
391
  sendAnswer(answer: RTCSessionDescriptionInit) {
397
392
  log.debug('sending answer');
398
393
  return this.sendRequest({
399
- case: 'answer',
400
- value: toProtoSessionDescription(answer),
394
+ $case: 'answer',
395
+ answer: toProtoSessionDescription(answer),
401
396
  });
402
397
  }
403
398
 
404
399
  sendIceCandidate(candidate: RTCIceCandidateInit, target: SignalTarget) {
405
400
  log.trace('sending ice candidate', candidate);
406
401
  return this.sendRequest({
407
- case: 'trickle',
408
- value: new TrickleRequest({
402
+ $case: 'trickle',
403
+ trickle: {
409
404
  candidateInit: JSON.stringify(candidate),
410
405
  target,
411
- }),
406
+ },
412
407
  });
413
408
  }
414
409
 
415
410
  sendMuteTrack(trackSid: string, muted: boolean) {
416
411
  return this.sendRequest({
417
- case: 'mute',
418
- value: new MuteTrackRequest({
412
+ $case: 'mute',
413
+ mute: {
419
414
  sid: trackSid,
420
415
  muted,
421
- }),
416
+ },
422
417
  });
423
418
  }
424
419
 
425
420
  sendAddTrack(req: AddTrackRequest) {
426
421
  return this.sendRequest({
427
- case: 'addTrack',
428
- value: req,
422
+ $case: 'addTrack',
423
+ addTrack: req,
429
424
  });
430
425
  }
431
426
 
432
427
  sendUpdateLocalMetadata(metadata: string, name: string) {
433
428
  return this.sendRequest({
434
- case: 'updateMetadata',
435
- value: new UpdateParticipantMetadata({
429
+ $case: 'updateMetadata',
430
+ updateMetadata: {
436
431
  metadata,
437
432
  name,
438
- }),
433
+ },
439
434
  });
440
435
  }
441
436
 
442
437
  sendUpdateTrackSettings(settings: UpdateTrackSettings) {
443
438
  this.sendRequest({
444
- case: 'trackSetting',
445
- value: settings,
439
+ $case: 'trackSetting',
440
+ trackSetting: settings,
446
441
  });
447
442
  }
448
443
 
449
444
  sendUpdateSubscription(sub: UpdateSubscription) {
450
445
  return this.sendRequest({
451
- case: 'subscription',
452
- value: sub,
446
+ $case: 'subscription',
447
+ subscription: sub,
453
448
  });
454
449
  }
455
450
 
456
451
  sendSyncState(sync: SyncState) {
457
452
  return this.sendRequest({
458
- case: 'syncState',
459
- value: sync,
453
+ $case: 'syncState',
454
+ syncState: sync,
460
455
  });
461
456
  }
462
457
 
463
458
  sendUpdateVideoLayers(trackSid: string, layers: VideoLayer[]) {
464
459
  return this.sendRequest({
465
- case: 'updateLayers',
466
- value: new UpdateVideoLayers({
460
+ $case: 'updateLayers',
461
+ updateLayers: {
467
462
  trackSid,
468
463
  layers,
469
- }),
464
+ },
470
465
  });
471
466
  }
472
467
 
473
468
  sendUpdateSubscriptionPermissions(allParticipants: boolean, trackPermissions: TrackPermission[]) {
474
469
  return this.sendRequest({
475
- case: 'subscriptionPermission',
476
- value: new SubscriptionPermission({
470
+ $case: 'subscriptionPermission',
471
+ subscriptionPermission: {
477
472
  allParticipants,
478
473
  trackPermissions,
479
- }),
474
+ },
480
475
  });
481
476
  }
482
477
 
483
478
  sendSimulateScenario(scenario: SimulateScenario) {
484
479
  return this.sendRequest({
485
- case: 'simulate',
486
- value: scenario,
480
+ $case: 'simulate',
481
+ simulate: scenario,
487
482
  });
488
483
  }
489
484
 
@@ -491,26 +486,26 @@ export class SignalClient {
491
486
  /** send both of ping and pingReq for compatibility to old and new server */
492
487
  return Promise.all([
493
488
  this.sendRequest({
494
- case: 'ping',
495
- value: protoInt64.parse(Date.now()),
489
+ $case: 'ping',
490
+ ping: Date.now(),
496
491
  }),
497
492
  this.sendRequest({
498
- case: 'pingReq',
499
- value: new Ping({
500
- timestamp: protoInt64.parse(Date.now()),
501
- rtt: protoInt64.parse(this.rtt),
502
- }),
493
+ $case: 'pingReq',
494
+ pingReq: {
495
+ timestamp: Date.now(),
496
+ rtt: this.rtt,
497
+ },
503
498
  }),
504
499
  ]);
505
500
  }
506
501
 
507
502
  sendLeave() {
508
503
  return this.sendRequest({
509
- case: 'leave',
510
- value: new LeaveRequest({
504
+ $case: 'leave',
505
+ leave: {
511
506
  canReconnect: false,
512
507
  reason: DisconnectReason.CLIENT_INITIATED,
513
- }),
508
+ },
514
509
  });
515
510
  }
516
511
 
@@ -532,16 +527,18 @@ export class SignalClient {
532
527
  await sleep(this.signalLatency);
533
528
  }
534
529
  if (!this.ws || this.ws.readyState !== this.ws.OPEN) {
535
- log.error(`cannot send signal request before connected, type: ${message?.case}`);
530
+ log.error(`cannot send signal request before connected, type: ${message?.$case}`);
536
531
  return;
537
532
  }
538
- const req = new SignalRequest({ message });
539
533
 
534
+ const req = {
535
+ message,
536
+ };
540
537
  try {
541
538
  if (this.useJSON) {
542
- this.ws.send(req.toJsonString());
539
+ this.ws.send(JSON.stringify(SignalRequest.toJSON(req)));
543
540
  } else {
544
- this.ws.send(req.toBinary());
541
+ this.ws.send(SignalRequest.encode(req).finish());
545
542
  }
546
543
  } catch (e) {
547
544
  log.error('error sending signal message', { error: e });
@@ -554,77 +551,77 @@ export class SignalClient {
554
551
  log.debug('received unsupported message');
555
552
  return;
556
553
  }
557
- if (msg.case === 'answer') {
558
- const sd = fromProtoSessionDescription(msg.value);
554
+ if (msg.$case === 'answer') {
555
+ const sd = fromProtoSessionDescription(msg.answer);
559
556
  if (this.onAnswer) {
560
557
  this.onAnswer(sd);
561
558
  }
562
- } else if (msg.case === 'offer') {
563
- const sd = fromProtoSessionDescription(msg.value);
559
+ } else if (msg.$case === 'offer') {
560
+ const sd = fromProtoSessionDescription(msg.offer);
564
561
  if (this.onOffer) {
565
562
  this.onOffer(sd);
566
563
  }
567
- } else if (msg.case === 'trickle') {
568
- const candidate: RTCIceCandidateInit = JSON.parse(msg.value.candidateInit!);
564
+ } else if (msg.$case === 'trickle') {
565
+ const candidate: RTCIceCandidateInit = JSON.parse(msg.trickle.candidateInit!);
569
566
  if (this.onTrickle) {
570
- this.onTrickle(candidate, msg.value.target);
567
+ this.onTrickle(candidate, msg.trickle.target);
571
568
  }
572
- } else if (msg.case === 'update') {
569
+ } else if (msg.$case === 'update') {
573
570
  if (this.onParticipantUpdate) {
574
- this.onParticipantUpdate(msg.value.participants ?? []);
571
+ this.onParticipantUpdate(msg.update.participants ?? []);
575
572
  }
576
- } else if (msg.case === 'trackPublished') {
573
+ } else if (msg.$case === 'trackPublished') {
577
574
  if (this.onLocalTrackPublished) {
578
- this.onLocalTrackPublished(msg.value);
575
+ this.onLocalTrackPublished(msg.trackPublished);
579
576
  }
580
- } else if (msg.case === 'speakersChanged') {
577
+ } else if (msg.$case === 'speakersChanged') {
581
578
  if (this.onSpeakersChanged) {
582
- this.onSpeakersChanged(msg.value.speakers ?? []);
579
+ this.onSpeakersChanged(msg.speakersChanged.speakers ?? []);
583
580
  }
584
- } else if (msg.case === 'leave') {
581
+ } else if (msg.$case === 'leave') {
585
582
  if (this.onLeave) {
586
- this.onLeave(msg.value);
583
+ this.onLeave(msg.leave);
587
584
  }
588
- } else if (msg.case === 'mute') {
585
+ } else if (msg.$case === 'mute') {
589
586
  if (this.onRemoteMuteChanged) {
590
- this.onRemoteMuteChanged(msg.value.sid, msg.value.muted);
587
+ this.onRemoteMuteChanged(msg.mute.sid, msg.mute.muted);
591
588
  }
592
- } else if (msg.case === 'roomUpdate') {
593
- if (this.onRoomUpdate && msg.value.room) {
594
- this.onRoomUpdate(msg.value.room);
589
+ } else if (msg.$case === 'roomUpdate') {
590
+ if (this.onRoomUpdate && msg.roomUpdate.room) {
591
+ this.onRoomUpdate(msg.roomUpdate.room);
595
592
  }
596
- } else if (msg.case === 'connectionQuality') {
593
+ } else if (msg.$case === 'connectionQuality') {
597
594
  if (this.onConnectionQuality) {
598
- this.onConnectionQuality(msg.value);
595
+ this.onConnectionQuality(msg.connectionQuality);
599
596
  }
600
- } else if (msg.case === 'streamStateUpdate') {
597
+ } else if (msg.$case === 'streamStateUpdate') {
601
598
  if (this.onStreamStateUpdate) {
602
- this.onStreamStateUpdate(msg.value);
599
+ this.onStreamStateUpdate(msg.streamStateUpdate);
603
600
  }
604
- } else if (msg.case === 'subscribedQualityUpdate') {
601
+ } else if (msg.$case === 'subscribedQualityUpdate') {
605
602
  if (this.onSubscribedQualityUpdate) {
606
- this.onSubscribedQualityUpdate(msg.value);
603
+ this.onSubscribedQualityUpdate(msg.subscribedQualityUpdate);
607
604
  }
608
- } else if (msg.case === 'subscriptionPermissionUpdate') {
605
+ } else if (msg.$case === 'subscriptionPermissionUpdate') {
609
606
  if (this.onSubscriptionPermissionUpdate) {
610
- this.onSubscriptionPermissionUpdate(msg.value);
607
+ this.onSubscriptionPermissionUpdate(msg.subscriptionPermissionUpdate);
611
608
  }
612
- } else if (msg.case === 'refreshToken') {
609
+ } else if (msg.$case === 'refreshToken') {
613
610
  if (this.onTokenRefresh) {
614
- this.onTokenRefresh(msg.value);
611
+ this.onTokenRefresh(msg.refreshToken);
615
612
  }
616
- } else if (msg.case === 'trackUnpublished') {
613
+ } else if (msg.$case === 'trackUnpublished') {
617
614
  if (this.onLocalTrackUnpublished) {
618
- this.onLocalTrackUnpublished(msg.value);
615
+ this.onLocalTrackUnpublished(msg.trackUnpublished);
619
616
  }
620
- } else if (msg.case === 'subscriptionResponse') {
617
+ } else if (msg.$case === 'subscriptionResponse') {
621
618
  if (this.onSubscriptionError) {
622
- this.onSubscriptionError(msg.value);
619
+ this.onSubscriptionError(msg.subscriptionResponse);
623
620
  }
624
- } else if (msg.case === 'pong') {
621
+ } else if (msg.$case === 'pong') {
625
622
  this.resetPingTimeout();
626
- } else if (msg.case === 'pongResp') {
627
- this.rtt = Date.now() - Number.parseInt(msg.value.lastPingTimestamp.toString());
623
+ } else if (msg.$case === 'pongResp') {
624
+ this.rtt = Date.now() - msg.pongResp.lastPingTimestamp;
628
625
  this.resetPingTimeout();
629
626
  } else {
630
627
  log.debug('unsupported message', msg);
@@ -727,10 +724,10 @@ function fromProtoSessionDescription(sd: SessionDescription): RTCSessionDescript
727
724
  export function toProtoSessionDescription(
728
725
  rsd: RTCSessionDescription | RTCSessionDescriptionInit,
729
726
  ): SessionDescription {
730
- const sd = new SessionDescription({
727
+ const sd: SessionDescription = {
731
728
  sdp: rsd.sdp!,
732
729
  type: rsd.type!,
733
- });
730
+ };
734
731
  return sd;
735
732
  }
736
733
 
@@ -1,5 +1,4 @@
1
- import { EventEmitter } from 'events';
2
- import type TypedEmitter from 'typed-emitter';
1
+ import EventEmitter from 'eventemitter3';
3
2
  import { CheckStatus, Checker } from './checks/Checker';
4
3
  import type { CheckInfo, InstantiableCheck } from './checks/Checker';
5
4
  import { PublishAudioCheck } from './checks/publishAudio';
@@ -11,7 +10,7 @@ import { WebSocketCheck } from './checks/websocket';
11
10
 
12
11
  export type { CheckInfo, CheckStatus };
13
12
 
14
- export class ConnectionCheck extends (EventEmitter as new () => TypedEmitter<ConnectionCheckCallbacks>) {
13
+ export class ConnectionCheck extends EventEmitter<ConnectionCheckCallbacks> {
15
14
  token: string;
16
15
 
17
16
  url: string;
@@ -1,5 +1,4 @@
1
- import { EventEmitter } from 'events';
2
- import type TypedEmitter from 'typed-emitter';
1
+ import EventEmitter from 'eventemitter3';
3
2
  import type { RoomConnectOptions, RoomOptions } from '../../options';
4
3
  import type RTCEngine from '../../room/RTCEngine';
5
4
  import Room, { ConnectionState } from '../../room/Room';
@@ -30,7 +29,7 @@ export interface CheckerOptions {
30
29
  connectOptions?: RoomConnectOptions;
31
30
  }
32
31
 
33
- export abstract class Checker extends (EventEmitter as new () => TypedEmitter<CheckerCallbacks>) {
32
+ export abstract class Checker extends EventEmitter<CheckerCallbacks> {
34
33
  protected url: string;
35
34
 
36
35
  protected token: string;
@@ -68,6 +67,7 @@ export abstract class Checker extends (EventEmitter as new () => TypedEmitter<Ch
68
67
  throw Error('check is running already');
69
68
  }
70
69
  this.setStatus(CheckStatus.RUNNING);
70
+ this.appendMessage(`${this.name} started.`);
71
71
 
72
72
  try {
73
73
  await this.perform();
@@ -1,4 +1,3 @@
1
- import { RoomEvent } from '../../room/events';
2
1
  import { Checker } from './Checker';
3
2
 
4
3
  export class WebRTCCheck extends Checker {
@@ -7,76 +6,13 @@ export class WebRTCCheck extends Checker {
7
6
  }
8
7
 
9
8
  protected async perform(): Promise<void> {
10
- let hasTcp = false;
11
- let hasIpv4Udp = false;
12
- this.room.on(RoomEvent.SignalConnected, () => {
13
- const prevTrickle = this.room.engine.client.onTrickle;
14
-
15
- const candidates: RTCIceCandidate[] = [];
16
- this.room.engine.client.onTrickle = (sd, target) => {
17
- console.log('got candidate', sd);
18
- if (sd.candidate) {
19
- const candidate = new RTCIceCandidate(sd);
20
- candidates.push(candidate);
21
- let str = `${candidate.protocol} ${candidate.address}:${candidate.port} ${candidate.type}`;
22
- if (candidate.protocol === 'tcp' && candidate.tcpType === 'passive') {
23
- hasTcp = true;
24
- str += ' (active)';
25
- } else if (candidate.protocol === 'udp' && candidate.address) {
26
- if (isIPPrivate(candidate.address)) {
27
- str += ' (private)';
28
- } else {
29
- hasIpv4Udp = true;
30
- }
31
- }
32
- this.appendMessage(str);
33
- }
34
- if (prevTrickle) {
35
- prevTrickle(sd, target);
36
- }
37
- };
38
-
39
- if (this.room.engine.subscriber) {
40
- this.room.engine.subscriber.pc.onicecandidateerror = (ev) => {
41
- if (ev instanceof RTCPeerConnectionIceErrorEvent) {
42
- this.appendWarning(
43
- `error with ICE candidate: ${ev.errorCode} ${ev.errorText} ${ev.url}`,
44
- );
45
- }
46
- };
47
- }
48
- });
49
9
  try {
50
- await this.connect();
10
+ console.log('initiating room connection');
11
+ this.room = await this.connect();
51
12
  console.log('now the room is connected');
52
13
  } catch (err) {
53
14
  this.appendWarning('ports need to be open on firewall in order to connect.');
54
15
  throw err;
55
16
  }
56
- if (!hasTcp) {
57
- this.appendWarning('Server is not configured for ICE/TCP');
58
- }
59
- if (!hasIpv4Udp) {
60
- this.appendWarning(
61
- 'No public IPv4 UDP candidates were found. Your server is likely not configured correctly',
62
- );
63
- }
64
- }
65
- }
66
-
67
- function isIPPrivate(address: string): boolean {
68
- const parts = address.split('.');
69
- if (parts.length === 4) {
70
- if (parts[0] === '10') {
71
- return true;
72
- } else if (parts[0] === '192' && parts[1] === '168') {
73
- return true;
74
- } else if (parts[0] === '172') {
75
- const second = parseInt(parts[1], 10);
76
- if (second >= 16 && second <= 31) {
77
- return true;
78
- }
79
- }
80
17
  }
81
- return false;
82
18
  }
@@ -1,5 +1,4 @@
1
1
  import { SignalClient } from '../../api/SignalClient';
2
- import { ServerInfo_Edition } from '../../proto/livekit_models_pb';
3
2
  import { Checker } from './Checker';
4
3
 
5
4
  export class WebSocketCheck extends Checker {
@@ -19,9 +18,6 @@ export class WebSocketCheck extends Checker {
19
18
  e2eeEnabled: false,
20
19
  });
21
20
  this.appendMessage(`Connected to server, version ${joinRes.serverVersion}.`);
22
- if (joinRes.serverInfo?.edition === ServerInfo_Edition.Cloud && joinRes.serverInfo?.region) {
23
- this.appendMessage(`LiveKit Cloud: ${joinRes.serverInfo?.region}`);
24
- }
25
21
  await signalClient.close();
26
22
  }
27
23
  }
@@ -1,7 +1,6 @@
1
- import { EventEmitter } from 'events';
2
- import type TypedEventEmitter from 'typed-emitter';
1
+ import EventEmitter from 'eventemitter3';
3
2
  import log from '../logger';
4
- import { Encryption_Type, TrackInfo } from '../proto/livekit_models_pb';
3
+ import { Encryption_Type, TrackInfo } from '../proto/livekit_models';
5
4
  import type RTCEngine from '../room/RTCEngine';
6
5
  import type Room from '../room/Room';
7
6
  import { ConnectionState } from '../room/Room';
@@ -33,7 +32,7 @@ import { isE2EESupported, isScriptTransformSupported, mimeTypeToVideoCodecString
33
32
  /**
34
33
  * @experimental
35
34
  */
36
- export class E2EEManager extends (EventEmitter as new () => TypedEventEmitter<E2EEManagerCallbacks>) {
35
+ export class E2EEManager extends EventEmitter<E2EEManagerCallbacks> {
37
36
  protected worker: Worker;
38
37
 
39
38
  protected room?: Room;
@@ -1,5 +1,4 @@
1
- import { EventEmitter } from 'events';
2
- import type TypedEventEmitter from 'typed-emitter';
1
+ import EventEmitter from 'eventemitter3';
3
2
  import { KEY_PROVIDER_DEFAULTS } from './constants';
4
3
  import type { KeyInfo, KeyProviderCallbacks, KeyProviderOptions } from './types';
5
4
  import { createKeyMaterialFromString } from './utils';
@@ -7,7 +6,7 @@ import { createKeyMaterialFromString } from './utils';
7
6
  /**
8
7
  * @experimental
9
8
  */
10
- export class BaseKeyProvider extends (EventEmitter as new () => TypedEventEmitter<KeyProviderCallbacks>) {
9
+ export class BaseKeyProvider extends EventEmitter<KeyProviderCallbacks> {
11
10
  private keyInfoMap: Map<string, KeyInfo>;
12
11
 
13
12
  private options: KeyProviderOptions;
@@ -7,9 +7,6 @@ export const ENCRYPTION_ALGORITHM = 'AES-GCM';
7
7
  // in the frame trailer.
8
8
  export const KEYRING_SIZE = 16;
9
9
 
10
- // How many consecutive frames can fail decrypting before a particular key gets marked as invalid
11
- export const DECRYPTION_FAILURE_TOLERANCE = 10;
12
-
13
10
  // We copy the first bytes of the VP8 payload unencrypted.
14
11
  // For keyframes this is 10 bytes, for non-keyframes (delta) 3. See
15
12
  // https://tools.ietf.org/html/rfc6386#section-9.1
@@ -40,5 +37,4 @@ export const KEY_PROVIDER_DEFAULTS: KeyProviderOptions = {
40
37
  sharedKey: false,
41
38
  ratchetSalt: SALT,
42
39
  ratchetWindowSize: 8,
43
- failureTolerance: DECRYPTION_FAILURE_TOLERANCE,
44
40
  } as const;
package/src/e2ee/types.ts CHANGED
@@ -110,7 +110,6 @@ export type KeyProviderOptions = {
110
110
  sharedKey: boolean;
111
111
  ratchetSalt: string;
112
112
  ratchetWindowSize: number;
113
- failureTolerance: number;
114
113
  };
115
114
 
116
115
  export type KeyProviderCallbacks = {
@@ -1,4 +1,6 @@
1
- import { describe, expect, it } from 'vitest';
1
+ /**
2
+ * @jest-environment node
3
+ */
2
4
  import { isFrameServerInjected } from './FrameCryptor';
3
5
 
4
6
  describe('FrameCryptor', () => {