livekit-client 2.4.1 → 2.5.0

package/src/api/SignalClient.ts

@@ -4,7 +4,6 @@ import {
   ClientInfo,
   ConnectionQualityUpdate,
   DisconnectReason,
-  ErrorResponse,
   JoinResponse,
   LeaveRequest,
   LeaveRequest_Action,
@@ -13,6 +12,7 @@ import {
   Ping,
   ReconnectReason,
   ReconnectResponse,
+  RequestResponse,
   Room,
   SessionDescription,
   SignalRequest,
@@ -142,7 +142,9 @@ export class SignalClient {
 
   onLeave?: (leave: LeaveRequest) => void;
 
-  onErrorResponse?: (error: ErrorResponse) => void;
+  onRequestResponse?: (response: RequestResponse) => void;
+
+  onLocalTrackSubscribed?: (trackSid: string) => void;
 
   connectOptions?: ConnectOpts;
 
@@ -440,6 +442,7 @@ export class SignalClient {
   async close(updateState: boolean = true) {
     const unlock = await this.closingLock.lock();
     try {
+      this.clearPingInterval();
       if (updateState) {
         this.state = SignalConnectionState.DISCONNECTING;
       }
@@ -470,7 +473,6 @@ export class SignalClient {
       if (updateState) {
         this.state = SignalConnectionState.DISCONNECTED;
       }
-      this.clearPingInterval();
       unlock();
     }
   }
@@ -739,9 +741,13 @@ export class SignalClient {
       this.rtt = Date.now() - Number.parseInt(msg.value.lastPingTimestamp.toString());
       this.resetPingTimeout();
       pingHandled = true;
-    } else if (msg.case === 'errorResponse') {
-      if (this.onErrorResponse) {
-        this.onErrorResponse(msg.value);
+    } else if (msg.case === 'requestResponse') {
+      if (this.onRequestResponse) {
+        this.onRequestResponse(msg.value);
+      }
+    } else if (msg.case === 'trackSubscribed') {
+      if (this.onLocalTrackSubscribed) {
+        this.onLocalTrackSubscribed(msg.value.trackSid);
       }
     } else {
       this.log.debug('unsupported message', { ...this.logContext, msgCase: msg.case });

package/src/connectionHelper/checks/publishAudio.ts

@@ -21,7 +21,10 @@ export class PublishAudioCheck extends Checker {
     }
     let numPackets = 0;
     stats.forEach((stat) => {
-      if (stat.type === 'outbound-rtp' && stat.mediaType === 'audio') {
+      if (
+        stat.type === 'outbound-rtp' &&
+        (stat.kind === 'audio' || (!stat.kind && stat.mediaType === 'audio'))
+      ) {
         numPackets = stat.packetsSent;
       }
     });

package/src/connectionHelper/checks/publishVideo.ts

@@ -12,7 +12,7 @@ export class PublishVideoCheck extends Checker {
     const track = await createLocalVideoTrack();
     room.localParticipant.publishTrack(track);
     // wait for a few seconds to publish
-    await new Promise((resolve) => setTimeout(resolve, 3000));
+    await new Promise((resolve) => setTimeout(resolve, 5000));
 
     // verify RTC stats that it's publishing
     const stats = await track.sender?.getStats();
@@ -21,8 +21,11 @@ export class PublishVideoCheck extends Checker {
     }
     let numPackets = 0;
     stats.forEach((stat) => {
-      if (stat.type === 'outbound-rtp' && stat.mediaType === 'video') {
-        numPackets = stat.packetsSent;
+      if (
+        stat.type === 'outbound-rtp' &&
+        (stat.kind === 'video' || (!stat.kind && stat.mediaType === 'video'))
+      ) {
+        numPackets += stat.packetsSent;
       }
     });
     if (numPackets === 0) {

package/src/room/PCTransport.ts

@@ -260,6 +260,7 @@ export default class PCTransport extends EventEmitter {
     // actually negotiate
     this.log.debug('starting to negotiate', this.logContext);
     const offer = await this.pc.createOffer(options);
+    this.log.debug('original offer', { sdp: offer.sdp, ...this.logContext });
 
     const sdpParsed = parse(offer.sdp ?? '');
     sdpParsed.media.forEach((media) => {

package/src/room/RTCEngine.ts

@@ -7,13 +7,13 @@ import {
   DataPacket,
   DataPacket_Kind,
   DisconnectReason,
-  ErrorResponse,
   type JoinResponse,
   type LeaveRequest,
   LeaveRequest_Action,
   ParticipantInfo,
   ReconnectReason,
   type ReconnectResponse,
+  RequestResponse,
   Room as RoomModel,
   SignalTarget,
   SpeakerInfo,
@@ -194,7 +194,8 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.emit(EngineEvent.SubscriptionPermissionUpdate, update);
     this.client.onSpeakersChanged = (update) => this.emit(EngineEvent.SpeakersChanged, update);
     this.client.onStreamStateUpdate = (update) => this.emit(EngineEvent.StreamStateChanged, update);
-    this.client.onErrorResponse = (error) => this.emit(EngineEvent.SignalRequestError, error);
+    this.client.onRequestResponse = (response) =>
+      this.emit(EngineEvent.SignalRequestResponse, response);
   }
 
   /** @internal */
@@ -493,6 +494,10 @@ export default class RTCEngine extends (EventEmitter as new () => TypedEventEmit
       this.emit(EngineEvent.LocalTrackUnpublished, response);
     };
 
+    this.client.onLocalTrackSubscribed = (trackSid: string) => {
+      this.emit(EngineEvent.LocalTrackSubscribed, trackSid);
+    };
+
     this.client.onTokenRefresh = (token: string) => {
       this.token = token;
     };
@@ -1393,7 +1398,7 @@ export type EngineEventCallbacks = {
   mediaTrackAdded: (
     track: MediaStreamTrack,
     streams: MediaStream,
-    receiver?: RTCRtpReceiver,
+    receiver: RTCRtpReceiver,
   ) => void;
   activeSpeakersUpdate: (speakers: Array<SpeakerInfo>) => void;
   dataPacketReceived: (packet: DataPacket) => void;
@@ -1412,9 +1417,10 @@ export type EngineEventCallbacks = {
   subscriptionPermissionUpdate: (update: SubscriptionPermissionUpdate) => void;
   subscribedQualityUpdate: (update: SubscribedQualityUpdate) => void;
   localTrackUnpublished: (unpublishedResponse: TrackUnpublishedResponse) => void;
+  localTrackSubscribed: (trackSid: string) => void;
   remoteMute: (trackSid: string, muted: boolean) => void;
   offline: () => void;
-  signalRequestError: (error: ErrorResponse) => void;
+  signalRequestResponse: (response: RequestResponse) => void;
 };
 
 function supportOptionalDatachannel(protocol: number | undefined): boolean {

package/src/room/Room.ts

@@ -328,7 +328,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
       .on(EngineEvent.SubscriptionPermissionUpdate, this.handleSubscriptionPermissionUpdate)
       .on(
         EngineEvent.MediaTrackAdded,
-        (mediaTrack: MediaStreamTrack, stream: MediaStream, receiver?: RTCRtpReceiver) => {
+        (mediaTrack: MediaStreamTrack, stream: MediaStream, receiver: RTCRtpReceiver) => {
           this.onTrackAdded(mediaTrack, stream, receiver);
         },
       )
@@ -520,7 +520,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
               return;
             }
           }
-          if (nextUrl) {
+          if (nextUrl && !this.abortController?.signal.aborted) {
             this.log.info(
               `Initial connection failed with ConnectionError: ${e.message}. Retrying with another region: ${nextUrl}`,
               this.logContext,
@@ -1152,7 +1152,7 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
   private onTrackAdded(
     mediaTrack: MediaStreamTrack,
     stream: MediaStream,
-    receiver?: RTCRtpReceiver,
+    receiver: RTCRtpReceiver,
   ) {
     // don't fire onSubscribed when connecting
     // WebRTC fires onTrack as soon as setRemoteDescription is called on the offer
@@ -2055,7 +2055,12 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
           sid: Math.floor(Math.random() * 10_000).toString(),
           type: TrackType.AUDIO,
         });
-        p.addSubscribedMediaTrack(dummyVideo, videoTrack.sid, new MediaStream([dummyVideo]));
+        p.addSubscribedMediaTrack(
+          dummyVideo,
+          videoTrack.sid,
+          new MediaStream([dummyVideo]),
+          new RTCRtpReceiver(),
+        );
         info.tracks = [...info.tracks, videoTrack];
       }
       if (participantOptions.audio) {
@@ -2065,7 +2070,12 @@ class Room extends (EventEmitter as new () => TypedEmitter<RoomEventCallbacks>)
           sid: Math.floor(Math.random() * 10_000).toString(),
           type: TrackType.AUDIO,
         });
-        p.addSubscribedMediaTrack(dummyTrack, audioTrack.sid, new MediaStream([dummyTrack]));
+        p.addSubscribedMediaTrack(
+          dummyTrack,
+          audioTrack.sid,
+          new MediaStream([dummyTrack]),
+          new RTCRtpReceiver(),
+        );
         info.tracks = [...info.tracks, audioTrack];
       }
 

package/src/room/errors.ts

@@ -1,4 +1,4 @@
-import { ErrorResponse_Reason } from '@livekit/protocol';
+import { RequestResponse_Reason } from '@livekit/protocol';
 
 export class LivekitError extends Error {
   code: number;
@@ -65,10 +65,14 @@ export class PublishDataError extends LivekitError {
   }
 }
 
+export type RequestErrorReason =
+  | Exclude<RequestResponse_Reason, RequestResponse_Reason.OK>
+  | 'TimeoutError';
+
 export class SignalRequestError extends LivekitError {
-  reason: ErrorResponse_Reason;
+  reason: RequestErrorReason;
 
-  constructor(message: string, reason: ErrorResponse_Reason = ErrorResponse_Reason.UNKNOWN) {
+  constructor(message: string, reason: RequestErrorReason) {
     super(15, message);
     this.reason = reason;
   }

package/src/room/events.ts

@@ -538,8 +538,9 @@ export enum EngineEvent {
   RemoteMute = 'remoteMute',
   SubscribedQualityUpdate = 'subscribedQualityUpdate',
   LocalTrackUnpublished = 'localTrackUnpublished',
+  LocalTrackSubscribed = 'localTrackSubscribed',
   Offline = 'offline',
-  SignalRequestError = 'signalRequestError',
+  SignalRequestResponse = 'signalRequestResponse',
 }
 
 export enum TrackEvent {

package/src/room/participant/LocalParticipant.ts

@@ -3,9 +3,10 @@ import {
   DataPacket,
   DataPacket_Kind,
   Encryption_Type,
-  ErrorResponse,
   ParticipantInfo,
   ParticipantPermission,
+  RequestResponse,
+  RequestResponse_Reason,
   SimulcastCodec,
   SubscribedQualityUpdate,
   TrackUnpublishedResponse,
@@ -177,7 +178,7 @@ export default class LocalParticipant extends Participant {
       .on(EngineEvent.LocalTrackUnpublished, this.handleLocalTrackUnpublished)
       .on(EngineEvent.SubscribedQualityUpdate, this.handleSubscribedQualityUpdate)
       .on(EngineEvent.Disconnected, this.handleDisconnected)
-      .on(EngineEvent.SignalRequestError, this.handleSignalRequestError);
+      .on(EngineEvent.SignalRequestResponse, this.handleSignalRequestResponse);
   }
 
   private handleReconnecting = () => {
@@ -200,11 +201,13 @@ export default class LocalParticipant extends Participant {
     }
   };
 
-  private handleSignalRequestError = (error: ErrorResponse) => {
-    const { requestId, reason, message } = error;
-    const failedRequest = this.pendingSignalRequests.get(requestId);
-    if (failedRequest) {
-      failedRequest.reject(new SignalRequestError(message, reason));
+  private handleSignalRequestResponse = (response: RequestResponse) => {
+    const { requestId, reason, message } = response;
+    const targetRequest = this.pendingSignalRequests.get(requestId);
+    if (targetRequest) {
+      if (reason !== RequestResponse_Reason.OK) {
+        targetRequest.reject(new SignalRequestError(message, reason));
+      }
       this.pendingSignalRequests.delete(requestId);
     }
   };
@@ -278,7 +281,9 @@ export default class LocalParticipant extends Participant {
           }
           await sleep(50);
         }
-        reject(new SignalRequestError('Request to update local metadata timed out'));
+        reject(
+          new SignalRequestError('Request to update local metadata timed out', 'TimeoutError'),
+        );
       } catch (e: any) {
         if (e instanceof Error) reject(e);
       }

package/src/room/participant/RemoteParticipant.ts

@@ -164,7 +164,7 @@ export default class RemoteParticipant extends Participant {
     mediaTrack: MediaStreamTrack,
     sid: Track.SID,
     mediaStream: MediaStream,
-    receiver?: RTCRtpReceiver,
+    receiver: RTCRtpReceiver,
     adaptiveStreamSettings?: AdaptiveStreamSettings,
     triesLeft?: number,
   ) {

package/src/room/track/RemoteAudioTrack.ts

@@ -25,7 +25,7 @@ export default class RemoteAudioTrack extends RemoteTrack<Track.Kind.Audio> {
   constructor(
     mediaTrack: MediaStreamTrack,
     sid: string,
-    receiver?: RTCRtpReceiver,
+    receiver: RTCRtpReceiver,
     audioContext?: AudioContext,
     audioOutput?: AudioOutputOptions,
     loggerOptions?: LoggerOptions,

package/src/room/track/RemoteTrack.ts

@@ -8,13 +8,13 @@ export default abstract class RemoteTrack<
   TrackKind extends Track.Kind = Track.Kind,
 > extends Track<TrackKind> {
   /** @internal */
-  receiver?: RTCRtpReceiver;
+  receiver: RTCRtpReceiver | undefined;
 
   constructor(
     mediaTrack: MediaStreamTrack,
     sid: string,
     kind: TrackKind,
-    receiver?: RTCRtpReceiver,
+    receiver: RTCRtpReceiver,
     loggerOptions?: LoggerOptions,
   ) {
     super(mediaTrack, kind, loggerOptions);
@@ -39,6 +39,9 @@ export default abstract class RemoteTrack<
     const onRemoveTrack = (event: MediaStreamTrackEvent) => {
       if (event.track === this._mediaStreamTrack) {
         stream.removeEventListener('removetrack', onRemoveTrack);
+        if (this.receiver && 'playoutDelayHint' in this.receiver) {
+          this.receiver.playoutDelayHint = undefined;
+        }
         this.receiver = undefined;
         this._currentBitrate = 0;
         this.emit(TrackEvent.Ended, this);
@@ -73,6 +76,39 @@ export default abstract class RemoteTrack<
     return statsReport;
   }
 
+  /**
+   * Allows to set a playout delay (in seconds) for this track.
+   * A higher value allows for more buffering of the track in the browser
+   * and will result in a delay of media being played back of `delayInSeconds`
+   */
+  setPlayoutDelay(delayInSeconds: number): void {
+    if (this.receiver) {
+      if ('playoutDelayHint' in this.receiver) {
+        this.receiver.playoutDelayHint = delayInSeconds;
+      } else {
+        this.log.warn('Playout delay not supported in this browser');
+      }
+    } else {
+      this.log.warn('Cannot set playout delay, track already ended');
+    }
+  }
+
+  /**
+   * Returns the current playout delay (in seconds) of this track.
+   */
+  getPlayoutDelay(): number {
+    if (this.receiver) {
+      if ('playoutDelayHint' in this.receiver) {
+        return this.receiver.playoutDelayHint as number;
+      } else {
+        this.log.warn('Playout delay not supported in this browser');
+      }
+    } else {
+      this.log.warn('Cannot get playout delay, track already ended');
+    }
+    return 0;
+  }
+
   /* @internal */
   startMonitor() {
     if (!this.monitorInterval) {

package/src/room/track/RemoteVideoTrack.ts

@@ -26,7 +26,7 @@ export default class RemoteVideoTrack extends RemoteTrack<Track.Kind.Video> {
   constructor(
     mediaTrack: MediaStreamTrack,
     sid: string,
-    receiver?: RTCRtpReceiver,
+    receiver: RTCRtpReceiver,
     adaptiveStreamSettings?: AdaptiveStreamSettings,
     loggerOptions?: LoggerOptions,
   ) {
@@ -226,7 +226,7 @@ export default class RemoteVideoTrack extends RemoteTrack<Track.Kind.Video> {
     );
 
     const backgroundPause =
-      this.adaptiveStreamSettings?.pauseVideoInBackground ?? true // default to true
+      (this.adaptiveStreamSettings?.pauseVideoInBackground ?? true) // default to true
         ? this.isInBackground
         : false;
     const isPiPMode = this.elementInfos.some((info) => info.pictureInPicture);

package/src/version.ts

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