Class HMSNoiseCancellationPlugin

Represents the HMS Noise Cancellation Plugin. This class encapsulates the functionality for managing noise cancellation within a room, including enabling, disabling, and checking the availability and current state of noise cancellation.

See

https://www.100ms.live/docs/react-native/v2/how-to-guides/extend-capabilities/noise-cancellation

Hierarchy

  • HMSNoiseCancellationPlugin

Constructors

constructor

Properties

initialState modelName

Methods

disable enable isEnabled isNoiseCancellationAvailable

Constructors

constructor

  • Constructs a new HMSNoiseCancellationPlugin instance with optional configuration settings. This constructor allows for the initialization of the plugin with specific noise cancellation model and initial state settings, providing flexibility in how noise cancellation is applied within the application.

    Parameters

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

      Optional configuration object for the plugin.

      • initialState: HMSNoiseCancellationInitialState

        Sets the initial state of noise cancellation (enabled or disabled) when the plugin is instantiated. Defaults to disabled if not specified.

      • modelName: SmallFullBand

        Specifies the noise cancellation model to be used. This determines the algorithm and intensity of noise cancellation. If not provided, a default model is used.

    Returns HMSNoiseCancellationPlugin

Properties

initialState

initialState: HMSNoiseCancellationInitialState

Defines the initial state of noise cancellation when the plugin is instantiated. This can be either enabled or disabled, providing control over the noise cancellation feature's activation upon initialization.

modelName

modelName: SmallFullBand

Specifies the model of noise cancellation to be used. This property determines the algorithm and intensity of noise cancellation, allowing for customization based on the requirements of the room or application.

Methods

disable

  • Disables noise cancellation.

    Returns Promise<boolean>

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

enable

  • Enables noise cancellation.

    Returns Promise<boolean>

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

isEnabled

isNoiseCancellationAvailable

  • 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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc