Merge "javadoc cleanup for audioeffect" into jb-mr2-dev (e4ef3849) · Commits · e / os / android_frameworks_base

media/java/android/media/audiofx/AudioEffect.java

+25 −7

Original line number	Original line	Diff line number	Diff line
	@@ -193,10 +193,14 @@ public class AudioEffect {
	* The effect descriptor contains information on a particular effect implemented in the		* The effect descriptor contains information on a particular effect implemented in the
	* audio framework:<br>		* audio framework:<br>
	* <ul>		* <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>uuid: UUID for this particular implementation</li>
	* <li>connectMode: {@link #EFFECT_INSERT}, {@link #EFFECT_AUXILIARY} or		* <li>connectMode: {@link #EFFECT_INSERT} or {@link #EFFECT_AUXILIARY}</li>
	* {at_link #EFFECT_PRE_PROCESSING}</li>
	* <li>name: human readable effect name</li>		* <li>name: human readable effect name</li>
	* <li>implementor: human readable effect implementor name</li>		* <li>implementor: human readable effect implementor name</li>
	* </ul>		* </ul>
	@@ -208,6 +212,19 @@ public class AudioEffect {
	public Descriptor() {		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,		public Descriptor(String type, String uuid, String connectMode,
	String name, String implementor) {		String name, String implementor) {
	this.type = UUID.fromString(type);		this.type = UUID.fromString(type);
	@@ -234,13 +251,14 @@ public class AudioEffect {
	*/		*/
	public UUID uuid;		public UUID uuid;
	/**		/**
	* Indicates if the effect is of insert category {@link #EFFECT_INSERT}, auxiliary		* Indicates if the effect is of insert category {@link #EFFECT_INSERT} or auxiliary
	* category {@link #EFFECT_AUXILIARY} or pre processing category		* category {@link #EFFECT_AUXILIARY}.
	* {at_link #EFFECT_PRE_PROCESSING}. Insert effects (Typically an Equalizer) are applied		* Insert effects (typically an {@link Equalizer}) are applied
	* to the entire audio source and usually not shared by several sources. Auxiliary effects		* 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		* (typically a reverberator) are applied to part of the signal (wet) and the effect output
	* is added to the original signal (dry).		* 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;		public String connectMode;
	/**		/**