DynamicsProcessing.Channel
public
static
final
class
DynamicsProcessing.Channel
extends Object
java.lang.Object | |
↳ | android.media.audiofx.DynamicsProcessing.Channel |
Class for Channel configuration parameters. It is composed of multiple stages, which can be used/enabled independently. Stages not used or disabled will be bypassed and the sound would be unaffected by them.
Summary
Public constructors | |
---|---|
Channel(float inputGain, boolean preEqInUse, int preEqBandCount, boolean mbcInUse, int mbcBandCount, boolean postEqInUse, int postEqBandCount, boolean limiterInUse)
Class constructor for Channel configuration. |
|
Channel(DynamicsProcessing.Channel cfg)
Class constructor for Channel configuration |
Public methods | |
---|---|
float
|
getInputGain()
Gets inputGain value in decibels (dB). |
DynamicsProcessing.Limiter
|
getLimiter()
Gets Limiter configuration stage |
DynamicsProcessing.Mbc
|
getMbc()
Gets Mbc configuration stage |
DynamicsProcessing.MbcBand
|
getMbcBand(int band)
Gets MbcBand configuration for Mbc stage, for given band index. |
DynamicsProcessing.Eq
|
getPostEq()
Gets PostEq configuration stage |
DynamicsProcessing.EqBand
|
getPostEqBand(int band)
Gets EqBand for PostEq stage for given band index. |
DynamicsProcessing.Eq
|
getPreEq()
Gets PreEq configuration stage |
DynamicsProcessing.EqBand
|
getPreEqBand(int band)
Gets EqBand for PreEq stage for given band index. |
void
|
setInputGain(float inputGain)
Sets inputGain value in decibels (dB). |
void
|
setLimiter(DynamicsProcessing.Limiter limiter)
Sets Limiter configuration stage. |
void
|
setMbc(DynamicsProcessing.Mbc mbc)
Sets Mbc configuration stage. |
void
|
setMbcBand(int band, DynamicsProcessing.MbcBand mbcBand)
Sets MbcBand for Mbc stage for given band index |
void
|
setPostEq(DynamicsProcessing.Eq postEq)
Sets PostEq configuration stage. |
void
|
setPostEqBand(int band, DynamicsProcessing.EqBand postEqBand)
Sets EqBand for PostEq stage for given band index |
void
|
setPreEq(DynamicsProcessing.Eq preEq)
Sets PreEq configuration stage. |
void
|
setPreEqBand(int band, DynamicsProcessing.EqBand preEqBand)
Sets EqBand for PreEq stage for given band index |
String
|
toString()
Returns a string representation of the object. |
Inherited methods | |
---|---|
Public constructors
Channel
public Channel (float inputGain, boolean preEqInUse, int preEqBandCount, boolean mbcInUse, int mbcBandCount, boolean postEqInUse, int postEqBandCount, boolean limiterInUse)
Class constructor for Channel configuration.
Parameters | |
---|---|
inputGain |
float : value in decibels (dB) of level change applied to the audio before
processing. A value of 0 dB means no change. |
preEqInUse |
boolean : true if PreEq stage will be used, false otherwise. This can't be
changed later. |
preEqBandCount |
int : number of bands for PreEq stage. This can't be changed later. |
mbcInUse |
boolean : true if Mbc stage will be used, false otherwise. This can't be changed
later. |
mbcBandCount |
int : number of bands for Mbc stage. This can't be changed later. |
postEqInUse |
boolean : true if PostEq stage will be used, false otherwise. This can't be
changed later. |
postEqBandCount |
int : number of bands for PostEq stage. This can't be changed later. |
limiterInUse |
boolean : true if Limiter stage will be used, false otherwise. This can't be
changed later. |
Channel
public Channel (DynamicsProcessing.Channel cfg)
Class constructor for Channel configuration
Parameters | |
---|---|
cfg |
DynamicsProcessing.Channel : copy constructor |
Public methods
getInputGain
public float getInputGain ()
Gets inputGain value in decibels (dB). 0 dB means no change;
Returns | |
---|---|
float |
gain value in decibels (dB) |
getLimiter
public DynamicsProcessing.Limiter getLimiter ()
Gets Limiter configuration stage
Returns | |
---|---|
DynamicsProcessing.Limiter |
Limiter configuration stage |
getMbc
public DynamicsProcessing.Mbc getMbc ()
Gets Mbc configuration stage
Returns | |
---|---|
DynamicsProcessing.Mbc |
Mbc configuration stage |
getMbcBand
public DynamicsProcessing.MbcBand getMbcBand (int band)
Gets MbcBand configuration for Mbc stage, for given band index.
Parameters | |
---|---|
band |
int : index of band of interest from Mbc stage |
Returns | |
---|---|
DynamicsProcessing.MbcBand |
MbcBand configuration |
getPostEq
public DynamicsProcessing.Eq getPostEq ()
Gets PostEq configuration stage
Returns | |
---|---|
DynamicsProcessing.Eq |
PostEq configuration stage |
getPostEqBand
public DynamicsProcessing.EqBand getPostEqBand (int band)
Gets EqBand for PostEq stage for given band index.
Parameters | |
---|---|
band |
int : index of band of interest from PostEq stage |
Returns | |
---|---|
DynamicsProcessing.EqBand |
EqBand configuration |
getPreEq
public DynamicsProcessing.Eq getPreEq ()
Gets PreEq configuration stage
Returns | |
---|---|
DynamicsProcessing.Eq |
PreEq configuration stage |
getPreEqBand
public DynamicsProcessing.EqBand getPreEqBand (int band)
Gets EqBand for PreEq stage for given band index.
Parameters | |
---|---|
band |
int : index of band of interest from PreEq stage |
Returns | |
---|---|
DynamicsProcessing.EqBand |
EqBand configuration |
setInputGain
public void setInputGain (float inputGain)
Sets inputGain value in decibels (dB). 0 dB means no change;
Parameters | |
---|---|
inputGain |
float : desired gain value in decibels (dB) |
setLimiter
public void setLimiter (DynamicsProcessing.Limiter limiter)
Sets Limiter configuration stage.
Parameters | |
---|---|
limiter |
DynamicsProcessing.Limiter : configuration stage. |
setMbc
public void setMbc (DynamicsProcessing.Mbc mbc)
Sets Mbc configuration stage. New Mbc stage must have the same number of bands than original Mbc stage.
setMbcBand
public void setMbcBand (int band, DynamicsProcessing.MbcBand mbcBand)
Sets MbcBand for Mbc stage for given band index
Parameters | |
---|---|
band |
int : index of band of interest from Mbc Stage |
mbcBand |
DynamicsProcessing.MbcBand : configuration to be set |
setPostEq
public void setPostEq (DynamicsProcessing.Eq postEq)
Sets PostEq configuration stage. New PostEq stage must have the same number of bands than original PostEq stage.
Parameters | |
---|---|
postEq |
DynamicsProcessing.Eq : configuration |
setPostEqBand
public void setPostEqBand (int band, DynamicsProcessing.EqBand postEqBand)
Sets EqBand for PostEq stage for given band index
Parameters | |
---|---|
band |
int : index of band of interest from PostEq stage |
postEqBand |
DynamicsProcessing.EqBand : configuration to be set. |
setPreEq
public void setPreEq (DynamicsProcessing.Eq preEq)
Sets PreEq configuration stage. New PreEq stage must have the same number of bands than original PreEq stage.
Parameters | |
---|---|
preEq |
DynamicsProcessing.Eq : configuration |
setPreEqBand
public void setPreEqBand (int band, DynamicsProcessing.EqBand preEqBand)
Sets EqBand for PreEq stage for given band index
Parameters | |
---|---|
band |
int : index of band of interest from PreEq stage |
preEqBand |
DynamicsProcessing.EqBand : configuration to be set. |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |