Class HMSAudioTrackSettings

Customize local peer's Audio track settings before Joining the Room.

Checkout Track Settings docs for more details https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/track-settings

Hierarchy

HMSAudioTrackSettings

Index

Constructors

constructor

Properties

audioMode? audioSource? initialState? noiseCancellationPlugin? useHardwareEchoCancellation?

Constructors

constructor

new HMSAudioTrackSettings(params): HMSAudioTrackSettings
Parameters
- params: {
      audioMode?: HMSIOSAudioMode;
      audioSource?: string[];
      initialState?: HMSTrackSettingsInitState;
      noiseCancellationPlugin?: HMSNoiseCancellationPlugin;
      useHardwareEchoCancellation?: boolean;
  }
  - Optional audioMode?: HMSIOSAudioMode
  - Optional audioSource?: string[]
  - Optional initialState?: HMSTrackSettingsInitState
  - Optional noiseCancellationPlugin?: HMSNoiseCancellationPlugin
  - Optional useHardwareEchoCancellation?: boolean
Returns HMSAudioTrackSettings
- Defined in src/classes/HMSAudioTrackSettings.ts:31

Properties

`Optional` audioMode

audioMode?: HMSIOSAudioMode

[iOS only] audioMode allows you to capture audio in its highest quality by disabling voice processing and increasing the maximum bandwidth limit

Checkout Music Mode docs for more details https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/microphone/music-mode

`Optional` audioSource

audioSource?: string[]

`Optional` initialState

initialState?: HMSTrackSettingsInitState

`Optional` noiseCancellationPlugin

noiseCancellationPlugin?: HMSNoiseCancellationPlugin

The noise cancellation plugin to use for the audio track.

`Optional` useHardwareEchoCancellation

useHardwareEchoCancellation?: boolean

Class HMSAudioTrackSettings

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

params: {
    audioMode?: HMSIOSAudioMode;
    audioSource?: string[];
    initialState?: HMSTrackSettingsInitState;
    noiseCancellationPlugin?: HMSNoiseCancellationPlugin;
    useHardwareEchoCancellation?: boolean;
}

`Optional` audioMode?: HMSIOSAudioMode

`Optional` audioSource?: string[]

`Optional` initialState?: HMSTrackSettingsInitState

`Optional` noiseCancellationPlugin?: HMSNoiseCancellationPlugin

`Optional` useHardwareEchoCancellation?: boolean

Returns HMSAudioTrackSettings

Properties

`Optional` audioMode

`Optional` audioSource

`Optional` initialState

`Optional` noiseCancellationPlugin

`Optional` useHardwareEchoCancellation

Settings

Member Visibility

Theme

On This Page

Class HMSAudioTrackSettings

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

params: { audioMode?: HMSIOSAudioMode; audioSource?: string[]; initialState?: HMSTrackSettingsInitState; noiseCancellationPlugin?: HMSNoiseCancellationPlugin; useHardwareEchoCancellation?: boolean; }

Optional audioMode?: HMSIOSAudioMode

Optional audioSource?: string[]

Optional initialState?: HMSTrackSettingsInitState

Optional noiseCancellationPlugin?: HMSNoiseCancellationPlugin

Optional useHardwareEchoCancellation?: boolean

Returns HMSAudioTrackSettings

Properties

Optional audioMode

Optional audioSource

Optional initialState

Optional noiseCancellationPlugin

Optional useHardwareEchoCancellation

Settings

Member Visibility

Theme

On This Page

params: {
audioMode?: HMSIOSAudioMode;
audioSource?: string[];
initialState?: HMSTrackSettingsInitState;
noiseCancellationPlugin?: HMSNoiseCancellationPlugin;
useHardwareEchoCancellation?: boolean;
}

`Optional` audioMode?: HMSIOSAudioMode

`Optional` audioSource?: string[]

`Optional` initialState?: HMSTrackSettingsInitState

`Optional` noiseCancellationPlugin?: HMSNoiseCancellationPlugin

`Optional` useHardwareEchoCancellation?: boolean

`Optional` audioMode

`Optional` audioSource

`Optional` initialState

`Optional` noiseCancellationPlugin

`Optional` useHardwareEchoCancellation