BandBase

Kotlin |Java

class BandBase

kotlin.Any
↳	android.media.audiofx.DynamicsProcessing.BandBase

Known Direct Subclasses

DynamicsProcessing.EqBand, DynamicsProcessing.MbcBand

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(enabled: Boolean, cutoffFrequency: Float)` Class constructor for BandBase

Public methods
open Float	`getCutoffFrequency()` gets cutoffFrequency for this band in Hertz (Hz)
open Boolean	`isEnabled()` returns enabled state of the band
open Unit	`setCutoffFrequency(frequency: Float)` sets topmost frequency number (in Hz) this band will process.
open Unit	`setEnabled(enabled: Boolean)` sets enabled state of the band
open String	`toString()`

Public constructors

BandBase

Added in API level 28

BandBase(
    enabled: Boolean, 
    cutoffFrequency: Float)

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

Added in API level 28

open fun getCutoffFrequency(): Float

gets cutoffFrequency for this band in Hertz (Hz)

Return
`Float`	cutoffFrequency for this band in Hertz (Hz)

isEnabled

Added in API level 28

open fun isEnabled(): Boolean

returns enabled state of the band

Return
`Boolean`	true if bands is enabled for processing, false otherwise

setCutoffFrequency

Added in API level 28

open fun setCutoffFrequency(frequency: Float): Unit

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.

Parameters
`frequency`	Float:

setEnabled

Added in API level 28

open fun setEnabled(enabled: Boolean): Unit

sets enabled state of the band

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

toString

Added in API level 28

open fun toString(): String

Return
`String`	a string representation of the object.