DynamicsProcessing.Stage

public static class DynamicsProcessing.Stage
extends Object

java.lang.Object
   ↳ android.media.audiofx.DynamicsProcessing.Stage


base class for the different stages.

Summary

Public constructors

DynamicsProcessing.Stage(boolean inUse, boolean enabled)

Class constructor for stage

Public methods

boolean isEnabled()

returns enabled state of the stage

boolean isInUse()

returns inUse state of the stage.

void setEnabled(boolean enabled)

sets enabled state of the stage

String toString()

Returns a string representation of the object.

Inherited methods

Public constructors

DynamicsProcessing.Stage

added in API level 28
public DynamicsProcessing.Stage (boolean inUse, 
                boolean enabled)

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.

Public methods

isEnabled

added in API level 28
public boolean isEnabled ()

returns enabled state of the stage

Returns
boolean true if stage is enabled for processing, false otherwise

isInUse

added in API level 28
public boolean isInUse ()

returns inUse state of the stage.

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

setEnabled

added in API level 28
public void setEnabled (boolean enabled)

sets enabled state of the stage

Parameters
enabled boolean: true for enabled, false otherwise

toString

added in API level 28
public String toString ()

Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Returns
String a string representation of the object.