Stage

Kotlin |Java

class Stage

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

Known Direct Subclasses

DynamicsProcessing.BandStage	Base class for stages that hold bands
DynamicsProcessing.Limiter	Class for Limiter Stage Limiter is a single band compressor at the end of the processing chain, commonly used to protect the signal from overloading and distortion.

Known Indirect Subclasses

DynamicsProcessing.Eq	Class for Equalizer stage
DynamicsProcessing.Mbc	Class for Multi-Band Compressor (MBC) stage

base class for the different stages.

Summary

Public constructors
`Stage(inUse: Boolean, enabled: Boolean)` Class constructor for stage

Public methods
open Boolean	`isEnabled()` returns enabled state of the stage
open Boolean	`isInUse()` returns inUse state of the stage.
open Unit	`setEnabled(enabled: Boolean)` sets enabled state of the stage
open String	`toString()`

Stage(
    inUse: Boolean, 
    enabled: Boolean)

Class constructor for stage

Parameters
`inUse`	Boolean: true if this stage is set to be used. False otherwise. Stages that are not set "inUse" at initialization time are not available to be used at any time.
`enabled`	Boolean: true if this stage is currently used to process sound. When disabled, the stage is bypassed and the sound is copied unaltered from input to output.

open fun isEnabled(): Boolean

returns enabled state of the stage

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

open fun isInUse(): Boolean

returns inUse state of the stage.

Return
`Boolean`	inUse state of the stage. True if this stage is currently used to process sound. When false, the stage is bypassed and the sound is copied unaltered from input to output.

open fun setEnabled(enabled: Boolean): Unit

sets enabled state of the stage

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

open fun toString(): String

Return
`String`	a string representation of the object.