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 in Dolby Voice conferences.

Parameters

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

NameTypeDescription
noiseLevelComfortNoiseLevelThe 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>