# Print output for @column tags ?>
Developers

- Design
- Develop
- Distribute

Developer Console

## Most visited

## Recently visited

## Results for

Summary: Constants | Inherited Constants | Inherited Fields | Ctors | Methods | Inherited Methods

# LoudnessEnhancer

`public class LoudnessEnhancer`
`` `extends AudioEffect` ``

java.lang.Object
↳ | android.media.audiofx.AudioEffect
| ↳ | android.media.audiofx.LoudnessEnhancer

LoudnessEnhancer is an audio effect for increasing audio loudness. The processing is parametrized by a target gain value, which determines the maximum amount by which an audio signal will be amplified; signals amplified outside of the sample range supported by the platform are compressed. An application creates a LoudnessEnhancer object to instantiate and control a this audio effect in the audio framework. To attach the LoudnessEnhancer to a particular AudioTrack or MediaPlayer, specify the audio session ID of this AudioTrack or MediaPlayer when constructing the effect (see `AudioTrack#getAudioSessionId()` and `MediaPlayer#getAudioSessionId()`).

## Summary

### Constants
`int` | `PARAM_TARGET_GAIN_MB` The maximum gain applied applied to the signal to process.

### Inherited constants
From class `android.media.audiofx.AudioEffect`
`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.
`String` | `ACTION_DISPLAY_AUDIO_EFFECT_CONTROL_PANEL` Intent to launch an audio effect control panel UI.
`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.
`int` | `ALREADY_EXISTS` Internal operation status.
`int` | `CONTENT_TYPE_GAME` Value for `EXTRA_CONTENT_TYPE` when the type of content played is game audio
`int` | `CONTENT_TYPE_MOVIE` Value for `EXTRA_CONTENT_TYPE` when the type of content played is video or movie
`int` | `CONTENT_TYPE_MUSIC` Value for `EXTRA_CONTENT_TYPE` when the type of content played is music
`int` | `CONTENT_TYPE_VOICE` Value for `EXTRA_CONTENT_TYPE` when the type of content played is voice audio
`String` | `EFFECT_AUXILIARY` Effect connection mode is auxiliary.
`String` | `EFFECT_INSERT` Effect connection mode is insert.
`String` | `EFFECT_POST_PROCESSING` Effect connection mode is post processing.
`String` | `EFFECT_PRE_PROCESSING` Effect connection mode is pre processing.
`int` | `ERROR` Unspecified error.
`int` | `ERROR_BAD_VALUE` Operation failed due to bad parameter value.
`int` | `ERROR_DEAD_OBJECT` Operation failed due to dead remote object.
`int` | `ERROR_INVALID_OPERATION` Operation failed because it was requested in wrong state.
`int` | `ERROR_NO_INIT` Operation failed due to bad object initialization.
`int` | `ERROR_NO_MEMORY` Operation failed due to lack of memory.
`String` | `EXTRA_AUDIO_SESSION` Contains the ID of the audio session the effects should be applied to.
`String` | `EXTRA_CONTENT_TYPE` Indicates which type of content is played by the application.
`String` | `EXTRA_PACKAGE_NAME` Contains the package name of the calling application.
`int` | `SUCCESS` Successful operation.

### Inherited fields
From class `android.media.audiofx.AudioEffect`
`public static final UUID` | `EFFECT_TYPE_AEC` UUID for Acoustic Echo Canceler (AEC)
`public static final UUID` | `EFFECT_TYPE_AGC` UUID for Automatic Gain Control (AGC)
`public static final UUID` | `EFFECT_TYPE_BASS_BOOST` UUID for bass boost effect
`public static final UUID` | `EFFECT_TYPE_DYNAMICS_PROCESSING` UUID for Dynamics Processing
`public static final UUID` | `EFFECT_TYPE_ENV_REVERB` UUID for environmental reverberation effect
`public static final UUID` | `EFFECT_TYPE_EQUALIZER` UUID for equalizer effect
`public static final UUID` | `EFFECT_TYPE_HAPTIC_GENERATOR` UUID for Haptic Generator.
`public static final UUID` | `EFFECT_TYPE_LOUDNESS_ENHANCER` UUID for Loudness Enhancer
`public static final UUID` | `EFFECT_TYPE_NS` UUID for Noise Suppressor (NS)
`public static final UUID` | `EFFECT_TYPE_PRESET_REVERB` UUID for preset reverberation effect
`public static final UUID` | `EFFECT_TYPE_VIRTUALIZER` UUID for virtualizer effect

### Public constructors
`LoudnessEnhancer(int audioSession)` Class constructor.

### Public methods
`float` | `getTargetGain()` Return the target gain.
`void` | `setTargetGain(int gainmB)` Set the target gain for the audio effect.

### Inherited methods
From class `android.media.audiofx.AudioEffect`
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`AudioEffect.Descriptor` | `getDescriptor()` Get the effect descriptor.
`boolean` | `getEnabled()` Returns effect enabled state
`int` | `getId()` Returns effect unique identifier.
`boolean` | `hasControl()` Checks if this AudioEffect object is controlling the effect engine.
`static Descriptor[]` | `queryEffects()` Query all effects available on the platform.
`void` | `release()` Releases the native AudioEffect resources.
`void` | `setControlStatusListener(AudioEffect.OnControlStatusChangeListener listener)` Sets the listener AudioEffect notifies when the effect engine control is taken or returned.
`void` | `setEnableStatusListener(AudioEffect.OnEnableStatusChangeListener listener)` Sets the listener AudioEffect notifies when the effect engine is enabled or disabled.
`int` | `setEnabled(boolean enabled)` Enable or disable the effect.
From class `java.lang.Object`
`Object` | `clone()` Creates and returns a copy of this object.
`boolean` | `equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void` | `finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>` | `getClass()` Returns the runtime class of this `Object`.
`int` | `hashCode()` Returns a hash code value for the object.
`final void` | `notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void` | `notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String` | `toString()` Returns a string representation of the object.
`final void` | `wait(long timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void` | `wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void` | `wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

## Constants

### PARAM_TARGET_GAIN_MB

    public static final int PARAM_TARGET_GAIN_MB

The maximum gain applied applied to the signal to process. It is expressed in millibels (100mB = 1dB) where 0mB corresponds to no amplification.

Constant Value: 0 (0x00000000)

## Public constructors

### LoudnessEnhancer

    public LoudnessEnhancer (int audioSession)

Class constructor.

Parameters
`audioSession` | `int`: system-wide unique audio session identifier. The LoudnessEnhancer will be attached to the MediaPlayer or AudioTrack in the same audio session.

Throws
`` | java.lang.IllegalStateException
`` | java.lang.IllegalArgumentException
`` | java.lang.UnsupportedOperationException
`` | java.lang.RuntimeException
`IllegalArgumentException` |
`IllegalStateException` |
`RuntimeException` |
`UnsupportedOperationException` |

## Public methods

### getTargetGain

    public float getTargetGain ()

Return the target gain.

Returns
`float` | the effect target gain expressed in mB.

Throws
`` | java.lang.IllegalStateException
`` | java.lang.IllegalArgumentException
`` | java.lang.UnsupportedOperationException
`IllegalArgumentException` |
`IllegalStateException` |
`UnsupportedOperationException` |

### setTargetGain

    public void setTargetGain (int gainmB)

Set the target gain for the audio effect. The target gain is the maximum value by which a sample value will be amplified when the effect is enabled.

Parameters
`gainmB` | `int`: the effect target gain expressed in mB. 0mB corresponds to no amplification.

Throws
`` | java.lang.IllegalStateException
`` | java.lang.IllegalArgumentException
`` | java.lang.UnsupportedOperationException
`IllegalArgumentException` |
`IllegalStateException` |
`UnsupportedOperationException` |

Full name *
Email address *
Company / developer name
One of your Play Store app URLs *
Which best describes your business:*
Apps
Games
Apps & Games
*
*