public class BassBoost
extends AudioEffect
java.lang.Object | ||
↳ | android.media.audiofx.AudioEffect | |
↳ | android.media.audiofx.BassBoost |
低音增强是一种音频效果,用于增强或放大声音的低频。 它与简单的均衡器相当,但限于低频范围内的一个频带放大。
应用程序创建一个BassBoost对象来实例化和控制音频框架中的低音增强引擎。
BassBoost实现公开的方法,参数类型和单位直接映射到SLBassBoostItf接口的OpenSL ES 1.0.1规范(http://www.khronos.org/opensles/)定义的方法,参数类型和单位。 有关更多详细信息,请参阅此规范。
要将BassBoost附加到特定的AudioTrack或MediaPlayer,请在构建BassBoost时指定此AudioTrack或MediaPlayer的音频会话ID。
注:不建议使用会话0将BassBoost附加到全局音频输出组合。
有关音频会话的详细信息,请参阅 getAudioSessionId()
。
有关控制音频效果的更多详细信息,请参见 AudioEffect
类。
Nested classes |
|
---|---|
interface |
BassBoost.OnParameterChangeListener OnParameterChangeListener接口定义了一个参数值发生变化时由BassBoost调用的方法。 |
class |
BassBoost.Settings Settings类重新组合所有的低音增强参数。 |
Constants |
|
---|---|
int |
PARAM_STRENGTH 低音增强效果强度。 |
int |
PARAM_STRENGTH_SUPPORTED 低音增强引擎支持强度参数。 |
Inherited constants |
---|
From class android.media.audiofx.AudioEffect
|
Inherited fields |
---|
From class android.media.audiofx.AudioEffect
|
Public constructors |
|
---|---|
BassBoost(int priority, int audioSession) 类构造函数。 |
Public methods |
|
---|---|
BassBoost.Settings |
getProperties() 获取低音增强属性。 |
short |
getRoundedStrength() 获取当前效果的强度。 |
boolean |
getStrengthSupported() 指示是否支持设置强度。 |
void |
setParameterListener(BassBoost.OnParameterChangeListener listener) 注册OnParameterChangeListener接口。 |
void |
setProperties(BassBoost.Settings settings) 设置低音增强属性。 |
void |
setStrength(short strength) 设置低音增强效果的强度。 |
Inherited methods |
|
---|---|
From class android.media.audiofx.AudioEffect
|
|
From class java.lang.Object
|
int PARAM_STRENGTH
低音增强效果强度。 参数ID为BassBoost.OnParameterChangeListener
常数值:1(0x00000001)
int PARAM_STRENGTH_SUPPORTED
低音增强引擎支持强度参数。 getParameter()的参数ID。
常量值:0(0x00000000)
BassBoost (int priority, int audioSession)
类构造函数。
Parameters | |
---|---|
priority |
int : 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 |
int : system wide unique audio session identifier. The BassBoost 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 |
BassBoost.Settings getProperties ()
获取低音增强属性。 当应用程序必须保存当前低音增强设置的快照时,此方法非常有用。
Returns | |
---|---|
BassBoost.Settings |
a BassBoost.Settings object containing all current parameters values |
Throws | |
---|---|
|
IllegalStateException |
|
IllegalArgumentException |
UnsupportedOperationException |
|
IllegalStateException |
|
IllegalArgumentException |
short getRoundedStrength ()
获取当前效果的强度。
Returns | |
---|---|
short |
the strength of the effect. The valid range for strength is [0, 1000], where 0 per mille designates the mildest effect and 1000 per mille the strongest |
Throws | |
---|---|
|
IllegalStateException |
|
IllegalArgumentException |
UnsupportedOperationException |
|
IllegalStateException |
|
IllegalArgumentException |
boolean getStrengthSupported ()
指示是否支持设置强度。 如果此方法返回false,则只支持一个强度,并且setStrength()方法总是四舍五入到该值。
Returns | |
---|---|
boolean |
true is strength parameter is supported, false otherwise |
void setParameterListener (BassBoost.OnParameterChangeListener listener)
注册OnParameterChangeListener接口。
Parameters | |
---|---|
listener |
BassBoost.OnParameterChangeListener : OnParameterChangeListener interface registered |
void setProperties (BassBoost.Settings settings)
设置低音增强属性。 当必须从先前的备份应用低音增强设置时,此方法非常有用。
Parameters | |
---|---|
settings |
BassBoost.Settings : a BassBoost.Settings object containing the properties to apply |
Throws | |
---|---|
|
IllegalStateException |
|
IllegalArgumentException |
UnsupportedOperationException |
|
IllegalStateException |
|
IllegalArgumentException |
void setStrength (short strength)
设置低音增强效果的强度。 如果实施不支持每千次精度设定强度,则允许将给定强度四舍五入到最接近的支持值。 您可以使用getRoundedStrength()
方法查询实际设置的(可能为四舍五入的)值。
Parameters | |
---|---|
strength |
short : 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. |
Throws | |
---|---|
|
IllegalStateException |
|
IllegalArgumentException |
UnsupportedOperationException |
|
IllegalStateException |
|
IllegalArgumentException |