AudioManager

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.

Broadcast Action: A sticky broadcast indicating an HMDI 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).

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

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

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,

Decrease the ringer volume.

Increase the ringer volume.

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

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

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.

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.

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.

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

Used to indicate a transient loss of audio focus.

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.

A failed focus change request.

A successful focus change request.

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

A default error code.

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

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.

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.

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

The new ringer mode.

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

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

The new vibrate setting for a particular type.

The vibrate type whose setting has changed.

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.

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

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

Show a toast containing the current volume.

Whether to vibrate if going into the vibrate ringer mode.

Focus has moved down

Focus has moved left

Focus has moved right

Focus has moved up

IME delete keypress sound

Invalid keypress sound

IME return_keypress sound

IME spacebar keypress sound

IME standard keypress sound

Keyboard and direction pad click sound

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

Invalid audio mode.

In call audio mode. A telephony call is established.

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

Normal audio mode: not ringing and no call established.

Ringing audio mode. An incoming is being signaled.

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.

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.

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

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.

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

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

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

Routing audio output to bluetooth A2DP

Routing audio output to bluetooth SCO

Routing audio output to earpiece

Routing audio output to headset

Routing audio output to speaker

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

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

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

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

The audio stream for alarms

The audio stream for DTMF Tones

The audio stream for music playback

The audio stream for notifications

The audio stream for the phone ring

The audio stream for system sounds

The audio stream for phone calls

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

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

Vibrate setting that suggests to never vibrate.

Vibrate setting that suggests to vibrate when possible.

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

Vibrate type that corresponds to notifications.

Vibrate type that corresponds to the ringer.

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

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.

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

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

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

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 the current audio mode.

Gets a variable number of parameter values from audio hardware.

Returns the value of the property with the specified key.

Returns the current ringtone mode.

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

Returns the maximum volume index for a particular stream.

Returns the current volume index for a particular stream.

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

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

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.

Checks whether communications use Bluetooth SCO.

Checks whether the microphone mute is on or off.

Checks whether any music is active.

Checks whether the speakerphone is on or off.

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)

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.

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

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

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

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.

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

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

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

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

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.

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.

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.

Sets a variable number of parameter values to audio hardware.

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

Sets the audio routing for a specified mode

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.

Mute or unmute an audio stream.

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.

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

Solo or unsolo a particular stream. All other streams are muted.

The solo command is protected against client process death: if a process with an active solo request on a stream dies, all streams that were muted because of this request will be unmuted automatically.

The solo requests for a given stream are cumulative: the AudioManager can receive several solo requests from one or more clients and the stream will be unsoloed only when the same number of unsolo requests are received.

For a better user experience, applications MUST unsolo a soloed stream in onPause() and solo is again in onResume() if appropriate.

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

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

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.

Sets audio routing to the wired headset on or off.

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.

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.

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.

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

Unregister the receiver of MEDIA_BUTTON intents.

Unregister the receiver of MEDIA_BUTTON intents.

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

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