DynamicsProcessing.MbcBand
public
static
final
class
DynamicsProcessing.MbcBand
extends DynamicsProcessing.BandBase
java.lang.Object | ||
↳ | android.media.audiofx.DynamicsProcessing.BandBase | |
↳ | android.media.audiofx.DynamicsProcessing.MbcBand |
Class for Multi-Band compressor bands MBC bands have multiple controllable parameters: enabled/disabled, cutoffFrequency, attackTime, releaseTime, ratio, threshold, kneeWidth, noiseGateThreshold, expanderRatio, preGain and postGain.
Summary
Public constructors | |
---|---|
MbcBand(boolean enabled, float cutoffFrequency, float attackTime, float releaseTime, float ratio, float threshold, float kneeWidth, float noiseGateThreshold, float expanderRatio, float preGain, float postGain)
Class constructor for MbcBand |
|
MbcBand(DynamicsProcessing.MbcBand cfg)
Class constructor for MbcBand |
Public methods | |
---|---|
float
|
getAttackTime()
gets attack time for compressor in milliseconds (ms) |
float
|
getExpanderRatio()
gets Expander ratio (1:N) for signals below the Noise Gate Threshold. |
float
|
getKneeWidth()
get Knee Width in decibels (dB) around compressor threshold point. |
float
|
getNoiseGateThreshold()
gets the noise gate threshold in decibels (dB) from 0 dB Full Scale (dBFS). |
float
|
getPostGain()
gets the gain applied to the signal AFTER compression. |
float
|
getPreGain()
gets the gain applied to the signal BEFORE the compression. |
float
|
getRatio()
gets the compressor ratio (N:1) |
float
|
getReleaseTime()
gets release time for compressor in milliseconds (ms) |
float
|
getThreshold()
gets the compressor threshold measured in decibels (dB) from 0 dB Full Scale (dBFS). |
void
|
setAttackTime(float attackTime)
sets attack time for compressor in milliseconds (ms) |
void
|
setExpanderRatio(float expanderRatio)
sets Expander ratio (1:N) for signals below the Noise Gate Threshold. |
void
|
setKneeWidth(float kneeWidth)
sets knee width in decibels (dB). |
void
|
setNoiseGateThreshold(float noiseGateThreshold)
sets noise gate threshod in decibels (dB). |
void
|
setPostGain(float postGain)
sets the gain to be applied to the siganl AFTER the compression. |
void
|
setPreGain(float preGain)
sets the gain to be applied to the signal BEFORE the compression, measured in decibels (dB), where 0 dB means no level change. |
void
|
setRatio(float ratio)
sets compressor ratio (N:1) |
void
|
setReleaseTime(float releaseTime)
sets release time for compressor in milliseconds (ms) |
void
|
setThreshold(float threshold)
sets the compressor threshold measured in decibels (dB) from 0 dB Full Scale (dBFS). |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
Public constructors
MbcBand
public MbcBand (boolean enabled, float cutoffFrequency, float attackTime, float releaseTime, float ratio, float threshold, float kneeWidth, float noiseGateThreshold, float expanderRatio, float preGain, float postGain)
Class constructor for MbcBand
Parameters | |
---|---|
enabled |
boolean : true if this band is currently used to process sound. When false,
the band is effectively muted and sound set to zero. |
cutoffFrequency |
float : topmost frequency number (in Hz) this band will process. The
effective bandwidth for the band is then computed using this and the previous band
topmost frequency (or 0 Hz for band number 0). Frequencies are expected to increase with
band number, thus band 0 cutoffFrequency <= band 1 cutoffFrequency, and so on. |
attackTime |
float : Attack Time for compressor in milliseconds (ms) |
releaseTime |
float : Release Time for compressor in milliseconds (ms) |
ratio |
float : Compressor ratio (N:1) (input:output) |
threshold |
float : Compressor threshold measured in decibels (dB) from 0 dB Full Scale
(dBFS). |
kneeWidth |
float : Width in decibels (dB) around compressor threshold point. |
noiseGateThreshold |
float : Noise gate threshold in decibels (dB) from 0 dB Full Scale
(dBFS). |
expanderRatio |
float : Expander ratio (1:N) (input:output) for signals below the Noise Gate
Threshold. |
preGain |
float : Gain applied to the signal BEFORE the compression. |
postGain |
float : Gain applied to the signal AFTER compression. |
MbcBand
public MbcBand (DynamicsProcessing.MbcBand cfg)
Class constructor for MbcBand
Parameters | |
---|---|
cfg |
DynamicsProcessing.MbcBand : copy constructor |
Public methods
getAttackTime
public float getAttackTime ()
gets attack time for compressor in milliseconds (ms)
Returns | |
---|---|
float |
attack time for compressor in milliseconds (ms) |
getExpanderRatio
public float getExpanderRatio ()
gets Expander ratio (1:N) for signals below the Noise Gate Threshold.
Returns | |
---|---|
float |
Expander ratio (1:N) |
getKneeWidth
public float getKneeWidth ()
get Knee Width in decibels (dB) around compressor threshold point. Widths are always positive, with higher values representing a wider area of transition from the linear zone to the compression zone. A knee of 0 dB means a more abrupt transition.
Returns | |
---|---|
float |
Knee Width in decibels (dB) |
getNoiseGateThreshold
public float getNoiseGateThreshold ()
gets the noise gate threshold in decibels (dB) from 0 dB Full Scale (dBFS). Noise gate thresholds are negative. Signals below this level will be expanded according the expanderRatio parameter. A Noise Gate Threshold of -75 dB means very quiet signals might be effectively removed from the signal.
Returns | |
---|---|
float |
Noise Gate Threshold in decibels (dB) |
getPostGain
public float getPostGain ()
gets the gain applied to the signal AFTER compression. Measured in decibels (dB) where 0 dB means no level change
Returns | |
---|---|
float |
postGain value in decibels (dB) |
getPreGain
public float getPreGain ()
gets the gain applied to the signal BEFORE the compression. Measured in decibels (dB) where 0 dB means no level change.
Returns | |
---|---|
float |
preGain value in decibels (dB) |
getRatio
public float getRatio ()
gets the compressor ratio (N:1)
Returns | |
---|---|
float |
compressor ratio (N:1) |
getReleaseTime
public float getReleaseTime ()
gets release time for compressor in milliseconds (ms)
Returns | |
---|---|
float |
release time for compressor in milliseconds (ms) |
getThreshold
public float getThreshold ()
gets the compressor threshold measured in decibels (dB) from 0 dB Full Scale (dBFS). Thresholds are negative. A threshold of 0 dB means no compression will take place.
Returns | |
---|---|
float |
compressor threshold in decibels (dB) |
setAttackTime
public void setAttackTime (float attackTime)
sets attack time for compressor in milliseconds (ms)
Parameters | |
---|---|
attackTime |
float : desired for compressor in milliseconds (ms) |
setExpanderRatio
public void setExpanderRatio (float expanderRatio)
sets Expander ratio (1:N) for signals below the Noise Gate Threshold.
Parameters | |
---|---|
expanderRatio |
float : desired expander ratio (1:N) |
setKneeWidth
public void setKneeWidth (float kneeWidth)
sets knee width in decibels (dB). See
getKneeWidth()
for more
information.
Parameters | |
---|---|
kneeWidth |
float : desired in decibels (dB) |
setNoiseGateThreshold
public void setNoiseGateThreshold (float noiseGateThreshold)
sets noise gate threshod in decibels (dB). See
getNoiseGateThreshold()
for more
information.
Parameters | |
---|---|
noiseGateThreshold |
float : desired in decibels (dB) |
setPostGain
public void setPostGain (float postGain)
sets the gain to be applied to the siganl AFTER the compression. Measured in decibels (dB), where 0 dB means no level change.
Parameters | |
---|---|
postGain |
float : desired value in decibels (dB) |
setPreGain
public void setPreGain (float preGain)
sets the gain to be applied to the signal BEFORE the compression, measured in decibels (dB), where 0 dB means no level change.
Parameters | |
---|---|
preGain |
float : desired in decibels (dB) |
setRatio
public void setRatio (float ratio)
sets compressor ratio (N:1)
Parameters | |
---|---|
ratio |
float : desired for the compressor (N:1) |
setReleaseTime
public void setReleaseTime (float releaseTime)
sets release time for compressor in milliseconds (ms)
Parameters | |
---|---|
releaseTime |
float : desired for compressor in milliseconds (ms) |
setThreshold
public void setThreshold (float threshold)
sets the compressor threshold measured in decibels (dB) from 0 dB Full Scale (dBFS). Thresholds are negative. A threshold of 0 dB means no compression will take place.
Parameters | |
---|---|
threshold |
float : desired for compressor in decibels(dB) |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |