livekit-client 2.11.4 → 2.13.0

package/src/e2ee/worker/e2ee.worker.ts

@@ -11,6 +11,7 @@ import type {
   KeyProviderOptions,
   RatchetMessage,
   RatchetRequestMessage,
+  RatchetResult,
 } from '../types';
 import { FrameCryptor, encryptionEnabledMap } from './FrameCryptor';
 import { ParticipantKeyHandler } from './ParticipantKeyHandler';
@@ -229,13 +230,17 @@ function setupCryptorErrorEvents(cryptor: FrameCryptor) {
   });
 }
 
-function emitRatchetedKeys(material: CryptoKey, participantIdentity: string, keyIndex?: number) {
+function emitRatchetedKeys(
+  ratchetResult: RatchetResult,
+  participantIdentity: string,
+  keyIndex?: number,
+) {
   const msg: RatchetMessage = {
     kind: `ratchetKey`,
     data: {
       participantIdentity,
       keyIndex,
-      material,
+      ratchetResult,
     },
   };
   postMessage(msg);

package/src/room/RTCEngine.ts

@@ -16,6 +16,7 @@ import {
   type ReconnectResponse,
   RequestResponse,
   Room as RoomModel,
+  RoomMovedResponse,
   RpcAck,
   RpcResponse,
   SignalTarget,
@@ -529,6 +530,11 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.emit(EngineEvent.SubscribedQualityUpdate, update);
     };
 
+    this.client.onRoomMoved = (res: RoomMovedResponse) => {
+      this.participantSid = res.participant?.sid;
+      this.emit(EngineEvent.RoomMoved, res);
+    };
+
     this.client.onClose = () => {
       this.handleDisconnect('signal', ReconnectReason.RR_SIGNAL_DISCONNECTED);
     };
@@ -616,8 +622,7 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
 
     // create data channels
     this.lossyDC = this.pcManager.createPublisherDataChannel(lossyDataChannel, {
-      // will drop older packets that arrive
-      ordered: true,
+      ordered: false,
       maxRetransmits: 0,
     });
     this.reliableDC = this.pcManager.createPublisherDataChannel(reliableDataChannel, {
@@ -1493,6 +1498,7 @@ export type EngineEventCallbacks = {
   dcBufferStatusChanged: (isLow: boolean, kind: DataPacket_Kind) => void;
   participantUpdate: (infos: ParticipantInfo[]) => void;
   roomUpdate: (room: RoomModel) => void;
+  roomMoved: (room: RoomMovedResponse) => void;
   connectionQualityUpdate: (update: ConnectionQualityUpdate) => void;
   speakersChanged: (speakerUpdates: SpeakerInfo[]) => void;
   streamStateChanged: (update: StreamStateUpdate) => void;

package/src/room/Room.ts

@@ -589,6 +589,25 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
           trackPublication,
           this.localParticipant,
         );
+      })
+      .on(EngineEvent.RoomMoved, (roomMoved) => {
+        this.log.debug('room moved', roomMoved);
+
+        if (roomMoved.room) {
+          this.handleRoomUpdate(roomMoved.room);
+        }
+
+        this.remoteParticipants.forEach((participant, identity) => {
+          this.handleParticipantDisconnected(identity, participant);
+        });
+
+        this.emit(RoomEvent.Moved, roomMoved.room!.name, roomMoved.token);
+
+        if (roomMoved.participant) {
+          this.handleParticipantUpdates([roomMoved.participant, ...roomMoved.otherParticipants]);
+        } else {
+          this.handleParticipantUpdates(roomMoved.otherParticipants);
+        }
       });
 
     if (this.localParticipant) {
@@ -1625,6 +1644,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       participant.unpublishTrack(publication.trackSid, true);
     });
     this.emit(RoomEvent.ParticipantDisconnected, participant);
+    participant.setDisconnected();
     this.localParticipant?.handleParticipantDisconnected(participant.identity);
   }
 
@@ -2221,6 +2241,9 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
           status,
           participant,
         );
+      })
+      .on(ParticipantEvent.Active, () => {
+        this.emitWhenConnected(RoomEvent.ParticipantActive, participant);
       });
 
     // update info at the end after callbacks have been set up
@@ -2611,6 +2634,7 @@ export type RoomEventCallbacks = {
   reconnected: () => void;
   disconnected: (reason?: DisconnectReason) => void;
   connectionStateChanged: (state: ConnectionState) => void;
+  moved: (name: string, token: string) => void;
   mediaDevicesChanged: () => void;
   participantConnected: (participant: RemoteParticipant) => void;
   participantDisconnected: (participant: RemoteParticipant) => void;
@@ -2694,4 +2718,5 @@ export type RoomEventCallbacks = {
   chatMessage: (message: ChatMessage, participant?: RemoteParticipant | LocalParticipant) => void;
   localTrackSubscribed: (publication: LocalTrackPublication, participant: LocalParticipant) => void;
   metricsReceived: (metrics: MetricsBatch, participant?: Participant) => void;
+  participantActive: (participant: Participant) => void;
 };

package/src/room/events.ts

@@ -52,6 +52,16 @@ export enum RoomEvent {
    */
   ConnectionStateChanged = 'connectionStateChanged',
 
+  /**
+   * When participant has been moved to a different room by the service request.
+   * The behavior looks like the participant has been disconnected and reconnected to a different room
+   * seamlessly without connection state transition.
+   * A new token will be provided for reconnecting to the new room if needed.
+   *
+   * args: ([[room: string, token: string]])
+   */
+  Moved = 'moved',
+
   /**
    * When input or output devices on the machine have changed.
    */
@@ -193,6 +203,13 @@ export enum RoomEvent {
    */
   ParticipantAttributesChanged = 'participantAttributesChanged',
 
+  /**
+   * Emitted when the participant's state changes to ACTIVE and is ready to send/receive data messages
+   *
+   * args: (participant: [[Participant]])
+   */
+  ParticipantActive = 'participantActive',
+
   /**
    * Room metadata is a simple way for app-specific state to be pushed to
    * all users.
@@ -530,6 +547,11 @@ export enum ParticipantEvent {
 
   /** only emitted on local participant */
   ChatMessage = 'chatMessage',
+
+  /**
+   * Emitted when the participant's state changes to ACTIVE and is ready to send/receive data messages
+   */
+  Active = 'active',
 }
 
 /** @internal */
@@ -563,6 +585,7 @@ export enum EngineEvent {
   Offline = 'offline',
   SignalRequestResponse = 'signalRequestResponse',
   SignalConnected = 'signalConnected',
+  RoomMoved = 'roomMoved',
 }
 
 export enum TrackEvent {

package/src/room/participant/LocalParticipant.ts

@@ -1780,6 +1780,7 @@ export default class LocalParticipant extends Participant {
       streamId,
       topic: info.topic,
       timestamp: numberToBigInt(Date.now()),
+      attributes: info.attributes,
       contentHeader: {
         case: 'byteHeader',
         value: new DataStream_ByteHeader({
@@ -2053,11 +2054,6 @@ export default class LocalParticipant extends Participant {
 
   /** @internal */
   updateInfo(info: ParticipantInfo): boolean {
-    if (info.sid !== this.sid) {
-      // drop updates that specify a wrong sid.
-      // the sid for local participant is only explicitly set on join and full reconnect
-      return false;
-    }
     if (!super.updateInfo(info)) {
       return false;
     }

package/src/room/participant/Participant.ts

@@ -1,6 +1,7 @@
 import {
   DataPacket_Kind,
   ParticipantInfo,
+  ParticipantInfo_State,
   ParticipantInfo_Kind as ParticipantKind,
   ParticipantPermission,
   ConnectionQuality as ProtoQuality,
@@ -18,7 +19,7 @@ import { Track } from '../track/Track';
 import type { TrackPublication } from '../track/TrackPublication';
 import { diffAttributes } from '../track/utils';
 import type { ChatMessage, LoggerOptions, TranscriptionSegment } from '../types';
-import { isAudioTrack } from '../utils';
+import { Future, isAudioTrack } from '../utils';
 
 export enum ConnectionQuality {
   Excellent = 'excellent',
@@ -93,6 +94,8 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
 
   protected loggerOptions?: LoggerOptions;
 
+  protected activeFuture?: Future<void>;
+
   protected get logContext() {
     return {
       ...this.loggerOptions?.loggerContextCb?.(),
@@ -110,6 +113,10 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
     return this.permissions?.agent || this.kind === ParticipantKind.AGENT;
   }
 
+  get isActive() {
+    return this.participantInfo?.state === ParticipantInfo_State.ACTIVE;
+  }
+
   get kind() {
     return this._kind;
   }
@@ -173,6 +180,28 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
     }
   }
 
+  /**
+   * Waits until the participant is active and ready to receive data messages
+   * @returns a promise that resolves when the participant is active
+   */
+  waitUntilActive(): Promise<void> {
+    if (this.isActive) {
+      return Promise.resolve();
+    }
+
+    if (this.activeFuture) {
+      return this.activeFuture.promise;
+    }
+
+    this.activeFuture = new Future<void>();
+
+    this.once(ParticipantEvent.Active, () => {
+      this.activeFuture?.resolve?.();
+      this.activeFuture = undefined;
+    });
+    return this.activeFuture.promise;
+  }
+
   get connectionQuality(): ConnectionQuality {
     return this._connectionQuality;
   }
@@ -224,12 +253,17 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
     this._setName(info.name);
     this._setMetadata(info.metadata);
     this._setAttributes(info.attributes);
+    if (
+      info.state === ParticipantInfo_State.ACTIVE &&
+      this.participantInfo?.state !== ParticipantInfo_State.ACTIVE
+    ) {
+      this.emit(ParticipantEvent.Active);
+    }
     if (info.permission) {
       this.setPermissions(info.permission);
     }
     // set this last so setMetadata can detect changes
     this.participantInfo = info;
-    this.log.trace('update participant info', { ...this.logContext, info });
     return true;
   }
 
@@ -310,6 +344,16 @@ export default class Participant extends (EventEmitter as new () => TypedEmitter
     }
   }
 
+  /**
+   * @internal
+   */
+  setDisconnected() {
+    if (this.activeFuture) {
+      this.activeFuture.reject?.(new Error('Participant disconnected'));
+      this.activeFuture = undefined;
+    }
+  }
+
   /**
    * @internal
    */
@@ -387,4 +431,5 @@ export type ParticipantEventCallbacks = {
   attributesChanged: (changedAttributes: Record<string, string>) => void;
   localTrackSubscribed: (trackPublication: LocalTrackPublication) => void;
   chatMessage: (msg: ChatMessage) => void;
+  active: () => void;
 };

package/src/room/track/RemoteAudioTrack.ts

@@ -104,8 +104,9 @@ export default class RemoteAudioTrack extends RemoteTrack<Track.Kind.Audio> {
     }
 
     if (this.sinkId && supportsSetSinkId(element)) {
-      /* @ts-ignore */
-      element.setSinkId(this.sinkId);
+      element.setSinkId(this.sinkId).catch((e) => {
+        this.log.error('Failed to set sink id on remote audio track', e, this.logContext);
+      });
     }
     if (this.audioContext && needsNewWebAudioConnection) {
       this.log.debug('using audio context mapping', this.logContext);

package/src/room/track/create.ts

@@ -78,18 +78,16 @@ export async function createLocalTracks(
       deviceId: { ideal: deviceId },
     };
   }
-  // TODO if internal options don't have device Id specified, set it to 'default'
   if (
     internalOptions.audio === true ||
     (typeof internalOptions.audio === 'object' && !internalOptions.audio.deviceId)
   ) {
     internalOptions.audio = { deviceId: 'default' };
   }
-  if (
-    internalOptions.video === true ||
-    (typeof internalOptions.video === 'object' && !internalOptions.video.deviceId)
-  ) {
+  if (internalOptions.video === true) {
     internalOptions.video = { deviceId: 'default' };
+  } else if (typeof internalOptions.video === 'object' && !internalOptions.video.deviceId) {
+    internalOptions.video.deviceId = 'default';
   }
   const opts = mergeDefaultOptions(internalOptions, audioDefaults, videoDefaults);
   const constraints = constraintsForOptions(opts);

package/src/version.ts

@@ -1,4 +1,4 @@
 import { version as v } from '../package.json';
 
 export const version = v;
-export const protocolVersion = 15;
+export const protocolVersion = 16;