AudioManager

ACTION_AUDIO_BECOMING_NOISY

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

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

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

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

Constant Value: "android.media.SCO_AUDIO_STATE_CHANGED"

ACTION_SCO_AUDIO_STATE_UPDATED

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 - The new SCO audio state.
• EXTRA_SCO_AUDIO_PREVIOUS_STATE- The previous SCO audio state.

EXTRA_SCO_AUDIO_STATE or EXTRA_SCO_AUDIO_PREVIOUS_STATE can be any of:

• SCO_AUDIO_STATE_DISCONNECTED,
• SCO_AUDIO_STATE_CONNECTING or
• SCO_AUDIO_STATE_CONNECTED,

Constant Value: "android.media.ACTION_SCO_AUDIO_STATE_UPDATED"

ADJUST_LOWER

int ADJUST_LOWER

Decrease the ringer volume.

Constant Value: -1 (0xffffffff)

ADJUST_MUTE

int ADJUST_MUTE

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

Constant Value: -100 (0xffffff9c)

ADJUST_RAISE

int ADJUST_RAISE

Increase the ringer volume.

Constant Value: 1 (0x00000001)

ADJUST_SAME

int ADJUST_SAME

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

Constant Value: 0 (0x00000000)

ADJUST_TOGGLE_MUTE

int ADJUST_TOGGLE_MUTE

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

Constant Value: 101 (0x00000065)

ADJUST_UNMUTE

int ADJUST_UNMUTE

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

Constant Value: 100 (0x00000064)

AUDIOFOCUS_GAIN

int AUDIOFOCUS_GAIN

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

Constant Value: 1 (0x00000001)

AUDIOFOCUS_GAIN_TRANSIENT

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.

Constant Value: 2 (0x00000002)

AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE

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.

Constant Value: 4 (0x00000004)

AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK

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.

Constant Value: 3 (0x00000003)

AUDIOFOCUS_LOSS

int AUDIOFOCUS_LOSS

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

Constant Value: -1 (0xffffffff)

AUDIOFOCUS_LOSS_TRANSIENT

int AUDIOFOCUS_LOSS_TRANSIENT

Used to indicate a transient loss of audio focus.

Constant Value: -2 (0xfffffffe)

AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK

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.

Constant Value: -3 (0xfffffffd)

AUDIOFOCUS_REQUEST_FAILED

int AUDIOFOCUS_REQUEST_FAILED

A failed focus change request.

Constant Value: 0 (0x00000000)

AUDIOFOCUS_REQUEST_GRANTED

int AUDIOFOCUS_REQUEST_GRANTED

A successful focus change request.

Constant Value: 1 (0x00000001)

AUDIO_SESSION_ID_GENERATE

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

int ERROR

A default error code.

Constant Value: -1 (0xffffffff)

ERROR_DEAD_OBJECT

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

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

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

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

String EXTRA_RINGER_MODE

The new ringer mode.

Constant Value: "android.media.EXTRA_RINGER_MODE"

EXTRA_SCO_AUDIO_PREVIOUS_STATE

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

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

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.

Constant Value: "android.media.EXTRA_VIBRATE_SETTING"

EXTRA_VIBRATE_TYPE

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.

Constant Value: "android.media.EXTRA_VIBRATE_TYPE"

FLAG_ALLOW_RINGER_MODES

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.

Constant Value: 2 (0x00000002)

FLAG_PLAY_SOUND

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).

Constant Value: 4 (0x00000004)

FLAG_REMOVE_SOUND_AND_VIBRATE

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

int FLAG_SHOW_UI

Show a toast containing the current volume.

Constant Value: 1 (0x00000001)

FLAG_VIBRATE

int FLAG_VIBRATE

Whether to vibrate if going into the vibrate ringer mode.

Constant Value: 16 (0x00000010)

FX_FOCUS_NAVIGATION_DOWN

int FX_FOCUS_NAVIGATION_DOWN

Focus has moved down

Constant Value: 2 (0x00000002)

FX_FOCUS_NAVIGATION_LEFT

int FX_FOCUS_NAVIGATION_LEFT

Focus has moved left

Constant Value: 3 (0x00000003)

FX_FOCUS_NAVIGATION_RIGHT

int FX_FOCUS_NAVIGATION_RIGHT

Focus has moved right

Constant Value: 4 (0x00000004)

FX_FOCUS_NAVIGATION_UP

int FX_FOCUS_NAVIGATION_UP

Focus has moved up

Constant Value: 1 (0x00000001)

FX_KEYPRESS_DELETE

int FX_KEYPRESS_DELETE

IME delete keypress sound

Constant Value: 7 (0x00000007)

FX_KEYPRESS_INVALID

int FX_KEYPRESS_INVALID

Invalid keypress sound

Constant Value: 9 (0x00000009)

FX_KEYPRESS_RETURN

int FX_KEYPRESS_RETURN

IME return_keypress sound

Constant Value: 8 (0x00000008)

FX_KEYPRESS_SPACEBAR

int FX_KEYPRESS_SPACEBAR

IME spacebar keypress sound

Constant Value: 6 (0x00000006)

FX_KEYPRESS_STANDARD

int FX_KEYPRESS_STANDARD

IME standard keypress sound

Constant Value: 5 (0x00000005)

FX_KEY_CLICK

int FX_KEY_CLICK

Keyboard and direction pad click sound

Constant Value: 0 (0x00000000)

GET_DEVICES_ALL

int GET_DEVICES_ALL

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

Constant Value: 3 (0x00000003)

GET_DEVICES_INPUTS

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

int GET_DEVICES_OUTPUTS

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

Constant Value: 2 (0x00000002)

MODE_CURRENT

int MODE_CURRENT

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

Constant Value: -1 (0xffffffff)

MODE_INVALID

int MODE_INVALID

Invalid audio mode.

Constant Value: -2 (0xfffffffe)

MODE_IN_CALL

int MODE_IN_CALL

In call audio mode. A telephony call is established.

Constant Value: 2 (0x00000002)

MODE_IN_COMMUNICATION

int MODE_IN_COMMUNICATION

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

Constant Value: 3 (0x00000003)

MODE_NORMAL

int MODE_NORMAL

Normal audio mode: not ringing and no call established.

Constant Value: 0 (0x00000000)

MODE_RINGTONE

int MODE_RINGTONE

Ringing audio mode. An incoming is being signaled.

Constant Value: 1 (0x00000001)

NUM_STREAMS

int NUM_STREAMS

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

Constant Value: 5 (0x00000005)

PROPERTY_OUTPUT_FRAMES_PER_BUFFER

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

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

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

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

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

String RINGER_MODE_CHANGED_ACTION

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

Constant Value: "android.media.RINGER_MODE_CHANGED"

RINGER_MODE_NORMAL

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.

Constant Value: 2 (0x00000002)

RINGER_MODE_SILENT

int RINGER_MODE_SILENT

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

Constant Value: 0 (0x00000000)

RINGER_MODE_VIBRATE

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.)

Constant Value: 1 (0x00000001)

ROUTE_ALL

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

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

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

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

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

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

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

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

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

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

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

int STREAM_ALARM

The audio stream for alarms

Constant Value: 4 (0x00000004)

STREAM_DTMF

int STREAM_DTMF

The audio stream for DTMF Tones

Constant Value: 8 (0x00000008)

STREAM_MUSIC

int STREAM_MUSIC

The audio stream for music playback

Constant Value: 3 (0x00000003)

STREAM_NOTIFICATION

int STREAM_NOTIFICATION

The audio stream for notifications

Constant Value: 5 (0x00000005)

STREAM_RING

int STREAM_RING

The audio stream for the phone ring

Constant Value: 2 (0x00000002)

STREAM_SYSTEM

int STREAM_SYSTEM

The audio stream for system sounds

Constant Value: 1 (0x00000001)

STREAM_VOICE_CALL

int STREAM_VOICE_CALL

The audio stream for phone calls

Constant Value: 0 (0x00000000)

USE_DEFAULT_STREAM_TYPE

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

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.

Constant Value: "android.media.VIBRATE_SETTING_CHANGED"

VIBRATE_SETTING_OFF

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.

Constant Value: 0 (0x00000000)

VIBRATE_SETTING_ON

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.

Constant Value: 1 (0x00000001)

VIBRATE_SETTING_ONLY_SILENT

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.

Constant Value: 2 (0x00000002)

VIBRATE_TYPE_NOTIFICATION

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.

Constant Value: 1 (0x00000001)

VIBRATE_TYPE_RINGER

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.

Constant Value: 0 (0x00000000)

abandonAudioFocus

int abandonAudioFocus (AudioManager.OnAudioFocusChangeListener l)

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

adjustStreamVolume

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.

adjustSuggestedStreamVolume

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().

adjustVolume

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().

dispatchMediaKeyEvent

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).

generateAudioSessionId

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.

getActiveRecordingConfigurations

List<AudioRecordingConfiguration> getActiveRecordingConfigurations ()

Returns the current active audio recording configurations of the device.

getDevices

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.

getMode

int getMode ()

Returns the current audio mode.

getParameters

String getParameters (String keys)

Gets a variable number of parameter values from audio hardware.

getProperty

String getProperty (String key)

Returns the value of the property with the specified key.

getRingerMode

int getRingerMode ()

Returns the current ringtone mode.

getRouting

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.

getStreamMaxVolume

int getStreamMaxVolume (int streamType)

Returns the maximum volume index for a particular stream.

getStreamVolume

int getStreamVolume (int streamType)

Returns the current volume index for a particular stream.

getVibrateSetting

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).

isBluetoothA2dpOn

boolean isBluetoothA2dpOn ()

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

isBluetoothScoAvailableOffCall

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.

isBluetoothScoOn

boolean isBluetoothScoOn ()

Checks whether communications use Bluetooth SCO.

isMicrophoneMute

boolean isMicrophoneMute ()

Checks whether the microphone mute is on or off.

isMusicActive

boolean isMusicActive ()

Checks whether any music is active.

isSpeakerphoneOn

boolean isSpeakerphoneOn ()

Checks whether the speakerphone is on or off.

isStreamMute

boolean isStreamMute (int streamType)

Returns the current mute state for a particular stream.

isVolumeFixed

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:

• adjustVolume(int, int)
• adjustSuggestedStreamVolume(int, int, int)
• adjustStreamVolume(int, int, int)
• setStreamVolume(int, int, int)
• setRingerMode(int)
• setStreamSolo(int, boolean)
• setStreamMute(int, boolean)

isWiredHeadsetOn

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.

loadSoundEffects

void loadSoundEffects ()

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

playSoundEffect

void playSoundEffect (int effectType)

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

playSoundEffect

void playSoundEffect (int effectType, 
                float volume)

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

registerAudioDeviceCallback

void registerAudioDeviceCallback (AudioDeviceCallback callback, 
                Handler handler)

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

registerAudioRecordingCallback

void registerAudioRecordingCallback (AudioManager.AudioRecordingCallback cb, 
                Handler handler)

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

registerMediaButtonEventReceiver

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.

registerMediaButtonEventReceiver

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.

registerRemoteControlClient

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.

registerRemoteController

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).

requestAudioFocus

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

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

setBluetoothA2dpOn

void setBluetoothA2dpOn (boolean on)

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

setBluetoothScoOn

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.

setMicrophoneMute

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.

setMode

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.

setParameters

void setParameters (String keyValuePairs)

Sets a variable number of parameter values to audio hardware.

setRingerMode

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().

setRouting

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

setSpeakerphoneOn

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.

setStreamMute

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.

setStreamSolo

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.

setStreamVolume

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().

setVibrateSetting

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.

setWiredHeadsetOn

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.

shouldVibrate

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.

startBluetoothSco

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.

stopBluetoothSco

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.

unloadSoundEffects

void unloadSoundEffects ()

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

unregisterAudioDeviceCallback

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.

unregisterAudioRecordingCallback

void unregisterAudioRecordingCallback (AudioManager.AudioRecordingCallback cb)

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

unregisterMediaButtonEventReceiver

void unregisterMediaButtonEventReceiver (PendingIntent eventReceiver)

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

Unregister the receiver of MEDIA_BUTTON intents.

unregisterMediaButtonEventReceiver

void unregisterMediaButtonEventReceiver (ComponentName eventReceiver)

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

Unregister the receiver of MEDIA_BUTTON intents.

unregisterRemoteControlClient

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.

unregisterRemoteController

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.