AudioEffectPreset enum

Preset audio effects.

To get better audio effects, Agora recommends calling setAudioProfile and setting the profile parameter as recommended below before using the preset audio effects.

Inheritance
Available extensions
Annotations
  • @JsonEnum(alwaysCreate: true)

Values

audioEffectOff → const AudioEffectPreset

Turn off voice effects, that is, use the original voice.

roomAcousticsKtv → const AudioEffectPreset

The voice effect typical of a KTV venue.

roomAcousticsVocalConcert → const AudioEffectPreset

The voice effect typical of a concert hall.

roomAcousticsStudio → const AudioEffectPreset

The voice effect typical of a recording studio.

roomAcousticsPhonograph → const AudioEffectPreset

The voice effect typical of a vintage phonograph.

roomAcousticsVirtualStereo → const AudioEffectPreset

The virtual stereo effect, which renders monophonic audio as stereo audio.

roomAcousticsSpacial → const AudioEffectPreset

A more spatial voice effect.

roomAcousticsEthereal → const AudioEffectPreset

A more ethereal voice effect.

roomAcoustics3dVoice → const AudioEffectPreset

A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period. If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.

roomAcousticsVirtualSurroundSound → const AudioEffectPreset

Virtual surround sound, that is, the SDK generates a simulated surround sound field on the basis of stereo channels, thereby creating a surround sound effect. If the virtual surround sound is enabled, users need to use stereo audio playback devices to hear the anticipated audio effect.

roomAcousticsChorus → const AudioEffectPreset

The audio effect of chorus. Agora recommends using this effect in chorus scenarios to enhance the sense of depth and dimension in the vocals.

voiceChangerEffectUncle → const AudioEffectPreset

A middle-aged man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.

voiceChangerEffectOldman → const AudioEffectPreset

An older man's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.

voiceChangerEffectBoy → const AudioEffectPreset

A boy's voice. Agora recommends using this preset to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.

voiceChangerEffectSister → const AudioEffectPreset

A young woman's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.

voiceChangerEffectGirl → const AudioEffectPreset

A girl's voice. Agora recommends using this preset to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.

voiceChangerEffectPigking → const AudioEffectPreset

The voice of Pig King, a character in Journey to the West who has a voice like a growling bear.

voiceChangerEffectHulk → const AudioEffectPreset

The Hulk's voice.

styleTransformationRnb → const AudioEffectPreset

The voice effect typical of R&B music.

styleTransformationPopular → const AudioEffectPreset

The voice effect typical of popular music.

pitchCorrection → const AudioEffectPreset

A pitch correction effect that corrects the user's pitch based on the pitch of the natural C major scale. After setting this voice effect, you can call setAudioEffectParameters to adjust the basic mode of tuning and the pitch of the main tone.

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
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<AudioEffectPreset>
A constant List of the values in this enum, in order of their declaration.