Android/frameworks_base
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge "javadoc cleanup for audioeffect" into jb-mr2-dev

Browse Source
This commit is contained in:
Scott Main
2013-06-04 16:42:22 +00:00
committed by Android (Google) Code Review
parent ac561b8bdd 1d154187a9
commit e4ef3849c5
1 changed files with 25 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
media/java/android/media/audiofx/AudioEffect.java
View File

@@ -193,10 +193,14 @@ public class AudioEffect {
* The effect descriptor contains information on a particular effect implemented in the
* audio framework:<br>
* <ul>
* <li>type: UUID identifying the effect type</li>
* <li>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}.
* </li>
* <li>uuid: UUID for this particular implementation</li>
* <li>connectMode: {@link #EFFECT_INSERT}, {@link #EFFECT_AUXILIARY} or
* {at_link #EFFECT_PRE_PROCESSING}</li>
* <li>connectMode: {@link #EFFECT_INSERT} or {@link #EFFECT_AUXILIARY}</li>
* <li>name: human readable effect name</li>
* <li>implementor: human readable effect implementor name</li>
* </ul>
@@ -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;
/**