diff --git a/media/java/android/media/audiofx/AudioEffect.java b/media/java/android/media/audiofx/AudioEffect.java index 031326ea138e1..52c0c2d9f5fa9 100644 --- a/media/java/android/media/audiofx/AudioEffect.java +++ b/media/java/android/media/audiofx/AudioEffect.java @@ -193,10 +193,14 @@ public class AudioEffect { * The effect descriptor contains information on a particular effect implemented in the * audio framework:
* @@ -208,6 +212,19 @@ public class AudioEffect { public Descriptor() { } + /** + * @param type UUID identifying the effect type. May be one of: + * {@link AudioEffect#EFFECT_TYPE_AEC}, {@link AudioEffect#EFFECT_TYPE_AGC}, + * {@link AudioEffect#EFFECT_TYPE_BASS_BOOST}, {@link AudioEffect#EFFECT_TYPE_ENV_REVERB}, + * {@link AudioEffect#EFFECT_TYPE_EQUALIZER}, {@link AudioEffect#EFFECT_TYPE_NS}, + * {@link AudioEffect#EFFECT_TYPE_PRESET_REVERB}, + * {@link AudioEffect#EFFECT_TYPE_VIRTUALIZER}. + * @param uuid UUID for this particular implementation + * @param connectMode {@link #EFFECT_INSERT} or {@link #EFFECT_AUXILIARY} + * @param name human readable effect name + * @param implementor human readable effect implementor name + * + */ public Descriptor(String type, String uuid, String connectMode, String name, String implementor) { this.type = UUID.fromString(type); @@ -234,13 +251,14 @@ public class AudioEffect { */ public UUID uuid; /** - * Indicates if the effect is of insert category {@link #EFFECT_INSERT}, auxiliary - * category {@link #EFFECT_AUXILIARY} or pre processing category - * {at_link #EFFECT_PRE_PROCESSING}. Insert effects (Typically an Equalizer) are applied + * Indicates if the effect is of insert category {@link #EFFECT_INSERT} or auxiliary + * category {@link #EFFECT_AUXILIARY}. + * Insert effects (typically an {@link 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. + * Audio pre processing are applied to audio captured on a particular + * {@link android.media.AudioRecord}. */ public String connectMode; /**