AudioEffectPreset enum

Preset voice effects. For better voice effects, Agora recommends setting the profile parameter of setAudioProfile to MusicHighQuality or MusicHighQualityStereo before using the following presets: RoomAcousticsKTV RoomAcousticsVocalConcert RoomAcousticsStudio RoomAcousticsPhonograph RoomAcousticsSpacial RoomAcousticsEthereal VoiceChangerEffectUncle VoiceChangerEffectOldMan VoiceChangerEffectBoy VoiceChangerEffectSister VoiceChangerEffectGirl VoiceChangerEffectPigKing VoiceChangerEffectHulk PitchCorrection

Inheritance

• Object
• Enum
• AudioEffectPreset

Constructors

AudioEffectPreset()

const

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. Before using this preset, set the profile parameter of setAudioProfile to MusicHighQuality or MusicHighQualityStereo; otherwise, the preset setting is invalid.

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 movement cycle is 10 seconds. After setting this effect, you can call setAudioEffectParameters to modify the movement period. Before using this preset, set the profile parameter of setAudioProfile to MusicStandardStereo or MusicHighQualityStereo; otherwise, the preset setting is invalid. If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.

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

A senior 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. Before using this preset, set the profile parameter of setAudioProfile to MusicHighQuality or MusicHighQualityStereo; otherwise, the preset setting is invalid.

StyleTransformationPopular → const AudioEffectPreset

The voice effect typical of popular music. Before using this preset, set the profile parameter of setAudioProfile to MusicHighQuality or MusicHighQualityStereo; otherwise, the preset setting is invalid.

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 setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.