Added in API level 28

Summary: Ctors | Methods | Inherited Methods

DynamicsProcessing.MbcBand

Kotlin |Java

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(DynamicsProcessing.MbcBand cfg)` Class constructor for MbcBand
`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

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

From class


        
          android.media.audiofx.DynamicsProcessing.BandBase

`float`	`getCutoffFrequency()` gets cutoffFrequency for this band in Hertz (Hz)
`boolean`	`isEnabled()` returns enabled state of the band
`void`	`setCutoffFrequency(float frequency)` sets topmost frequency number (in Hz) this band will process.
`void`	`setEnabled(boolean enabled)` sets enabled state of the band
`String`	`toString()` Returns a string representation of the object.

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 constructors

MbcBand

Added in API level 28

public MbcBand (DynamicsProcessing.MbcBand cfg)

Class constructor for MbcBand

Parameters
`cfg`	`DynamicsProcessing.MbcBand`: copy constructor

MbcBand

Added in API level 28

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.

Public methods

getAttackTime

Added in API level 28

public float getAttackTime ()

gets attack time for compressor in milliseconds (ms)

Returns
`float`	attack time for compressor in milliseconds (ms)

getExpanderRatio

Added in API level 28

public float getExpanderRatio ()

gets Expander ratio (1:N) for signals below the Noise Gate Threshold.

Returns
`float`	Expander ratio (1:N)

getKneeWidth

Added in API level 28

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

Added in API level 28

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

Added in API level 28

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

Added in API level 28

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

Added in API level 28

public float getRatio ()

gets the compressor ratio (N:1)

Returns
`float`	compressor ratio (N:1)

getReleaseTime

Added in API level 28

public float getReleaseTime ()

gets release time for compressor in milliseconds (ms)

Returns
`float`	release time for compressor in milliseconds (ms)

getThreshold

Added in API level 28

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

Added in API level 28

public void setAttackTime (float attackTime)

sets attack time for compressor in milliseconds (ms)

Parameters
`attackTime`	`float`: desired for compressor in milliseconds (ms)

setExpanderRatio

Added in API level 28

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

Added in API level 28

public void setKneeWidth (float kneeWidth)

sets knee width in decibels (dB). See getKneeWidth() for more information.

Parameters
`kneeWidth`	`float`: desired in decibels (dB)

setNoiseGateThreshold

Added in API level 28

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

Added in API level 28

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

Added in API level 28

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

Added in API level 28

public void setRatio (float ratio)

sets compressor ratio (N:1)

Parameters
`ratio`	`float`: desired for the compressor (N:1)

setReleaseTime

Added in API level 28

public void setReleaseTime (float releaseTime)

sets release time for compressor in milliseconds (ms)

Parameters
`releaseTime`	`float`: desired for compressor in milliseconds (ms)

setThreshold

Added in API level 28

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

Added in API level 28

public String toString ()

Returns a string representation of the object.

Returns
`String`	a string representation of the object.