livekit-client 1.1.3 → 1.1.6

package/dist/livekit-client.esm.mjs

@@ -10070,7 +10070,7 @@ function computeBitrate(currentStats, prevStats) {
   return (bytesNow - bytesPrev) * 8 * 1000 / (currentStats.timestamp - prevStats.timestamp);
 }
 
-var version$1 = "1.1.3";
+var version$1 = "1.1.6";
 
 const version = version$1;
 const protocolVersion = 8;
@@ -10180,6 +10180,15 @@ function getEmptyAudioStreamTrack() {
 
   return emptyAudioStreamTrack;
 }
+class Future {
+  constructor() {
+    this.promise = new Promise((resolve, reject) => {
+      this.resolve = resolve;
+      this.reject = reject;
+    });
+  }
+
+}
 
 const defaultId = 'default';
 class DeviceManager {
@@ -11060,6 +11069,7 @@ function detachTrack(track, element) {
 
 class LocalTrack extends Track {
   constructor(mediaTrack, kind, constraints) {
+    let userProvidedTrack = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
     super(mediaTrack, kind);
     this._isUpstreamPaused = false;
 
@@ -11076,6 +11086,7 @@ class LocalTrack extends Track {
     this.constraints = constraints !== null && constraints !== void 0 ? constraints : mediaTrack.getConstraints();
     this.reacquireTrack = false;
     this.wasMuted = false;
+    this.providedByUser = userProvidedTrack;
   }
 
   get id() {
@@ -11105,6 +11116,10 @@ class LocalTrack extends Track {
   get isUpstreamPaused() {
     return this._isUpstreamPaused;
   }
+
+  get isUserProvided() {
+    return this.providedByUser;
+  }
   /**
    * @returns DeviceID of the device that is currently being used for this track
    */
@@ -11136,6 +11151,8 @@ class LocalTrack extends Track {
   }
 
   async replaceTrack(track) {
+    let userProvidedTrack = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : true;
+
     if (!this.sender) {
       throw new TrackInvalidError('unable to replace an unpublished track');
     } // detach
@@ -11164,6 +11181,7 @@ class LocalTrack extends Track {
       attachToElement(track, el);
     });
     this.mediaStream = new MediaStream([track]);
+    this.providedByUser = userProvidedTrack;
     return this;
   }
 
@@ -11235,7 +11253,7 @@ class LocalTrack extends Track {
     if (!isMobile()) return;
     livekitLogger.debug("visibility changed, is in Background: ".concat(this.isInBackground));
 
-    if (!this.isInBackground && this.needsReAcquisition) {
+    if (!this.isInBackground && this.needsReAcquisition && !this.isUserProvided) {
       livekitLogger.debug("track needs to be reaquired, restarting ".concat(this.source));
       await this.restart();
       this.reacquireTrack = false; // Restore muted state if had to be restarted
@@ -11386,7 +11404,8 @@ function getNewAudioContext() {
 
 class LocalAudioTrack extends LocalTrack {
   constructor(mediaTrack, constraints) {
-    super(mediaTrack, Track.Kind.Audio, constraints);
+    let userProvidedTrack = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+    super(mediaTrack, Track.Kind.Audio, constraints, userProvidedTrack);
     /** @internal */
 
     this.stopOnMute = false;
@@ -11446,7 +11465,7 @@ class LocalAudioTrack extends LocalTrack {
   }
 
   async unmute() {
-    if (this.source === Track.Source.Microphone && this.stopOnMute) {
+    if (this.source === Track.Source.Microphone && this.stopOnMute && !this.isUserProvided) {
       livekitLogger.debug('reacquiring mic track');
       await this.restartTrack();
     }
@@ -11530,7 +11549,8 @@ class LocalAudioTrack extends LocalTrack {
 const refreshSubscribedCodecAfterNewCodec = 5000;
 class LocalVideoTrack extends LocalTrack {
   constructor(mediaTrack, constraints) {
-    super(mediaTrack, Track.Kind.Video, constraints);
+    let userProvidedTrack = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : true;
+    super(mediaTrack, Track.Kind.Video, constraints, userProvidedTrack);
     this.simulcastCodecs = new Map();
 
     this.monitorSender = async () => {
@@ -11627,7 +11647,7 @@ class LocalVideoTrack extends LocalTrack {
   }
 
   async unmute() {
-    if (this.source === Track.Source.Camera) {
+    if (this.source === Track.Source.Camera && !this.isUserProvided) {
       livekitLogger.debug('reacquiring camera track');
       await this.restartTrack();
     }
@@ -12955,10 +12975,10 @@ function trackPermissionToProto(perms) {
 function mediaTrackToLocalTrack(mediaStreamTrack, constraints) {
   switch (mediaStreamTrack.kind) {
     case 'audio':
-      return new LocalAudioTrack(mediaStreamTrack, constraints);
+      return new LocalAudioTrack(mediaStreamTrack, constraints, false);
 
     case 'video':
-      return new LocalVideoTrack(mediaStreamTrack, constraints);
+      return new LocalVideoTrack(mediaStreamTrack, constraints, false);
 
     default:
       throw new TrackInvalidError("unsupported track type: ".concat(mediaStreamTrack.kind));
@@ -13204,6 +13224,7 @@ class RemoteTrackPublication extends TrackPublication {
 
     this.handleEnded = track => {
       this.emit(TrackEvent.Ended, track);
+      this.setTrack(undefined);
     };
 
     this.handleVisibilityChange = visible => {
@@ -13331,6 +13352,8 @@ class RemoteTrackPublication extends TrackPublication {
   get videoQuality() {
     return this.currentVideoQuality;
   }
+  /** @internal */
+
 
   setTrack(track) {
     if (this.track) {
@@ -13536,7 +13559,9 @@ class RemoteParticipant extends Participant {
     track.isMuted = publication.isMuted;
     track.setMediaStream(mediaStream);
     track.start();
-    publication.setTrack(track); // set participant volume on new microphone tracks
+    publication.setTrack(track); // subscription means participant has permissions to subscribe
+
+    publication._allowed = true; // set participant volume on new microphone tracks
 
     if (this.volume !== undefined && track instanceof RemoteAudioTrack && track.source === Track.Source.Microphone) {
       track.setVolume(this.volume);
@@ -14065,12 +14090,12 @@ class LocalParticipant extends Participant {
       throw new TrackInvalidError('no video track found');
     }
 
-    const screenVideo = new LocalVideoTrack(tracks[0]);
+    const screenVideo = new LocalVideoTrack(tracks[0], undefined, false);
     screenVideo.source = Track.Source.ScreenShare;
     const localTracks = [screenVideo];
 
     if (stream.getAudioTracks().length > 0) {
-      const screenAudio = new LocalAudioTrack(stream.getAudioTracks()[0]);
+      const screenAudio = new LocalAudioTrack(stream.getAudioTracks()[0], undefined, false);
       screenAudio.source = Track.Source.ScreenShareAudio;
       localTracks.push(screenAudio);
     }
@@ -14093,11 +14118,11 @@ class LocalParticipant extends Participant {
     if (track instanceof MediaStreamTrack) {
       switch (track.kind) {
         case 'audio':
-          track = new LocalAudioTrack(track);
+          track = new LocalAudioTrack(track, undefined, true);
           break;
 
         case 'video':
-          track = new LocalVideoTrack(track);
+          track = new LocalVideoTrack(track, undefined, true);
           break;
 
         default:
@@ -14584,57 +14609,6 @@ class LocalParticipant extends Participant {
 
 }
 
-class Queue {
-  constructor() {
-    this.queue = [];
-    this.running = false;
-  }
-
-  enqueue(cb) {
-    livekitLogger.trace('enqueuing request to fire later');
-    this.queue.push(cb);
-  }
-
-  dequeue() {
-    const evt = this.queue.shift();
-    if (evt) evt();
-    livekitLogger.trace('firing request from queue');
-  }
-
-  async run() {
-    if (this.running) return;
-    livekitLogger.trace('start queue');
-    this.running = true;
-
-    while (this.running && this.queue.length > 0) {
-      this.dequeue();
-    }
-
-    this.running = false;
-    livekitLogger.trace('queue finished');
-  }
-
-  pause() {
-    livekitLogger.trace('pausing queue');
-    this.running = false;
-  }
-
-  reset() {
-    livekitLogger.trace('resetting queue');
-    this.running = false;
-    this.queue = [];
-  }
-
-  isRunning() {
-    return this.running;
-  }
-
-  isEmpty() {
-    return this.queue.length === 0;
-  }
-
-}
-
 /*
  *  Copyright (c) 2016 The WebRTC project authors. All Rights Reserved.
  *
@@ -18120,6 +18094,57 @@ adapterFactory({
   window: typeof window === 'undefined' ? undefined : window
 });
 
+class Queue {
+  constructor() {
+    this.queue = [];
+    this.running = false;
+  }
+
+  enqueue(cb) {
+    livekitLogger.trace('enqueuing request to fire later');
+    this.queue.push(cb);
+  }
+
+  dequeue() {
+    const evt = this.queue.shift();
+    if (evt) evt();
+    livekitLogger.trace('firing request from queue');
+  }
+
+  async run() {
+    if (this.running) return;
+    livekitLogger.trace('start queue');
+    this.running = true;
+
+    while (this.running && this.queue.length > 0) {
+      this.dequeue();
+    }
+
+    this.running = false;
+    livekitLogger.trace('queue finished');
+  }
+
+  pause() {
+    livekitLogger.trace('pausing queue');
+    this.running = false;
+  }
+
+  reset() {
+    livekitLogger.trace('resetting queue');
+    this.running = false;
+    this.queue = [];
+  }
+
+  isRunning() {
+    return this.running;
+  }
+
+  isEmpty() {
+    return this.queue.length === 0;
+  }
+
+}
+
 const passThroughQueueSignals = ['syncState', 'trickle', 'offer', 'answer', 'simulate', 'leave'];
 
 function canPassThroughQueue(req) {
@@ -19416,14 +19441,18 @@ class Room extends events.exports.EventEmitter {
     this.audioEnabled = true;
 
     this.connect = async (url, token, opts) => {
-      var _a, _b; // guard against calling connect
-
+      var _a, _b, _c, _d;
 
-      if (this.state !== ConnectionState.Disconnected) {
+      if (this.state === ConnectionState.Connected) {
+        // when the state is reconnecting or connected, this function returns immediately
         livekitLogger.warn("already connected to room ".concat(this.name));
         return;
       }
 
+      if (this.connectFuture) {
+        return this.connectFuture.promise;
+      }
+
       this.setAndEmitConnectionState(ConnectionState.Connecting);
 
       if (!this.abortController || this.abortController.signal.aborted) {
@@ -19489,50 +19518,48 @@ class Room extends events.exports.EventEmitter {
         this.metadata = joinResponse.room.metadata;
         this.emit(RoomEvent.SignalConnected);
       } catch (err) {
-        this.engine.close();
-        this.setAndEmitConnectionState(ConnectionState.Disconnected);
+        this.recreateEngine();
+        this.setAndEmitConnectionState(ConnectionState.Disconnected, new ConnectionError('could not establish signal connection'));
         throw err;
       } // don't return until ICE connected
 
 
-      return new Promise((resolve, reject) => {
-        var _a, _b;
+      const connectTimeout = setTimeout(() => {
+        // timeout
+        this.recreateEngine();
+        this.setAndEmitConnectionState(ConnectionState.Disconnected, new ConnectionError('could not connect PeerConnection after timeout'));
+      }, maxICEConnectTimeout);
 
-        const connectTimeout = setTimeout(() => {
-          // timeout
-          this.engine.close();
-          this.setAndEmitConnectionState(ConnectionState.Disconnected);
-          reject(new ConnectionError('could not connect after timeout'));
-        }, maxICEConnectTimeout);
-
-        const abortHandler = () => {
-          livekitLogger.warn('closing engine');
-          clearTimeout(connectTimeout);
-          this.engine.close();
-          this.setAndEmitConnectionState(ConnectionState.Disconnected);
-          reject(new ConnectionError('room connection has been cancelled'));
-        };
+      const abortHandler = () => {
+        livekitLogger.warn('closing engine');
+        clearTimeout(connectTimeout);
+        this.recreateEngine();
+        this.setAndEmitConnectionState(ConnectionState.Disconnected, new ConnectionError('room connection has been cancelled'));
+      };
 
-        if ((_a = this.abortController) === null || _a === void 0 ? void 0 : _a.signal.aborted) {
-          abortHandler();
-        }
+      if ((_c = this.abortController) === null || _c === void 0 ? void 0 : _c.signal.aborted) {
+        abortHandler();
+      }
 
-        (_b = this.abortController) === null || _b === void 0 ? void 0 : _b.signal.addEventListener('abort', abortHandler);
-        this.engine.once(EngineEvent.Connected, () => {
-          var _a, _b;
+      (_d = this.abortController) === null || _d === void 0 ? void 0 : _d.signal.addEventListener('abort', abortHandler);
+      this.engine.once(EngineEvent.Connected, () => {
+        var _a, _b;
 
-          clearTimeout(connectTimeout);
-          (_a = this.abortController) === null || _a === void 0 ? void 0 : _a.signal.removeEventListener('abort', abortHandler); // also hook unload event
+        clearTimeout(connectTimeout);
+        (_a = this.abortController) === null || _a === void 0 ? void 0 : _a.signal.removeEventListener('abort', abortHandler); // also hook unload event
 
-          if (isWeb()) {
-            window.addEventListener('beforeunload', this.onBeforeUnload);
-            (_b = navigator.mediaDevices) === null || _b === void 0 ? void 0 : _b.addEventListener('devicechange', this.handleDeviceChange);
-          }
+        if (isWeb()) {
+          window.addEventListener('beforeunload', this.onBeforeUnload);
+          (_b = navigator.mediaDevices) === null || _b === void 0 ? void 0 : _b.addEventListener('devicechange', this.handleDeviceChange);
+        }
 
-          this.setAndEmitConnectionState(ConnectionState.Connected);
-          resolve(this);
-        });
+        this.setAndEmitConnectionState(ConnectionState.Connected);
       });
+
+      if (this.connectFuture) {
+        /** @ts-ignore */
+        return this.connectFuture.promise;
+      }
     };
     /**
      * disconnects the room, emits [[RoomEvent.Disconnected]]
@@ -19573,14 +19600,14 @@ class Room extends events.exports.EventEmitter {
     };
 
     this.handleRestarting = () => {
-      if (this.setAndEmitConnectionState(ConnectionState.Reconnecting)) {
-        this.emit(RoomEvent.Reconnecting);
-      } // also unwind existing participants & existing subscriptions
-
-
+      // also unwind existing participants & existing subscriptions
       for (const p of this.participants.values()) {
         this.handleParticipantDisconnected(p.sid, p);
       }
+
+      if (this.setAndEmitConnectionState(ConnectionState.Reconnecting)) {
+        this.emit(RoomEvent.Reconnecting);
+      }
     };
 
     this.handleRestarted = async joinResponse => {
@@ -19609,7 +19636,7 @@ class Room extends events.exports.EventEmitter {
         this.localParticipant.unpublishTrack(track, false);
 
         if (!track.isMuted) {
-          if (track instanceof LocalAudioTrack || track instanceof LocalVideoTrack) {
+          if ((track instanceof LocalAudioTrack || track instanceof LocalVideoTrack) && !track.isUserProvided) {
             // we need to restart the track before publishing, often a full reconnect
             // is necessary because computer had gone to sleep.
             livekitLogger.debug('restarting existing track', {
@@ -19648,7 +19675,7 @@ class Room extends events.exports.EventEmitter {
           this.handleParticipantDisconnected(info.sid, remoteParticipant);
         } else if (isNewParticipant) {
           // fire connected event
-          this.emit(RoomEvent.ParticipantConnected, remoteParticipant);
+          this.emitWhenConnected(RoomEvent.ParticipantConnected, remoteParticipant);
         } else {
           // just update, no events
           remoteParticipant.updateInfo(info);
@@ -19690,7 +19717,7 @@ class Room extends events.exports.EventEmitter {
         }
       });
       this.activeSpeakers = activeSpeakers;
-      this.emit(RoomEvent.ActiveSpeakersChanged, activeSpeakers);
+      this.emitWhenConnected(RoomEvent.ActiveSpeakersChanged, activeSpeakers);
     }; // process list of changed speakers
 
 
@@ -19722,7 +19749,7 @@ class Room extends events.exports.EventEmitter {
       const activeSpeakers = Array.from(lastSpeakers.values());
       activeSpeakers.sort((a, b) => b.audioLevel - a.audioLevel);
       this.activeSpeakers = activeSpeakers;
-      this.emit(RoomEvent.ActiveSpeakersChanged, activeSpeakers);
+      this.emitWhenConnected(RoomEvent.ActiveSpeakersChanged, activeSpeakers);
     };
 
     this.handleStreamStateUpdate = streamStateUpdate => {
@@ -19741,7 +19768,7 @@ class Room extends events.exports.EventEmitter {
 
         pub.track.streamState = Track.streamStateFromProto(streamState.state);
         participant.emit(ParticipantEvent.TrackStreamStateChanged, pub, pub.track.streamState);
-        this.emit(ParticipantEvent.TrackStreamStateChanged, pub, pub.track.streamState, participant);
+        this.emitWhenConnected(RoomEvent.TrackStreamStateChanged, pub, pub.track.streamState, participant);
       });
     };
 
@@ -19760,7 +19787,7 @@ class Room extends events.exports.EventEmitter {
 
       pub._allowed = update.allowed;
       participant.emit(ParticipantEvent.TrackSubscriptionPermissionChanged, pub, pub.subscriptionStatus);
-      this.emit(ParticipantEvent.TrackSubscriptionPermissionChanged, pub, pub.subscriptionStatus, participant);
+      this.emitWhenConnected(RoomEvent.TrackSubscriptionPermissionChanged, pub, pub.subscriptionStatus, participant);
     };
 
     this.handleDataPacket = (userPacket, kind) => {
@@ -19797,7 +19824,7 @@ class Room extends events.exports.EventEmitter {
 
     this.handleRoomUpdate = r => {
       this.metadata = r.metadata;
-      this.emit(RoomEvent.RoomMetadataChanged, r.metadata);
+      this.emitWhenConnected(RoomEvent.RoomMetadataChanged, r.metadata);
     };
 
     this.handleConnectionQualityUpdate = update => {
@@ -19855,6 +19882,10 @@ class Room extends events.exports.EventEmitter {
         this.sendSyncState();
       }
     }).on(EngineEvent.Restarting, this.handleRestarting).on(EngineEvent.Restarted, this.handleRestarted);
+
+    if (this.localParticipant) {
+      this.localParticipant.engine = this.engine;
+    }
   }
   /**
    * getLocalDevices abstracts navigator.mediaDevices.enumerateDevices.
@@ -20031,6 +20062,17 @@ class Room extends events.exports.EventEmitter {
     }
   }
 
+  recreateEngine() {
+    this.engine.close();
+    /* @ts-ignore */
+
+    this.engine = undefined; // clear out existing remote participants, since they may have attached
+    // the old engine
+
+    this.participants.clear();
+    this.createEngine();
+  }
+
   onTrackAdded(mediaTrack, stream, receiver) {
     // don't fire onSubscribed when connecting
     // WebRTC fires onTrack as soon as setRemoteDescription is called on the offer
@@ -20040,7 +20082,7 @@ class Room extends events.exports.EventEmitter {
     if (this.state === ConnectionState.Connecting || this.state === ConnectionState.Reconnecting) {
       setTimeout(() => {
         this.onTrackAdded(mediaTrack, stream, receiver);
-      }, 10);
+      }, 50);
       return;
     }
 
@@ -20117,7 +20159,7 @@ class Room extends events.exports.EventEmitter {
     participant.tracks.forEach(publication => {
       participant.unpublishTrack(publication.trackSid, true);
     });
-    this.emit(RoomEvent.ParticipantDisconnected, participant);
+    this.emitWhenConnected(RoomEvent.ParticipantDisconnected, participant);
   }
 
   acquireAudioContext() {
@@ -20251,12 +20293,41 @@ class Room extends events.exports.EventEmitter {
     }
   }
 
-  setAndEmitConnectionState(state) {
+  setAndEmitConnectionState(state, error) {
     if (state === this.state) {
       // unchanged
       return false;
     }
 
+    switch (state) {
+      case ConnectionState.Connecting:
+      case ConnectionState.Reconnecting:
+        if (!this.connectFuture) {
+          // reuse existing connect future if possible
+          this.connectFuture = new Future();
+        }
+
+        break;
+
+      case ConnectionState.Connected:
+        if (this.connectFuture) {
+          this.connectFuture.resolve();
+          this.connectFuture = undefined;
+        }
+
+        break;
+
+      case ConnectionState.Disconnected:
+        if (this.connectFuture) {
+          error !== null && error !== void 0 ? error : error = new Error('disconnected from Room');
+          this.connectFuture.reject(error);
+          this.connectFuture = undefined;
+        }
+
+        break;
+
+    }
+
     this.state = state;
     this.emit(RoomEvent.ConnectionStateChanged, this.state);
     return true;
@@ -20386,12 +20457,12 @@ async function createLocalScreenTracks(options) {
     throw new TrackInvalidError('no video track found');
   }
 
-  const screenVideo = new LocalVideoTrack(tracks[0]);
+  const screenVideo = new LocalVideoTrack(tracks[0], undefined, false);
   screenVideo.source = Track.Source.ScreenShare;
   const localTracks = [screenVideo];
 
   if (stream.getAudioTracks().length > 0) {
-    const screenAudio = new LocalAudioTrack(stream.getAudioTracks()[0]);
+    const screenAudio = new LocalAudioTrack(stream.getAudioTracks()[0], undefined, false);
     screenAudio.source = Track.Source.ScreenShareAudio;
     localTracks.push(screenAudio);
   }