DynamicsProcessing.BandBase | API reference

Summary: Ctors | Methods | Inherited Methods

public static class DynamicsProcessing.BandBase
extends Object

Known direct subclasses

DynamicsProcessing.EqBand	Class for Equalizer Bands Equalizer bands have three controllable parameters: enabled/disabled, cutoffFrequency and gain
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.

Base class for bands

Summary

Public constructors
`BandBase(boolean enabled, float cutoffFrequency)` Class constructor for BandBase

Public methods
`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.

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 constructors

BandBase

public BandBase (boolean enabled, 
                float cutoffFrequency)

Class constructor for BandBase

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.

Public methods

getCutoffFrequency

public float getCutoffFrequency ()

gets cutoffFrequency for this band in Hertz (Hz)

Returns
`float`	cutoffFrequency for this band in Hertz (Hz)

isEnabled

public boolean isEnabled ()

returns enabled state of the band

Returns
`boolean`	true if bands is enabled for processing, false otherwise

setCutoffFrequency

public void setCutoffFrequency (float frequency)

sets 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.

setEnabled

public void setEnabled (boolean enabled)

sets enabled state of the band

Parameters
`enabled`	`boolean`: true for enabled, false otherwise

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.