Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 01421d76 authored by Jean-Michel Trivi's avatar Jean-Michel Trivi Committed by Android (Google) Code Review
Browse files

Merge "Audio stream types: javadoc fix to indicate they're for volume"

parents 1daab17f 46d5b820

media/java/android/media/AudioManager.java

+14 −11
Original line number Diff line number Diff line
@@ -312,29 +312,32 @@ public class AudioManager { 
     */

    public static final String EXTRA_ENCODINGS = "android.media.extra.ENCODINGS";



    /** The audio stream for phone calls */

    /** Used to identify the volume of audio streams for phone calls */

    public static final int STREAM_VOICE_CALL = AudioSystem.STREAM_VOICE_CALL;

    /** The audio stream for system sounds */

    /** Used to identify the volume of audio streams for system sounds */

    public static final int STREAM_SYSTEM = AudioSystem.STREAM_SYSTEM;

    /** The audio stream for the phone ring */

    /** Used to identify the volume of audio streams for the phone ring */

    public static final int STREAM_RING = AudioSystem.STREAM_RING;

    /** The audio stream for music playback */

    /** Used to identify the volume of audio streams for music playback */

    public static final int STREAM_MUSIC = AudioSystem.STREAM_MUSIC;

    /** The audio stream for alarms */

    /** Used to identify the volume of audio streams for alarms */

    public static final int STREAM_ALARM = AudioSystem.STREAM_ALARM;

    /** The audio stream for notifications */

    /** Used to identify the volume of audio streams for notifications */

    public static final int STREAM_NOTIFICATION = AudioSystem.STREAM_NOTIFICATION;

    /** @hide The audio stream for phone calls when connected to bluetooth */

    /** @hide Used to identify the volume of audio streams for phone calls when connected

     *        to bluetooth */

    public static final int STREAM_BLUETOOTH_SCO = AudioSystem.STREAM_BLUETOOTH_SCO;

    /** @hide The audio stream for enforced system sounds in certain countries (e.g camera in Japan) */

    /** @hide Used to identify the volume of audio streams for enforced system sounds

     *        in certain countries (e.g camera in Japan) */

    public static final int STREAM_SYSTEM_ENFORCED = AudioSystem.STREAM_SYSTEM_ENFORCED;

    /** The audio stream for DTMF Tones */

    /** Used to identify the volume of audio streams for DTMF Tones */

    public static final int STREAM_DTMF = AudioSystem.STREAM_DTMF;

    /** @hide The audio stream for text to speech (TTS) */

    /** @hide Used to identify the volume of audio streams exclusively transmitted through the

     *        speaker (TTS) of the device */

    public static final int STREAM_TTS = AudioSystem.STREAM_TTS;

    /** Number of audio streams */

    /**

     * @deprecated Use AudioSystem.getNumStreamTypes() instead

     * @deprecated Do not iterate on volume stream type values.

     */

    @Deprecated public static final int NUM_STREAMS = AudioSystem.NUM_STREAMS;

media/java/android/media/AudioSystem.java

+13 −11
Original line number Diff line number Diff line
@@ -39,27 +39,29 @@ public class AudioSystem 
     * If these are modified, please also update Settings.System.VOLUME_SETTINGS

     * and attrs.xml and AudioManager.java.

     */

    /* The default audio stream */

    /** Used to identify the default audio stream volume */

    public static final int STREAM_DEFAULT = -1;

    /* The audio stream for phone calls */

    /** Used to identify the volume of audio streams for phone calls */

    public static final int STREAM_VOICE_CALL = 0;

    /* The audio stream for system sounds */

    /** Used to identify the volume of audio streams for system sounds */

    public static final int STREAM_SYSTEM = 1;

    /* The audio stream for the phone ring and message alerts */

    /** Used to identify the volume of audio streams for the phone ring and message alerts */

    public static final int STREAM_RING = 2;

    /* The audio stream for music playback */

    /** Used to identify the volume of audio streams for music playback */

    public static final int STREAM_MUSIC = 3;

    /* The audio stream for alarms */

    /** Used to identify the volume of audio streams for alarms */

    public static final int STREAM_ALARM = 4;

    /* The audio stream for notifications */

    /** Used to identify the volume of audio streams for notifications */

    public static final int STREAM_NOTIFICATION = 5;

    /* @hide The audio stream for phone calls when connected on bluetooth */

    /** Used to identify the volume of audio streams for phone calls when connected on bluetooth */

    public static final int STREAM_BLUETOOTH_SCO = 6;

    /* @hide The audio stream for enforced system sounds in certain countries (e.g camera in Japan) */

    /** Used to identify the volume of audio streams for enforced system sounds in certain

     * countries (e.g camera in Japan) */

    public static final int STREAM_SYSTEM_ENFORCED = 7;

    /* @hide The audio stream for DTMF tones */

    /** Used to identify the volume of audio streams for DTMF tones */

    public static final int STREAM_DTMF = 8;

    /* @hide The audio stream for text to speech (TTS) */

    /** Used to identify the volume of audio streams exclusively transmitted through the

     *  speaker (TTS) of the device */

    public static final int STREAM_TTS = 9;

    /**

     * @deprecated Use {@link #numStreamTypes() instead}