| java.lang.Object | |
| ↳ | com.h6ah4i.android.media.standard.audiofx.StandardLoudnessEnhancer |
Summary
|
[Expand]
Inherited Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
 From interface
com.h6ah4i.android.media.audiofx.IAudioEffect
| |||||||||||
|
From interface
com.h6ah4i.android.media.audiofx.ILoudnessEnhancer
| |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| StandardLoudnessEnhancer(int audioSession) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean |
getEnabled()
Returns effect enabled state
| ||||||||||
| int |
getId()
Returns effect unique identifier.
| ||||||||||
| AudioEffect |
getLoudnessEnhancer()
Get underlying LoudnessEnhancer instance.
| ||||||||||
| ILoudnessEnhancer.Settings |
getProperties()
Gets the ludness enhancer properties.
| ||||||||||
| float |
getTargetGain()
Return the target gain.
| ||||||||||
| boolean |
hasControl()
Checks if this AudioEffect object is controlling the effect engine.
| ||||||||||
| static boolean | isAvailable() | ||||||||||
| void |
release()
Releases the native AudioEffect resources.
| ||||||||||
| void |
setControlStatusListener(IAudioEffect.OnControlStatusChangeListener listener)
Sets the listener AudioEffect notifies when the effect engine control is
taken or returned.
| ||||||||||
| void |
setEnableStatusListener(IAudioEffect.OnEnableStatusChangeListener listener)
Sets the listener AudioEffect notifies when the effect engine is enabled
or disabled.
| ||||||||||
| int |
setEnabled(boolean enabled)
Enable or disable the effect.
| ||||||||||
| void |
setProperties(ILoudnessEnhancer.Settings settings)
Sets the ludness enhancer properties.
| ||||||||||
| void |
setTargetGain(int gainmB)
Return the target gain.
| ||||||||||
| Protected Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| void | checkIsNotReleased() | ||||||||||
| void | checkIsNotReleased(String methodName) | ||||||||||
| AudioEffect | getAudioEffect() | ||||||||||
| void | workaroundPrevReleaseSync() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
|
From interface
com.h6ah4i.android.media.IReleasable
| |||||||||||
|
From interface
com.h6ah4i.android.media.audiofx.IAudioEffect
| |||||||||||
|
From interface
com.h6ah4i.android.media.audiofx.ILoudnessEnhancer
| |||||||||||
Public Constructors
public StandardLoudnessEnhancer (int audioSession)
Throws
| IllegalStateException | |
|---|---|
| UnsupportedOperationException |
Public Methods
public boolean getEnabled ()
Returns effect enabled state
Returns
- true if the effect is enabled, false otherwise.
Throws
| IllegalStateException |
|---|
public int getId ()
Returns effect unique identifier. This system wide unique identifier can be used to attach this effect to a MediaPlayer or an AudioTrack when the effect is an auxiliary effect (Reverb)
Returns
- the effect identifier.
Throws
| IllegalStateException |
|---|
public AudioEffect getLoudnessEnhancer ()
Get underlying LoudnessEnhancer instance.
Returns
- underlying LoudnessEnhancer instance.
public ILoudnessEnhancer.Settings getProperties ()
Gets the ludness enhancer properties. This method is useful when a snapshot of current ludness enhancer settings must be saved by the application.
Returns
- a ILoudnessEnhancer.Settings object containing all current parameters values
Throws
| IllegalArgumentException | |
|---|---|
| IllegalStateException | |
| UnsupportedOperationException |
public float getTargetGain ()
Return the target gain.
Returns
- the effect target gain expressed in mB.
Throws
| IllegalStateException | |
|---|---|
| UnsupportedOperationException |
public boolean hasControl ()
Checks if this AudioEffect object is controlling the effect engine.
Returns
- true if this instance has control of effect engine, false otherwise.
Throws
| IllegalStateException |
|---|
public static boolean isAvailable ()
public void release ()
Releases the native AudioEffect resources. It is a good practice to release the effect engine when not in use as control can be returned to other applications or the native resources released.
public void setControlStatusListener (IAudioEffect.OnControlStatusChangeListener listener)
Sets the listener AudioEffect notifies when the effect engine control is taken or returned.
Throws
| IllegalStateException |
|---|
public void setEnableStatusListener (IAudioEffect.OnEnableStatusChangeListener listener)
Sets the listener AudioEffect notifies when the effect engine is enabled or disabled.
Throws
| IllegalStateException |
|---|
public int setEnabled (boolean enabled)
Enable or disable the effect. Creating an audio effect does not automatically apply this effect on the audio source. It creates the resources necessary to process this effect but the audio signal is still bypassed through the effect engine. Calling this method will make that the effect is actually applied or not to the audio content being played in the corresponding audio session.
Parameters
| enabled | the requested enable state |
|---|
Returns
SUCCESSin case of success,ERROR_INVALID_OPERATIONorERROR_DEAD_OBJECTin case of failure.
Throws
| IllegalStateException |
|---|
public void setProperties (ILoudnessEnhancer.Settings settings)
Sets the ludness enhancer properties. This method is useful when ludness enhancer settings have to be applied from a previous backup.
Parameters
| settings | a ILoudnessEnhancer.Settings object containing the properties to apply |
|---|
Throws
| IllegalArgumentException | |
|---|---|
| IllegalStateException | |
| UnsupportedOperationException |
public void setTargetGain (int gainmB)
Return the target gain.
Throws
| IllegalArgumentException | |
|---|---|
| IllegalStateException |