Links
Android Sites
Language
Results
Loading...
| java.lang.Object | ||
| ↳ | android.media.audiofx.AudioEffect | |
| ↳ | android.media.audiofx.BassBoost | |
Bass boost is an audio effect to boost or amplify low frequencies of the sound. It is comparable to a simple equalizer but limited to one band amplification in the low frequency range.
An application creates a BassBoost object to instantiate and control a bass boost engine in the audio framework.
The methods, parameter types and units exposed by the BassBoost implementation are directly mapping those defined by the OpenSL ES 1.0.1 Specification (http://www.khronos.org/opensles/) for the SLBassBoostItf interface. Please refer to this specification for more details.
To attach the BassBoost to a particular AudioTrack or MediaPlayer, specify the audio session ID of this AudioTrack or MediaPlayer when constructing the BassBoost.
NOTE: attaching a BassBoost to the global audio output mix by use of session 0 is deprecated.
See
getAudioSessionId()
for details on audio sessions.
See
AudioEffect
class for more details on
controlling audio effects.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
BassBoost.OnParameterChangeListener | The OnParameterChangeListener interface defines a method called by the BassBoost when a parameter value has changed. | |||||||||
|
|
BassBoost.Settings | The Settings class regroups all bass boost parameters. | |||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | PARAM_STRENGTH | Bass boost effect strength. | |||||||||
| int | PARAM_STRENGTH_SUPPORTED | Is strength parameter supported by bass boost engine. | |||||||||
|
[Expand]
Inherited Constants
|
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
android.media.audiofx.AudioEffect
|
|||||||||||
|
[Expand]
Inherited Fields
|
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
android.media.audiofx.AudioEffect
|
|||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Class constructor.
|
||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
Gets the bass boost properties.
|
||||||||||
|
|
Gets the current strength of the effect.
|
||||||||||
|
|
Indicates whether setting strength is supported.
|
||||||||||
|
|
Registers an OnParameterChangeListener interface.
|
||||||||||
|
|
Sets the bass boost properties.
|
||||||||||
|
|
Sets the strength of the bass boost effect.
|
||||||||||
|
[Expand]
Inherited Methods
|
|||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
android.media.audiofx.AudioEffect
|
|||||||||||
|
From class
java.lang.Object
|
|||||||||||
Bass boost effect strength. Parameter ID for
BassBoost.OnParameterChangeListener
Is strength parameter supported by bass boost engine. Parameter ID for getParameter().
Class constructor.
| priority | the priority level requested by the application for controlling the BassBoost engine. As the same engine can be shared by several applications, this parameter indicates how much the requesting application needs control of effect parameters. The normal priority is 0, above normal is a positive number, below normal a negative number. |
|---|---|
| audioSession | system wide unique audio session identifier. The BassBoost will be attached to the MediaPlayer or AudioTrack in the same audio session. |
| java.lang.IllegalStateException | |
| java.lang.IllegalArgumentException | |
| java.lang.UnsupportedOperationException | |
| RuntimeException | |
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException |
Gets the bass boost properties. This method is useful when a snapshot of current bass boost settings must be saved by the application.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Gets the current strength of the effect.
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Indicates whether setting strength is supported. If this method returns false, only one strength is supported and the setStrength() method always rounds to that value.
Registers an OnParameterChangeListener interface.
| listener | OnParameterChangeListener interface registered |
|---|
Sets the bass boost properties. This method is useful when bass boost settings have to be applied from a previous backup.
| settings | a BassBoost.Settings object containing the properties to apply |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |
Sets the strength of the bass boost effect. If the implementation does not support per mille
accuracy for setting the strength, it is allowed to round the given strength to the nearest
supported value. You can use the
getRoundedStrength()
method to query the
(possibly rounded) value that was actually set.
| strength | strength of the effect. The valid range for strength strength is [0, 1000], where 0 per mille designates the mildest effect and 1000 per mille designates the strongest. |
|---|
| IllegalStateException | |
| IllegalArgumentException | |
| UnsupportedOperationException | |
| IllegalStateException | |
| IllegalArgumentException |