Class for Config object, used by DynamicsProcessing to configure and update the audio effect.
use Builder to instantiate objects of this type.
Nested classes
class
DynamicsProcessing.Config.Builder
Public methods
DynamicsProcessing.Channel
getChannelByChannelIndex (int channelIndex)
Gets the Channel configuration object by using the channel index
float
getInputGainByChannelIndex (int channelIndex)
Gets inputGain value in decibels (dB) for channel indicated by channelIndex
DynamicsProcessing.Limiter
getLimiterByChannelIndex (int channelIndex)
DynamicsProcessing.MbcBand
getMbcBandByChannelIndex (int channelIndex, int band)
int
getMbcBandCount ()
Gets number of bands configured for the Mbc stage.
DynamicsProcessing.Mbc
getMbcByChannelIndex (int channelIndex)
DynamicsProcessing.EqBand
getPostEqBandByChannelIndex (int channelIndex, int band)
int
getPostEqBandCount ()
Gets number of bands configured for the PostEq stage.
DynamicsProcessing.Eq
getPostEqByChannelIndex (int channelIndex)
DynamicsProcessing.EqBand
getPreEqBandByChannelIndex (int channelIndex, int band)
int
getPreEqBandCount ()
Gets number of bands configured for the PreEq stage.
DynamicsProcessing.Eq
getPreEqByChannelIndex (int channelIndex)
Gets PreEq stage from channel indicated by channelIndex
float
getPreferredFrameDuration ()
Gets preferred frame duration in milliseconds (ms).
int
getVariant ()
Gets variant for effect engine See DynamicsProcessing.VARIANT_FAVOR_FREQUENCY_RESOLUTION and
DynamicsProcessing.VARIANT_FAVOR_TIME_RESOLUTION .
boolean
isLimiterInUse ()
Gets if Limiter stage is in use
boolean
isMbcInUse ()
Gets if Mbc stage is in use
boolean
isPostEqInUse ()
Gets if PostEq stage is in use
boolean
isPreEqInUse ()
Gets if preEq stage is in use
void
setAllChannelsTo (DynamicsProcessing.Channel channel)
Sets ALL channels to the chosen Channel object.
void
setChannelTo (int channelIndex, DynamicsProcessing.Channel channel)
Sets the chosen Channel object in the selected channelIndex
Note that all the stages should have the same number of bands than the existing Channel
object.
void
setInputGainAllChannelsTo (float inputGain)
Sets the inputGain value in decibels (dB) for ALL channels
void
setInputGainByChannelIndex (int channelIndex, float inputGain)
Sets the inputGain value in decibels (dB) for the channel indicated by channelIndex.
void
setLimiterAllChannelsTo (DynamicsProcessing.Limiter limiter)
void
setLimiterByChannelIndex (int channelIndex, DynamicsProcessing.Limiter limiter)
void
setMbcAllChannelsTo (DynamicsProcessing.Mbc mbc)
void
setMbcBandAllChannelsTo (int band, DynamicsProcessing.MbcBand mbcBand)
void
setMbcBandByChannelIndex (int channelIndex, int band, DynamicsProcessing.MbcBand mbcBand)
void
setMbcByChannelIndex (int channelIndex, DynamicsProcessing.Mbc mbc)
void
setPostEqAllChannelsTo (DynamicsProcessing.Eq postEq)
void
setPostEqBandAllChannelsTo (int band, DynamicsProcessing.EqBand postEqBand)
void
setPostEqBandByChannelIndex (int channelIndex, int band, DynamicsProcessing.EqBand postEqBand)
void
setPostEqByChannelIndex (int channelIndex, DynamicsProcessing.Eq postEq)
void
setPreEqAllChannelsTo (DynamicsProcessing.Eq preEq)
Sets the PreEq stage configuration for ALL channels.
void
setPreEqBandAllChannelsTo (int band, DynamicsProcessing.EqBand preEqBand)
void
setPreEqBandByChannelIndex (int channelIndex, int band, DynamicsProcessing.EqBand preEqBand)
void
setPreEqByChannelIndex (int channelIndex, DynamicsProcessing.Eq preEq)
Sets the PreEq stage configuration for the channel indicated by channelIndex.
String
toString ()
Returns a string representation of the object.
Inherited methods
From class
java.lang.Object
Object
clone ()
Creates and returns a copy of this object.
boolean
equals (Object obj)
Indicates whether some other object is "equal to" this one.
void
finalize ()
Called by the garbage collector on an object when garbage collection
determines that there are no more references to the object.
final
Class <?>
getClass ()
Returns the runtime class of this Object.
int
hashCode ()
Returns a hash code value for the object.
final
void
notify ()
Wakes up a single thread that is waiting on this object's
monitor.
final
void
notifyAll ()
Wakes up all threads that are waiting on this object's monitor.
String
toString ()
Returns a string representation of the object.
final
void
wait (long timeoutMillis, int nanos)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted , or until a
certain amount of real time has elapsed.
final
void
wait (long timeoutMillis)
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted , or until a
certain amount of real time has elapsed.
final
void
wait ()
Causes the current thread to wait until it is awakened, typically
by being notified or interrupted .
Public methods
getChannelByChannelIndex
public DynamicsProcessing.Channel getChannelByChannelIndex (int channelIndex)
Gets the Channel configuration object by using the channel index
Parameters
channelIndex
int: of desired Channel object
public float getInputGainByChannelIndex (int channelIndex)
Gets inputGain value in decibels (dB) for channel indicated by channelIndex
Parameters
channelIndex
int: index of channel of interest
Returns
float
inputGain value in decibels (dB). 0 dB means no change.
getLimiterByChannelIndex
public DynamicsProcessing.Limiter getLimiterByChannelIndex (int channelIndex)
Parameters
channelIndex
int
getMbcBandByChannelIndex
public DynamicsProcessing.MbcBand getMbcBandByChannelIndex (int channelIndex,
int band)
Parameters
channelIndex
int
band
int
getMbcBandCount
public int getMbcBandCount ()
Gets number of bands configured for the Mbc stage.
Returns
int
number of bands configured for the Mbc stage.
getMbcByChannelIndex
public DynamicsProcessing.Mbc getMbcByChannelIndex (int channelIndex)
Parameters
channelIndex
int
getPostEqBandByChannelIndex
public DynamicsProcessing.EqBand getPostEqBandByChannelIndex (int channelIndex,
int band)
Parameters
channelIndex
int
band
int
getPostEqBandCount
public int getPostEqBandCount ()
Gets number of bands configured for the PostEq stage.
Returns
int
number of bands configured for the PostEq stage.
getPostEqByChannelIndex
public DynamicsProcessing.Eq getPostEqByChannelIndex (int channelIndex)
Parameters
channelIndex
int
getPreEqBandByChannelIndex
public DynamicsProcessing.EqBand getPreEqBandByChannelIndex (int channelIndex,
int band)
Parameters
channelIndex
int
band
int
getPreEqBandCount
public int getPreEqBandCount ()
Gets number of bands configured for the PreEq stage.
Returns
int
number of bands configured for the PreEq stage.
getPreEqByChannelIndex
public DynamicsProcessing.Eq getPreEqByChannelIndex (int channelIndex)
Gets PreEq stage from channel indicated by channelIndex
Parameters
channelIndex
int: index of channel of interest
getPreferredFrameDuration
public float getPreferredFrameDuration ()
Gets preferred frame duration in milliseconds (ms).
Returns
float
preferred frame duration in milliseconds (ms)
isLimiterInUse
public boolean isLimiterInUse ()
Gets if Limiter stage is in use
Returns
boolean
true if Limiter stage is in use;
isMbcInUse
public boolean isMbcInUse ()
Gets if Mbc stage is in use
Returns
boolean
true if Mbc stage is in use;
isPostEqInUse
public boolean isPostEqInUse ()
Gets if PostEq stage is in use
Returns
boolean
true if PostEq stage is in use;
isPreEqInUse
public boolean isPreEqInUse ()
Gets if preEq stage is in use
Returns
boolean
true if preEq stage is in use;
public void setAllChannelsTo (DynamicsProcessing.Channel channel)
Sets ALL channels to the chosen Channel object. Note that all the stages should have the
same number of bands than the existing ones.
Parameters
channel
DynamicsProcessing.Channel: Channel configuration object to be set.
public void setChannelTo (int channelIndex,
DynamicsProcessing.Channel channel)
Sets the chosen Channel object in the selected channelIndex
Note that all the stages should have the same number of bands than the existing Channel
object.
Parameters
channelIndex
int: index of channel to be replaced
channel
DynamicsProcessing.Channel: Channel configuration object to be set
public void setInputGainAllChannelsTo (float inputGain)
Sets the inputGain value in decibels (dB) for ALL channels
Parameters
inputGain
float: desired value in decibels (dB)
public void setInputGainByChannelIndex (int channelIndex,
float inputGain)
Sets the inputGain value in decibels (dB) for the channel indicated by channelIndex.
Parameters
channelIndex
int: index of channel of interest
inputGain
float: desired value in decibels (dB).
public void setLimiterByChannelIndex (int channelIndex,
DynamicsProcessing.Limiter limiter)
Parameters
channelIndex
int
limiter
DynamicsProcessing.Limiter
public void setMbcBandAllChannelsTo (int band,
DynamicsProcessing.MbcBand mbcBand)
Parameters
band
int
mbcBand
DynamicsProcessing.MbcBand
public void setMbcBandByChannelIndex (int channelIndex,
int band,
DynamicsProcessing.MbcBand mbcBand)
Parameters
channelIndex
int
band
int
mbcBand
DynamicsProcessing.MbcBand
public void setMbcByChannelIndex (int channelIndex,
DynamicsProcessing.Mbc mbc)
Parameters
channelIndex
int
mbc
DynamicsProcessing.Mbc
setPostEqAllChannelsTo
public void setPostEqAllChannelsTo (DynamicsProcessing.Eq postEq)
Parameters
postEq
DynamicsProcessing.Eq
setPostEqBandAllChannelsTo
public void setPostEqBandAllChannelsTo (int band,
DynamicsProcessing.EqBand postEqBand)
Parameters
band
int
postEqBand
DynamicsProcessing.EqBand
setPostEqBandByChannelIndex
public void setPostEqBandByChannelIndex (int channelIndex,
int band,
DynamicsProcessing.EqBand postEqBand)
Parameters
channelIndex
int
band
int
postEqBand
DynamicsProcessing.EqBand
setPostEqByChannelIndex
public void setPostEqByChannelIndex (int channelIndex,
DynamicsProcessing.Eq postEq)
Parameters
channelIndex
int
postEq
DynamicsProcessing.Eq
public void setPreEqAllChannelsTo (DynamicsProcessing.Eq preEq)
Sets the PreEq stage configuration for ALL channels. Note that new preEq stage must have
the same number of bands than original preEq stages.
Parameters
preEq
DynamicsProcessing.Eq: desired PreEq configuration to be set
public void setPreEqBandAllChannelsTo (int band,
DynamicsProcessing.EqBand preEqBand)
Parameters
band
int
preEqBand
DynamicsProcessing.EqBand
public void setPreEqBandByChannelIndex (int channelIndex,
int band,
DynamicsProcessing.EqBand preEqBand)
Parameters
channelIndex
int
band
int
preEqBand
DynamicsProcessing.EqBand
public void setPreEqByChannelIndex (int channelIndex,
DynamicsProcessing.Eq preEq)
Sets the PreEq stage configuration for the channel indicated by channelIndex. Note that
new preEq stage must have the same number of bands than original preEq stage
Parameters
channelIndex
int: index of channel to be set
preEq
DynamicsProcessing.Eq: desired PreEq configuration to be set
toString
public String toString ()
Returns a string representation of the object.
Returns
String
a string representation of the object.
Content and code samples on this page are subject to the licenses described in the Content License . Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[]]