Merge \\"More javadoc for audio recording activity API\\" into nyc-dev am: 8d5fd92314

am: a90df50109

Change-Id: I256b03cae0e76b7a5c61a691c9359a091f1f666a
This commit is contained in:
Jean-Michel Trivi
2016-07-08 19:55:08 +00:00
committed by android-build-merger
2 changed files with 15 additions and 3 deletions

View File

@@ -2744,6 +2744,7 @@ public class AudioManager {
* to be notified. * to be notified.
* Use {@link AudioManager#getActiveRecordingConfigurations()} to query the current * Use {@link AudioManager#getActiveRecordingConfigurations()} to query the current
* configuration. * configuration.
* @see AudioRecordingConfiguration
*/ */
public static abstract class AudioRecordingCallback { public static abstract class AudioRecordingCallback {
/** /**
@@ -2850,6 +2851,7 @@ public class AudioManager {
* Returns the current active audio recording configurations of the device. * Returns the current active audio recording configurations of the device.
* @return a non-null list of recording configurations. An empty list indicates there is * @return a non-null list of recording configurations. An empty list indicates there is
* no recording active when queried. * no recording active when queried.
* @see AudioRecordingConfiguration
*/ */
public @NonNull List<AudioRecordingConfiguration> getActiveRecordingConfigurations() { public @NonNull List<AudioRecordingConfiguration> getActiveRecordingConfigurations() {
final IAudioService service = getService(); final IAudioService service = getService();

View File

@@ -28,8 +28,18 @@ import java.util.Objects;
/** /**
* The AudioRecordingConfiguration class collects the information describing an audio recording * The AudioRecordingConfiguration class collects the information describing an audio recording
* session. This information is returned through the * session.
* {@link AudioManager#getActiveRecordingConfigurations()} method. * <p>Direct polling (see {@link AudioManager#getActiveRecordingConfigurations()}) or callback
* (see {@link AudioManager#registerAudioRecordingCallback(android.media.AudioManager.AudioRecordingCallback, android.os.Handler)}
* methods are ways to receive information about the current recording configuration of the device.
* <p>An audio recording configuration contains information about the recording format as used by
* the application ({@link #getClientFormat()}, as well as the recording format actually used by
* the device ({@link #getFormat()}). The two recording formats may, for instance, be at different
* sampling rates due to hardware limitations (e.g. application recording at 44.1kHz whereas the
* device always records at 48kHz, and the Android framework resamples for the application).
* <p>The configuration also contains the use case for which audio is recorded
* ({@link #getClientAudioSource()}), enabling the ability to distinguish between different
* activities such as ongoing voice recognition or camcorder recording.
* *
*/ */
public final class AudioRecordingConfiguration implements Parcelable { public final class AudioRecordingConfiguration implements Parcelable {