Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AudioOption

Start audio option interface.

Hierarchy

  • AudioOption

Index

Properties

Properties

Optional autoStartAudioInSafari

autoStartAudioInSafari?: boolean

Start audio automatically in Safari.

In the Safari browser, when calling startAudio automatically or programmatically without any gesture (such as a click or touch on the document), the value of autoStartAudioInSafari should be true. Other than that, the value should always be false or unset.

Note: Use this option only if you are auto starting audio without a user click for Desktop Safari running macOS 15.2 to 16.0.

Optional backgroundNoiseSuppression

backgroundNoiseSuppression?: boolean

Suppress some kinds of background noise (e.g. dog barking,lawn mower,clapping, fans, pen tapping).

Note: Enabling this option may increase CPU utilization. It requires SharedArrayBuffer for WebAssembly audio, but not for WebRTC audio.

Optional customAudioConstraints

customAudioConstraints?: MediaTrackConstraints

Specifies custom audio constraints for the microphone.

  • When set, these constraints override other options such as microphoneId, backgroundNoiseSuppression, originalSound, etc.
  • Use this option only in specific scenarios. Normally, the SDK automatically optimizes the constraints.
  • This applies only to the current microphone. Switching microphones using stream.switchMicrophone will not carry over customAudioConstraints, as different microphones may have different capabilities.
  • Enabling backgroundNoiseSuppression or originalSound after setting this option will remove the custom constraints.
since

2.4.5

Optional highBitrate

highBitrate?: boolean

128 kbps bitrate

Optional mediaFile

mediaFile?: MediaPlaybackFile

Specify a media file as the audio input. It can be an audio file or a video file.

  • If you need to use a video file (mp4) for both video and audio input, make sure the URL is exactly the same and start video first.

Optional microphoneId

microphoneId?: string

Microphone ID for the microphone capturing the audio, if not specified, use system default.

Optional mute

mute?: boolean

Join audio with microphone muted.

Optional originalSound

originalSound?: boolean | { hifi?: boolean; stereo?: boolean }

Support original sound

Note: originalsound and backgroundNoiseSuppression conflict with each other. If originalSound is enabled, backgroundNoiseSuppression will be disabled.

You can set the original sound for hifi, stereo, or both:

  • hifi: high fidelity audio
  • stereo: stereo audio

Optional speakerId

speakerId?: string

Audio speaker ID to play audio, if not specified, use system default.

Optional speakerOnly

speakerOnly?: boolean

Join audio only with the audio speaker, the microphone is not connected.

Optional syncButtonsOnHeadset

syncButtonsOnHeadset?: boolean

Sync mute or unmute state for the audio devices made by these manufactures: AVer, Crestron, Jabra, Logitech, Plantronics, Polycom, Shure, Yamaha, and Yealink.