Agora Web SDK API Reference

Overview AgoraRTC AgoraRTCClient LocalTrack RemoteTrack Error codes

Configurations for the audio track from the audio captured by a microphone. Set these configurations when calling AgoraRTC.createMicrophoneAudioTrack.

Hierarchy

MicrophoneAudioTrackInitConfig

Index

Properties

Optional AEC

AEC: undefined | false | true

Whether to enable acoustic echo cancellation:

true: Enable acoustic echo cancellation.
false: Do not enable acoustic echo cancellation.

Optional AGC

AGC: undefined | false | true

Whether to enable audio gain control:

true: Enable audio gain control.
false: Do not enable audio gain control.

Optional ANS

ANS: undefined | false | true

Whether to enable automatic noise suppression:

true: Enable automatic noise suppression.
false: Do not automatic noise suppression.

Optional encoderConfig

encoderConfig: AudioEncoderConfiguration | AudioEncoderConfigurationPreset

The audio encoder configurations.

You can set the audio encoder configurations in either of the following ways:

Pass the preset audio encoder configurations by using AudioEncoderConfigurationPreset.
Pass your customized audio encoder configurations by using AudioEncoderConfiguration.

Firefox does not support setting the audio encoding rate.

Optional microphoneId

microphoneId: undefined | string

Specifies the microphone ID.

You can get a list of the available microphones by calling AgoraRTC.getMicrophones.