Release - 0.12.17

100mslive · Aug 14, 2024 · f185635 · f185635
2 parents 580d445 + 13de4e3
commit f185635
Show file tree

Hide file tree

Showing 66 changed files with 911 additions and 534 deletions.
diff --git a/.github/workflows/lint-test-build.yml b/.github/workflows/lint-test-build.yml
@@ -1,5 +1,9 @@
 name: Lint, Test and Build
-on: [push]
+on: 
+  push:
+  merge_group:
+   types: [checks_requested]
+
 jobs:
   build:
     runs-on: ubuntu-latest

diff --git a/examples/prebuilt-react-integration/index.html b/examples/prebuilt-react-integration/index.html
@@ -1,4 +1,4 @@
-<!doctype html>
+<!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />

diff --git a/examples/prebuilt-react-integration/package.json b/examples/prebuilt-react-integration/package.json
diff --git a/packages/hls-player/package.json b/packages/hls-player/package.json
diff --git a/packages/hls-player/src/controllers/HMSHLSPlayer.ts b/packages/hls-player/src/controllers/HMSHLSPlayer.ts
@@ -277,7 +277,7 @@ export class HMSHLSPlayer implements IHMSHLSPlayer, IHMSHLSPlayerEventEmitter {
         this.emitEvent(HMSHLSPlayerEvents.ERROR, error);
         break;
       }
-      // Below one are network related errors
+      // Below ones are network related errors
       case Hls.ErrorDetails.MANIFEST_LOAD_ERROR: {
         const error = HMSHLSErrorFactory.HLSNetworkError.manifestLoadError(detail);
         this.emitEvent(HMSHLSPlayerEvents.ERROR, error);

diff --git a/packages/hls-stats/package.json b/packages/hls-stats/package.json
diff --git a/packages/hms-video-store/package.json b/packages/hms-video-store/package.json
diff --git a/packages/hms-video-store/src/analytics/AnalyticsEventFactory.ts b/packages/hms-video-store/src/analytics/AnalyticsEventFactory.ts
@@ -256,6 +256,18 @@ export default class AnalyticsEventFactory {
       level: AnalyticsEventLevel.INFO,
     });
   }
+
+  static interruption(started: boolean, type: string, deviceInfo: Partial<MediaDeviceInfo>) {
+    return new AnalyticsEvent({
+      name: `${started ? 'interruption.start' : 'interruption.stop'}`,
+      level: AnalyticsEventLevel.INFO,
+      properties: {
+        type,
+        ...deviceInfo,
+      },
+    });
+  }
+
   private static eventNameFor(name: string, ok: boolean) {
     const suffix = ok ? 'success' : 'failed';
     return `${name}.${suffix}`;

diff --git a/packages/hms-video-store/src/analytics/AnalyticsTransport.ts b/packages/hms-video-store/src/analytics/AnalyticsTransport.ts
@@ -9,7 +9,30 @@ export abstract class AnalyticsTransport {
   abstract failedEvents: Queue<AnalyticsEvent>;
   private readonly TAG = '[AnalyticsTransport]';
 
+  private eventCount = 0;
+  private lastResetTime: number = Date.now();
+  private readonly MAX_EVENTS_PER_MINUTE: number = 200;
+  private readonly RESET_INTERVAL_MS: number = 60000;
+
+  private checkRateLimit() {
+    const now = Date.now();
+    if (now - this.lastResetTime >= this.RESET_INTERVAL_MS) {
+      this.eventCount = 0;
+      this.lastResetTime = now;
+    }
+    if (this.eventCount >= this.MAX_EVENTS_PER_MINUTE) {
+      throw new Error('Too many events being sent, please check the implementation.');
+    }
+    this.eventCount++;
+  }
+
   sendEvent(event: AnalyticsEvent) {
+    try {
+      this.checkRateLimit();
+    } catch (e) {
+      HMSLogger.w(this.TAG, 'Rate limit exceeded', e);
+      throw e;
+    }
     try {
       this.sendSingleEvent(event);
       this.flushFailedEvents();

diff --git a/packages/hms-video-store/src/audio-sink-manager/AudioSinkManager.ts b/packages/hms-video-store/src/audio-sink-manager/AudioSinkManager.ts
@@ -97,6 +97,7 @@ export class AudioSinkManager {
 
   cleanup() {
     this.audioSink?.remove();
+    this.earpieceSelected = false;
     this.audioSink = undefined;
     if (this.timer) {
       clearInterval(this.timer);
@@ -295,32 +296,18 @@ export class AudioSinkManager {
     if ('ondevicechange' in navigator.mediaDevices) {
       return;
     }
-    let bluetoothDevice: InputDeviceInfo | null = null;
-    let speakerPhone: InputDeviceInfo | null = null;
-    let wired: InputDeviceInfo | null = null;
-    let earpiece: InputDeviceInfo | null = null;
-
-    for (const device of this.deviceManager.audioInput) {
-      const label = device.label.toLowerCase();
-      if (label.includes('speakerphone')) {
-        speakerPhone = device;
-      } else if (label.includes('wired')) {
-        wired = device;
-      } else if (label.includes('bluetooth')) {
-        bluetoothDevice = device;
-      } else if (label.includes('earpiece')) {
-        earpiece = device;
-      }
-    }
+    const { bluetoothDevice, earpiece, speakerPhone, wired } = this.deviceManager.categorizeAudioInputDevices();
     const localAudioTrack = this.store.getLocalPeer()?.audioTrack;
     if (localAudioTrack && earpiece) {
-      const externalDeviceID = bluetoothDevice?.deviceId || wired?.deviceId || speakerPhone?.deviceId;
+      const manualSelection = this.deviceManager.getManuallySelectedAudioDevice();
+      const externalDeviceID =
+        manualSelection?.deviceId || bluetoothDevice?.deviceId || wired?.deviceId || speakerPhone?.deviceId;
       HMSLogger.d(this.TAG, 'externalDeviceID', externalDeviceID);
       // already selected appropriate device
-      if (localAudioTrack.settings.deviceId === externalDeviceID) {
+      if (localAudioTrack.settings.deviceId === externalDeviceID && this.earpieceSelected) {
         return;
       }
-      if (!this.earpieceSelected) {
+      if (!this.earpieceSelected && bluetoothDevice?.deviceId !== externalDeviceID) {
         await localAudioTrack.setSettings({ deviceId: earpiece?.deviceId }, true);
         this.earpieceSelected = true;
       }

diff --git a/packages/hms-video-store/src/connection/HMSConnection.ts b/packages/hms-video-store/src/connection/HMSConnection.ts
@@ -28,6 +28,8 @@ export default abstract class HMSConnection {
    *  - [HMSSubscribeConnection] clears this list as soon as we call [addIceCandidate]
    */
   readonly candidates = new Array<RTCIceCandidateInit>();
+  // @ts-ignore
+  private sfuNodeId?: string;
 
   selectedCandidatePair?: RTCIceCandidatePair;
 
@@ -48,6 +50,10 @@ export default abstract class HMSConnection {
     return this.role === HMSConnectionRole.Publish ? HMSAction.PUBLISH : HMSAction.SUBSCRIBE;
   }
 
+  setSfuNodeId(nodeId?: string) {
+    this.sfuNodeId = nodeId;
+  }
+
   addTransceiver(track: MediaStreamTrack, init: RTCRtpTransceiverInit): RTCRtpTransceiver {
     return this.nativeConnection.addTransceiver(track, init);
   }
@@ -198,7 +204,7 @@ export default abstract class HMSConnection {
     return await this.nativeConnection.getStats();
   }
 
-  async close() {
+  close() {
     this.nativeConnection.close();
   }
 

diff --git a/packages/hms-video-store/src/connection/publish/publishConnection.ts b/packages/hms-video-store/src/connection/publish/publishConnection.ts
@@ -32,7 +32,6 @@ export default class HMSPublishConnection extends HMSConnection {
       this.observer.onIceConnectionChange(this.nativeConnection.iceConnectionState);
     };
 
-    // @TODO(eswar): Remove this. Use iceconnectionstate change with interval and threshold.
     this.nativeConnection.onconnectionstatechange = () => {
       this.observer.onConnectionStateChange(this.nativeConnection.connectionState);
 
@@ -51,6 +50,11 @@ export default class HMSPublishConnection extends HMSConnection {
     };
   }
 
+  close() {
+    super.close();
+    this.channel.close();
+  }
+
   initAfterJoin() {
     this.nativeConnection.onnegotiationneeded = async () => {
       HMSLogger.d(this.TAG, `onnegotiationneeded`);

diff --git a/packages/hms-video-store/src/connection/subscribe/subscribeConnection.ts b/packages/hms-video-store/src/connection/subscribe/subscribeConnection.ts
@@ -154,8 +154,8 @@ export default class HMSSubscribeConnection extends HMSConnection {
     return this.sendMessage(request, id);
   }
 
-  async close() {
-    await super.close();
+  close() {
+    super.close();
     this.apiChannel?.close();
   }
 

diff --git a/packages/hms-video-store/src/device-manager/DeviceManager.ts b/packages/hms-video-store/src/device-manager/DeviceManager.ts
@@ -4,6 +4,7 @@ import { ErrorFactory } from '../error/ErrorFactory';
 import { HMSException } from '../error/HMSException';
 import { EventBus } from '../events/EventBus';
 import { DeviceMap, HMSDeviceChangeEvent, SelectedDevices } from '../interfaces';
+import { isIOS } from '../internal';
 import { HMSAudioTrackSettingsBuilder, HMSVideoTrackSettingsBuilder } from '../media/settings';
 import { HMSLocalAudioTrack, HMSLocalTrack, HMSLocalVideoTrack } from '../media/tracks';
 import { Store } from '../sdk/store';
@@ -205,7 +206,11 @@ export class DeviceManager implements HMSDeviceManager {
     }
     const audioDeviceId = this.store.getConfig()?.settings?.audioInputDeviceId;
     if (!audioDeviceId && localPeer?.audioTrack) {
-      await localPeer.audioTrack.setSettings({ deviceId: this.audioInput[0]?.deviceId }, true);
+      const getInitialDeviceId = () => {
+        const nonIPhoneDevice = this.audioInput.find(device => !device.label.toLowerCase().includes('iphone'));
+        return isIOS() && nonIPhoneDevice ? nonIPhoneDevice?.deviceId : this.getNewAudioInputDevice()?.deviceId;
+      };
+      await localPeer.audioTrack.setSettings({ deviceId: getInitialDeviceId() }, true);
     }
   };
 
@@ -232,16 +237,12 @@ export class DeviceManager implements HMSDeviceManager {
    * @returns {MediaDeviceInfo}
    */
   getNewAudioInputDevice() {
-    const localPeer = this.store.getLocalPeer();
-    const audioTrack = localPeer?.audioTrack;
-    const manualSelection = this.audioInput.find(
-      device => device.deviceId === audioTrack?.getManuallySelectedDeviceId(),
-    );
+    const manualSelection = this.getManuallySelectedAudioDevice();
     if (manualSelection) {
       return manualSelection;
     }
     // if manually selected device is not available, reset on the track
-    audioTrack?.resetManuallySelectedDeviceId();
+    this.store.getLocalPeer()?.audioTrack?.resetManuallySelectedDeviceId();
     const defaultDevice = this.audioInput.find(device => device.deviceId === 'default');
     if (defaultDevice) {
       // Selecting a non-default device so that the deviceId comparision does not give
@@ -416,6 +417,35 @@ export class DeviceManager implements HMSDeviceManager {
     }
   };
 
+  getManuallySelectedAudioDevice() {
+    const localPeer = this.store.getLocalPeer();
+    const audioTrack = localPeer?.audioTrack;
+    return this.audioInput.find(device => device.deviceId === audioTrack?.getManuallySelectedDeviceId());
+  }
+
+  // specifically used for mweb
+  categorizeAudioInputDevices() {
+    let bluetoothDevice: InputDeviceInfo | null = null;
+    let speakerPhone: InputDeviceInfo | null = null;
+    let wired: InputDeviceInfo | null = null;
+    let earpiece: InputDeviceInfo | null = null;
+
+    for (const device of this.audioInput) {
+      const label = device.label.toLowerCase();
+      if (label.includes('speakerphone')) {
+        speakerPhone = device;
+      } else if (label.includes('wired')) {
+        wired = device;
+      } else if (/airpods|buds|wireless|bluetooth/gi.test(label)) {
+        bluetoothDevice = device;
+      } else if (label.includes('earpiece')) {
+        earpiece = device;
+      }
+    }
+
+    return { bluetoothDevice, speakerPhone, wired, earpiece };
+  }
+
   // eslint-disable-next-line complexity
   private getAudioOutputDeviceMatchingInput(inputDevice?: MediaDeviceInfo) {
     const blacklist = this.store.getConfig()?.settings?.speakerAutoSelectionBlacklist || [];

diff --git a/packages/hms-video-store/src/interfaces/room.ts b/packages/hms-video-store/src/interfaces/room.ts
@@ -33,13 +33,8 @@ export interface HMSRoom {
   description?: string;
   max_size?: number;
   large_room_optimization?: boolean;
-  /**
-   * @alpha
-   */
   isEffectsEnabled?: boolean;
-  /**
-   * @alpha
-   */
+  isVBEnabled?: boolean;
   effectsKey?: string;
   isHipaaEnabled?: boolean;
   isNoiseCancellationEnabled?: boolean;

diff --git a/packages/hms-video-store/src/interfaces/update-listener.ts b/packages/hms-video-store/src/interfaces/update-listener.ts
@@ -83,6 +83,7 @@ export interface HMSUpdateListener extends DeviceChangeListener, SessionStoreLis
   onError(error: HMSException): void;
   onReconnecting(error: HMSException): void;
   onReconnected(): void;
+  onSFUMigration?: () => void;
   onRoleChangeRequest(request: HMSRoleChangeRequest): void;
   onRoleUpdate(newRole: string): void;
   onChangeTrackStateRequest(request: HMSChangeTrackStateRequest): void;