LocalAudio
The LocalAudio model allows enabling and disabling the local participant's audio as well as setting and checking the capture mode and comfort noise level.
This model is supported only in SDK 3.7 and later.
Methods
getCaptureMode
▸ getCaptureMode(): Promise<AudioCaptureModeOptions>
Returns the local participant's audio capture mode in Dolby Voice conferences.
Returns
Promise<AudioCaptureModeOptions>
setCaptureMode
▸ setCaptureMode(options): Promise<void>
Sets the local participant's audio capture mode. The following modes are available:
-
Standard: The default mode that optimizes captured audio for speech by aggressively removing non-speech content, such as background noise. The mode is supported in SDK 3.7 and later.
-
Unprocessed: Reduces latency that comes from audio processing and prevents over-processing audio in some scenarios. The mode is supported in SDK 3.7 and later.
Note: In SDK 3.8 and prior releases, this API is supported only in Dolby Voice conferences.
Parameters
| Name | Type |
|---|---|
options | AudioCaptureModeOptions |
Returns
Promise<void>
getComfortNoiseLevel
▸ getComfortNoiseLevel(): Promise<ComfortNoiseLevel>
Returns the comfort noise level setting for output devices in Dolby Voice conferences.
Returns
Promise<ComfortNoiseLevel>
setComfortNoiseLevel
▸ setComfortNoiseLevel(noiseLevel): Promise<void>
Configures the comfort noise level for output devices in Dolby Voice conferences.
Parameters
| Name | Type | Description |
|---|---|---|
noiseLevel | ComfortNoiseLevel | The selected comfort noise level. |
Returns
Promise<void>
start
▸ start(): Promise<void>
Starts sending the local participant’s audio streams from the local client to the conference.
This method is not available for listeners in Dolby Voice conferences.
The method requires up to a few seconds to become effective.
Returns
Promise<void>
stop
▸ stop(): Promise<void>
Stops sending local participant’s audio from the local client to the conference.
This method is not available for listeners in Dolby Voice conferences.
The method requires up to a few seconds to become effective.
Returns
Promise<void>
preview
▸ preview(): AudioPreview
Allows the local participant to test different capture modes and voice fonts before a conference. The method sets a preview recorder that records the participant's audio and plays it back. Before playing the recorded audio, set the captureMode to a preferred setting that you wish to try. The method is supported only in SDK 3.10 and later.
Returns
Updated about 2 months ago