livekit-client 1.0.0 → 1.0.1

package/dist/index.d.ts

@@ -12,7 +12,7 @@ import LocalVideoTrack from './room/track/LocalVideoTrack';
 import RemoteAudioTrack from './room/track/RemoteAudioTrack';
 import RemoteTrack from './room/track/RemoteTrack';
 import RemoteTrackPublication from './room/track/RemoteTrackPublication';
-import RemoteVideoTrack from './room/track/RemoteVideoTrack';
+import RemoteVideoTrack, { ElementInfo } from './room/track/RemoteVideoTrack';
 import { TrackPublication } from './room/track/TrackPublication';
 export * from './options';
 export * from './room/errors';
@@ -22,5 +22,5 @@ export * from './room/track/options';
 export * from './room/track/Track';
 export * from './room/track/types';
 export * from './version';
-export { setLogLevel, setLogExtension, LogLevel, Room, ConnectionState, RoomState, DataPacket_Kind, Participant, RemoteParticipant, LocalParticipant, LocalAudioTrack, LocalVideoTrack, LocalTrack, LocalTrackPublication, RemoteTrack, RemoteAudioTrack, RemoteVideoTrack, RemoteTrackPublication, ParticipantTrackPermission, TrackPublication, VideoQuality, ConnectionQuality, };
+export { setLogLevel, setLogExtension, LogLevel, Room, ConnectionState, RoomState, DataPacket_Kind, Participant, RemoteParticipant, LocalParticipant, LocalAudioTrack, LocalVideoTrack, LocalTrack, LocalTrackPublication, RemoteTrack, RemoteAudioTrack, RemoteVideoTrack, RemoteTrackPublication, ParticipantTrackPermission, TrackPublication, VideoQuality, ConnectionQuality, ElementInfo, };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,gBAAgB,MAAM,qCAAqC,CAAC;AACnE,OAAO,WAAW,EAAE,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,+CAA+C,CAAC;AAC3F,OAAO,iBAAiB,MAAM,sCAAsC,CAAC;AACrE,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,eAAe,MAAM,8BAA8B,CAAC;AAC3D,OAAO,UAAU,MAAM,yBAAyB,CAAC;AACjD,OAAO,qBAAqB,MAAM,oCAAoC,CAAC;AACvE,OAAO,eAAe,MAAM,8BAA8B,CAAC;AAC3D,OAAO,gBAAgB,MAAM,+BAA+B,CAAC;AAC7D,OAAO,WAAW,MAAM,0BAA0B,CAAC;AACnD,OAAO,sBAAsB,MAAM,qCAAqC,CAAC;AACzE,OAAO,gBAAgB,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,OAAO,EACL,WAAW,EACX,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,eAAe,EACf,SAAS,EACT,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,0BAA0B,EAC1B,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,GAClB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAClE,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACvE,OAAO,gBAAgB,MAAM,qCAAqC,CAAC;AACnE,OAAO,WAAW,EAAE,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,+CAA+C,CAAC;AAC3F,OAAO,iBAAiB,MAAM,sCAAsC,CAAC;AACrE,OAAO,IAAI,EAAE,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC/D,OAAO,eAAe,MAAM,8BAA8B,CAAC;AAC3D,OAAO,UAAU,MAAM,yBAAyB,CAAC;AACjD,OAAO,qBAAqB,MAAM,oCAAoC,CAAC;AACvE,OAAO,eAAe,MAAM,8BAA8B,CAAC;AAC3D,OAAO,gBAAgB,MAAM,+BAA+B,CAAC;AAC7D,OAAO,WAAW,MAAM,0BAA0B,CAAC;AACnD,OAAO,sBAAsB,MAAM,qCAAqC,CAAC;AACzE,OAAO,gBAAgB,EAAE,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,+BAA+B,CAAC;AAEjE,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,WAAW,CAAC;AAC1B,OAAO,EACL,WAAW,EACX,eAAe,EACf,QAAQ,EACR,IAAI,EACJ,eAAe,EACf,SAAS,EACT,eAAe,EACf,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,eAAe,EACf,UAAU,EACV,qBAAqB,EACrB,WAAW,EACX,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,0BAA0B,EAC1B,gBAAgB,EAChB,YAAY,EACZ,iBAAiB,EACjB,WAAW,GACZ,CAAC"}

package/dist/livekit-client.esm.mjs

@@ -9779,7 +9779,7 @@ class DeviceManager {
 }
 DeviceManager.mediaDeviceKinds = ['audioinput', 'audiooutput', 'videoinput'];
 
-const version = '1.0.0';
+const version = '1.0.1';
 const protocolVersion = 7;
 
 const separator = '|';
@@ -10332,6 +10332,7 @@ function eventTargetAgnosticAddListener(emitter, name, listener, flags) {
   }
 }
 
+const BACKGROUND_REACTION_DELAY = 5000; // keep old audio elements when detached, we would re-use them since on iOS
 // Safari tracks which audio elements have been "blessed" by the user.
 
 const recycledElements = [];
@@ -10343,7 +10344,17 @@ class Track extends events.exports.EventEmitter {
     this._currentBitrate = 0;
 
     this.appVisibilityChangedListener = () => {
-      this.handleAppVisibilityChanged();
+      if (this.backgroundTimeout) {
+        clearTimeout(this.backgroundTimeout);
+      } // delay app visibility update if it goes to hidden
+      // update immediately if it comes back to focus
+
+
+      if (document.visibilityState === 'hidden') {
+        this.backgroundTimeout = setTimeout(() => this.handleAppVisibilityChanged(), BACKGROUND_REACTION_DELAY);
+      } else {
+        this.handleAppVisibilityChanged();
+      }
     };
 
     this.kind = kind;
@@ -11252,7 +11263,7 @@ class LocalVideoTrack extends LocalTrack {
           bytesSent: v.bytesSent,
           framesSent: v.framesSent,
           timestamp: v.timestamp,
-          rid: (_a = v.rid) !== null && _a !== void 0 ? _a : '',
+          rid: (_a = v.rid) !== null && _a !== void 0 ? _a : v.id,
           retransmittedPacketsSent: v.retransmittedPacketsSent,
           qualityLimitationReason: v.qualityLimitationReason,
           qualityLimitationResolutionChanges: v.qualityLimitationResolutionChanges
@@ -11657,21 +11668,6 @@ class RemoteVideoTrack extends RemoteTrack {
       }, monitorFrequency);
     };
 
-    this.handleVisibilityChanged = entry => {
-      const {
-        target,
-        isIntersecting
-      } = entry;
-      const elementInfo = this.elementInfos.find(info => info.element === target);
-
-      if (elementInfo) {
-        elementInfo.visible = isIntersecting;
-        elementInfo.visibilityChangedAt = Date.now();
-      }
-
-      this.updateVisibility();
-    };
-
     this.debouncedHandleResize = r(() => {
       this.updateDimensions();
     }, REACTION_DELAY);
@@ -11718,23 +11714,55 @@ class RemoteVideoTrack extends RemoteTrack {
 
 
     if (this.adaptiveStreamSettings && this.elementInfos.find(info => info.element === element) === undefined) {
-      this.elementInfos.push({
-        element,
-        visible: true // default visible
+      const elementInfo = new HTMLElementInfo(element);
+      this.observeElementInfo(elementInfo);
+    }
 
-      });
-      element.handleResize = this.debouncedHandleResize;
-      element.handleVisibilityChanged = this.handleVisibilityChanged;
-      getIntersectionObserver().observe(element);
-      getResizeObserver().observe(element); // trigger the first resize update cycle
+    this.hasUsedAttach = true;
+    return element;
+  }
+  /**
+   * Observe an ElementInfo for changes when adaptive streaming.
+   * @param elementInfo
+   * @internal
+   */
+
+
+  observeElementInfo(elementInfo) {
+    if (this.adaptiveStreamSettings && this.elementInfos.find(info => info === elementInfo) === undefined) {
+      elementInfo.handleResize = () => {
+        this.debouncedHandleResize();
+      };
+
+      elementInfo.handleVisibilityChanged = () => {
+        this.updateVisibility();
+      };
+
+      this.elementInfos.push(elementInfo);
+      elementInfo.observe(); // trigger the first resize update cycle
       // if the tab is backgrounded, the initial resize event does not fire until
       // the tab comes into focus for the first time.
 
       this.debouncedHandleResize();
+      this.updateVisibility();
     }
+  }
+  /**
+   * Stop observing an ElementInfo for changes.
+   * @param elementInfo
+   * @internal
+   */
 
-    this.hasUsedAttach = true;
-    return element;
+
+  stopObservingElementInfo(elementInfo) {
+    const stopElementInfos = this.elementInfos.filter(info => info === elementInfo);
+
+    for (const info of stopElementInfos) {
+      info.stopObserving();
+    }
+
+    this.elementInfos = this.elementInfos.filter(info => info !== elementInfo);
+    this.updateVisibility();
   }
 
   detach(element) {
@@ -11785,24 +11813,28 @@ class RemoteVideoTrack extends RemoteTrack {
   }
 
   stopObservingElement(element) {
-    var _a, _b;
+    const stopElementInfos = this.elementInfos.filter(info => info.element === element);
+
+    for (const info of stopElementInfos) {
+      info.stopObserving();
+    }
 
-    (_a = getIntersectionObserver()) === null || _a === void 0 ? void 0 : _a.unobserve(element);
-    (_b = getResizeObserver()) === null || _b === void 0 ? void 0 : _b.unobserve(element);
     this.elementInfos = this.elementInfos.filter(info => info.element !== element);
   }
 
   async handleAppVisibilityChanged() {
     await super.handleAppVisibilityChanged();
-    if (!this.isAdaptiveStream) return; // on desktop don't pause when tab is backgrounded
-
-    if (!isMobile()) return;
+    if (!this.isAdaptiveStream) return;
     this.updateVisibility();
   }
 
   updateVisibility() {
+    var _a, _b;
+
     const lastVisibilityChange = this.elementInfos.reduce((prev, info) => Math.max(prev, info.visibilityChangedAt || 0), 0);
-    const isVisible = this.elementInfos.some(info => info.visible) && !this.isInBackground;
+    const backgroundPause = ((_b = (_a = this.adaptiveStreamSettings) === null || _a === void 0 ? void 0 : _a.pauseVideoInBackground) !== null && _b !== void 0 ? _b : true // default to true
+    ) ? this.isInBackground : false;
+    const isVisible = this.elementInfos.some(info => info.visible) && !backgroundPause;
 
     if (this.lastVisible === isVisible) {
       return;
@@ -11829,8 +11861,8 @@ class RemoteVideoTrack extends RemoteTrack {
     for (const info of this.elementInfos) {
       const pixelDensity = (_b = (_a = this.adaptiveStreamSettings) === null || _a === void 0 ? void 0 : _a.pixelDensity) !== null && _b !== void 0 ? _b : 1;
       const pixelDensityValue = pixelDensity === 'screen' ? window.devicePixelRatio : pixelDensity;
-      const currentElementWidth = info.element.clientWidth * pixelDensityValue;
-      const currentElementHeight = info.element.clientHeight * pixelDensityValue;
+      const currentElementWidth = info.width() * pixelDensityValue;
+      const currentElementHeight = info.height() * pixelDensityValue;
 
       if (currentElementWidth + currentElementHeight > maxWidth + maxHeight) {
         maxWidth = currentElementWidth;
@@ -11851,6 +11883,59 @@ class RemoteVideoTrack extends RemoteTrack {
 
 }
 
+class HTMLElementInfo {
+  constructor(element) {
+    let visible = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+
+    this.onVisibilityChanged = entry => {
+      var _a;
+
+      const {
+        target,
+        isIntersecting
+      } = entry;
+
+      if (target === this.element) {
+        this.visible = isIntersecting;
+        this.visibilityChangedAt = Date.now();
+        (_a = this.handleVisibilityChanged) === null || _a === void 0 ? void 0 : _a.call(this);
+      }
+    };
+
+    this.element = element;
+    this.visible = visible;
+    this.visibilityChangedAt = 0;
+  }
+
+  width() {
+    return this.element.clientWidth;
+  }
+
+  height() {
+    return this.element.clientWidth;
+  }
+
+  observe() {
+    this.element.handleResize = () => {
+      var _a;
+
+      (_a = this.handleResize) === null || _a === void 0 ? void 0 : _a.call(this);
+    };
+
+    this.element.handleVisibilityChanged = this.onVisibilityChanged;
+    getIntersectionObserver().observe(this.element);
+    getResizeObserver().observe(this.element);
+  }
+
+  stopObserving() {
+    var _a, _b;
+
+    (_a = getIntersectionObserver()) === null || _a === void 0 ? void 0 : _a.unobserve(this.element);
+    (_b = getResizeObserver()) === null || _b === void 0 ? void 0 : _b.unobserve(this.element);
+  }
+
+}
+
 class TrackPublication extends events.exports.EventEmitter {
   constructor(kind, id, name) {
     super();
@@ -19258,7 +19343,7 @@ class Room extends events.exports.EventEmitter {
       var _a, _b;
 
       if (pub.track) {
-        this.localParticipant.unpublishTrack(pub.track);
+        this.localParticipant.unpublishTrack(pub.track, shouldStopTracks);
       }
 
       if (shouldStopTracks) {