LoudnessEnhancer
public
class
LoudnessEnhancer
extends AudioEffect
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
Public methods |
float
|
getTargetGain()
Return the target gain.
|
void
|
setTargetGain(int gainmB)
Set the target gain for the audio effect.
|
Inherited methods |
|
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 timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait(long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted, or until a
certain amount of real time has elapsed.
|
final
void
|
wait()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted.
|
|
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. |
Public methods
getTargetGain
public float getTargetGain ()
Return the target gain.
Returns |
float |
the effect target gain expressed in mB. |
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. |