Class HMSNoiseCancellationPlugin

constructor

• new HMSNoiseCancellationPlugin(config?): HMSNoiseCancellationPlugin

• Creates an instance of HMSNoiseCancellationPlugin.

  Parameters

  • Optional config: {
        initialState: HMSNoiseCancellationInitialState;
        modelName: SmallFullBand;
    }

    The configuration options.

    • initialState: HMSNoiseCancellationInitialState

      The initial state for noise cancellation.

    • modelName: SmallFullBand

      The model name for noise cancellation.

  Returns HMSNoiseCancellationPlugin

initialState

modelName

disable

• disable(): Promise<boolean>

• Disables noise cancellation.

  Returns Promise<boolean>

  A promise that resolves to true if noise cancellation is disabled, otherwise, rejected promise is returned

enable

• enable(): Promise<boolean>

• Enables noise cancellation.

  Returns Promise<boolean>

  A promise that resolves to true if noise cancellation is enabled, otherwise, rejected promise is returned

isEnabled

• isEnabled(): Promise<boolean>

• Checks if noise cancellation is enabled.

  Returns Promise<boolean>

  true if noise cancellation is enabled, false otherwise.

isNoiseCancellationAvailable

• isNoiseCancellationAvailable(): Promise<boolean>

• To make noise cancellation work your room needs to have noise cancellation feature enabled.

  Gets whether noise cancellation is available for your room.

  Returns Promise<boolean>

  True if noise cancellation is available, false otherwise.

  Note: You can call this API to check the state of noise cancellation only after successfully joining the room.