Descriptor
open class Descriptor
| kotlin.Any | |
| ↳ | android.media.audiofx.AudioEffect.Descriptor |
The effect descriptor contains information on a particular effect implemented in the audio framework:
- type: UUID identifying the effect type. May be 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,AudioEffect.EFFECT_TYPE_HAPTIC_GENERATOR. - uuid: UUID for this particular implementation
- connectMode:
EFFECT_INSERTorEFFECT_AUXILIARY - name: human readable effect name
- implementor: human readable effect implementor name
queryEffects() returns an array of Descriptors to facilitate effects enumeration.
Summary
| Public constructors | |
|---|---|
| Public methods | |
|---|---|
| open Boolean | |
| open Int |
hashCode() |
| Properties | |
|---|---|
| String! |
Indicates if the effect is of insert category |
| String! |
Human readable effect implementor name |
| String! |
Human readable effect name |
| UUID! |
Indicates the generic type of the effect (Equalizer, Bass boost ...). |
| UUID! |
Indicates the particular implementation of the effect in that type. |
Public constructors
Descriptor
Descriptor(
type: String!,
uuid: String!,
connectMode: String!,
name: String!,
implementor: String!)
| Parameters | |
|---|---|
type |
String!: UUID identifying the effect type. May be 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, AudioEffect.EFFECT_TYPE_HAPTIC_GENERATOR. |
uuid |
String!: UUID for this particular implementation |
connectMode |
String!: EFFECT_INSERT or EFFECT_AUXILIARY |
name |
String!: human readable effect name |
implementor |
String!: human readable effect implementor name |
Public methods
equals
open fun equals(other: Any?): Boolean
| Parameters | |
|---|---|
obj |
the reference object with which to compare. |
| Return | |
|---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
hashCode
open fun hashCode(): Int
| Return | |
|---|---|
Int |
a hash code value for this object. |
Properties
connectMode
var connectMode: String!
Indicates if the effect is of insert category EFFECT_INSERT or auxiliary category 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 android.media.AudioRecord.
type
var type: UUID!
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
var 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.