AudioEffect

Kotlin |Java

open class AudioEffect

kotlin.Any
↳	android.media.audiofx.AudioEffect

Known Direct Subclasses

AcousticEchoCanceler, AutomaticGainControl, BassBoost, DynamicsProcessing, EnvironmentalReverb, Equalizer, HapticGenerator, LoudnessEnhancer, NoiseSuppressor, PresetReverb, Virtualizer

AcousticEchoCanceler	Acoustic Echo Canceler (AEC).
AutomaticGainControl	Automatic Gain Control (AGC).
BassBoost	Bass boost is an audio effect to boost or amplify low frequencies of the sound.
DynamicsProcessing	DynamicsProcessing is an audio effect for equalizing and changing dynamic range properties of the sound.
EnvironmentalReverb	A sound generated within a room travels in many directions.
Equalizer	An Equalizer is used to alter the frequency response of a particular music source or of the main output mix.
HapticGenerator	Haptic Generator(HG).
LoudnessEnhancer	LoudnessEnhancer is an audio effect for increasing audio loudness.
NoiseSuppressor	Noise Suppressor (NS).
PresetReverb	A sound generated within a room travels in many directions.
Virtualizer	An audio virtualizer is a general name for an effect to spatialize audio channels.

AudioEffect is the base class for controlling audio effects provided by the android audio framework.

Applications should not use the AudioEffect class directly but one of its derived classes to control specific effects:

To apply the audio effect to a specific AudioTrack or MediaPlayer instance, the application must specify the audio session ID of that instance when creating the AudioEffect. (see android.media.MediaPlayer#getAudioSessionId() for details on audio sessions).

NOTE: attaching insert effects (equalizer, bass boost, virtualizer) to the global audio output mix by use of session 0 is deprecated.

Creating an AudioEffect object will create the corresponding effect engine in the audio framework if no instance of the same effect type exists in the specified audio session. If one exists, this instance will be used.

The application creating the AudioEffect object (or a derived class) will either receive control of the effect engine or not depending on the priority parameter. If priority is higher than the priority used by the current effect engine owner, the control will be transfered to the new object. Otherwise control will remain with the previous object. In this case, the new application will be notified of changes in effect engine state or control ownership by the appropriate listener.

Summary

Nested classes

Nested classes
open	`Descriptor` The effect descriptor contains information on a particular effect implemented in the audio framework: type: UUID identifying the effect type. May be one of: `AudioEffect#EFFECT_TYPE_AEC`, `AudioEffect#EFFECT_TYPE_AGC`, `AudioEffect#EFFECT_TYPE_BASS_BOOST`, `AudioEffect#EFFECT_TYPE_ENV_REVERB`, `AudioEffect#EFFECT_TYPE_EQUALIZER`, `AudioEffect#EFFECT_TYPE_NS`, `AudioEffect#EFFECT_TYPE_PRESET_REVERB`, `AudioEffect#EFFECT_TYPE_VIRTUALIZER`, `AudioEffect#EFFECT_TYPE_DYNAMICS_PROCESSING`, `AudioEffect#EFFECT_TYPE_HAPTIC_GENERATOR`. uuid: UUID for this particular implementation connectMode: `EFFECT_INSERT` or `EFFECT_AUXILIARY` name: human readable effect name implementor: human readable effect implementor name The method `queryEffects()` returns an array of Descriptors to facilitate effects enumeration.
abstract	`OnControlStatusChangeListener` The OnControlStatusChangeListener interface defines a method called by the AudioEffect when control of the effect engine is gained or lost by the application
abstract	`OnEnableStatusChangeListener` The OnEnableStatusChangeListener interface defines a method called by the AudioEffect when the enabled state of the effect engine was changed by the controlling application.

open

Descriptor

The effect descriptor contains information on a particular effect implemented in the audio framework:

type: UUID identifying the effect type. May be one of: AudioEffect#EFFECT_TYPE_AEC, AudioEffect#EFFECT_TYPE_AGC, AudioEffect#EFFECT_TYPE_BASS_BOOST, AudioEffect#EFFECT_TYPE_ENV_REVERB, AudioEffect#EFFECT_TYPE_EQUALIZER, AudioEffect#EFFECT_TYPE_NS, AudioEffect#EFFECT_TYPE_PRESET_REVERB, AudioEffect#EFFECT_TYPE_VIRTUALIZER, AudioEffect#EFFECT_TYPE_DYNAMICS_PROCESSING, AudioEffect#EFFECT_TYPE_HAPTIC_GENERATOR.
uuid: UUID for this particular implementation
connectMode: EFFECT_INSERT or EFFECT_AUXILIARY
name: human readable effect name
implementor: human readable effect implementor name

The method queryEffects() returns an array of Descriptors to facilitate effects enumeration.

abstract

OnControlStatusChangeListener

The OnControlStatusChangeListener interface defines a method called by the AudioEffect when control of the effect engine is gained or lost by the application

abstract

OnEnableStatusChangeListener

The OnEnableStatusChangeListener interface defines a method called by the AudioEffect when the enabled state of the effect engine was changed by the controlling application.

Constants
static String	`ACTION_CLOSE_AUDIO_EFFECT_CONTROL_SESSION` Intent to signal to the effect control application or service that an audio session is closed and that effects should not be applied anymore.
static String	`ACTION_DISPLAY_AUDIO_EFFECT_CONTROL_PANEL` Intent to launch an audio effect control panel UI.
static String	`ACTION_OPEN_AUDIO_EFFECT_CONTROL_SESSION` Intent to signal to the effect control application or service that a new audio session is opened and requires audio effects to be applied.
static Int	`ALREADY_EXISTS` Internal operation status.
static Int	`CONTENT_TYPE_GAME` Value for `EXTRA_CONTENT_TYPE` when the type of content played is game audio
static Int	`CONTENT_TYPE_MOVIE` Value for `EXTRA_CONTENT_TYPE` when the type of content played is video or movie
static Int	`CONTENT_TYPE_MUSIC` Value for `EXTRA_CONTENT_TYPE` when the type of content played is music
static Int	`CONTENT_TYPE_VOICE` Value for `EXTRA_CONTENT_TYPE` when the type of content played is voice audio
static String	`EFFECT_AUXILIARY` Effect connection mode is auxiliary.
static String	`EFFECT_INSERT` Effect connection mode is insert.
static String	`EFFECT_POST_PROCESSING` Effect connection mode is post processing.
static String	`EFFECT_PRE_PROCESSING` Effect connection mode is pre processing.
static Int	`ERROR` Unspecified error.
static Int	`ERROR_BAD_VALUE` Operation failed due to bad parameter value.
static Int	`ERROR_DEAD_OBJECT` Operation failed due to dead remote object.
static Int	`ERROR_INVALID_OPERATION` Operation failed because it was requested in wrong state.
static Int	`ERROR_NO_INIT` Operation failed due to bad object initialization.
static Int	`ERROR_NO_MEMORY` Operation failed due to lack of memory.
static String	`EXTRA_AUDIO_SESSION` Contains the ID of the audio session the effects should be applied to.
static String	`EXTRA_CONTENT_TYPE` Indicates which type of content is played by the application.
static String	`EXTRA_PACKAGE_NAME` Contains the package name of the calling application.
static Int	`SUCCESS` Successful operation.

Public methods
open AudioEffect.Descriptor!	`getDescriptor()` Get the effect descriptor.
open Boolean	`getEnabled()` Returns effect enabled state
open Int	`getId()` Returns effect unique identifier.
open Boolean	`hasControl()` Checks if this AudioEffect object is controlling the effect engine.
open static Array<AudioEffect.Descriptor!>!	`queryEffects()` Query all effects available on the platform.
open Unit	`release()` Releases the native AudioEffect resources.
open Unit	`setControlStatusListener(listener: AudioEffect.OnControlStatusChangeListener!)` Sets the listener AudioEffect notifies when the effect engine control is taken or returned.
open Unit	`setEnableStatusListener(listener: AudioEffect.OnEnableStatusChangeListener!)` Sets the listener AudioEffect notifies when the effect engine is enabled or disabled.
open Int	`setEnabled(enabled: Boolean)` Enable or disable the effect.

Protected methods
open Unit	`finalize()`

Properties
static UUID!	`EFFECT_TYPE_AEC` UUID for Acoustic Echo Canceler (AEC)
static UUID!	`EFFECT_TYPE_AGC` UUID for Automatic Gain Control (AGC)
static UUID!	`EFFECT_TYPE_BASS_BOOST` UUID for bass boost effect
static UUID!	`EFFECT_TYPE_DYNAMICS_PROCESSING` UUID for Dynamics Processing
static UUID!	`EFFECT_TYPE_ENV_REVERB` UUID for environmental reverberation effect
static UUID!	`EFFECT_TYPE_EQUALIZER` UUID for equalizer effect
static UUID	`EFFECT_TYPE_HAPTIC_GENERATOR` UUID for Haptic Generator.
static UUID!	`EFFECT_TYPE_LOUDNESS_ENHANCER` UUID for Loudness Enhancer
static UUID!	`EFFECT_TYPE_NS` UUID for Noise Suppressor (NS)
static UUID!	`EFFECT_TYPE_PRESET_REVERB` UUID for preset reverberation effect
static UUID!	`EFFECT_TYPE_VIRTUALIZER` UUID for virtualizer effect

AudioEffect

Summary

Constants

ACTION_CLOSE_AUDIO_EFFECT_CONTROL_SESSION

ACTION_DISPLAY_AUDIO_EFFECT_CONTROL_PANEL

ACTION_OPEN_AUDIO_EFFECT_CONTROL_SESSION

ALREADY_EXISTS

CONTENT_TYPE_GAME

CONTENT_TYPE_MOVIE

CONTENT_TYPE_MUSIC

CONTENT_TYPE_VOICE

EFFECT_AUXILIARY

EFFECT_INSERT

EFFECT_POST_PROCESSING

EFFECT_PRE_PROCESSING

ERROR

ERROR_BAD_VALUE

ERROR_DEAD_OBJECT

ERROR_INVALID_OPERATION

ERROR_NO_INIT

ERROR_NO_MEMORY

EXTRA_AUDIO_SESSION

EXTRA_CONTENT_TYPE

EXTRA_PACKAGE_NAME

SUCCESS

Public methods

getDescriptor

getEnabled

getId

hasControl

queryEffects

release

setControlStatusListener

setEnableStatusListener

setEnabled

Protected methods

finalize

Properties

EFFECT_TYPE_AEC

EFFECT_TYPE_AGC

EFFECT_TYPE_BASS_BOOST

EFFECT_TYPE_DYNAMICS_PROCESSING

EFFECT_TYPE_ENV_REVERB

EFFECT_TYPE_EQUALIZER

EFFECT_TYPE_HAPTIC_GENERATOR

EFFECT_TYPE_LOUDNESS_ENHANCER

EFFECT_TYPE_NS

EFFECT_TYPE_PRESET_REVERB

EFFECT_TYPE_VIRTUALIZER