Skip to content

Most visited

Recently visited

navigation
Added in API level 1

AudioManager

public class AudioManager
extends Object

java.lang.Object
   ↳ android.media.AudioManager


AudioManager provides access to volume and ringer mode control.

Use Context.getSystemService(Context.AUDIO_SERVICE) to get an instance of this class.

Summary

Nested classes

class AudioManager.AudioRecordingCallback

Interface for receiving update notifications about the recording configuration. 

interface AudioManager.OnAudioFocusChangeListener

Interface definition for a callback to be invoked when the audio focus of the system is updated. 

Constants

String ACTION_AUDIO_BECOMING_NOISY

Broadcast intent, a hint for applications that audio is about to become 'noisy' due to a change in audio outputs.

String ACTION_HDMI_AUDIO_PLUG

Broadcast Action: A sticky broadcast indicating an HDMI cable was plugged or unplugged.

String ACTION_HEADSET_PLUG

Broadcast Action: Wired Headset plugged in or unplugged.

String ACTION_SCO_AUDIO_STATE_CHANGED

This constant was deprecated in API level 14. Use ACTION_SCO_AUDIO_STATE_UPDATED instead

String ACTION_SCO_AUDIO_STATE_UPDATED

Sticky broadcast intent action indicating that the bluetoooth SCO audio connection state has been updated.

int ADJUST_LOWER

Decrease the ringer volume.

int ADJUST_MUTE

Mute the volume.

int ADJUST_RAISE

Increase the ringer volume.

int ADJUST_SAME

Maintain the previous ringer volume.

int ADJUST_TOGGLE_MUTE

Toggle the mute state.

int ADJUST_UNMUTE

Unmute the volume.

int AUDIOFOCUS_GAIN

Used to indicate a gain of audio focus, or a request of audio focus, of unknown duration.

int AUDIOFOCUS_GAIN_TRANSIENT

Used to indicate a temporary gain or request of audio focus, anticipated to last a short amount of time.

int AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE

Used to indicate a temporary request of audio focus, anticipated to last a short amount of time, during which no other applications, or system components, should play anything.

int AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK

Used to indicate a temporary request of audio focus, anticipated to last a short amount of time, and where it is acceptable for other audio applications to keep playing after having lowered their output level (also referred to as "ducking").

int AUDIOFOCUS_LOSS

Used to indicate a loss of audio focus of unknown duration.

int AUDIOFOCUS_LOSS_TRANSIENT

Used to indicate a transient loss of audio focus.

int AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK

Used to indicate a transient loss of audio focus where the loser of the audio focus can lower its output volume if it wants to continue playing (also referred to as "ducking"), as the new focus owner doesn't require others to be silent.

int AUDIOFOCUS_REQUEST_FAILED

A failed focus change request.

int AUDIOFOCUS_REQUEST_GRANTED

A successful focus change request.

int AUDIO_SESSION_ID_GENERATE

A special audio session ID to indicate that the audio session ID isn't known and the framework should generate a new value.

int ERROR

A default error code.

int ERROR_DEAD_OBJECT

An error code indicating that the object reporting it is no longer valid and needs to be recreated.

String EXTRA_AUDIO_PLUG_STATE

Extra used in ACTION_HDMI_AUDIO_PLUG to communicate whether HDMI is plugged in or unplugged.

String EXTRA_ENCODINGS

Extra used in ACTION_HDMI_AUDIO_PLUG to define the audio encodings supported by the connected HDMI device.

String EXTRA_MAX_CHANNEL_COUNT

Extra used in ACTION_HDMI_AUDIO_PLUG to define the maximum number of channels supported by the HDMI device.

String EXTRA_RINGER_MODE

The new ringer mode.

String EXTRA_SCO_AUDIO_PREVIOUS_STATE

Extra for intent ACTION_SCO_AUDIO_STATE_UPDATED containing the previous bluetooth SCO connection state.

String EXTRA_SCO_AUDIO_STATE

Extra for intent ACTION_SCO_AUDIO_STATE_CHANGED or ACTION_SCO_AUDIO_STATE_UPDATED containing the new bluetooth SCO connection state.

String EXTRA_VIBRATE_SETTING

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode and listen to RINGER_MODE_CHANGED_ACTION instead.

String EXTRA_VIBRATE_TYPE

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode and listen to RINGER_MODE_CHANGED_ACTION instead.

int FLAG_ALLOW_RINGER_MODES

Whether to include ringer modes as possible options when changing volume.

int FLAG_PLAY_SOUND

Whether to play a sound when changing the volume.

int FLAG_REMOVE_SOUND_AND_VIBRATE

Removes any sounds/vibrate that may be in the queue, or are playing (related to changing volume).

int FLAG_SHOW_UI

Show a toast containing the current volume.

int FLAG_VIBRATE

Whether to vibrate if going into the vibrate ringer mode.

int FX_FOCUS_NAVIGATION_DOWN

Focus has moved down

int FX_FOCUS_NAVIGATION_LEFT

Focus has moved left

int FX_FOCUS_NAVIGATION_RIGHT

Focus has moved right

int FX_FOCUS_NAVIGATION_UP

Focus has moved up

int FX_KEYPRESS_DELETE

IME delete keypress sound

int FX_KEYPRESS_INVALID

Invalid keypress sound

int FX_KEYPRESS_RETURN

IME return_keypress sound

int FX_KEYPRESS_SPACEBAR

IME spacebar keypress sound

int FX_KEYPRESS_STANDARD

IME standard keypress sound

int FX_KEY_CLICK

Keyboard and direction pad click sound

int GET_DEVICES_ALL

Specifies to the getDevices(int) method to include both source and sink devices.

int GET_DEVICES_INPUTS

Specifies to the getDevices(int) method to include source (i.e.

int GET_DEVICES_OUTPUTS

Specifies to the getDevices(int) method to include sink (i.e.

int MODE_CURRENT

Current audio mode.

int MODE_INVALID

Invalid audio mode.

int MODE_IN_CALL

In call audio mode.

int MODE_IN_COMMUNICATION

In communication audio mode.

int MODE_NORMAL

Normal audio mode: not ringing and no call established.

int MODE_RINGTONE

Ringing audio mode.

int NUM_STREAMS

This constant was deprecated in API level 3. Use AudioSystem.getNumStreamTypes() instead

String PROPERTY_OUTPUT_FRAMES_PER_BUFFER

Used as a key for getProperty(String) to request the native or optimal output buffer size for this device's primary output stream, in decimal PCM frames.

String PROPERTY_OUTPUT_SAMPLE_RATE

Used as a key for getProperty(String) to request the native or optimal output sample rate for this device's primary output stream, in decimal Hz.

String PROPERTY_SUPPORT_AUDIO_SOURCE_UNPROCESSED

Used as a key for getProperty(String) to determine if the unprocessed audio source is available and supported with the expected frequency range and level response.

String PROPERTY_SUPPORT_MIC_NEAR_ULTRASOUND

Used as a key for getProperty(String) to determine if the default microphone audio source supports near-ultrasound frequencies (range of 18 - 21 kHz).

String PROPERTY_SUPPORT_SPEAKER_NEAR_ULTRASOUND

Used as a key for getProperty(String) to determine if the default speaker audio path supports near-ultrasound frequencies (range of 18 - 21 kHz).

String RINGER_MODE_CHANGED_ACTION

Sticky broadcast intent action indicating that the ringer mode has changed.

int RINGER_MODE_NORMAL

Ringer mode that may be audible and may vibrate.

int RINGER_MODE_SILENT

Ringer mode that will be silent and will not vibrate.

int RINGER_MODE_VIBRATE

Ringer mode that will be silent and will vibrate.

int ROUTE_ALL

This constant was deprecated in API level 5. Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

int ROUTE_BLUETOOTH

This constant was deprecated in API level 3. use ROUTE_BLUETOOTH_SCODo not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

int ROUTE_BLUETOOTH_A2DP

This constant was deprecated in API level 5. Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

int ROUTE_BLUETOOTH_SCO

This constant was deprecated in API level 5. Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

int ROUTE_EARPIECE

This constant was deprecated in API level 5. Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

int ROUTE_HEADSET

This constant was deprecated in API level 5. Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

int ROUTE_SPEAKER

This constant was deprecated in API level 5. Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

int SCO_AUDIO_STATE_CONNECTED

Value for extra EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE indicating that the SCO audio channel is established

int SCO_AUDIO_STATE_CONNECTING

Value for extra EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE indicating that the SCO audio channel is being established

int SCO_AUDIO_STATE_DISCONNECTED

Value for extra EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE indicating that the SCO audio channel is not established

int SCO_AUDIO_STATE_ERROR

Value for extra EXTRA_SCO_AUDIO_STATE indicating that there was an error trying to obtain the state

int STREAM_ALARM

The audio stream for alarms

int STREAM_DTMF

The audio stream for DTMF Tones

int STREAM_MUSIC

The audio stream for music playback

int STREAM_NOTIFICATION

The audio stream for notifications

int STREAM_RING

The audio stream for the phone ring

int STREAM_SYSTEM

The audio stream for system sounds

int STREAM_VOICE_CALL

The audio stream for phone calls

int USE_DEFAULT_STREAM_TYPE

Suggests using the default stream type.

String VIBRATE_SETTING_CHANGED_ACTION

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode and listen to RINGER_MODE_CHANGED_ACTION instead.

int VIBRATE_SETTING_OFF

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

int VIBRATE_SETTING_ON

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

int VIBRATE_SETTING_ONLY_SILENT

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

int VIBRATE_TYPE_NOTIFICATION

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

int VIBRATE_TYPE_RINGER

This constant was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Public methods

int abandonAudioFocus(AudioManager.OnAudioFocusChangeListener l)

Abandon audio focus.

void adjustStreamVolume(int streamType, int direction, int flags)

Adjusts the volume of a particular stream by one step in a direction.

void adjustSuggestedStreamVolume(int direction, int suggestedStreamType, int flags)

Adjusts the volume of the most relevant stream, or the given fallback stream.

void adjustVolume(int direction, int flags)

Adjusts the volume of the most relevant stream.

void dispatchMediaKeyEvent(KeyEvent keyEvent)

Sends a simulated key event for a media button.

int generateAudioSessionId()

Return a new audio session identifier not associated with any player or effect.

List<AudioRecordingConfiguration> getActiveRecordingConfigurations()

Returns the current active audio recording configurations of the device.

AudioDeviceInfo[] getDevices(int flags)

Returns an array of AudioDeviceInfo objects corresponding to the audio devices currently connected to the system and meeting the criteria specified in the flags parameter.

int getMode()

Returns the current audio mode.

String getParameters(String keys)

Gets a variable number of parameter values from audio hardware.

String getProperty(String key)

Returns the value of the property with the specified key.

int getRingerMode()

Returns the current ringtone mode.

int getRouting(int mode)

This method was deprecated in API level 4. Do not query audio routing directly, use isSpeakerphoneOn(), isBluetoothScoOn(), isBluetoothA2dpOn() and isWiredHeadsetOn() methods instead.

int getStreamMaxVolume(int streamType)

Returns the maximum volume index for a particular stream.

int getStreamVolume(int streamType)

Returns the current volume index for a particular stream.

int getVibrateSetting(int vibrateType)

This method was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

boolean isBluetoothA2dpOn()

Checks whether A2DP audio routing to the Bluetooth headset is on or off.

boolean isBluetoothScoAvailableOffCall()

Indicates if current platform supports use of SCO for off call use cases.

boolean isBluetoothScoOn()

Checks whether communications use Bluetooth SCO.

boolean isMicrophoneMute()

Checks whether the microphone mute is on or off.

boolean isMusicActive()

Checks whether any music is active.

boolean isSpeakerphoneOn()

Checks whether the speakerphone is on or off.

boolean isStreamMute(int streamType)

Returns the current mute state for a particular stream.

boolean isVolumeFixed()

Indicates if the device implements a fixed volume policy.

boolean isWiredHeadsetOn()

This method was deprecated in API level 14. Use only to check is a headset is connected or not.

void loadSoundEffects()

Load Sound effects.

void playSoundEffect(int effectType)

Plays a sound effect (Key clicks, lid open/close...)

void playSoundEffect(int effectType, float volume)

Plays a sound effect (Key clicks, lid open/close...)

void registerAudioDeviceCallback(AudioDeviceCallback callback, Handler handler)

Registers an AudioDeviceCallback object to receive notifications of changes to the set of connected audio devices.

void registerAudioRecordingCallback(AudioManager.AudioRecordingCallback cb, Handler handler)

Register a callback to be notified of audio recording changes through AudioManager.AudioRecordingCallback

void registerMediaButtonEventReceiver(ComponentName eventReceiver)

This method was deprecated in API level 21. Use setMediaButtonReceiver(PendingIntent) instead.

void registerMediaButtonEventReceiver(PendingIntent eventReceiver)

This method was deprecated in API level 21. Use setMediaButtonReceiver(PendingIntent) instead.

void registerRemoteControlClient(RemoteControlClient rcClient)

This method was deprecated in API level 21. Use MediaSession instead.

boolean registerRemoteController(RemoteController rctlr)

This method was deprecated in API level 21. Use addOnActiveSessionsChangedListener(android.media.session.MediaSessionManager.OnActiveSessionsChangedListener, ComponentName) and MediaController instead.

int requestAudioFocus(AudioManager.OnAudioFocusChangeListener l, int streamType, int durationHint)

Request audio focus.

void setBluetoothA2dpOn(boolean on)

This method was deprecated in API level 5. Do not use.

void setBluetoothScoOn(boolean on)

Request use of Bluetooth SCO headset for communications.

void setMicrophoneMute(boolean on)

Sets the microphone mute on or off.

void setMode(int mode)

Sets the audio mode.

void setParameters(String keyValuePairs)

Sets a variable number of parameter values to audio hardware.

void setRingerMode(int ringerMode)

Sets the ringer mode.

void setRouting(int mode, int routes, int mask)

This method was deprecated in API level 4. Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

void setSpeakerphoneOn(boolean on)

Sets the speakerphone on or off.

void setStreamMute(int streamType, boolean state)

This method was deprecated in API level 23. Use adjustStreamVolume(int, int, int) with ADJUST_MUTE or ADJUST_UNMUTE instead.

void setStreamSolo(int streamType, boolean state)

This method was deprecated in API level 23. Do not use. If you need exclusive audio playback use requestAudioFocus(AudioManager.OnAudioFocusChangeListener, int, int).

void setStreamVolume(int streamType, int index, int flags)

Sets the volume index for a particular stream.

void setVibrateSetting(int vibrateType, int vibrateSetting)

This method was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

void setWiredHeadsetOn(boolean on)

This method was deprecated in API level 5. Do not use.

boolean shouldVibrate(int vibrateType)

This method was deprecated in API level 16. Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

void startBluetoothSco()

Start bluetooth SCO audio connection.

void stopBluetoothSco()

Stop bluetooth SCO audio connection.

void unloadSoundEffects()

Unload Sound effects.

void unregisterAudioDeviceCallback(AudioDeviceCallback callback)

Unregisters an AudioDeviceCallback object which has been previously registered to receive notifications of changes to the set of connected audio devices.

void unregisterAudioRecordingCallback(AudioManager.AudioRecordingCallback cb)

Unregister an audio recording callback previously registered with registerAudioRecordingCallback(AudioRecordingCallback, Handler).

void unregisterMediaButtonEventReceiver(PendingIntent eventReceiver)

This method was deprecated in API level 21. Use MediaSession instead.

void unregisterMediaButtonEventReceiver(ComponentName eventReceiver)

This method was deprecated in API level 21. Use MediaSession instead.

void unregisterRemoteControlClient(RemoteControlClient rcClient)

This method was deprecated in API level 21. Use MediaSession instead.

void unregisterRemoteController(RemoteController rctlr)

This method was deprecated in API level 21. Use removeOnActiveSessionsChangedListener(android.media.session.MediaSessionManager.OnActiveSessionsChangedListener) instead.

Inherited methods

From class java.lang.Object

Constants

ACTION_AUDIO_BECOMING_NOISY

Added in API level 3
String ACTION_AUDIO_BECOMING_NOISY

Broadcast intent, a hint for applications that audio is about to become 'noisy' due to a change in audio outputs. For example, this intent may be sent when a wired headset is unplugged, or when an A2DP audio sink is disconnected, and the audio system is about to automatically switch audio route to the speaker. Applications that are controlling audio streams may consider pausing, reducing volume or some other action on receipt of this intent so as not to surprise the user with audio from the speaker.

Constant Value: "android.media.AUDIO_BECOMING_NOISY"

ACTION_HDMI_AUDIO_PLUG

Added in API level 21
String ACTION_HDMI_AUDIO_PLUG

Broadcast Action: A sticky broadcast indicating an HDMI cable was plugged or unplugged. The intent will have the following extra values: EXTRA_AUDIO_PLUG_STATE, EXTRA_MAX_CHANNEL_COUNT, EXTRA_ENCODINGS.

It can only be received by explicitly registering for it with registerReceiver(BroadcastReceiver, IntentFilter).

Constant Value: "android.media.action.HDMI_AUDIO_PLUG"

ACTION_HEADSET_PLUG

Added in API level 21
String ACTION_HEADSET_PLUG

Broadcast Action: Wired Headset plugged in or unplugged. You cannot receive this through components declared in manifests, only by explicitly registering for it with Context.registerReceiver().

The intent will have the following extra values:

  • state - 0 for unplugged, 1 for plugged.
  • name - Headset type, human readable string
  • microphone - 1 if headset has a microphone, 0 otherwise

Constant Value: "android.intent.action.HEADSET_PLUG"

ACTION_SCO_AUDIO_STATE_CHANGED

Added in API level 8
String ACTION_SCO_AUDIO_STATE_CHANGED

This constant was deprecated in API level 14.
Use ACTION_SCO_AUDIO_STATE_UPDATED instead

Sticky broadcast intent action indicating that the bluetoooth SCO audio connection state has changed. The intent contains on extra EXTRA_SCO_AUDIO_STATE indicating the new state which is either SCO_AUDIO_STATE_DISCONNECTED or SCO_AUDIO_STATE_CONNECTED

See also:

Constant Value: "android.media.SCO_AUDIO_STATE_CHANGED"

ACTION_SCO_AUDIO_STATE_UPDATED

Added in API level 14
String ACTION_SCO_AUDIO_STATE_UPDATED

Sticky broadcast intent action indicating that the bluetoooth SCO audio connection state has been updated.

This intent has two extras:

EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE can be any of:

See also:

Constant Value: "android.media.ACTION_SCO_AUDIO_STATE_UPDATED"

ADJUST_LOWER

Added in API level 1
int ADJUST_LOWER

Decrease the ringer volume.

See also:

Constant Value: -1 (0xffffffff)

ADJUST_MUTE

Added in API level 23
int ADJUST_MUTE

Mute the volume. Has no effect if the stream is already muted.

See also:

Constant Value: -100 (0xffffff9c)

ADJUST_RAISE

Added in API level 1
int ADJUST_RAISE

Increase the ringer volume.

See also:

Constant Value: 1 (0x00000001)

ADJUST_SAME

Added in API level 1
int ADJUST_SAME

Maintain the previous ringer volume. This may be useful when needing to show the volume toast without actually modifying the volume.

See also:

Constant Value: 0 (0x00000000)

ADJUST_TOGGLE_MUTE

Added in API level 23
int ADJUST_TOGGLE_MUTE

Toggle the mute state. If muted the stream will be unmuted. If not muted the stream will be muted.

See also:

Constant Value: 101 (0x00000065)

ADJUST_UNMUTE

Added in API level 23
int ADJUST_UNMUTE

Unmute the volume. Has no effect if the stream is not muted.

See also:

Constant Value: 100 (0x00000064)

AUDIOFOCUS_GAIN

Added in API level 8
int AUDIOFOCUS_GAIN

Used to indicate a gain of audio focus, or a request of audio focus, of unknown duration.

See also:

Constant Value: 1 (0x00000001)

AUDIOFOCUS_GAIN_TRANSIENT

Added in API level 8
int AUDIOFOCUS_GAIN_TRANSIENT

Used to indicate a temporary gain or request of audio focus, anticipated to last a short amount of time. Examples of temporary changes are the playback of driving directions, or an event notification.

See also:

Constant Value: 2 (0x00000002)

AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE

Added in API level 19
int AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE

Used to indicate a temporary request of audio focus, anticipated to last a short amount of time, during which no other applications, or system components, should play anything. Examples of exclusive and transient audio focus requests are voice memo recording and speech recognition, during which the system shouldn't play any notifications, and media playback should have paused.

See also:

Constant Value: 4 (0x00000004)

AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK

Added in API level 8
int AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK

Used to indicate a temporary request of audio focus, anticipated to last a short amount of time, and where it is acceptable for other audio applications to keep playing after having lowered their output level (also referred to as "ducking"). Examples of temporary changes are the playback of driving directions where playback of music in the background is acceptable.

See also:

Constant Value: 3 (0x00000003)

AUDIOFOCUS_LOSS

Added in API level 8
int AUDIOFOCUS_LOSS

Used to indicate a loss of audio focus of unknown duration.

See also:

Constant Value: -1 (0xffffffff)

AUDIOFOCUS_LOSS_TRANSIENT

Added in API level 8
int AUDIOFOCUS_LOSS_TRANSIENT

Used to indicate a transient loss of audio focus.

See also:

Constant Value: -2 (0xfffffffe)

AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK

Added in API level 8
int AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK

Used to indicate a transient loss of audio focus where the loser of the audio focus can lower its output volume if it wants to continue playing (also referred to as "ducking"), as the new focus owner doesn't require others to be silent.

See also:

Constant Value: -3 (0xfffffffd)

AUDIOFOCUS_REQUEST_FAILED

Added in API level 8
int AUDIOFOCUS_REQUEST_FAILED

A failed focus change request.

Constant Value: 0 (0x00000000)

AUDIOFOCUS_REQUEST_GRANTED

Added in API level 8
int AUDIOFOCUS_REQUEST_GRANTED

A successful focus change request.

Constant Value: 1 (0x00000001)

AUDIO_SESSION_ID_GENERATE

Added in API level 21
int AUDIO_SESSION_ID_GENERATE

A special audio session ID to indicate that the audio session ID isn't known and the framework should generate a new value. This can be used when building a new AudioTrack instance with AudioTrack(AudioAttributes, AudioFormat, int, int, int).

Constant Value: 0 (0x00000000)

ERROR

Added in API level 21
int ERROR

A default error code.

Constant Value: -1 (0xffffffff)

ERROR_DEAD_OBJECT

Added in API level 21
int ERROR_DEAD_OBJECT

An error code indicating that the object reporting it is no longer valid and needs to be recreated.

Constant Value: -6 (0xfffffffa)

EXTRA_AUDIO_PLUG_STATE

Added in API level 21
String EXTRA_AUDIO_PLUG_STATE

Extra used in ACTION_HDMI_AUDIO_PLUG to communicate whether HDMI is plugged in or unplugged. An integer value of 1 indicates a plugged-in state, 0 is unplugged.

Constant Value: "android.media.extra.AUDIO_PLUG_STATE"

EXTRA_ENCODINGS

Added in API level 21
String EXTRA_ENCODINGS

Extra used in ACTION_HDMI_AUDIO_PLUG to define the audio encodings supported by the connected HDMI device. The corresponding array of encoding values is only available when the device is plugged in (as expressed by EXTRA_AUDIO_PLUG_STATE). Encoding values are defined in AudioFormat (for instance see ENCODING_PCM_16BIT). Use getIntArrayExtra(String) to retrieve the encoding values.

Constant Value: "android.media.extra.ENCODINGS"

EXTRA_MAX_CHANNEL_COUNT

Added in API level 21
String EXTRA_MAX_CHANNEL_COUNT

Extra used in ACTION_HDMI_AUDIO_PLUG to define the maximum number of channels supported by the HDMI device. The corresponding integer value is only available when the device is plugged in (as expressed by EXTRA_AUDIO_PLUG_STATE).

Constant Value: "android.media.extra.MAX_CHANNEL_COUNT"

EXTRA_RINGER_MODE

Added in API level 1
String EXTRA_RINGER_MODE

The new ringer mode.

See also:

Constant Value: "android.media.EXTRA_RINGER_MODE"

EXTRA_SCO_AUDIO_PREVIOUS_STATE

Added in API level 14
String EXTRA_SCO_AUDIO_PREVIOUS_STATE

Extra for intent ACTION_SCO_AUDIO_STATE_UPDATED containing the previous bluetooth SCO connection state.

Constant Value: "android.media.extra.SCO_AUDIO_PREVIOUS_STATE"

EXTRA_SCO_AUDIO_STATE

Added in API level 8
String EXTRA_SCO_AUDIO_STATE

Extra for intent ACTION_SCO_AUDIO_STATE_CHANGED or ACTION_SCO_AUDIO_STATE_UPDATED containing the new bluetooth SCO connection state.

Constant Value: "android.media.extra.SCO_AUDIO_STATE"

EXTRA_VIBRATE_SETTING

Added in API level 1
String EXTRA_VIBRATE_SETTING

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode and listen to RINGER_MODE_CHANGED_ACTION instead.

The new vibrate setting for a particular type.

See also:

Constant Value: "android.media.EXTRA_VIBRATE_SETTING"

EXTRA_VIBRATE_TYPE

Added in API level 1
String EXTRA_VIBRATE_TYPE

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode and listen to RINGER_MODE_CHANGED_ACTION instead.

The vibrate type whose setting has changed.

See also:

Constant Value: "android.media.EXTRA_VIBRATE_TYPE"

FLAG_ALLOW_RINGER_MODES

Added in API level 1
int FLAG_ALLOW_RINGER_MODES

Whether to include ringer modes as possible options when changing volume. For example, if true and volume level is 0 and the volume is adjusted with ADJUST_LOWER, then the ringer mode may switch the silent or vibrate mode.

By default this is on for the ring stream. If this flag is included, this behavior will be present regardless of the stream type being affected by the ringer mode.

See also:

Constant Value: 2 (0x00000002)

FLAG_PLAY_SOUND

Added in API level 1
int FLAG_PLAY_SOUND

Whether to play a sound when changing the volume.

If this is given to adjustVolume(int, int) or adjustSuggestedStreamVolume(int, int, int), it may be ignored in some cases (for example, the decided stream type is not STREAM_RING, or the volume is being adjusted downward).

See also:

Constant Value: 4 (0x00000004)

FLAG_REMOVE_SOUND_AND_VIBRATE

Added in API level 1
int FLAG_REMOVE_SOUND_AND_VIBRATE

Removes any sounds/vibrate that may be in the queue, or are playing (related to changing volume).

Constant Value: 8 (0x00000008)

FLAG_SHOW_UI

Added in API level 1
int FLAG_SHOW_UI

Show a toast containing the current volume.

See also:

Constant Value: 1 (0x00000001)

FLAG_VIBRATE

Added in API level 1
int FLAG_VIBRATE

Whether to vibrate if going into the vibrate ringer mode.

Constant Value: 16 (0x00000010)

FX_FOCUS_NAVIGATION_DOWN

Added in API level 1
int FX_FOCUS_NAVIGATION_DOWN

Focus has moved down

See also:

Constant Value: 2 (0x00000002)

FX_FOCUS_NAVIGATION_LEFT

Added in API level 1
int FX_FOCUS_NAVIGATION_LEFT

Focus has moved left

See also:

Constant Value: 3 (0x00000003)

FX_FOCUS_NAVIGATION_RIGHT

Added in API level 1
int FX_FOCUS_NAVIGATION_RIGHT

Focus has moved right

See also:

Constant Value: 4 (0x00000004)

FX_FOCUS_NAVIGATION_UP

Added in API level 1
int FX_FOCUS_NAVIGATION_UP

Focus has moved up

See also:

Constant Value: 1 (0x00000001)

FX_KEYPRESS_DELETE

Added in API level 3
int FX_KEYPRESS_DELETE

IME delete keypress sound

See also:

Constant Value: 7 (0x00000007)

FX_KEYPRESS_INVALID

Added in API level 19
int FX_KEYPRESS_INVALID

Invalid keypress sound

See also:

Constant Value: 9 (0x00000009)

FX_KEYPRESS_RETURN

Added in API level 3
int FX_KEYPRESS_RETURN

IME return_keypress sound

See also:

Constant Value: 8 (0x00000008)

FX_KEYPRESS_SPACEBAR

Added in API level 3
int FX_KEYPRESS_SPACEBAR

IME spacebar keypress sound

See also:

Constant Value: 6 (0x00000006)

FX_KEYPRESS_STANDARD

Added in API level 3
int FX_KEYPRESS_STANDARD

IME standard keypress sound

See also:

Constant Value: 5 (0x00000005)

FX_KEY_CLICK

Added in API level 1
int FX_KEY_CLICK

Keyboard and direction pad click sound

See also:

Constant Value: 0 (0x00000000)

GET_DEVICES_ALL

Added in API level 23
int GET_DEVICES_ALL

Specifies to the getDevices(int) method to include both source and sink devices.

Constant Value: 3 (0x00000003)

GET_DEVICES_INPUTS

Added in API level 23
int GET_DEVICES_INPUTS

Specifies to the getDevices(int) method to include source (i.e. input) audio devices.

Constant Value: 1 (0x00000001)

GET_DEVICES_OUTPUTS

Added in API level 23
int GET_DEVICES_OUTPUTS

Specifies to the getDevices(int) method to include sink (i.e. output) audio devices.

Constant Value: 2 (0x00000002)

MODE_CURRENT

Added in API level 1
int MODE_CURRENT

Current audio mode. Used to apply audio routing to current mode.

Constant Value: -1 (0xffffffff)

MODE_INVALID

Added in API level 1
int MODE_INVALID

Invalid audio mode.

Constant Value: -2 (0xfffffffe)

MODE_IN_CALL

Added in API level 1
int MODE_IN_CALL

In call audio mode. A telephony call is established.

Constant Value: 2 (0x00000002)

MODE_IN_COMMUNICATION

Added in API level 11
int MODE_IN_COMMUNICATION

In communication audio mode. An audio/video chat or VoIP call is established.

Constant Value: 3 (0x00000003)

MODE_NORMAL

Added in API level 1
int MODE_NORMAL

Normal audio mode: not ringing and no call established.

Constant Value: 0 (0x00000000)

MODE_RINGTONE

Added in API level 1
int MODE_RINGTONE

Ringing audio mode. An incoming is being signaled.

Constant Value: 1 (0x00000001)

NUM_STREAMS

Added in API level 1
int NUM_STREAMS

This constant was deprecated in API level 3.
Use AudioSystem.getNumStreamTypes() instead

Constant Value: 5 (0x00000005)

PROPERTY_OUTPUT_FRAMES_PER_BUFFER

Added in API level 17
String PROPERTY_OUTPUT_FRAMES_PER_BUFFER

Used as a key for getProperty(String) to request the native or optimal output buffer size for this device's primary output stream, in decimal PCM frames.

Constant Value: "android.media.property.OUTPUT_FRAMES_PER_BUFFER"

PROPERTY_OUTPUT_SAMPLE_RATE

Added in API level 17
String PROPERTY_OUTPUT_SAMPLE_RATE

Used as a key for getProperty(String) to request the native or optimal output sample rate for this device's primary output stream, in decimal Hz.

Constant Value: "android.media.property.OUTPUT_SAMPLE_RATE"

PROPERTY_SUPPORT_AUDIO_SOURCE_UNPROCESSED

Added in API level 24
String PROPERTY_SUPPORT_AUDIO_SOURCE_UNPROCESSED

Used as a key for getProperty(String) to determine if the unprocessed audio source is available and supported with the expected frequency range and level response.

Constant Value: "android.media.property.SUPPORT_AUDIO_SOURCE_UNPROCESSED"

PROPERTY_SUPPORT_MIC_NEAR_ULTRASOUND

Added in API level 23
String PROPERTY_SUPPORT_MIC_NEAR_ULTRASOUND

Used as a key for getProperty(String) to determine if the default microphone audio source supports near-ultrasound frequencies (range of 18 - 21 kHz).

Constant Value: "android.media.property.SUPPORT_MIC_NEAR_ULTRASOUND"

PROPERTY_SUPPORT_SPEAKER_NEAR_ULTRASOUND

Added in API level 23
String PROPERTY_SUPPORT_SPEAKER_NEAR_ULTRASOUND

Used as a key for getProperty(String) to determine if the default speaker audio path supports near-ultrasound frequencies (range of 18 - 21 kHz).

Constant Value: "android.media.property.SUPPORT_SPEAKER_NEAR_ULTRASOUND"

RINGER_MODE_CHANGED_ACTION

Added in API level 1
String RINGER_MODE_CHANGED_ACTION

Sticky broadcast intent action indicating that the ringer mode has changed. Includes the new ringer mode.

See also:

Constant Value: "android.media.RINGER_MODE_CHANGED"

RINGER_MODE_NORMAL

Added in API level 1
int RINGER_MODE_NORMAL

Ringer mode that may be audible and may vibrate. It will be audible if the volume before changing out of this mode was audible. It will vibrate if the vibrate setting is on.

See also:

Constant Value: 2 (0x00000002)

RINGER_MODE_SILENT

Added in API level 1
int RINGER_MODE_SILENT

Ringer mode that will be silent and will not vibrate. (This overrides the vibrate setting.)

See also:

Constant Value: 0 (0x00000000)

RINGER_MODE_VIBRATE

Added in API level 1
int RINGER_MODE_VIBRATE

Ringer mode that will be silent and will vibrate. (This will cause the phone ringer to always vibrate, but the notification vibrate to only vibrate if set.)

See also:

Constant Value: 1 (0x00000001)

ROUTE_ALL

Added in API level 1
int ROUTE_ALL

This constant was deprecated in API level 5.
Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Used for mask parameter of setRouting(int, int, int).

Constant Value: -1 (0xffffffff)

ROUTE_BLUETOOTH

Added in API level 1
int ROUTE_BLUETOOTH

This constant was deprecated in API level 3.
use ROUTE_BLUETOOTH_SCODo not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Constant Value: 4 (0x00000004)

ROUTE_BLUETOOTH_A2DP

Added in API level 3
int ROUTE_BLUETOOTH_A2DP

This constant was deprecated in API level 5.
Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to bluetooth A2DP

Constant Value: 16 (0x00000010)

ROUTE_BLUETOOTH_SCO

Added in API level 3
int ROUTE_BLUETOOTH_SCO

This constant was deprecated in API level 5.
Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to bluetooth SCO

Constant Value: 4 (0x00000004)

ROUTE_EARPIECE

Added in API level 1
int ROUTE_EARPIECE

This constant was deprecated in API level 5.
Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to earpiece

Constant Value: 1 (0x00000001)

ROUTE_HEADSET

Added in API level 1
int ROUTE_HEADSET

This constant was deprecated in API level 5.
Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to headset

Constant Value: 8 (0x00000008)

ROUTE_SPEAKER

Added in API level 1
int ROUTE_SPEAKER

This constant was deprecated in API level 5.
Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to speaker

Constant Value: 2 (0x00000002)

SCO_AUDIO_STATE_CONNECTED

Added in API level 8
int SCO_AUDIO_STATE_CONNECTED

Value for extra EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE indicating that the SCO audio channel is established

Constant Value: 1 (0x00000001)

SCO_AUDIO_STATE_CONNECTING

Added in API level 14
int SCO_AUDIO_STATE_CONNECTING

Value for extra EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE indicating that the SCO audio channel is being established

Constant Value: 2 (0x00000002)

SCO_AUDIO_STATE_DISCONNECTED

Added in API level 8
int SCO_AUDIO_STATE_DISCONNECTED

Value for extra EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE indicating that the SCO audio channel is not established

Constant Value: 0 (0x00000000)

SCO_AUDIO_STATE_ERROR

Added in API level 8
int SCO_AUDIO_STATE_ERROR

Value for extra EXTRA_SCO_AUDIO_STATE indicating that there was an error trying to obtain the state

Constant Value: -1 (0xffffffff)

STREAM_ALARM

Added in API level 1
int STREAM_ALARM

The audio stream for alarms

Constant Value: 4 (0x00000004)

STREAM_DTMF

Added in API level 5
int STREAM_DTMF

The audio stream for DTMF Tones

Constant Value: 8 (0x00000008)

STREAM_MUSIC

Added in API level 1
int STREAM_MUSIC

The audio stream for music playback

Constant Value: 3 (0x00000003)

STREAM_NOTIFICATION

Added in API level 3
int STREAM_NOTIFICATION

The audio stream for notifications

Constant Value: 5 (0x00000005)

STREAM_RING

Added in API level 1
int STREAM_RING

The audio stream for the phone ring

Constant Value: 2 (0x00000002)

STREAM_SYSTEM

Added in API level 1
int STREAM_SYSTEM

The audio stream for system sounds

Constant Value: 1 (0x00000001)

STREAM_VOICE_CALL

Added in API level 1
int STREAM_VOICE_CALL

The audio stream for phone calls

Constant Value: 0 (0x00000000)

USE_DEFAULT_STREAM_TYPE

Added in API level 1
int USE_DEFAULT_STREAM_TYPE

Suggests using the default stream type. This may not be used in all places a stream type is needed.

Constant Value: -2147483648 (0x80000000)

VIBRATE_SETTING_CHANGED_ACTION

Added in API level 1
String VIBRATE_SETTING_CHANGED_ACTION

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode and listen to RINGER_MODE_CHANGED_ACTION instead.

Broadcast intent action indicating that the vibrate setting has changed. Includes the vibrate type and its new setting.

See also:

Constant Value: "android.media.VIBRATE_SETTING_CHANGED"

VIBRATE_SETTING_OFF

Added in API level 1
int VIBRATE_SETTING_OFF

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Vibrate setting that suggests to never vibrate.

See also:

Constant Value: 0 (0x00000000)

VIBRATE_SETTING_ON

Added in API level 1
int VIBRATE_SETTING_ON

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Vibrate setting that suggests to vibrate when possible.

See also:

Constant Value: 1 (0x00000001)

VIBRATE_SETTING_ONLY_SILENT

Added in API level 1
int VIBRATE_SETTING_ONLY_SILENT

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Vibrate setting that suggests to only vibrate when in the vibrate ringer mode.

See also:

Constant Value: 2 (0x00000002)

VIBRATE_TYPE_NOTIFICATION

Added in API level 1
int VIBRATE_TYPE_NOTIFICATION

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Vibrate type that corresponds to notifications.

See also:

Constant Value: 1 (0x00000001)

VIBRATE_TYPE_RINGER

Added in API level 1
int VIBRATE_TYPE_RINGER

This constant was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Vibrate type that corresponds to the ringer.

See also:

Constant Value: 0 (0x00000000)

Public methods

abandonAudioFocus

Added in API level 8
int abandonAudioFocus (AudioManager.OnAudioFocusChangeListener l)

Abandon audio focus. Causes the previous focus owner, if any, to receive focus.

Parameters
l AudioManager.OnAudioFocusChangeListener: the listener with which focus was requested.
Returns
int AUDIOFOCUS_REQUEST_FAILED or AUDIOFOCUS_REQUEST_GRANTED

adjustStreamVolume

Added in API level 1
void adjustStreamVolume (int streamType, 
                int direction, 
                int flags)

Adjusts the volume of a particular stream by one step in a direction.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

Parameters
streamType int: The stream type to adjust. One of STREAM_VOICE_CALL, STREAM_SYSTEM, STREAM_RING, STREAM_MUSIC or STREAM_ALARM
direction int: The direction to adjust the volume. One of ADJUST_LOWER, ADJUST_RAISE, or ADJUST_SAME.
flags int: One or more flags.

See also:

adjustSuggestedStreamVolume

Added in API level 1
void adjustSuggestedStreamVolume (int direction, 
                int suggestedStreamType, 
                int flags)

Adjusts the volume of the most relevant stream, or the given fallback stream.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

This method has no effect if the device implements a fixed volume policy as indicated by isVolumeFixed().

Parameters
direction int: The direction to adjust the volume. One of ADJUST_LOWER, ADJUST_RAISE, ADJUST_SAME, ADJUST_MUTE, ADJUST_UNMUTE, or ADJUST_TOGGLE_MUTE.
suggestedStreamType int: The stream type that will be used if there isn't a relevant stream. USE_DEFAULT_STREAM_TYPE is valid here.
flags int: One or more flags.

See also:

adjustVolume

Added in API level 1
void adjustVolume (int direction, 
                int flags)

Adjusts the volume of the most relevant stream. For example, if a call is active, it will have the highest priority regardless of if the in-call screen is showing. Another example, if music is playing in the background and a call is not active, the music stream will be adjusted.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

This method has no effect if the device implements a fixed volume policy as indicated by isVolumeFixed().

Parameters
direction int: The direction to adjust the volume. One of ADJUST_LOWER, ADJUST_RAISE, ADJUST_SAME, ADJUST_MUTE, ADJUST_UNMUTE, or ADJUST_TOGGLE_MUTE.
flags int: One or more flags.

See also:

dispatchMediaKeyEvent

Added in API level 19
void dispatchMediaKeyEvent (KeyEvent keyEvent)

Sends a simulated key event for a media button. To simulate a key press, you must first send a KeyEvent built with a ACTION_DOWN action, then another event with the ACTION_UP action.

The key event will be sent to the current media key event consumer which registered with registerMediaButtonEventReceiver(PendingIntent).

Parameters
keyEvent KeyEvent: a KeyEvent instance whose key code is one of KEYCODE_MUTE, KEYCODE_HEADSETHOOK, KEYCODE_MEDIA_PLAY, KEYCODE_MEDIA_PAUSE, KEYCODE_MEDIA_PLAY_PAUSE, KEYCODE_MEDIA_STOP, KEYCODE_MEDIA_NEXT, KEYCODE_MEDIA_PREVIOUS, KEYCODE_MEDIA_REWIND, KEYCODE_MEDIA_RECORD, KEYCODE_MEDIA_FAST_FORWARD, KEYCODE_MEDIA_CLOSE, KEYCODE_MEDIA_EJECT, or KEYCODE_MEDIA_AUDIO_TRACK.

generateAudioSessionId

Added in API level 21
int generateAudioSessionId ()

Return a new audio session identifier not associated with any player or effect. An audio session identifier is a system wide unique identifier for a set of audio streams (one or more mixed together).

The primary use of the audio session ID is to associate audio effects to audio players, such as MediaPlayer or AudioTrack: all audio effects sharing the same audio session ID will be applied to the mixed audio content of the players that share the same audio session.

This method can for instance be used when creating one of the AudioEffect objects to define the audio session of the effect, or to specify a session for a speech synthesis utterance in TextToSpeech.Engine.

Returns
int a new unclaimed and unused audio session identifier, or ERROR when the system failed to generate a new session, a condition in which audio playback or recording will subsequently fail as well.

getActiveRecordingConfigurations

Added in API level 24
List<AudioRecordingConfiguration> getActiveRecordingConfigurations ()

Returns the current active audio recording configurations of the device.

Returns
List<AudioRecordingConfiguration> a non-null list of recording configurations. An empty list indicates there is no recording active when queried.

See also:

getDevices

Added in API level 23
AudioDeviceInfo[] getDevices (int flags)

Returns an array of AudioDeviceInfo objects corresponding to the audio devices currently connected to the system and meeting the criteria specified in the flags parameter.

Parameters
flags int: A set of bitflags specifying the criteria to test.
Returns
AudioDeviceInfo[] A (possibly zero-length) array of AudioDeviceInfo objects.

See also:

getMode

Added in API level 1
int getMode ()

Returns the current audio mode.

Returns
int the current audio mode (MODE_NORMAL, MODE_RINGTONE, MODE_IN_CALL or MODE_IN_COMMUNICATION). Returns the current current audio state from the HAL.

getParameters

Added in API level 5
String getParameters (String keys)

Gets a variable number of parameter values from audio hardware.

Parameters
keys String: list of parameters
Returns
String list of parameters key value pairs in the form: key1=value1;key2=value2;...

getProperty

Added in API level 17
String getProperty (String key)

Returns the value of the property with the specified key.

Parameters
key String: One of the strings corresponding to a property key: either PROPERTY_OUTPUT_SAMPLE_RATE, PROPERTY_OUTPUT_FRAMES_PER_BUFFER, PROPERTY_SUPPORT_MIC_NEAR_ULTRASOUND, PROPERTY_SUPPORT_SPEAKER_NEAR_ULTRASOUND, or PROPERTY_SUPPORT_AUDIO_SOURCE_UNPROCESSED.
Returns
String A string representing the associated value for that property key, or null if there is no value for that key.

getRingerMode

Added in API level 1
int getRingerMode ()

Returns the current ringtone mode.

Returns
int The current ringtone mode, one of RINGER_MODE_NORMAL, RINGER_MODE_SILENT, or RINGER_MODE_VIBRATE.

See also:

getRouting

Added in API level 1
int getRouting (int mode)

This method was deprecated in API level 4.
Do not query audio routing directly, use isSpeakerphoneOn(), isBluetoothScoOn(), isBluetoothA2dpOn() and isWiredHeadsetOn() methods instead.

Returns the current audio routing bit vector for a specified mode.

Parameters
mode int: audio mode to get route (e.g., MODE_RINGTONE)
Returns
int an audio route bit vector that can be compared with ROUTE_xxx bits

getStreamMaxVolume

Added in API level 1
int getStreamMaxVolume (int streamType)

Returns the maximum volume index for a particular stream.

Parameters
streamType int: The stream type whose maximum volume index is returned.
Returns
int The maximum valid volume index for the stream.

See also:

getStreamVolume

Added in API level 1
int getStreamVolume (int streamType)

Returns the current volume index for a particular stream.

Parameters
streamType int: The stream type whose volume index is returned.
Returns
int The current volume index for the stream.

See also:

getVibrateSetting

Added in API level 1
int getVibrateSetting (int vibrateType)

This method was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Returns whether the user's vibrate setting for a vibrate type.

This shouldn't be needed by most clients that want to vibrate, instead see shouldVibrate(int).

Parameters
vibrateType int: The type of vibrate. One of VIBRATE_TYPE_NOTIFICATION or VIBRATE_TYPE_RINGER.
Returns
int The vibrate setting, one of VIBRATE_SETTING_ON, VIBRATE_SETTING_OFF, or VIBRATE_SETTING_ONLY_SILENT.

See also:

isBluetoothA2dpOn

Added in API level 3
boolean isBluetoothA2dpOn ()

Checks whether A2DP audio routing to the Bluetooth headset is on or off.

Returns
boolean true if A2DP audio is being routed to/from Bluetooth headset; false if otherwise

isBluetoothScoAvailableOffCall

Added in API level 8
boolean isBluetoothScoAvailableOffCall ()

Indicates if current platform supports use of SCO for off call use cases. Application wanted to use bluetooth SCO audio when the phone is not in call must first call this method to make sure that the platform supports this feature.

Returns
boolean true if bluetooth SCO can be used for audio when not in call false otherwise

See also:

isBluetoothScoOn

Added in API level 1
boolean isBluetoothScoOn ()

Checks whether communications use Bluetooth SCO.

Returns
boolean true if SCO is used for communications; false if otherwise

isMicrophoneMute

Added in API level 1
boolean isMicrophoneMute ()

Checks whether the microphone mute is on or off.

Returns
boolean true if microphone is muted, false if it's not

isMusicActive

Added in API level 1
boolean isMusicActive ()

Checks whether any music is active.

Returns
boolean true if any music tracks are active.

isSpeakerphoneOn

Added in API level 1
boolean isSpeakerphoneOn ()

Checks whether the speakerphone is on or off.

Returns
boolean true if speakerphone is on, false if it's off

isStreamMute

Added in API level 23
boolean isStreamMute (int streamType)

Returns the current mute state for a particular stream.

Parameters
streamType int: The stream to get mute state for.
Returns
boolean The mute state for the given stream.

See also:

isVolumeFixed

Added in API level 21
boolean isVolumeFixed ()

Indicates if the device implements a fixed volume policy.

Some devices may not have volume control and may operate at a fixed volume, and may not enable muting or changing the volume of audio streams. This method will return true on such devices.

The following APIs have no effect when volume is fixed:

Returns
boolean

isWiredHeadsetOn

Added in API level 5
boolean isWiredHeadsetOn ()

This method was deprecated in API level 14.
Use only to check is a headset is connected or not.

Checks whether a wired headset is connected or not.

This is not a valid indication that audio playback is actually over the wired headset as audio routing depends on other conditions.

Returns
boolean true if a wired headset is connected. false if otherwise

loadSoundEffects

Added in API level 1
void loadSoundEffects ()

Load Sound effects. This method must be called when sound effects are enabled.

playSoundEffect

Added in API level 1
void playSoundEffect (int effectType)

Plays a sound effect (Key clicks, lid open/close...)

Parameters
effectType int: The type of sound effect. One of FX_KEY_CLICK, FX_FOCUS_NAVIGATION_UP, FX_FOCUS_NAVIGATION_DOWN, FX_FOCUS_NAVIGATION_LEFT, FX_FOCUS_NAVIGATION_RIGHT, FX_KEYPRESS_STANDARD, FX_KEYPRESS_SPACEBAR, FX_KEYPRESS_DELETE, FX_KEYPRESS_RETURN, FX_KEYPRESS_INVALID, NOTE: This version uses the UI settings to determine whether sounds are heard or not.

playSoundEffect

Added in API level 3
void playSoundEffect (int effectType, 
                float volume)

Plays a sound effect (Key clicks, lid open/close...)

Parameters
effectType int: The type of sound effect. One of FX_KEY_CLICK, FX_FOCUS_NAVIGATION_UP, FX_FOCUS_NAVIGATION_DOWN, FX_FOCUS_NAVIGATION_LEFT, FX_FOCUS_NAVIGATION_RIGHT, FX_KEYPRESS_STANDARD, FX_KEYPRESS_SPACEBAR, FX_KEYPRESS_DELETE, FX_KEYPRESS_RETURN, FX_KEYPRESS_INVALID,
volume float: Sound effect volume. The volume value is a raw scalar so UI controls should be scaled logarithmically. If a volume of -1 is specified, the AudioManager.STREAM_MUSIC stream volume minus 3dB will be used. NOTE: This version is for applications that have their own settings panel for enabling and controlling volume.

registerAudioDeviceCallback

Added in API level 23
void registerAudioDeviceCallback (AudioDeviceCallback callback, 
                Handler handler)

Registers an AudioDeviceCallback object to receive notifications of changes to the set of connected audio devices.

Parameters
callback AudioDeviceCallback: The AudioDeviceCallback object to receive connect/disconnect notifications.
handler Handler: Specifies the Handler object for the thread on which to execute the callback. If null, the Handler associated with the main Looper will be used.

registerAudioRecordingCallback

Added in API level 24
void registerAudioRecordingCallback (AudioManager.AudioRecordingCallback cb, 
                Handler handler)

Register a callback to be notified of audio recording changes through AudioManager.AudioRecordingCallback

Parameters
cb AudioManager.AudioRecordingCallback: non-null callback to register
handler Handler: the Handler object for the thread on which to execute the callback. If null, the Handler associated with the main Looper will be used.

registerMediaButtonEventReceiver

Added in API level 8
void registerMediaButtonEventReceiver (ComponentName eventReceiver)

This method was deprecated in API level 21.
Use setMediaButtonReceiver(PendingIntent) instead.

Register a component to be the sole receiver of MEDIA_BUTTON intents.

Parameters
eventReceiver ComponentName: identifier of a BroadcastReceiver that will receive the media button intent. This broadcast receiver must be declared in the application manifest. The package of the component must match that of the context you're registering from.

registerMediaButtonEventReceiver

Added in API level 18
void registerMediaButtonEventReceiver (PendingIntent eventReceiver)

This method was deprecated in API level 21.
Use setMediaButtonReceiver(PendingIntent) instead.

Register a component to be the sole receiver of MEDIA_BUTTON intents. This is like registerMediaButtonEventReceiver(android.content.ComponentName), but allows the buttons to go to any PendingIntent. Note that you should only use this form if you know you will continue running for the full time until unregistering the PendingIntent.

Parameters
eventReceiver PendingIntent: target that will receive media button intents. The PendingIntent will be sent an ACTION_MEDIA_BUTTON event when a media button action occurs, with EXTRA_KEY_EVENT added and holding the key code of the media button that was pressed.

registerRemoteControlClient

Added in API level 14
void registerRemoteControlClient (RemoteControlClient rcClient)

This method was deprecated in API level 21.
Use MediaSession instead.

Registers the remote control client for providing information to display on the remote controls.

Parameters
rcClient RemoteControlClient: The remote control client from which remote controls will receive information to display.

See also:

registerRemoteController

Added in API level 19
boolean registerRemoteController (RemoteController rctlr)

This method was deprecated in API level 21.
Use addOnActiveSessionsChangedListener(android.media.session.MediaSessionManager.OnActiveSessionsChangedListener, ComponentName) and MediaController instead.

Registers a RemoteController instance for it to receive media metadata updates and playback state information from applications using RemoteControlClient, and control their playback.

Registration requires the RemoteController.OnClientUpdateListener listener to be one of the enabled notification listeners (see NotificationListenerService).

Parameters
rctlr RemoteController: the object to register.
Returns
boolean true if the RemoteController was successfully registered, false if an error occurred, due to an internal system error, or insufficient permissions.

requestAudioFocus

Added in API level 8
int requestAudioFocus (AudioManager.OnAudioFocusChangeListener l, 
                int streamType, 
                int durationHint)

Request audio focus. Send a request to obtain the audio focus

Parameters
l AudioManager.OnAudioFocusChangeListener: the listener to be notified of audio focus changes
streamType int: the main audio stream type affected by the focus request
durationHint int: use AUDIOFOCUS_GAIN_TRANSIENT to indicate this focus request is temporary, and focus will be abandonned shortly. Examples of transient requests are for the playback of driving directions, or notifications sounds. Use AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK to indicate also that it's ok for the previous focus owner to keep playing if it ducks its audio output. Alternatively use AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE for a temporary request that benefits from the system not playing disruptive sounds like notifications, for usecases such as voice memo recording, or speech recognition. Use AUDIOFOCUS_GAIN for a focus request of unknown duration such as the playback of a song or a video.
Returns
int AUDIOFOCUS_REQUEST_FAILED or AUDIOFOCUS_REQUEST_GRANTED

setBluetoothA2dpOn

Added in API level 3
void setBluetoothA2dpOn (boolean on)

This method was deprecated in API level 5.
Do not use.

Parameters
on boolean: set true to route A2DP audio to/from Bluetooth headset; false disable A2DP audio

setBluetoothScoOn

Added in API level 1
void setBluetoothScoOn (boolean on)

Request use of Bluetooth SCO headset for communications.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

Parameters
on boolean: set true to use bluetooth SCO for communications; false to not use bluetooth SCO for communications

setMicrophoneMute

Added in API level 1
void setMicrophoneMute (boolean on)

Sets the microphone mute on or off.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

Parameters
on boolean: set true to mute the microphone; false to turn mute off

setMode

Added in API level 1
void setMode (int mode)

Sets the audio mode.

The audio mode encompasses audio routing AND the behavior of the telephony layer. Therefore this method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application. In particular, the MODE_IN_CALL mode should only be used by the telephony application when it places a phone call, as it will cause signals from the radio layer to feed the platform mixer.

Parameters
mode int: the requested audio mode (MODE_NORMAL, MODE_RINGTONE, MODE_IN_CALL or MODE_IN_COMMUNICATION). Informs the HAL about the current audio state so that it can route the audio appropriately.

setParameters

Added in API level 5
void setParameters (String keyValuePairs)

Sets a variable number of parameter values to audio hardware.

Parameters
keyValuePairs String: list of parameters key value pairs in the form: key1=value1;key2=value2;...

setRingerMode

Added in API level 1
void setRingerMode (int ringerMode)

Sets the ringer mode.

Silent mode will mute the volume and will not vibrate. Vibrate mode will mute the volume and vibrate. Normal mode will be audible and may vibrate according to user settings.

This method has no effect if the device implements a fixed volume policy as indicated by isVolumeFixed(). *

From N onward, ringer mode adjustments that would toggle Do Not Disturb are not allowed unless the app has been granted Do Not Disturb Access. See isNotificationPolicyAccessGranted().

Parameters
ringerMode int: The ringer mode, one of RINGER_MODE_NORMAL, RINGER_MODE_SILENT, or RINGER_MODE_VIBRATE.

See also:

setRouting

Added in API level 1
void setRouting (int mode, 
                int routes, 
                int mask)

This method was deprecated in API level 4.
Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Sets the audio routing for a specified mode

Parameters
mode int: audio mode to change route. E.g., MODE_RINGTONE.
routes int: bit vector of routes requested, created from one or more of ROUTE_xxx types. Set bits indicate that route should be on
mask int: bit vector of routes to change, created from one or more of ROUTE_xxx types. Unset bits indicate the route should be left unchanged

setSpeakerphoneOn

Added in API level 1
void setSpeakerphoneOn (boolean on)

Sets the speakerphone on or off.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

Parameters
on boolean: set true to turn on speakerphone; false to turn it off

setStreamMute

Added in API level 1
void setStreamMute (int streamType, 
                boolean state)

This method was deprecated in API level 23.
Use adjustStreamVolume(int, int, int) with ADJUST_MUTE or ADJUST_UNMUTE instead.

Mute or unmute an audio stream.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

This method has no effect if the device implements a fixed volume policy as indicated by isVolumeFixed().

This method was deprecated in API level 22. Prior to API level 22 this method had significantly different behavior and should be used carefully. The following applies only to pre-22 platforms:

  • The mute command is protected against client process death: if a process with an active mute request on a stream dies, this stream will be unmuted automatically.
  • The mute requests for a given stream are cumulative: the AudioManager can receive several mute requests from one or more clients and the stream will be unmuted only when the same number of unmute requests are received.
  • For a better user experience, applications MUST unmute a muted stream in onPause() and mute is again in onResume() if appropriate.

Parameters
streamType int: The stream to be muted/unmuted.
state boolean: The required mute state: true for mute ON, false for mute OFF

See also:

setStreamSolo

Added in API level 1
void setStreamSolo (int streamType, 
                boolean state)

This method was deprecated in API level 23.
Do not use. If you need exclusive audio playback use requestAudioFocus(AudioManager.OnAudioFocusChangeListener, int, int).

Solo or unsolo a particular stream.

Do not use. This method has been deprecated and is now a no-op. requestAudioFocus(AudioManager.OnAudioFocusChangeListener, int, int) should be used for exclusive audio playback.

Parameters
streamType int: The stream to be soloed/unsoloed.
state boolean: The required solo state: true for solo ON, false for solo OFF

See also:

setStreamVolume

Added in API level 1
void setStreamVolume (int streamType, 
                int index, 
                int flags)

Sets the volume index for a particular stream.

This method has no effect if the device implements a fixed volume policy as indicated by isVolumeFixed().

From N onward, volume adjustments that would toggle Do Not Disturb are not allowed unless the app has been granted Do Not Disturb Access. See isNotificationPolicyAccessGranted().

Parameters
streamType int: The stream whose volume index should be set.
index int: The volume index to set. See getStreamMaxVolume(int) for the largest valid value.
flags int: One or more flags.

See also:

setVibrateSetting

Added in API level 1
void setVibrateSetting (int vibrateType, 
                int vibrateSetting)

This method was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Sets the setting for when the vibrate type should vibrate.

This method should only be used by applications that replace the platform-wide management of audio settings or the main telephony application.

Parameters
vibrateType int: The type of vibrate. One of VIBRATE_TYPE_NOTIFICATION or VIBRATE_TYPE_RINGER.
vibrateSetting int: The vibrate setting, one of VIBRATE_SETTING_ON, VIBRATE_SETTING_OFF, or VIBRATE_SETTING_ONLY_SILENT.

See also:

setWiredHeadsetOn

Added in API level 5
void setWiredHeadsetOn (boolean on)

This method was deprecated in API level 5.
Do not use.

Sets audio routing to the wired headset on or off.

Parameters
on boolean: set true to route audio to/from wired headset; false disable wired headset audio

shouldVibrate

Added in API level 1
boolean shouldVibrate (int vibrateType)

This method was deprecated in API level 16.
Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Returns whether a particular type should vibrate according to user settings and the current ringer mode.

This shouldn't be needed by most clients that use notifications to vibrate. The notification manager will not vibrate if the policy doesn't allow it, so the client should always set a vibrate pattern and let the notification manager control whether or not to actually vibrate.

Parameters
vibrateType int: The type of vibrate. One of VIBRATE_TYPE_NOTIFICATION or VIBRATE_TYPE_RINGER.
Returns
boolean Whether the type should vibrate at the instant this method is called.

See also:

startBluetoothSco

Added in API level 8
void startBluetoothSco ()

Start bluetooth SCO audio connection.

Requires Permission: MODIFY_AUDIO_SETTINGS.

This method can be used by applications wanting to send and received audio to/from a bluetooth SCO headset while the phone is not in call.

As the SCO connection establishment can take several seconds, applications should not rely on the connection to be available when the method returns but instead register to receive the intent ACTION_SCO_AUDIO_STATE_UPDATED and wait for the state to be SCO_AUDIO_STATE_CONNECTED.

As the ACTION_SCO_AUDIO_STATE_UPDATED intent is sticky, the application can check the SCO audio state before calling startBluetoothSco() by reading the intent returned by the receiver registration. If the state is already CONNECTED, no state change will be received via the intent after calling startBluetoothSco(). It is however useful to call startBluetoothSco() so that the connection stays active in case the current initiator stops the connection.

Unless the connection is already active as described above, the state will always transition from DISCONNECTED to CONNECTING and then either to CONNECTED if the connection succeeds or back to DISCONNECTED if the connection fails (e.g no headset is connected).

When finished with the SCO connection or if the establishment fails, the application must call stopBluetoothSco() to clear the request and turn down the bluetooth connection.

Even if a SCO connection is established, the following restrictions apply on audio output streams so that they can be routed to SCO headset:

  • the stream type must be STREAM_VOICE_CALL
  • the format must be mono
  • the sampling must be 16kHz or 8kHz

The following restrictions apply on input streams:

  • the format must be mono
  • the sampling must be 8kHz

Note that the phone application always has the priority on the usage of the SCO connection for telephony. If this method is called while the phone is in call it will be ignored. Similarly, if a call is received or sent while an application is using the SCO connection, the connection will be lost for the application and NOT returned automatically when the call ends.

NOTE: up to and including API version JELLY_BEAN_MR1, this method initiates a virtual voice call to the bluetooth headset. After API version JELLY_BEAN_MR2 only a raw SCO audio connection is established.

See also:

stopBluetoothSco

Added in API level 8
void stopBluetoothSco ()

Stop bluetooth SCO audio connection.

Requires Permission: MODIFY_AUDIO_SETTINGS.

This method must be called by applications having requested the use of bluetooth SCO audio with startBluetoothSco() when finished with the SCO connection or if connection fails.

See also:

unloadSoundEffects

Added in API level 1
void unloadSoundEffects ()

Unload Sound effects. This method can be called to free some memory when sound effects are disabled.

unregisterAudioDeviceCallback

Added in API level 23
void unregisterAudioDeviceCallback (AudioDeviceCallback callback)

Unregisters an AudioDeviceCallback object which has been previously registered to receive notifications of changes to the set of connected audio devices.

Parameters
callback AudioDeviceCallback: The AudioDeviceCallback object that was previously registered with {@link AudioManager#registerAudioDeviceCallback) to be unregistered.

unregisterAudioRecordingCallback

Added in API level 24
void unregisterAudioRecordingCallback (AudioManager.AudioRecordingCallback cb)

Unregister an audio recording callback previously registered with registerAudioRecordingCallback(AudioRecordingCallback, Handler).

Parameters
cb AudioManager.AudioRecordingCallback: non-null callback to unregister

unregisterMediaButtonEventReceiver

Added in API level 18
void unregisterMediaButtonEventReceiver (PendingIntent eventReceiver)

This method was deprecated in API level 21.
Use MediaSession instead.

Unregister the receiver of MEDIA_BUTTON intents.

Parameters
eventReceiver PendingIntent: same PendingIntent that was registed with registerMediaButtonEventReceiver(PendingIntent).

unregisterMediaButtonEventReceiver

Added in API level 8
void unregisterMediaButtonEventReceiver (ComponentName eventReceiver)

This method was deprecated in API level 21.
Use MediaSession instead.

Unregister the receiver of MEDIA_BUTTON intents.

Parameters
eventReceiver ComponentName: identifier of a BroadcastReceiver that was registered with registerMediaButtonEventReceiver(ComponentName).

unregisterRemoteControlClient

Added in API level 14
void unregisterRemoteControlClient (RemoteControlClient rcClient)

This method was deprecated in API level 21.
Use MediaSession instead.

Unregisters the remote control client that was providing information to display on the remote controls.

Parameters
rcClient RemoteControlClient: The remote control client to unregister.

See also:

unregisterRemoteController

Added in API level 19
void unregisterRemoteController (RemoteController rctlr)

This method was deprecated in API level 21.
Use removeOnActiveSessionsChangedListener(android.media.session.MediaSessionManager.OnActiveSessionsChangedListener) instead.

Unregisters a RemoteController, causing it to no longer receive media metadata and playback state information, and no longer be capable of controlling playback.

Parameters
rctlr RemoteController: the object to unregister.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.