/** The ComfortNoiseLevel enum gathers the available comfort noise levels. */
export declare enum ComfortNoiseLevel {
/** The default comfort noise level that is based on the device database. The database includes the proper comfort noise levels, individual for all devices. */
Default = "default",
/** The low comfort noise level. */
Low = "low",
/** The medium comfort noise level. */
Medium = "medium",
/** The disabled comfort noise. */
Off = "off"
}
/**
* The AudioCaptureModeOptions model allows selecting the preferred audio capture mode and additional options for the preferred mode.
*
* This model is available in SDK 3.7 and later.
*/
export interface AudioCaptureModeOptions {
/** The preferred audio mode for capturing the local participant's audio. */
mode: AudioCaptureMode;
/** The preferred level of noise reduction. This property is supported only in the Standard mode. */
noiseReduction?: NoiseReductionLevel;
/** The preferred voice modification effect that you can use to change the local participant's voice in real time. This property is supported only in the Standard mode in SDK 3.10 and later. */
voiceFont?: VoiceFont;
}
/** The AudioCaptureMode model allows selecting the preferred mode for capturing the local participant's audio.
*
* This model is available in SDK 3.7 and later.
*/
export declare enum AudioCaptureMode {
/** The default mode aimed at enhancing speech to create a conversation-focused conference environment. This mode 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.
*/
Standard = "STANDARD",
/** Disables audio processing to allow transmitting non-voice audio to a conference. The mode is supported in SDK 3.7 and later. */
Unprocessed = "UNPROCESSED"
}
/**
* The NoiseReductionLevel model allows selecting the preferred level of noise reduction.
*
* This model is available in SDK 3.7 and later.
*/
export declare enum NoiseReductionLevel {
/** The default level that removes all background sounds to improve voice quality. Use this mode if you want to send only voice to a conference. */
High = "HIGH",
/**
* Removes stationary background sounds, such as the sound of a computer fan, air conditioning, or microphone hum, from audio transmitted to a conference. In this mode, non-stationary sounds are transmitted to give participants full context of other participants' environments and create a more realistic audio experience. If you want to send only voice to a conference, use the [High](#high) level.
*/
Low = "LOW"
}
/**
* The VoiceFont model gathers the possible voice modification effects that you can use to change the local participant's voice in real time. The model is supported only in SDK 3.10 and later.
*
* The following table lists audio samples for each available voice font:
*
*
*
*
*
Voice font
*
Example 1
*
Example 2
*
*
*
none
*
*
*
*
*
abyss
*
*
*
*
*
amRadio
*
*
*
*
*
brokenRobot
*
*
*
*
*
darkModulation
*
*
*
*
*
feminine
*
*
*
*
*
helium
*
*
*
*
*
interference
*
*
*
*
*
masculine
*
*
*
*
*
nervousRobot
*
*
*
*
*
starshipCaptain
*
*
*
*
*
swarm
*
*
*
*
*
wobble
*
*
*
*
*
*/
export declare enum VoiceFont {
None = "NONE",
Masculine = "MASCULINE",
Feminine = "FEMININE",
Helium = "HELIUM",
DarkModulation = "DARK_MODULATION",
BrokenRobot = "BROKEN_ROBOT",
Interference = "INTERFERENCE",
Abyss = "ABYSS",
Wobble = "WOBBLE",
StarshipCaptain = "STARSHIP_CAPTAIN",
NervousRobot = "NERVOUS_ROBOT",
Swarm = "SWARM",
AmRadio = "AM_RADIO"
}
/**
* The AudioPreviewStatus model gathers all possible statuses of audio samples recording for audio preview.
*
* This model is available in SDK 3.10 and later.
*/
export declare enum AudioPreviewStatus {
/** There is no recording available. */
NoRecordingAvailable = "NoRecordingAvailable",
/** The recording is available. */
RecordingAvailable = "RecordingAvailable",
/** Recording is in progress. */
Recording = "Recording",
/** The recording is played. */
Playing = "Playing",
/** The audio session configuration is restarted; there are no recording in the memory. */
Released = "Released"
}