AudioEffect.Descriptor

connectMode

public String connectMode

Indicates if the effect is of insert category AudioEffect.EFFECT_INSERT or auxiliary category AudioEffect.EFFECT_AUXILIARY. Insert effects (typically an Equalizer) are applied to the entire audio source and usually not shared by several sources. Auxiliary effects (typically a reverberator) are applied to part of the signal (wet) and the effect output is added to the original signal (dry). Audio pre processing are applied to audio captured on a particular AudioRecord.

implementor

public String implementor

Human readable effect implementor name

name

public String name

Human readable effect name

type

public UUID type

Indicates the generic type of the effect (Equalizer, Bass boost ...). One of AudioEffect.EFFECT_TYPE_AEC, AudioEffect.EFFECT_TYPE_AGC, AudioEffect.EFFECT_TYPE_BASS_BOOST, AudioEffect.EFFECT_TYPE_ENV_REVERB, AudioEffect.EFFECT_TYPE_EQUALIZER, AudioEffect.EFFECT_TYPE_NS, AudioEffect.EFFECT_TYPE_PRESET_REVERB AudioEffect.EFFECT_TYPE_VIRTUALIZER, AudioEffect.EFFECT_TYPE_DYNAMICS_PROCESSING, or AudioEffect.EFFECT_TYPE_HAPTIC_GENERATOR.
For reverberation, bass boost, EQ and virtualizer, the UUID corresponds to the OpenSL ES Interface ID.

uuid

public UUID uuid

Indicates the particular implementation of the effect in that type. Several effects can have the same type but this uuid is unique to a given implementation.

Descriptor

public Descriptor ()

Descriptor

public Descriptor (String type, 
                String uuid, 
                String connectMode, 
                String name, 
                String implementor)

equals

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

hashCode

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.