lightbulb_outline Please take our October 2018 developer survey. Start survey

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

Inherited fields

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

Constants

PARAM_TARGET_GAIN_MB

added in API level 19
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

added in API level 19
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
RuntimeException
IllegalStateException
IllegalArgumentException
UnsupportedOperationException

Public methods

getTargetGain

added in API level 19
public float getTargetGain ()

Return the target gain.

Returns
float the effect target gain expressed in mB.

Throws
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalStateException
IllegalArgumentException

setTargetGain

added in API level 19
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
IllegalStateException
IllegalArgumentException
UnsupportedOperationException
IllegalStateException
IllegalArgumentException