NEW_API: Unhide audio effect APIs.
This change unhides all public APIs for controling audio effects exposed by the following classes: - AudioEffect - BassBoost - EnvironmentalReverb - Equalizer - PresetReverb - Virtualizer - Visualizer Also fixes several problems in javadoc. Change-Id: I541ee4ad0232312ec720545737cbcdb8c9a82597
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/*
|
||||
* Copyright (C) 2009 The Android Open Source Project
|
||||
* Copyright (C) 2010 The Android Open Source Project
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
@@ -42,10 +42,7 @@ import java.util.StringTokenizer;
|
||||
* <p>To attach the Virtualizer to a particular AudioTrack or MediaPlayer, specify the audio session
|
||||
* ID of this AudioTrack or MediaPlayer when constructing the Virtualizer. If the audio session ID 0
|
||||
* is specified, the Virtualizer applies to the main audio output mix.
|
||||
// TODO when AudioEffect is unhidden
|
||||
// <p> See {_at_link android.media.AudioEffect} class for more details on controlling audio effects.
|
||||
*
|
||||
* {@hide Pending API council review}
|
||||
* <p> See {@link android.media.AudioEffect} class for more details on controlling audio effects.
|
||||
*/
|
||||
|
||||
public class Virtualizer extends AudioEffect {
|
||||
@@ -89,7 +86,7 @@ public class Virtualizer extends AudioEffect {
|
||||
* engine. As the same engine can be shared by several applications, this parameter indicates
|
||||
* how much the requesting application needs control of effect parameters. The normal priority
|
||||
* is 0, above normal is a positive number, below normal a negative number.
|
||||
* @param audioSession System wide unique audio session identifier. If audioSession
|
||||
* @param audioSession system wide unique audio session identifier. If audioSession
|
||||
* is not 0, the Virtualizer will be attached to the MediaPlayer or AudioTrack in the
|
||||
* same audio session. Otherwise, the Virtualizer will apply to the output mix.
|
||||
*
|
||||
@@ -122,7 +119,7 @@ public class Virtualizer extends AudioEffect {
|
||||
* accuracy for setting the strength, it is allowed to round the given strength to the nearest
|
||||
* supported value. You can use the {@link #getRoundedStrength()} method to query the
|
||||
* (possibly rounded) value that was actually set.
|
||||
* @param strength Strength of the effect. The valid range for strength strength is [0, 1000],
|
||||
* @param strength strength of the effect. The valid range for strength strength is [0, 1000],
|
||||
* where 0 per mille designates the mildest effect and 1000 per mille designates the strongest.
|
||||
* @throws IllegalStateException
|
||||
* @throws IllegalArgumentException
|
||||
@@ -135,7 +132,7 @@ public class Virtualizer extends AudioEffect {
|
||||
|
||||
/**
|
||||
* Gets the current strength of the effect.
|
||||
* @return The strength of the effect. The valid range for strength is [0, 1000], where 0 per
|
||||
* @return the strength of the effect. The valid range for strength is [0, 1000], where 0 per
|
||||
* mille designates the mildest effect and 1000 per mille the strongest
|
||||
* @throws IllegalStateException
|
||||
* @throws IllegalArgumentException
|
||||
@@ -159,8 +156,7 @@ public class Virtualizer extends AudioEffect {
|
||||
* Virtualizer engine.
|
||||
* @param effect the Virtualizer on which the interface is registered.
|
||||
* @param status status of the set parameter operation.
|
||||
// TODO when AudioEffect is unhidden
|
||||
// See {_at_link android.media.AudioEffect#setParameter(byte[], byte[])}.
|
||||
* See {@link android.media.AudioEffect#setParameter(byte[], byte[])}.
|
||||
* @param param ID of the modified parameter. See {@link #PARAM_STRENGTH} ...
|
||||
* @param value the new parameter value.
|
||||
*/
|
||||
@@ -283,6 +279,7 @@ public class Virtualizer extends AudioEffect {
|
||||
/**
|
||||
* Sets the virtualizer properties. This method is useful when virtualizer settings have to
|
||||
* be applied from a previous backup.
|
||||
* @param settings a Virtualizer.Settings object containing the properties to apply
|
||||
* @throws IllegalStateException
|
||||
* @throws IllegalArgumentException
|
||||
* @throws UnsupportedOperationException
|
||||
|
||||
Reference in New Issue
Block a user