Android APIs
public class

LoudnessEnhancer

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

Class Overview

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 getAudioSessionId() and getAudioSessionId()).

Summary

Constants
int PARAM_TARGET_GAIN_MB The maximum gain applied applied to the signal to process.
[Expand]
Inherited Constants
From class android.media.audiofx.AudioEffect
[Expand]
Inherited Fields
From class android.media.audiofx.AudioEffect
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.
[Expand]
Inherited Methods
From class android.media.audiofx.AudioEffect
From class java.lang.Object

Constants

public static final int PARAM_TARGET_GAIN_MB

Added in API level 19

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

public LoudnessEnhancer (int audioSession)

Added in API level 19

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
RuntimeException
IllegalStateException
IllegalArgumentException
UnsupportedOperationException

Public Methods

public float getTargetGain ()

Added in API level 19

Return the target gain.

Returns
float the effect target gain expressed in mB.
Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalStateException
IllegalArgumentException

public void setTargetGain (int gainmB)

Added in API level 19

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
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalStateException
IllegalArgumentException