@100mslive/react-native-hms 2.0.0-alpha.0 → 2.0.0-alpha.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "description": "Integrate Real Time Audio and Video conferencing, Interactive Live Streaming, and Chat in your apps with 100ms React Native SDK. With support for HLS and RTMP Live Streaming and Recording, Picture-in-Picture (PiP), one-to-one Video Call Modes, Audio Rooms, Video Player and much more, add immersive real-time communications to your apps.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -17,6 +17,8 @@
     "sdk-versions.json",
     "!lib/typescript/example",
     "!android/build",
+    "!android/.gradle",
+    "!android/.idea",
     "!ios/build",
     "!**/__tests__",
     "!**/__fixtures__",
@@ -88,9 +90,31 @@
     "connection",
     "service",
     "telecom",
-    "reaction"
+    "reaction",
+    "cpaas",
+    "polls",
+    "quiz",
+    "leaderboard",
+    "noise",
+    "cancellation",
+    "virtual",
+    "background",
+    "blur",
+    "plugin",
+    "filters",
+    "beautify",
+    "beauty",
+    "enhance",
+    "enhancement",
+    "snapchat",
+    "zoom",
+    "teams",
+    "ai"
   ],
-  "repository": "https://github.com/100mslive/100ms-react-native",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/100mslive/100ms-react-native.git"
+  },
   "author": "Yogesh <yogesh@100ms.live> (https://www.100ms.live/)",
   "license": "MIT",
   "bugs": {
@@ -104,7 +128,7 @@
     "@commitlint/config-conventional": "^11.0.0",
     "@react-native-community/eslint-config": "^2.0.0",
     "@types/jest": "^26.0.0",
-    "@types/react": "^16.9.19",
+    "@types/react": "^18.3.1",
     "@types/react-native": "^0.64.5",
     "commitlint": "^11.0.0",
     "eslint": "^7.2.0",
@@ -113,15 +137,30 @@
     "husky": "^4.2.5",
     "jest": "^26.0.1",
     "prettier": "^2.0.5",
-    "react": "17.0.1",
-    "react-native": "0.64.4",
+    "react": "18.2.0",
+    "react-native": "0.73.11",
     "react-native-builder-bob": "^0.18.0",
     "typedoc": "^0.24.7",
     "typescript": "^4.6.3"
   },
   "peerDependencies": {
     "react": "*",
-    "react-native": "*"
+    "react-native": ">=0.77.3"
+  },
+  "codegenConfig": {
+    "name": "RNHmsSpec",
+    "type": "all",
+    "jsSrcsDir": "src/specs",
+    "android": {
+      "javaPackageName": "com.reactnativehmssdk"
+    },
+    "ios": {
+      "componentProvider": {
+        "HMSView": "HMSViewComponentView",
+        "HMSHLSPlayer": "HMSHLSPlayerComponentView"
+      }
+    },
+    "includesGeneratedCode": false
   },
   "jest": {
     "preset": "react-native",
@@ -185,6 +224,9 @@
       ]
     ]
   },
+  "overrides": {
+    "fast-xml-parser": "^5.3.4"
+  },
   "dependencies": {
     "zustand": "^4.3.8"
   }

package/react-native-hms.podspec

@@ -7,17 +7,71 @@ Pod::Spec.new do |s|
   s.name         = "react-native-hms"
   s.version      = package["version"]
   s.summary      = package["description"]
+  s.description  = package["description"]
   s.homepage     = package["homepage"]
   s.license      = package["license"]
   s.authors      = package["author"]
 
-  s.platforms    = { :ios => "12.0" }
+  s.platforms    = { :ios => "16.0" }
   s.source       = { :git => "https://github.com/100mslive/100ms-react-native.git", :tag => "#{s.version}" }
 
   s.source_files = "ios/**/*.{h,m,mm,swift}"
+  s.requires_arc = true
+  s.swift_version = "5.0"
 
-  s.dependency "React-Core"
+  # ---------------------------------------------------------------------------
+  # Workaround for upstream CocoaPods bug (open since 2016):
+  #   https://github.com/CocoaPods/CocoaPods/issues/5351
+  #   https://github.com/CocoaPods/CocoaPods/issues/9432
+  #
+  # Because this pod has a Swift bridging header (`Hmssdk-Bridging-Header.h`),
+  # CocoaPods adds `-import-underlying-module` to the Swift compile flags. That
+  # flag makes `swiftc -emit-objc-header` inject this line near the top of the
+  # auto-generated `react_native_hms-Swift.h`:
+  #
+  #     #import <react_native_hms/react_native_hms.h>     ← Xcode expects this
+  #
+  # But CocoaPods names the actual umbrella header verbatim with the pod name:
+  #
+  #     react-native-hms-umbrella.h                       ← CocoaPods creates this
+  #
+  # Same content, different name — and our `.mm` files fail to compile because
+  # `react_native_hms.h` doesn't exist on disk.
+  #
+  # The script below runs before every compile and creates `react_native_hms.h`
+  # as a copy of the existing umbrella. Self-contained in this podspec — zero
+  # changes required on the consumer side.
+  #
+  # Long-term fix: drop `Hmssdk-Bridging-Header.h` and use `import React` in
+  # each Swift file. That removes `-import-underlying-module` from the Swift
+  # flags entirely and makes this workaround unnecessary. Tracked for Phase 2.
+  # ---------------------------------------------------------------------------
+  s.script_phases = [
+    {
+      :name => "[react-native-hms] Create Swift umbrella header alias",
+      :execution_position => :before_compile,
+      :script => <<~SCRIPT,
+        set -e
+        UMBRELLA_DIR="${PODS_ROOT:-${SRCROOT}/Pods}/Headers/Public/react_native_hms"
+        SRC="${UMBRELLA_DIR}/react-native-hms-umbrella.h"
+        DST="${UMBRELLA_DIR}/react_native_hms.h"
+        if [ -f "${SRC}" ] && [ ! -f "${DST}" ]; then
+          cp "${SRC}" "${DST}"
+        fi
+      SCRIPT
+    },
+  ]
+
+  # Use modern dependency installation if available, otherwise fallback to React-Core
+  if defined?(install_modules_dependencies()) != nil
+    install_modules_dependencies(s)
+  else
+    s.dependency "React-Core"
+  end
+
+  # 100ms SDK dependencies
   s.dependency "HMSSDK", sdkVersions["ios"]
   s.dependency 'HMSBroadcastExtensionSDK', sdkVersions["iOSBroadcastExtension"]
   s.dependency 'HMSHLSPlayerSDK', sdkVersions["iOSHMSHLSPlayer"]
+  s.dependency 'HMSNoiseCancellationModels', sdkVersions["iOSNoiseCancellationModels"]
 end

package/sdk-versions.json

@@ -1,6 +1,7 @@
 {
-  "ios": "1.1.0",
-  "iOSBroadcastExtension": "0.0.9",
+  "ios": "1.17.0",
+  "iOSBroadcastExtension": "1.0.1",
   "iOSHMSHLSPlayer": "0.0.2",
-  "android": "2.7.7"
+  "iOSNoiseCancellationModels": "1.0.0",
+  "android": "2.9.78"
 }

package/src/classes/HMSAudioDevice.ts

@@ -1,7 +1,25 @@
+/**
+ * Enum for HMSAudioDevice types.
+ *
+ * This enum represents the different types of audio devices that can be used
+ * in the context of the HMS SDK. It provides a way to specify the preferred
+ * audio output device for audio playback.
+ *
+ * @enum {string}
+ */
 export enum HMSAudioDevice {
+  /** Use the speakerphone for audio output. */
   SPEAKER_PHONE = 'SPEAKER_PHONE',
+
+  /** Use a wired headset for audio output, if connected. */
   WIRED_HEADSET = 'WIRED_HEADSET',
+
+  /** Use the earpiece for audio output. */
   EARPIECE = 'EARPIECE',
+
+  /** Use a Bluetooth device for audio output, if connected. */
   BLUETOOTH = 'BLUETOOTH',
+
+  /** Automatically select the best audio output device based on the current state. */
   AUTOMATIC = 'AUTOMATIC',
 }

package/src/classes/HMSAudioMixingMode.ts

@@ -1,3 +1,14 @@
+/**
+ * Enum for HMS Audio Mixing Mode options.
+ *
+ * Defines the modes available for audio mixing in a session. These modes determine how audio tracks are mixed and played back.
+ *
+ * - `TALK_ONLY`: Only the talk (voice) track is active, suitable for sessions focusing on voice communication.
+ * - `TALK_AND_MUSIC`: Both talk and music tracks are active, allowing for background music with clear voice overlay.
+ * - `MUSIC_ONLY`: Only the music track is active, ideal for sessions focusing on music playback.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share
+ */
 export enum HMSAudioMixingMode {
   TALK_ONLY = 'TALK_ONLY',
   TALK_AND_MUSIC = 'TALK_AND_MUSIC',

package/src/classes/HMSAudioTrack.ts

@@ -2,6 +2,15 @@ import { HMSTrack } from './HMSTrack';
 import type { HMSTrackSource } from './HMSTrackSource';
 import type { HMSTrackType } from './HMSTrackType';
 
+/**
+ * Represents an audio track within the HMS (100ms) system.
+ *
+ * This class extends `HMSTrack` to provide functionalities specific to audio tracks. It includes a constructor
+ * that allows for the initialization of the audio track with various parameters such as track ID, source, description,
+ * mute state, ID, and type. These parameters provide detailed information about the audio track and its characteristics.
+ *
+ * @extends HMSTrack
+ */
 export class HMSAudioTrack extends HMSTrack {
   constructor(params?: {
     trackId: string;

package/src/classes/HMSAudioTrackSettings.ts

@@ -1,4 +1,5 @@
 import type { HMSIOSAudioMode } from './HMSIOSAudioMode';
+import type { HMSNoiseCancellationPlugin } from './HMSNoiseCancellationPlugin';
 import type { HMSTrackSettingsInitState } from './HMSTrackSettingsInitState';
 
 /**
@@ -19,15 +20,25 @@ export class HMSAudioTrackSettings {
    */
   audioMode?: HMSIOSAudioMode; // ios only
 
+  /**
+   * The noise cancellation plugin to use for the audio track.
+   * @type {HMSNoiseCancellationPlugin}
+   *
+   * Checkout Noise Cancellation docs for more details {@link https://www.100ms.live/docs/ios/v2/how-to-guides/extend-capabilities/plugins/noise-cancellation}
+   */
+  noiseCancellationPlugin?: HMSNoiseCancellationPlugin;
+
   constructor(params: {
     initialState?: HMSTrackSettingsInitState;
     useHardwareEchoCancellation?: boolean;
     audioSource?: string[];
     audioMode?: HMSIOSAudioMode;
+    noiseCancellationPlugin?: HMSNoiseCancellationPlugin;
   }) {
     this.useHardwareEchoCancellation = params.useHardwareEchoCancellation;
     this.initialState = params.initialState;
     this.audioSource = params.audioSource;
     this.audioMode = params.audioMode;
+    this.noiseCancellationPlugin = params.noiseCancellationPlugin;
   }
 }

package/src/classes/HMSBrowserRecordingState.ts

@@ -1,4 +1,5 @@
 import type { HMSException } from './HMSException';
+import type { HMSRecordingState } from './HMSRecordingState';
 
 export class HMSBrowserRecordingState {
   initialising: boolean;
@@ -6,6 +7,7 @@ export class HMSBrowserRecordingState {
   error?: HMSException;
   startedAt?: Date;
   stoppedAt?: Date;
+  state: HMSRecordingState;
 
   constructor(params: {
     initialising: boolean;
@@ -13,11 +15,13 @@ export class HMSBrowserRecordingState {
     error?: HMSException;
     startedAt?: Date;
     stoppedAt?: Date;
+    state: HMSRecordingState;
   }) {
     this.initialising = params.initialising;
     this.running = params.running;
     this.error = params.error;
     this.startedAt = params.startedAt;
     this.stoppedAt = params.stoppedAt;
+    this.state = params.state;
   }
 }

package/src/classes/HMSCameraControl.ts

@@ -1,6 +1,6 @@
 import { HMSConstants } from './HMSConstants';
 
-import HMSManager from './HMSManagerModule';
+import HMSManager from '../modules/HMSManagerModule';
 
 export class HMSCameraControl {
   /**

package/src/classes/HMSCameraFacing.ts

@@ -1,4 +1,15 @@
+/**
+ * Enum for camera facing directions in a 100ms (HMS) application.
+ *
+ * This enumeration defines the possible camera facing options for video tracks in a 100ms (HMS) application, allowing developers to specify whether the front or back camera should be used during a video session.
+ * This can be particularly useful for applications that need to switch between cameras or provide users with the option to choose their preferred camera.
+ *
+ * @enum {string}
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/mute#switch-camera
+ */
 export enum HMSCameraFacing {
+  /** Represents the front camera on a device. */
   FRONT = 'FRONT',
+  /** Represents the back camera on a device. */
   BACK = 'BACK',
 }

package/src/classes/HMSConfig.ts

@@ -1,3 +1,30 @@
+/**
+ * Represents the configuration needed to join a room in the HMS ecosystem.
+ *
+ * This class encapsulates all necessary details required to initiate a connection to a room, including user identification,
+ * authentication token, optional endpoint for different server connections, metadata for additional information about the connection,
+ * and a flag to capture network quality during the preview phase.
+ *
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/join
+ *
+ * @param {Object} params - The configuration parameters.
+ * @param {string} params.username - The username of the participant.
+ * @param {string} params.authToken - The authentication token for room access.
+ * @param {string} [params.endpoint] - Optional. The endpoint URL for the connection.
+ * @param {string} [params.metadata] - Optional. Additional metadata associated with the Local Peer.
+ * @param {boolean} [params.captureNetworkQualityInPreview] - Optional. Flag to capture network quality in the preview phase.
+ * @constructor
+ *
+ * @example
+ * const config = new HMSConfig({
+ *  username: 'username',
+ *  authToken: 'authToken',
+ *  metadata: 'metadata',
+ *  captureNetworkQualityInPreview: true,
+ * });
+ *
+ */
 export class HMSConfig {
   username: string;
   authToken: string;

package/src/classes/HMSEncoder.ts

@@ -1,4 +1,4 @@
-import HMSManager from './HMSManagerModule';
+import HMSManager from '../modules/HMSManagerModule';
 
 import { HMSTrack } from './HMSTrack';
 import { HMSAudioTrack } from './HMSAudioTrack';
@@ -40,6 +40,8 @@ import { HMSLayer } from './HMSLayer';
 import { HMSSimulcastLayerDefinition } from './HMSSimulcastLayerDefinition';
 import { HMSQualityLimitationReasons } from './HMSQualityLimitationReasons';
 import { HMSTrackType } from './HMSTrackType';
+import { HMSHLSPlaylistType } from './HMSHLSPlaylistType';
+import type { Transcriptions } from './transcriptions';
 
 interface InitialData {
   roles: Record<string, HMSRole>;
@@ -453,6 +455,7 @@ export class HMSEncoder {
       startedAt: HMSEncoder.encodeDate(data?.startedAt),
       stoppedAt: HMSEncoder.encodeDate(data?.stoppedAt),
       error: data?.error || undefined,
+      state: data?.state,
     });
   }
 
@@ -461,6 +464,7 @@ export class HMSEncoder {
       running: data?.running || false,
       error: data?.error || undefined,
       startedAt: HMSEncoder.encodeDate(data?.startedAt),
+      state: data?.state,
     });
   }
 
@@ -468,8 +472,8 @@ export class HMSEncoder {
     return new HMSRtmpStreamingState({
       running: data?.running || false,
       startedAt: HMSEncoder.encodeDate(data?.startedAt),
-      stoppedAt: HMSEncoder.encodeDate(data?.stoppedAt),
       error: data?.error || undefined,
+      state: data?.state,
     });
   }
 
@@ -487,6 +491,9 @@ export class HMSEncoder {
   static encodeHLSStreamingState(data: any) {
     return new HMSHLSStreamingState({
       running: data?.running || false,
+      startedAt: HMSEncoder.encodeDate(data?.startedAt),
+      error: data?.error || undefined,
+      state: data?.state,
       variants: Array.isArray(data?.variants)
         ? this.encodeHLSVariants(data?.variants)
         : undefined,
@@ -498,8 +505,8 @@ export class HMSEncoder {
       return new HMSHLSRecordingState({
         running: data?.running || false,
         startedAt: HMSEncoder.encodeDate(data?.startedAt),
-        singleFilePerLayer: data?.singleFilePerLayer || false,
-        videoOnDemand: data?.videoOnDemand || false,
+        error: data?.error || undefined,
+        state: data?.state,
       });
     } else {
       return undefined;
@@ -515,6 +522,9 @@ export class HMSEncoder {
         meetingUrl: item.meetingUrl,
         metadata: item?.metaData ? item?.metadata : undefined,
         startedAt: HMSEncoder.encodeDate(item?.startedAt),
+        playlistType: item?.playlistType
+          ? this.getHLSVariantPlaylistType(item.playlistType.toUpperCase())
+          : undefined,
       });
       variants.push(variant);
     });
@@ -522,6 +532,15 @@ export class HMSEncoder {
     return variants;
   }
 
+  static getHLSVariantPlaylistType(type: String) {
+    switch (type) {
+      case 'DVR':
+        return HMSHLSPlaylistType.DVR;
+      default:
+        return HMSHLSPlaylistType.noDVR;
+    }
+  }
+
   static encodeHMSNetworkQuality(data: any) {
     if (data) {
       return new HMSNetworkQuality({
@@ -682,4 +701,38 @@ export class HMSEncoder {
 
     return transformed;
   }
+
+  static encodeTranscriptions(data: Array<any>): Array<Transcriptions> {
+    if (Array.isArray(data)) {
+      data.forEach((transcriptions: Transcriptions) => {
+        if ('initialisedAt' in transcriptions) {
+          transcriptions.initialisedAt = this.encodeDate(
+            transcriptions.initialisedAt
+          );
+        }
+        if ('startedAt' in transcriptions) {
+          transcriptions.startedAt = this.encodeDate(transcriptions.startedAt);
+        }
+        if ('stoppedAt' in transcriptions) {
+          transcriptions.stoppedAt = this.encodeDate(transcriptions.stoppedAt);
+        }
+        if ('updatedAt' in transcriptions) {
+          transcriptions.updatedAt = this.encodeDate(transcriptions.updatedAt);
+        }
+      });
+      return data as Array<Transcriptions>;
+    } else {
+      return [];
+    }
+  }
+
+  static transformTranscripts(data: Array<any>) {
+    data.forEach((encodedTranscript) => {
+      if ('peerId' in encodedTranscript) {
+        encodedTranscript.peer = HMSEncoder.encodeHmsPeer({
+          peerID: encodedTranscript.peerId,
+        });
+      }
+    });
+  }
 }

package/src/classes/HMSException.ts

@@ -1,3 +1,21 @@
+/**
+ * Represents an exception specific to the HMS SDK in a React Native context.
+ *
+ * This class encapsulates detailed information about errors that can occur while interacting with the HMS SDK.
+ * It includes a numeric code to identify the type of error, a human-readable description, and optionally,
+ * a message, name, and action that are primarily available on Android. Additionally, it indicates whether
+ * the error is terminal (i.e., cannot be recovered from) and whether a retry might be possible.
+ *
+ * @class HMSException
+ * @property {number} code - Numeric error code representing the type of error.
+ * @property {string} description - A brief, human-readable description of the error.
+ * @property {string} [message] - Additional message information about the error (Android only).
+ * @property {string} [name] - The name of the error (Android only).
+ * @property {string} [action] - The action during which the error occurred (Android only).
+ * @property {boolean} isTerminal - Indicates whether the error is terminal.
+ * @property {boolean} [canRetry] - Indicates whether the operation that caused the error can be retried (Android only).
+ *
+ */
 export class HMSException {
   code: number;
   description: string;

package/src/classes/HMSHLSPlaylistType.ts

@@ -0,0 +1,4 @@
+export enum HMSHLSPlaylistType {
+  DVR = 'DVR',
+  noDVR = 'noDVR',
+}

package/src/classes/HMSHLSRecordingState.ts

@@ -1,18 +1,20 @@
+import type { HMSException } from './HMSException';
+import type { HMSRecordingState } from './HMSRecordingState';
+
 export class HMSHLSRecordingState {
-  singleFilePerLayer: boolean;
-  videoOnDemand: boolean;
   running: boolean;
+  error?: HMSException;
   startedAt?: Date;
-
+  state: HMSRecordingState;
   constructor(params: {
-    singleFilePerLayer: boolean;
-    videoOnDemand: boolean;
     running: boolean;
     startedAt?: Date;
+    error?: HMSException;
+    state: HMSRecordingState;
   }) {
-    this.singleFilePerLayer = params.singleFilePerLayer;
-    this.videoOnDemand = params.videoOnDemand;
     this.running = params.running;
     this.startedAt = params.startedAt;
+    this.error = params.error;
+    this.state = params.state;
   }
 }

package/src/classes/HMSHLSStreamingState.ts

@@ -1,11 +1,25 @@
 import type { HMSHLSVariant } from './HMSHLSVariant';
+import type { HMSException } from './HMSException';
+import type { HMSStreamingState } from './HMSStreamingState';
 
 export class HMSHLSStreamingState {
   running: boolean;
+  startedAt?: Date;
+  error?: HMSException;
+  state: HMSStreamingState;
   variants?: Array<HMSHLSVariant>;
 
-  constructor(params: { running: boolean; variants?: Array<HMSHLSVariant> }) {
+  constructor(params: {
+    running: boolean;
+    startedAt?: Date;
+    error?: HMSException;
+    state: HMSStreamingState;
+    variants?: Array<HMSHLSVariant>;
+  }) {
     this.running = params.running;
+    this.startedAt = params.startedAt;
+    this.error = params.error;
+    this.state = params.state;
     this.variants = params.variants;
   }
 }

package/src/classes/HMSHLSTimedMetadata.ts

@@ -0,0 +1,16 @@
+/**
+ * Defines the structure for HLS (HTTP Live Streaming) timed metadata.
+ *
+ * This interface is used to represent metadata that can be synchronized with HLS video playback.
+ * The metadata includes a payload, which is the content of the metadata, and a duration, specifying how long (in seconds)
+ * the metadata should be displayed during the stream.
+ * This can be used for a variety of purposes such as displaying song titles, advertisements, or other relevant information at specific times during the stream.
+ *
+ * @interface HMSHLSTimedMetadata
+ * @property {string} payload - The content of the metadata to be displayed.
+ * @property {number} duration - The duration (in seconds) for which the metadata should be displayed.
+ */
+export interface HMSHLSTimedMetadata {
+  payload: string;
+  duration: number;
+}

package/src/classes/HMSHLSVariant.ts

@@ -1,18 +1,23 @@
+import type { HMSHLSPlaylistType } from './HMSHLSPlaylistType';
+
 export class HMSHLSVariant {
   hlsStreamUrl?: string;
   meetingUrl?: string;
   metadata?: string;
   startedAt?: Date;
+  playlistType?: HMSHLSPlaylistType;
 
   constructor(params: {
     hlsStreamUrl?: string;
     meetingUrl?: string;
     metadata?: string;
     startedAt?: Date;
+    playlistType?: HMSHLSPlaylistType;
   }) {
     this.hlsStreamUrl = params.hlsStreamUrl;
     this.meetingUrl = params.meetingUrl;
     this.metadata = params.metadata;
     this.startedAt = params.startedAt;
+    this.playlistType = params.playlistType;
   }
 }

package/src/classes/HMSIOSAudioMode.ts

@@ -1,3 +1,18 @@
+/**
+ * Enum for specifying the audio mode in an iOS environment within a 100ms (HMS) application.
+ *
+ * This enumeration provides options to configure the audio mode for an iOS application using the 100ms (HMS) SDK.
+ * It allows for the selection between `voice` and `music` modes, catering to different use cases such as
+ * prioritizing voice clarity or enhancing music quality during a session.
+ *
+ * @enum {string}
+ * @property {string} VOICE - Configures the audio session for optimized voice communication.
+ *                            This mode enhances voice clarity, making it suitable for calls or conferences.
+ * @property {string} MUSIC - Configures the audio session for music playback.
+ *                            This mode enhances music fidelity, making it suitable for streams or recordings that prioritize music quality.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/microphone/music-mode
+ */
 export enum HMSIOSAudioMode {
   VOICE = 'voice',
   MUSIC = 'music',