AudioEffectPreset enum

Preset audio effect options.

setAudioProfile profile Preset audio effects profile roomAcousticsVirtualStereo roomAcoustics3dVoice roomAcousticsVirtualSurroundSound audioProfileMusicHighQualityStereo or audioProfileMusicStandardStereo Other preset audio effects (excluding audioEffectOff) audioProfileMusicHighQuality or audioProfileMusicHighQualityStereo

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

Values

audioEffectOff → const AudioEffectPreset

Original sound, i.e., disables voice effects.

roomAcousticsKtv → const AudioEffectPreset

KTV.

roomAcousticsVocalConcert → const AudioEffectPreset

Concert.

roomAcousticsStudio → const AudioEffectPreset

Studio.

roomAcousticsPhonograph → const AudioEffectPreset

Phonograph.

roomAcousticsVirtualStereo → const AudioEffectPreset

Virtual stereo, where the SDK renders mono audio into stereo sound.

roomAcousticsSpacial → const AudioEffectPreset

Spacious.

roomAcousticsEthereal → const AudioEffectPreset

Ethereal.

roomAcoustics3dVoice → const AudioEffectPreset

3D voice, where the SDK renders audio to surround the user. The surround cycle defaults to 10 seconds. After setting this effect, you can also call setAudioEffectParameters to modify the surround cycle. To experience the expected effect of 3D voice, users need to use audio playback devices that support stereo.

roomAcousticsVirtualSurroundSound → const AudioEffectPreset

Virtual surround sound, where the SDK simulates surround sound based on stereo channels to create an immersive effect. To experience the expected effect of virtual surround sound, users need to use audio playback devices that support stereo.

roomAcousticsChorus → const AudioEffectPreset

Chorus. Agora recommends using this in chorus scenarios to make vocals sound more spatial and three-dimensional.

voiceChangerEffectUncle → const AudioEffectPreset

Deep male voice. Recommended for processing male voices; otherwise, the effect may not be as expected.

voiceChangerEffectOldman → const AudioEffectPreset

Elderly male. Recommended for processing male voices; otherwise, the effect may not be as expected.

voiceChangerEffectBoy → const AudioEffectPreset

Boy. Recommended for processing male voices; otherwise, the effect may not be as expected.

voiceChangerEffectSister → const AudioEffectPreset

Young woman. Recommended for processing female voices; otherwise, the effect may not be as expected.

voiceChangerEffectGirl → const AudioEffectPreset

Girl. Recommended for processing female voices; otherwise, the effect may not be as expected.

voiceChangerEffectPigking → const AudioEffectPreset

Pigsy.

voiceChangerEffectHulk → const AudioEffectPreset

Hulk.

styleTransformationRnb → const AudioEffectPreset

R&B.

styleTransformationPopular → const AudioEffectPreset

Pop.

pitchCorrection → const AudioEffectPreset

Electronic voice, where the SDK corrects the pitch based on the natural major scale with C as the tonic. After setting this effect, you can also call setAudioEffectParameters to adjust the base scale and tonic pitch.

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.