livekit-client 0.18.4 → 0.18.5

package/dist/livekit-client.esm.mjs

@@ -9783,7 +9783,7 @@ class DeviceManager {
 }
 DeviceManager.mediaDeviceKinds = ['audioinput', 'audiooutput', 'videoinput'];
 
-const version = '0.18.4';
+const version = '0.18.5';
 const protocolVersion = 7;
 
 const separator = '|';
@@ -10351,7 +10351,7 @@ class Track extends events.exports.EventEmitter {
     };
 
     this.kind = kind;
-    this.mediaStreamTrack = mediaTrack;
+    this._mediaStreamTrack = mediaTrack;
     this.source = Track.Source.Unknown;
 
     if (isWeb()) {
@@ -10368,6 +10368,10 @@ class Track extends events.exports.EventEmitter {
     return this._currentBitrate;
   }
 
+  get mediaStreamTrack() {
+    return this._mediaStreamTrack;
+  }
+
   attach(element) {
     let elementType = 'audio';
 
@@ -10401,7 +10405,7 @@ class Track extends events.exports.EventEmitter {
     // we'll want to re-attach it in that case
 
 
-    attachToElement(this.mediaStreamTrack, element);
+    attachToElement(this._mediaStreamTrack, element);
 
     if (element instanceof HTMLAudioElement) {
       // manually play audio to detect audio playback status
@@ -10419,7 +10423,7 @@ class Track extends events.exports.EventEmitter {
   detach(element) {
     // detach from a single element
     if (element) {
-      detachTrack(this.mediaStreamTrack, element);
+      detachTrack(this._mediaStreamTrack, element);
       const idx = this.attachedElements.indexOf(element);
 
       if (idx >= 0) {
@@ -10433,7 +10437,7 @@ class Track extends events.exports.EventEmitter {
 
     const detached = [];
     this.attachedElements.forEach(elm => {
-      detachTrack(this.mediaStreamTrack, elm);
+      detachTrack(this._mediaStreamTrack, elm);
       detached.push(elm);
       this.recycleElement(elm);
       this.emit(TrackEvent.ElementDetached, elm);
@@ -10444,7 +10448,7 @@ class Track extends events.exports.EventEmitter {
   }
 
   stop() {
-    this.mediaStreamTrack.stop();
+    this._mediaStreamTrack.stop();
 
     if (isWeb()) {
       document.removeEventListener('visibilitychange', this.appVisibilityChangedListener);
@@ -10452,11 +10456,11 @@ class Track extends events.exports.EventEmitter {
   }
 
   enable() {
-    this.mediaStreamTrack.enabled = true;
+    this._mediaStreamTrack.enabled = true;
   }
 
   disable() {
-    this.mediaStreamTrack.enabled = false;
+    this._mediaStreamTrack.enabled = false;
   }
 
   recycleElement(element) {
@@ -10686,14 +10690,15 @@ class LocalTrack extends Track {
       this.emit(TrackEvent.Ended, this);
     };
 
-    this.mediaStreamTrack.addEventListener('ended', this.handleEnded);
+    this._mediaStreamTrack.addEventListener('ended', this.handleEnded);
+
     this.constraints = constraints !== null && constraints !== void 0 ? constraints : mediaTrack.getConstraints();
     this.reacquireTrack = false;
     this.wasMuted = false;
   }
 
   get id() {
-    return this.mediaStreamTrack.id;
+    return this._mediaStreamTrack.id;
   }
 
   get dimensions() {
@@ -10704,7 +10709,7 @@ class LocalTrack extends Track {
     const {
       width,
       height
-    } = this.mediaStreamTrack.getSettings();
+    } = this._mediaStreamTrack.getSettings();
 
     if (width && height) {
       return {
@@ -10733,7 +10738,8 @@ class LocalTrack extends Track {
     const {
       deviceId,
       groupId
-    } = this.mediaStreamTrack.getSettings();
+    } = this._mediaStreamTrack.getSettings();
+
     const kind = this.kind === Track.Kind.Audio ? 'audioinput' : 'videoinput';
     return DeviceManager.getInstance().normalizeDeviceId(kind, deviceId, groupId);
   }
@@ -10755,17 +10761,20 @@ class LocalTrack extends Track {
 
 
     this.attachedElements.forEach(el => {
-      detachTrack(this.mediaStreamTrack, el);
+      detachTrack(this._mediaStreamTrack, el);
     });
-    this.mediaStreamTrack.removeEventListener('ended', this.handleEnded); // on Safari, the old audio track must be stopped before attempting to acquire
+
+    this._mediaStreamTrack.removeEventListener('ended', this.handleEnded); // on Safari, the old audio track must be stopped before attempting to acquire
     // the new track, otherwise the new track will stop with
     // 'A MediaStreamTrack ended due to a capture failure`
 
-    this.mediaStreamTrack.stop();
+
+    this._mediaStreamTrack.stop();
+
     track.addEventListener('ended', this.handleEnded);
     livekitLogger.debug('replace MediaStreamTrack');
     await this.sender.replaceTrack(track);
-    this.mediaStreamTrack = track;
+    this._mediaStreamTrack = track;
     this.attachedElements.forEach(el => {
       attachToElement(track, el);
     });
@@ -10796,20 +10805,23 @@ class LocalTrack extends Track {
 
 
     this.attachedElements.forEach(el => {
-      detachTrack(this.mediaStreamTrack, el);
+      detachTrack(this._mediaStreamTrack, el);
     });
-    this.mediaStreamTrack.removeEventListener('ended', this.handleEnded); // on Safari, the old audio track must be stopped before attempting to acquire
+
+    this._mediaStreamTrack.removeEventListener('ended', this.handleEnded); // on Safari, the old audio track must be stopped before attempting to acquire
     // the new track, otherwise the new track will stop with
     // 'A MediaStreamTrack ended due to a capture failure`
 
-    this.mediaStreamTrack.stop(); // create new track and attach
+
+    this._mediaStreamTrack.stop(); // create new track and attach
+
 
     const mediaStream = await navigator.mediaDevices.getUserMedia(streamConstraints);
     const newTrack = mediaStream.getTracks()[0];
     newTrack.addEventListener('ended', this.handleEnded);
     livekitLogger.debug('re-acquired MediaStreamTrack');
     await this.sender.replaceTrack(newTrack);
-    this.mediaStreamTrack = newTrack;
+    this._mediaStreamTrack = newTrack;
     this.attachedElements.forEach(el => {
       attachToElement(newTrack, el);
     });
@@ -10824,12 +10836,12 @@ class LocalTrack extends Track {
     }
 
     this.isMuted = muted;
-    this.mediaStreamTrack.enabled = !muted;
+    this._mediaStreamTrack.enabled = !muted;
     this.emit(muted ? TrackEvent.Muted : TrackEvent.Unmuted, this);
   }
 
   get needsReAcquisition() {
-    return this.mediaStreamTrack.readyState !== 'live' || this.mediaStreamTrack.muted || !this.mediaStreamTrack.enabled || this.reacquireTrack;
+    return this._mediaStreamTrack.readyState !== 'live' || this._mediaStreamTrack.muted || !this._mediaStreamTrack.enabled || this.reacquireTrack;
   }
 
   async handleAppVisibilityChanged() {
@@ -10879,7 +10891,7 @@ class LocalTrack extends Track {
 
     this._isUpstreamPaused = false;
     this.emit(TrackEvent.UpstreamResumed, this);
-    await this.sender.replaceTrack(this.mediaStreamTrack);
+    await this.sender.replaceTrack(this._mediaStreamTrack);
   }
 
 }
@@ -11004,7 +11016,9 @@ class LocalAudioTrack extends LocalTrack {
       try {
         stats = await this.getSenderStats();
       } catch (e) {
-        livekitLogger.error('could not get audio sender stats', e);
+        livekitLogger.error('could not get audio sender stats', {
+          error: e
+        });
         return;
       }
 
@@ -11038,7 +11052,7 @@ class LocalAudioTrack extends LocalTrack {
     if (this.source === Track.Source.Microphone && this.stopOnMute) {
       livekitLogger.debug('stopping mic track'); // also stop the track, so that microphone indicator is turned off
 
-      this.mediaStreamTrack.stop();
+      this._mediaStreamTrack.stop();
     }
 
     await super.mute();
@@ -11192,7 +11206,9 @@ class LocalVideoTrack extends LocalTrack {
 
   stop() {
     this.sender = undefined;
-    this.mediaStreamTrack.getConstraints();
+
+    this._mediaStreamTrack.getConstraints();
+
     super.stop();
   }
 
@@ -11200,7 +11216,7 @@ class LocalVideoTrack extends LocalTrack {
     if (this.source === Track.Source.Camera) {
       livekitLogger.debug('stopping camera track'); // also stop the track, so that camera indicator is turned off
 
-      this.mediaStreamTrack.stop();
+      this._mediaStreamTrack.stop();
     }
 
     await super.mute();
@@ -11381,7 +11397,7 @@ class LocalVideoTrack extends LocalTrack {
     if (!isMobile()) return;
 
     if (this.isInBackground && this.source === Track.Source.Camera) {
-      this.mediaStreamTrack.enabled = false;
+      this._mediaStreamTrack.enabled = false;
     }
   }
 
@@ -11672,6 +11688,14 @@ class RemoteVideoTrack extends RemoteTrack {
   get isAdaptiveStream() {
     return this.adaptiveStreamSettings !== undefined;
   }
+
+  get mediaStreamTrack() {
+    if (this.isAdaptiveStream && this.attachedElements.length === 0) {
+      throw Error('When using adaptiveStream, you need to use remoteVideoTrack.attach() to add the track to a HTMLVideoElement, direct usage of mediaStreamTrack is unsupported in this case');
+    }
+
+    return this._mediaStreamTrack;
+  }
   /** @internal */
 
 
@@ -11680,9 +11704,9 @@ class RemoteVideoTrack extends RemoteTrack {
     this.attachedElements.forEach(element => {
       // detach or attach
       if (muted) {
-        detachTrack(this.mediaStreamTrack, element);
+        detachTrack(this._mediaStreamTrack, element);
       } else {
-        attachToElement(this.mediaStreamTrack, element);
+        attachToElement(this._mediaStreamTrack, element);
       }
     });
   }
@@ -12432,9 +12456,10 @@ function computeVideoEncodings(isScreenShare, width, height, options) {
   }
 
   const useSimulcast = options === null || options === void 0 ? void 0 : options.simulcast;
+  const scalabilityMode = options === null || options === void 0 ? void 0 : options.scalabilityMode;
 
-  if (!videoEncoding && !useSimulcast || !width || !height) {
-    // when we aren't simulcasting, will need to return a single encoding without
+  if (!videoEncoding && !useSimulcast && !scalabilityMode || !width || !height) {
+    // when we aren't simulcasting or svc, will need to return a single encoding without
     // capping bandwidth. we always require a encoding for dynacast
     return [{}];
   }
@@ -12445,11 +12470,41 @@ function computeVideoEncodings(isScreenShare, width, height, options) {
     livekitLogger.debug('using video encoding', videoEncoding);
   }
 
+  const original = new VideoPreset(width, height, videoEncoding.maxBitrate, videoEncoding.maxFramerate);
+  livekitLogger.debug("scalabilityMode ".concat(scalabilityMode));
+
+  if (scalabilityMode) {
+    const encodings = []; // svc use first encoding as the original, so we sort encoding from high to low
+
+    switch (scalabilityMode) {
+      case 'L3T3':
+        for (let i = 0; i < 3; i += 1) {
+          encodings.push({
+            rid: videoRids[2 - i],
+            scaleResolutionDownBy: 2 ** i,
+            maxBitrate: videoEncoding ? videoEncoding.maxBitrate / 2 ** i : 0,
+
+            /* @ts-ignore */
+            maxFramerate: original.encoding.maxFramerate,
+
+            /* @ts-ignore */
+            scalabilityMode: 'L3T3'
+          });
+        }
+
+        livekitLogger.debug('encodings', encodings);
+        return encodings;
+
+      default:
+        // TODO : support other scalability modes
+        throw new Error("unsupported scalabilityMode: ".concat(scalabilityMode));
+    }
+  }
+
   if (!useSimulcast) {
     return [videoEncoding];
   }
 
-  const original = new VideoPreset(width, height, videoEncoding.maxBitrate, videoEncoding.maxFramerate);
   let presets = [];
 
   if (isScreenShare) {
@@ -13441,7 +13496,7 @@ class LocalParticipant extends Participant {
 
 
   async publishTrack(track, options) {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
 
     const opts = _objectSpread2(_objectSpread2({}, (_a = this.roomOptions) === null || _a === void 0 ? void 0 : _a.publishDefaults), options); // convert raw media track into audio or video track
 
@@ -13514,7 +13569,19 @@ class LocalParticipant extends Participant {
       const height = (_e = settings.height) !== null && _e !== void 0 ? _e : (_f = track.dimensions) === null || _f === void 0 ? void 0 : _f.height; // width and height should be defined for video
 
       req.width = width !== null && width !== void 0 ? width : 0;
-      req.height = height !== null && height !== void 0 ? height : 0;
+      req.height = height !== null && height !== void 0 ? height : 0; // for svc codecs, disable simulcast and enable scalability L3T3
+      // by default
+
+      if (track instanceof LocalVideoTrack) {
+        if ((opts === null || opts === void 0 ? void 0 : opts.videoCodec) === 'vp9' || (opts === null || opts === void 0 ? void 0 : opts.videoCodec) === 'av1') {
+          opts.simulcast = false;
+          opts.scalabilityMode = (_g = opts.scalabilityMode) !== null && _g !== void 0 ? _g : 'L3T3';
+        } else {
+          // other codecs, unset scalability
+          opts.scalabilityMode = undefined;
+        }
+      }
+
       encodings = computeVideoEncodings(track.source === Track.Source.ScreenShare, width, height, opts);
       req.layers = videoLayersFromEncodings(req.width, req.height, encodings);
     } else if (track.kind === Track.Kind.Audio && opts.audioBitrate) {
@@ -13544,6 +13611,11 @@ class LocalParticipant extends Participant {
     }
 
     const transceiver = this.engine.publisher.pc.addTransceiver(track.mediaStreamTrack, transceiverInit);
+
+    if (opts.videoCodec) {
+      this.setPreferredCodec(transceiver, track.kind, opts.videoCodec);
+    }
+
     this.engine.negotiate(); // store RTPSender
 
     track.sender = transceiver.sender;
@@ -13554,10 +13626,6 @@ class LocalParticipant extends Participant {
       track.startMonitor();
     }
 
-    if (opts.videoCodec) {
-      this.setPreferredCodec(transceiver, track.kind, opts.videoCodec);
-    }
-
     this.addTrackPublication(publication); // send event for publication
 
     this.emit(ParticipantEvent.LocalTrackPublished, publication);
@@ -13739,21 +13807,38 @@ class LocalParticipant extends Participant {
 
     const cap = RTCRtpSender.getCapabilities(kind);
     if (!cap) return;
-    const selected = cap.codecs.find(c => {
+    let selected;
+    const codecs = [];
+    cap.codecs.forEach(c => {
       const codec = c.mimeType.toLowerCase();
-      const matchesVideoCodec = codec === "video/".concat(videoCodec); // for h264 codecs that have sdpFmtpLine available, use only if the
+      const matchesVideoCodec = codec === "video/".concat(videoCodec);
+
+      if (selected !== undefined) {
+        codecs.push(c);
+        return;
+      } // for h264 codecs that have sdpFmtpLine available, use only if the
       // profile-level-id is 42e01f for cross-browser compatibility
 
+
       if (videoCodec === 'h264' && c.sdpFmtpLine) {
-        return matchesVideoCodec && c.sdpFmtpLine.includes('profile-level-id=42e01f');
+        if (matchesVideoCodec && c.sdpFmtpLine.includes('profile-level-id=42e01f')) {
+          selected = c;
+          return;
+        }
+      }
+
+      if (matchesVideoCodec || codec === 'audio/opus') {
+        selected = c;
+        return;
       }
 
-      return matchesVideoCodec || codec === 'audio/opus';
+      codecs.push(c);
     });
 
     if (selected && 'setCodecPreferences' in transceiver) {
       // @ts-ignore
-      transceiver.setCodecPreferences([selected]);
+      codecs.unshift(selected);
+      transceiver.setCodecPreferences(codecs);
     }
   }
   /** @internal */
@@ -18525,12 +18610,11 @@ const publishDefaults = {
 };
 const audioDefaults = {
   autoGainControl: true,
-  channelCount: 1,
   echoCancellation: true,
   noiseSuppression: true
 };
 const videoDefaults = {
-  resolution: VideoPresets.h540.resolution
+  resolution: VideoPresets.h720.resolution
 };
 
 var RoomState;