livekit-client 1.11.0 → 1.11.2

package/dist/livekit-client.esm.mjs

@@ -14187,7 +14187,7 @@ function getMatch(exp, ua) {
   return match && match.length >= id && match[id] || '';
 }
 
-var version$1 = "1.11.0";
+var version$1 = "1.11.2";
 
 const version = version$1;
 const protocolVersion = 9;
@@ -14636,6 +14636,27 @@ class Mutex {
     return willUnlock;
   }
 }
+function unwrapConstraint(constraint) {
+  if (typeof constraint === 'string') {
+    return constraint;
+  }
+  if (Array.isArray(constraint)) {
+    return constraint[0];
+  }
+  if (constraint.exact) {
+    if (Array.isArray(constraint.exact)) {
+      return constraint.exact[0];
+    }
+    return constraint.exact;
+  }
+  if (constraint.ideal) {
+    if (Array.isArray(constraint.ideal)) {
+      return constraint.ideal[0];
+    }
+    return constraint.ideal;
+  }
+  throw Error('could not unwrap constraint');
+}
 
 var QueueTaskStatus;
 (function (QueueTaskStatus) {
@@ -16734,6 +16755,11 @@ var RoomEvent;
    * args: (isLow: boolean, kind: [[DataPacket_Kind]])
    */
   RoomEvent["DCBufferStatusChanged"] = "dcBufferStatusChanged";
+  /**
+   * Triggered by a call to room.switchActiveDevice
+   * args: (kind: MediaDeviceKind, deviceId: string)
+   */
+  RoomEvent["ActiveDeviceChanged"] = "activeDeviceChanged";
 })(RoomEvent || (RoomEvent = {}));
 var ParticipantEvent;
 (function (ParticipantEvent) {
@@ -18377,8 +18403,56 @@ class LocalTrack extends Track {
       if (this.isInBackground) {
         this.reacquireTrack = true;
       }
+      this._mediaStreamTrack.removeEventListener('mute', this.pauseUpstream);
+      this._mediaStreamTrack.removeEventListener('unmute', this.resumeUpstream);
       this.emit(TrackEvent.Ended, this);
     };
+    /**
+     * pauses publishing to the server without disabling the local MediaStreamTrack
+     * this is used to display a user's own video locally while pausing publishing to
+     * the server.
+     * this API is unsupported on Safari < 12 due to a bug
+     **/
+    this.pauseUpstream = () => __awaiter(this, void 0, void 0, function* () {
+      const unlock = yield this.pauseUpstreamLock.lock();
+      try {
+        if (this._isUpstreamPaused === true) {
+          return;
+        }
+        if (!this.sender) {
+          livekitLogger.warn('unable to pause upstream for an unpublished track');
+          return;
+        }
+        this._isUpstreamPaused = true;
+        this.emit(TrackEvent.UpstreamPaused, this);
+        const browser = getBrowser();
+        if ((browser === null || browser === void 0 ? void 0 : browser.name) === 'Safari' && compareVersions(browser.version, '12.0') < 0) {
+          // https://bugs.webkit.org/show_bug.cgi?id=184911
+          throw new DeviceUnsupportedError('pauseUpstream is not supported on Safari < 12.');
+        }
+        yield this.sender.replaceTrack(null);
+      } finally {
+        unlock();
+      }
+    });
+    this.resumeUpstream = () => __awaiter(this, void 0, void 0, function* () {
+      const unlock = yield this.pauseUpstreamLock.lock();
+      try {
+        if (this._isUpstreamPaused === false) {
+          return;
+        }
+        if (!this.sender) {
+          livekitLogger.warn('unable to resume upstream for an unpublished track');
+          return;
+        }
+        this._isUpstreamPaused = false;
+        this.emit(TrackEvent.UpstreamResumed, this);
+        // this operation is noop if mediastreamtrack is already being sent
+        yield this.sender.replaceTrack(this._mediaStreamTrack);
+      } finally {
+        unlock();
+      }
+    });
     this.reacquireTrack = false;
     this.providedByUser = userProvidedTrack;
     this.muteLock = new Mutex();
@@ -18444,10 +18518,7 @@ class LocalTrack extends Track {
         // the track is "muted"
         // note this is different from LocalTrack.mute because we do not want to
         // touch MediaStreamTrack.enabled
-        newTrack.addEventListener('mute', () => {
-          livekitLogger.info('pausing upstream due to device mute');
-          this.pauseUpstream();
-        });
+        newTrack.addEventListener('mute', this.pauseUpstream);
         newTrack.addEventListener('unmute', this.resumeUpstream);
         this.constraints = newTrack.getConstraints();
       }
@@ -18519,7 +18590,7 @@ class LocalTrack extends Track {
         throw new TrackInvalidError('unable to replace an unpublished track');
       }
       livekitLogger.debug('replace MediaStreamTrack');
-      this.setMediaStreamTrack(track);
+      yield this.setMediaStreamTrack(track);
       // this must be synced *after* setting mediaStreamTrack above, since it relies
       // on the previous state in order to cleanup
       this.providedByUser = userProvidedTrack;
@@ -18559,7 +18630,7 @@ class LocalTrack extends Track {
       const newTrack = mediaStream.getTracks()[0];
       newTrack.addEventListener('ended', this.handleEnded);
       livekitLogger.debug('re-acquired MediaStreamTrack');
-      this.setMediaStreamTrack(newTrack);
+      yield this.setMediaStreamTrack(newTrack);
       this.constraints = constraints;
       if (this.processor) {
         const processor = this.processor;
@@ -18605,59 +18676,12 @@ class LocalTrack extends Track {
   stop() {
     var _a;
     super.stop();
+    this._mediaStreamTrack.removeEventListener('ended', this.handleEnded);
+    this._mediaStreamTrack.removeEventListener('mute', this.pauseUpstream);
+    this._mediaStreamTrack.removeEventListener('unmute', this.resumeUpstream);
     (_a = this.processor) === null || _a === void 0 ? void 0 : _a.destroy();
     this.processor = undefined;
   }
-  /**
-   * pauses publishing to the server without disabling the local MediaStreamTrack
-   * this is used to display a user's own video locally while pausing publishing to
-   * the server.
-   * this API is unsupported on Safari < 12 due to a bug
-   **/
-  pauseUpstream() {
-    return __awaiter(this, void 0, void 0, function* () {
-      const unlock = yield this.pauseUpstreamLock.lock();
-      try {
-        if (this._isUpstreamPaused === true) {
-          return;
-        }
-        if (!this.sender) {
-          livekitLogger.warn('unable to pause upstream for an unpublished track');
-          return;
-        }
-        this._isUpstreamPaused = true;
-        this.emit(TrackEvent.UpstreamPaused, this);
-        const browser = getBrowser();
-        if ((browser === null || browser === void 0 ? void 0 : browser.name) === 'Safari' && compareVersions(browser.version, '12.0') < 0) {
-          // https://bugs.webkit.org/show_bug.cgi?id=184911
-          throw new DeviceUnsupportedError('pauseUpstream is not supported on Safari < 12.');
-        }
-        yield this.sender.replaceTrack(null);
-      } finally {
-        unlock();
-      }
-    });
-  }
-  resumeUpstream() {
-    return __awaiter(this, void 0, void 0, function* () {
-      const unlock = yield this.pauseUpstreamLock.lock();
-      try {
-        if (this._isUpstreamPaused === false) {
-          return;
-        }
-        if (!this.sender) {
-          livekitLogger.warn('unable to resume upstream for an unpublished track');
-          return;
-        }
-        this._isUpstreamPaused = false;
-        this.emit(TrackEvent.UpstreamResumed, this);
-        // this operation is noop if mediastreamtrack is already being sent
-        yield this.sender.replaceTrack(this._mediaStreamTrack);
-      } finally {
-        unlock();
-      }
-    });
-  }
   /**
    * Sets a processor on this track.
    * See https://github.com/livekit/track-processors-js for example usage
@@ -18768,12 +18792,13 @@ class LocalAudioTrack extends LocalTrack {
   setDeviceId(deviceId) {
     return __awaiter(this, void 0, void 0, function* () {
       if (this.constraints.deviceId === deviceId) {
-        return;
+        return true;
       }
       this.constraints.deviceId = deviceId;
       if (!this.isMuted) {
         yield this.restartTrack();
       }
+      return unwrapConstraint(deviceId) === this.mediaStreamTrack.getSettings().deviceId;
     });
   }
   mute() {
@@ -19361,8 +19386,8 @@ class LocalVideoTrack extends LocalTrack {
   }
   setDeviceId(deviceId) {
     return __awaiter(this, void 0, void 0, function* () {
-      if (this.constraints.deviceId === deviceId) {
-        return;
+      if (this.constraints.deviceId === deviceId && this._mediaStreamTrack.getSettings().deviceId === unwrapConstraint(deviceId)) {
+        return true;
       }
       this.constraints.deviceId = deviceId;
       // when video is muted, underlying media stream track is stopped and
@@ -19370,6 +19395,7 @@ class LocalVideoTrack extends LocalTrack {
       if (!this.isMuted) {
         yield this.restartTrack();
       }
+      return unwrapConstraint(deviceId) === this._mediaStreamTrack.getSettings().deviceId;
     });
   }
   restartTrack(options) {
@@ -19864,7 +19890,6 @@ class RemoteVideoTrack extends RemoteTrack {
   constructor(mediaTrack, sid, receiver, adaptiveStreamSettings) {
     super(mediaTrack, sid, Track.Kind.Video, receiver);
     this.elementInfos = [];
-    this.isObserved = false;
     this.monitorReceiver = () => __awaiter(this, void 0, void 0, function* () {
       if (!this.receiver) {
         this._currentBitrate = 0;
@@ -19884,10 +19909,10 @@ class RemoteVideoTrack extends RemoteTrack {
   get isAdaptiveStream() {
     return this.adaptiveStreamSettings !== undefined;
   }
+  /**
+   * Note: When using adaptiveStream, you need to use remoteVideoTrack.attach() to add the track to a HTMLVideoElement, otherwise your video tracks might never start
+   */
   get mediaStreamTrack() {
-    if (this.isAdaptiveStream && !this.isObserved) {
-      livekitLogger.warn('When using adaptiveStream, you need to use remoteVideoTrack.attach() to add the track to a HTMLVideoElement, otherwise your video tracks might never start');
-    }
     return this._mediaStreamTrack;
   }
   /** @internal */
@@ -19936,7 +19961,6 @@ class RemoteVideoTrack extends RemoteTrack {
       // the tab comes into focus for the first time.
       this.debouncedHandleResize();
       this.updateVisibility();
-      this.isObserved = true;
     } else {
       livekitLogger.warn('visibility resize observer not triggered');
     }
@@ -22064,6 +22088,7 @@ class Room extends EventEmitter {
    */
   constructor(options) {
     var _this;
+    var _a;
     super();
     _this = this;
     this.state = ConnectionState.Disconnected;
@@ -22089,7 +22114,7 @@ class Room extends EventEmitter {
       this.setAndEmitConnectionState(ConnectionState.Connecting);
       const urlProvider = new RegionUrlProvider(url, token);
       const connectFn = (resolve, reject, regionUrl) => __awaiter(this, void 0, void 0, function* () {
-        var _a;
+        var _b;
         if (this.abortController) {
           this.abortController.abort();
         }
@@ -22104,7 +22129,7 @@ class Room extends EventEmitter {
           if (isCloud(new URL(url)) && e instanceof ConnectionError && e.reason !== 3 /* ConnectionErrorReason.Cancelled */) {
             let nextUrl = null;
             try {
-              nextUrl = yield urlProvider.getNextBestRegionUrl((_a = this.abortController) === null || _a === void 0 ? void 0 : _a.signal);
+              nextUrl = yield urlProvider.getNextBestRegionUrl((_b = this.abortController) === null || _b === void 0 ? void 0 : _b.signal);
             } catch (error) {
               if (error instanceof ConnectionError && (error.status === 401 || error.reason === 3 /* ConnectionErrorReason.Cancelled */)) {
                 reject(error);
@@ -22166,7 +22191,7 @@ class Room extends EventEmitter {
       }
     };
     this.attemptConnection = (url, token, opts, abortController) => __awaiter(this, void 0, void 0, function* () {
-      var _b;
+      var _c;
       if (this.state === ConnectionState.Reconnecting) {
         livekitLogger.info('Reconnection attempt replaced by new connection attempt');
         // make sure we close and recreate the existing engine in order to get rid of any potentially ongoing reconnection attempts
@@ -22225,7 +22250,7 @@ class Room extends EventEmitter {
       }
       if (isWeb()) {
         document.addEventListener('freeze', this.onPageLeave);
-        (_b = navigator.mediaDevices) === null || _b === void 0 ? void 0 : _b.addEventListener('devicechange', this.handleDeviceChange);
+        (_c = navigator.mediaDevices) === null || _c === void 0 ? void 0 : _c.addEventListener('devicechange', this.handleDeviceChange);
       }
       this.setAndEmitConnectionState(ConnectionState.Connected);
       this.emit(RoomEvent.Connected);
@@ -22237,7 +22262,7 @@ class Room extends EventEmitter {
     this.disconnect = function () {
       let stopTracks = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
       return __awaiter(_this, void 0, void 0, function* () {
-        var _c, _d, _e, _f;
+        var _d, _e, _f, _g;
         const unlock = yield this.disconnectLock.lock();
         try {
           if (this.state === ConnectionState.Disconnected) {
@@ -22250,13 +22275,13 @@ class Room extends EventEmitter {
           if (this.state === ConnectionState.Connecting || this.state === ConnectionState.Reconnecting) {
             // try aborting pending connection attempt
             livekitLogger.warn('abort connection attempt');
-            (_c = this.abortController) === null || _c === void 0 ? void 0 : _c.abort();
+            (_d = this.abortController) === null || _d === void 0 ? void 0 : _d.abort();
             // in case the abort controller didn't manage to cancel the connection attempt, reject the connect promise explicitly
-            (_e = (_d = this.connectFuture) === null || _d === void 0 ? void 0 : _d.reject) === null || _e === void 0 ? void 0 : _e.call(_d, new ConnectionError('Client initiated disconnect'));
+            (_f = (_e = this.connectFuture) === null || _e === void 0 ? void 0 : _e.reject) === null || _f === void 0 ? void 0 : _f.call(_e, new ConnectionError('Client initiated disconnect'));
             this.connectFuture = undefined;
           }
           // send leave
-          if ((_f = this.engine) === null || _f === void 0 ? void 0 : _f.client.isConnected) {
+          if ((_g = this.engine) === null || _g === void 0 ? void 0 : _g.client.isConnected) {
             yield this.engine.client.sendLeave();
           }
           // close engine (also closes client)
@@ -22326,7 +22351,7 @@ class Room extends EventEmitter {
         livekitLogger.debug("fully reconnected to server", {
           region: joinResponse.serverRegion
         });
-      } catch (_g) {
+      } catch (_h) {
         // reconnection failed, handleDisconnect is being invoked already, just return here
         return;
       }
@@ -22551,6 +22576,16 @@ class Room extends EventEmitter {
     this.options.publishDefaults = Object.assign(Object.assign({}, publishDefaults), options === null || options === void 0 ? void 0 : options.publishDefaults);
     this.maybeCreateEngine();
     this.disconnectLock = new Mutex();
+    this.activeDeviceMap = new Map();
+    if (this.options.videoCaptureDefaults.deviceId) {
+      this.activeDeviceMap.set('videoinput', unwrapConstraint(this.options.videoCaptureDefaults.deviceId));
+    }
+    if (this.options.audioCaptureDefaults.deviceId) {
+      this.activeDeviceMap.set('audioinput', unwrapConstraint(this.options.audioCaptureDefaults.deviceId));
+    }
+    if ((_a = this.options.audioOutput) === null || _a === void 0 ? void 0 : _a.deviceId) {
+      this.switchActiveDevice('audiooutput', unwrapConstraint(this.options.audioOutput.deviceId));
+    }
     this.localParticipant = new LocalParticipant('', '', this.engine, this.options);
   }
   /**
@@ -22816,15 +22851,16 @@ class Room extends EventEmitter {
   }
   /**
    * Returns the active audio output device used in this room.
-   *
-   * Note: to get the active `audioinput` or `videoinput` use [[LocalTrack.getDeviceId()]]
-   *
    * @return the previously successfully set audio output device ID or an empty string if the default device is used.
+   * @deprecated use `getActiveDevice('audiooutput')` instead
    */
   getActiveAudioOutputDevice() {
     var _a, _b;
     return (_b = (_a = this.options.audioOutput) === null || _a === void 0 ? void 0 : _a.deviceId) !== null && _b !== void 0 ? _b : '';
   }
+  getActiveDevice(kind) {
+    return this.activeDeviceMap.get(kind);
+  }
   /**
    * Switches all active devices used in this room to the given device.
    *
@@ -22837,21 +22873,24 @@ class Room extends EventEmitter {
    */
   switchActiveDevice(kind, deviceId) {
     let exact = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
-    var _a;
-    var _b;
+    var _a, _b;
+    var _c;
     return __awaiter(this, void 0, void 0, function* () {
+      let deviceHasChanged = false;
+      let success = true;
       const deviceConstraint = exact ? {
         exact: deviceId
       } : deviceId;
       if (kind === 'audioinput') {
         const prevDeviceId = this.options.audioCaptureDefaults.deviceId;
         this.options.audioCaptureDefaults.deviceId = deviceConstraint;
+        deviceHasChanged = prevDeviceId !== deviceConstraint;
         const tracks = Array.from(this.localParticipant.audioTracks.values()).filter(track => track.source === Track.Source.Microphone);
         try {
-          yield Promise.all(tracks.map(t => {
+          success = (yield Promise.all(tracks.map(t => {
             var _a;
             return (_a = t.audioTrack) === null || _a === void 0 ? void 0 : _a.setDeviceId(deviceConstraint);
-          }));
+          }))).every(val => val === true);
         } catch (e) {
           this.options.audioCaptureDefaults.deviceId = prevDeviceId;
           throw e;
@@ -22859,33 +22898,44 @@ class Room extends EventEmitter {
       } else if (kind === 'videoinput') {
         const prevDeviceId = this.options.videoCaptureDefaults.deviceId;
         this.options.videoCaptureDefaults.deviceId = deviceConstraint;
+        deviceHasChanged = prevDeviceId !== deviceConstraint;
         const tracks = Array.from(this.localParticipant.videoTracks.values()).filter(track => track.source === Track.Source.Camera);
         try {
-          yield Promise.all(tracks.map(t => {
+          success = (yield Promise.all(tracks.map(t => {
             var _a;
             return (_a = t.videoTrack) === null || _a === void 0 ? void 0 : _a.setDeviceId(deviceConstraint);
-          }));
+          }))).every(val => val === true);
         } catch (e) {
           this.options.videoCaptureDefaults.deviceId = prevDeviceId;
           throw e;
         }
       } else if (kind === 'audiooutput') {
-        // TODO add support for webaudio mix once the API becomes available https://github.com/WebAudio/web-audio-api/pull/2498
-        if (!supportsSetSinkId()) {
+        if (!supportsSetSinkId() && !this.options.expWebAudioMix || this.audioContext && !('setSinkId' in this.audioContext)) {
           throw new Error('cannot switch audio output, setSinkId not supported');
         }
-        (_a = (_b = this.options).audioOutput) !== null && _a !== void 0 ? _a : _b.audioOutput = {};
+        (_a = (_c = this.options).audioOutput) !== null && _a !== void 0 ? _a : _c.audioOutput = {};
         const prevDeviceId = this.options.audioOutput.deviceId;
         this.options.audioOutput.deviceId = deviceId;
+        deviceHasChanged = prevDeviceId !== deviceConstraint;
         try {
-          yield Promise.all(Array.from(this.participants.values()).map(p => p.setAudioOutput({
-            deviceId
-          })));
+          if (this.options.expWebAudioMix) {
+            // @ts-expect-error setSinkId is not yet in the typescript type of AudioContext
+            (_b = this.audioContext) === null || _b === void 0 ? void 0 : _b.setSinkId(deviceId);
+          } else {
+            yield Promise.all(Array.from(this.participants.values()).map(p => p.setAudioOutput({
+              deviceId
+            })));
+          }
         } catch (e) {
           this.options.audioOutput.deviceId = prevDeviceId;
           throw e;
         }
       }
+      if (deviceHasChanged && success) {
+        this.activeDeviceMap.set(kind, deviceId);
+        this.emit(RoomEvent.ActiveDeviceChanged, kind, deviceId);
+      }
+      return success;
     });
   }
   setupLocalParticipantEvents() {