VoiceBeautifierPreset enum

The options for SDK preset voice beautifier effects.

Inheritance
Annotations
  • @JsonEnum(alwaysCreate: true)

Constructors

VoiceBeautifierPreset()
const

Values

voiceBeautifierOff → const VoiceBeautifierPreset

Turn off voice beautifier effects and use the original voice.

chatBeautifierMagnetic → const VoiceBeautifierPreset

A more magnetic voice. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may experience vocal distortion.

chatBeautifierFresh → const VoiceBeautifierPreset

A fresher voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.

chatBeautifierVitality → const VoiceBeautifierPreset

A more vital voice. Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may experience vocal distortion.

singingBeautifier → const VoiceBeautifierPreset

Singing beautifier effect. If you call setVoiceBeautifierPreset (singingBeautifier), you can beautify a male-sounding voice and add a reverberation effect that sounds like singing in a small room. Agora recommends using this enumerator to process a male-sounding voice; otherwise, you might experience vocal distortion. If you call setVoiceBeautifierParameters (singingBeautifier, param1, param2), you can beautify a male or female-sounding voice and add a reverberation effect.

timbreTransformationVigorous → const VoiceBeautifierPreset

A more vigorous voice.

timbreTransformationDeep → const VoiceBeautifierPreset

A deep voice.

timbreTransformationMellow → const VoiceBeautifierPreset

A mellower voice.

timbreTransformationFalsetto → const VoiceBeautifierPreset

Falsetto.

timbreTransformationFull → const VoiceBeautifierPreset

A fuller voice.

timbreTransformationClear → const VoiceBeautifierPreset

A clearer voice.

timbreTransformationResounding → const VoiceBeautifierPreset

A more resounding voice.

timbreTransformationRinging → const VoiceBeautifierPreset

A more ringing voice.

ultraHighQualityVoice → const VoiceBeautifierPreset

A ultra-high quality voice, which makes the audio clearer and restores more details. To achieve better audio effect quality, Agora recommends that you set the profile of to audioProfileMusicHighQuality (4) or audioProfileMusicHighQualityStereo (5) and scenario to audioScenarioGameStreaming (3) before calling setVoiceBeautifierPreset. If you have an audio capturing device that can already restore audio details to a high degree, Agora recommends that you do not enable ultra-high quality; otherwise, the SDK may over-restore audio details, and you may not hear the anticipated voice effect.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<VoiceBeautifierPreset>
A constant List of the values in this enum, in order of their declaration.