Added in API level 19

LoudnessEnhancer


open class LoudnessEnhancer : AudioEffect
kotlin.Any
   ↳ 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
static Int

The maximum gain applied applied to the signal to process.

Inherited constants
Public constructors
LoudnessEnhancer(audioSession: Int)

Class constructor.

Public methods
open Float

Return the target gain.

open Unit
setTargetGain(gainmB: Int)

Set the target gain for the audio effect.

Inherited functions
Inherited properties

Constants

PARAM_TARGET_GAIN_MB

Added in API level 19
static val PARAM_TARGET_GAIN_MB: Int

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

Value: 0

Public constructors

LoudnessEnhancer

Added in API level 19
LoudnessEnhancer(audioSession: Int)

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.
Exceptions
java.lang.IllegalStateException
java.lang.IllegalArgumentException
java.lang.UnsupportedOperationException
java.lang.RuntimeException

Public methods

getTargetGain

Added in API level 19
open fun getTargetGain(): Float

Return the target gain.

Return
Float the effect target gain expressed in mB.
Exceptions
java.lang.IllegalStateException
java.lang.IllegalArgumentException
java.lang.UnsupportedOperationException

setTargetGain

Added in API level 19
open fun setTargetGain(gainmB: Int): Unit

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.
Exceptions
java.lang.IllegalStateException
java.lang.IllegalArgumentException
java.lang.UnsupportedOperationException