AudioEffectPreset enum

The options for SDK preset audio effects.

Inheritance
Available extensions

Values

AudioEffectOff → const AudioEffectPreset

Turn off audio effects and use the original voice.

RoomAcousticsKTV → const AudioEffectPreset

An audio effect typical of a KTV venue.

RoomAcousticsVocalConcert → const AudioEffectPreset

An audio effect typical of a concert hall.

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

RoomAcousticsStudio → const AudioEffectPreset

An audio effect typical of a recording studio.

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

RoomAcousticsPhonograph → const AudioEffectPreset

An audio effect typical of a vintage phonograph.

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

RoomAcousticsVirtualStereo → const AudioEffectPreset

A virtual stereo effect that renders monophonic audio as stereo audio.

Note

Call setAudioProfile and set the profile parameter to MusicStandardStereo(3) or MusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

RoomAcousticsSpacial → const AudioEffectPreset

A more spatial audio effect.

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

RoomAcousticsEthereal → const AudioEffectPreset

A more ethereal audio effect.

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

RoomAcoustics3DVoice → const AudioEffectPreset

A 3D voice effect that makes the voice appear to be moving around the user. The default cycle period of the 3D voice effect is 10 seconds. To change the cycle period, call RtcEngine.setAudioEffectParameters after this method.

Note

  • Call setAudioProfile and set the profile parameter to MusicStandardStereo(3) or MusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
  • If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
VoiceChangerEffectUncle → const AudioEffectPreset

The voice of a middle-aged man.

Note

  • Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.
VoiceChangerEffectOldMan → const AudioEffectPreset

The voice of an old man.

Note

  • Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.
VoiceChangerEffectBoy → const AudioEffectPreset

The voice of a boy.

Note

  • Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.
VoiceChangerEffectSister → const AudioEffectPreset

The voice of a young woman.

Note

  • Agora recommends using this enumerator to process a female-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.
VoiceChangerEffectGirl → const AudioEffectPreset

The voice of a girl.

Note

  • Agora recommends using this enumerator to process a male-sounding voice; otherwise, you may not hear the anticipated voice effect.
  • To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.
VoiceChangerEffectPigKing → const AudioEffectPreset

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

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

VoiceChangerEffectHulk → const AudioEffectPreset

The voice of Hulk.

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

StyleTransformationRnB → const AudioEffectPreset

An audio effect typical of R&B music.

Note

Call RtcEngine.setAudioProfile and set the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

StyleTransformationPopular → const AudioEffectPreset

An audio effect typical of popular music.

Note

Call RtcEngine.setAudioProfile and set the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.

PitchCorrection → const AudioEffectPreset

A pitch correction effect that corrects the user’s pitch based on the pitch of the natural C major scale. To change the basic mode and tonic pitch, call RtcEngine.setAudioEffectParameters after this method.

Note

To achieve better audio effect quality, Agora recommends calling RtcEngine.setAudioProfile and setting the profile parameter to MusicHighQuality(4) or MusicHighQualityStereo(5) before setting this enumerator.

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