AudioManager

ACTION_AUDIO_BECOMING_NOISY

static val ACTION_AUDIO_BECOMING_NOISY: String

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.

Value: "android.media.AUDIO_BECOMING_NOISY"

ACTION_HDMI_AUDIO_PLUG

static val ACTION_HDMI_AUDIO_PLUG: String

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 android.content.Context#registerReceiver(BroadcastReceiver,IntentFilter).

Value: "android.media.action.HDMI_AUDIO_PLUG"

ACTION_HEADSET_PLUG

static val ACTION_HEADSET_PLUG: String

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

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

Value: "android.intent.action.HEADSET_PLUG"

ACTION_MICROPHONE_MUTE_CHANGED

static val ACTION_MICROPHONE_MUTE_CHANGED: String

Broadcast Action: microphone muting state changed. You cannot receive this through components declared in manifests, only by explicitly registering for it with android.content.Context#registerReceiver(BroadcastReceiver,IntentFilter).

The intent has no extra values, use isMicrophoneMute to check whether the microphone is muted.

Value: "android.media.action.MICROPHONE_MUTE_CHANGED"

ACTION_SCO_AUDIO_STATE_CHANGED

static val ACTION_SCO_AUDIO_STATE_CHANGED: String

Deprecated: Use ACTION_SCO_AUDIO_STATE_UPDATED instead

Sticky broadcast intent action indicating that the Bluetooth 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

Value: "android.media.SCO_AUDIO_STATE_CHANGED"

ACTION_SCO_AUDIO_STATE_UPDATED

static val ACTION_SCO_AUDIO_STATE_UPDATED: String

Sticky broadcast intent action indicating that the Bluetooth 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,

Value: "android.media.ACTION_SCO_AUDIO_STATE_UPDATED"

ACTION_SPEAKERPHONE_STATE_CHANGED

static val ACTION_SPEAKERPHONE_STATE_CHANGED: String

Broadcast Action: speakerphone state changed. You cannot receive this through components declared in manifests, only by explicitly registering for it with android.content.Context#registerReceiver(BroadcastReceiver,IntentFilter).

The intent has no extra values, use isSpeakerphoneOn to check whether the speakerphone functionality is enabled or not.

Value: "android.media.action.SPEAKERPHONE_STATE_CHANGED"

ADJUST_LOWER

static val ADJUST_LOWER: Int

Decrease the ringer volume.

Value: -1

ADJUST_MUTE

static val ADJUST_MUTE: Int

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

Value: -100

ADJUST_RAISE

static val ADJUST_RAISE: Int

Increase the ringer volume.

Value: 1

ADJUST_SAME

static val ADJUST_SAME: Int

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

Value: 0

ADJUST_TOGGLE_MUTE

static val ADJUST_TOGGLE_MUTE: Int

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

Value: 101

ADJUST_UNMUTE

static val ADJUST_UNMUTE: Int

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

Value: 100

AUDIOFOCUS_GAIN

static val AUDIOFOCUS_GAIN: Int

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

Value: 1

AUDIOFOCUS_GAIN_TRANSIENT

static val AUDIOFOCUS_GAIN_TRANSIENT: Int

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.

Value: 2

AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE

static val AUDIOFOCUS_GAIN_TRANSIENT_EXCLUSIVE: Int

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.

Value: 4

AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK

static val AUDIOFOCUS_GAIN_TRANSIENT_MAY_DUCK: Int

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.

Value: 3

AUDIOFOCUS_LOSS

static val AUDIOFOCUS_LOSS: Int

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

Value: -1

AUDIOFOCUS_LOSS_TRANSIENT

static val AUDIOFOCUS_LOSS_TRANSIENT: Int

Used to indicate a transient loss of audio focus.

Value: -2

AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK

static val AUDIOFOCUS_LOSS_TRANSIENT_CAN_DUCK: Int

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.

Value: -3

AUDIOFOCUS_NONE

static val AUDIOFOCUS_NONE: Int

Used to indicate no audio focus has been gained or lost, or requested.

Value: 0

AUDIOFOCUS_REQUEST_DELAYED

static val AUDIOFOCUS_REQUEST_DELAYED: Int

A focus change request whose granting is delayed: the request was successful, but the requester will only be granted audio focus once the condition that prevented immediate granting has ended. See requestAudioFocus(android.media.AudioFocusRequest) and AudioFocusRequest.Builder#setAcceptsDelayedFocusGain(boolean)

Value: 2

AUDIOFOCUS_REQUEST_FAILED

static val AUDIOFOCUS_REQUEST_FAILED: Int

A failed focus change request.

Value: 0

AUDIOFOCUS_REQUEST_GRANTED

static val AUDIOFOCUS_REQUEST_GRANTED: Int

A successful focus change request.

Value: 1

AUDIO_SESSION_ID_GENERATE

static val AUDIO_SESSION_ID_GENERATE: Int

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#AudioTrack(AudioAttributes, AudioFormat, int, int, int).

Value: 0

DIRECT_PLAYBACK_BITSTREAM_SUPPORTED

static val DIRECT_PLAYBACK_BITSTREAM_SUPPORTED: Int

Return value for getDirectPlaybackSupport(android.media.AudioFormat,android.media.AudioAttributes): direct playback supported. This value covers direct playback that is bitstream pass-through such as compressed pass-through.

Value: 4

DIRECT_PLAYBACK_NOT_SUPPORTED

static val DIRECT_PLAYBACK_NOT_SUPPORTED: Int

Return value for getDirectPlaybackSupport(android.media.AudioFormat,android.media.AudioAttributes): direct playback not supported.

Value: 0

DIRECT_PLAYBACK_OFFLOAD_GAPLESS_SUPPORTED

static val DIRECT_PLAYBACK_OFFLOAD_GAPLESS_SUPPORTED: Int

Return value for getDirectPlaybackSupport(android.media.AudioFormat,android.media.AudioAttributes): direct offload playback supported with gapless transitions. Compressed offload is a variant of direct playback. It is the feature that allows audio processing tasks to be done on the Android device but not on the application processor, instead, it is handled by dedicated hardware such as audio DSPs. That will allow the application processor to be idle as much as possible, which is good for power saving. Compressed offload playback supports AudioTrack.StreamEventCallback for event notifications. Gapless transitions indicates the ability to play consecutive audio tracks without an audio silence in between.

Value: 3

DIRECT_PLAYBACK_OFFLOAD_SUPPORTED

static val DIRECT_PLAYBACK_OFFLOAD_SUPPORTED: Int

Return value for getDirectPlaybackSupport(android.media.AudioFormat,android.media.AudioAttributes): direct offload playback supported. Compressed offload is a variant of direct playback. It is the feature that allows audio processing tasks to be done on the Android device but not on the application processor, instead, it is handled by dedicated hardware such as audio DSPs. That will allow the application processor to be idle as much as possible, which is good for power saving. Compressed offload playback supports AudioTrack.StreamEventCallback for event notifications.

Value: 1

ENCODED_SURROUND_OUTPUT_ALWAYS

static val ENCODED_SURROUND_OUTPUT_ALWAYS: Int

The surround sound formats are ALWAYS available, even if they are not detected by the hardware. Those formats will be reported as part of the HDMI output capability. Applications are then free to use either PCM or encoded output.

Value: 2

ENCODED_SURROUND_OUTPUT_AUTO

static val ENCODED_SURROUND_OUTPUT_AUTO: Int

The surround sound formats are available for use if they are detected. This is the default mode.

Value: 0

ENCODED_SURROUND_OUTPUT_MANUAL

static val ENCODED_SURROUND_OUTPUT_MANUAL: Int

Surround sound formats are available according to the choice of user, even if they are not detected by the hardware. Those formats will be reported as part of the HDMI output capability. Applications are then free to use either PCM or encoded output.

Value: 3

ENCODED_SURROUND_OUTPUT_NEVER

static val ENCODED_SURROUND_OUTPUT_NEVER: Int

The surround sound formats are NEVER available, even if they are detected by the hardware. Those formats will not be reported.

Value: 1

ENCODED_SURROUND_OUTPUT_UNKNOWN

static val ENCODED_SURROUND_OUTPUT_UNKNOWN: Int

The mode for surround sound formats is unknown.

Value: -1

ERROR

static val ERROR: Int

A default error code.

Value: -1

ERROR_DEAD_OBJECT

static val ERROR_DEAD_OBJECT: Int

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

Value: -6

EXTRA_AUDIO_PLUG_STATE

static val EXTRA_AUDIO_PLUG_STATE: String

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.

Value: "android.media.extra.AUDIO_PLUG_STATE"

EXTRA_ENCODINGS

static val EXTRA_ENCODINGS: String

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 AudioFormat#ENCODING_PCM_16BIT). Use android.content.Intent#getIntArrayExtra(String) to retrieve the encoding values.

Value: "android.media.extra.ENCODINGS"

EXTRA_MAX_CHANNEL_COUNT

static val EXTRA_MAX_CHANNEL_COUNT: String

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

Value: "android.media.extra.MAX_CHANNEL_COUNT"

EXTRA_RINGER_MODE

static val EXTRA_RINGER_MODE: String

The new ringer mode.

Value: "android.media.EXTRA_RINGER_MODE"

EXTRA_SCO_AUDIO_PREVIOUS_STATE

static val EXTRA_SCO_AUDIO_PREVIOUS_STATE: String

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

Value: "android.media.extra.SCO_AUDIO_PREVIOUS_STATE"

EXTRA_SCO_AUDIO_STATE

static val EXTRA_SCO_AUDIO_STATE: String

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

Value: "android.media.extra.SCO_AUDIO_STATE"

EXTRA_VIBRATE_SETTING

static val EXTRA_VIBRATE_SETTING: String

Deprecated: 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.

Value: "android.media.EXTRA_VIBRATE_SETTING"

EXTRA_VIBRATE_TYPE

static val EXTRA_VIBRATE_TYPE: String

Deprecated: 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.

Value: "android.media.EXTRA_VIBRATE_TYPE"

FLAG_ALLOW_RINGER_MODES

static val FLAG_ALLOW_RINGER_MODES: Int

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.

Value: 2

FLAG_PLAY_SOUND

static val FLAG_PLAY_SOUND: Int

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 AudioManager#STREAM_RING, or the volume is being adjusted downward).

Value: 4

FLAG_REMOVE_SOUND_AND_VIBRATE

static val FLAG_REMOVE_SOUND_AND_VIBRATE: Int

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

Value: 8

FLAG_SHOW_UI

static val FLAG_SHOW_UI: Int

Show a toast containing the current volume.

Value: 1

FLAG_VIBRATE

static val FLAG_VIBRATE: Int

Whether to vibrate if going into the vibrate ringer mode.

Value: 16

FX_BACK

static val FX_BACK: Int

Back sound

Value: 10

FX_FOCUS_NAVIGATION_DOWN

static val FX_FOCUS_NAVIGATION_DOWN: Int

Focus has moved down

Value: 2

FX_FOCUS_NAVIGATION_LEFT

static val FX_FOCUS_NAVIGATION_LEFT: Int

Focus has moved left

Value: 3

FX_FOCUS_NAVIGATION_RIGHT

static val FX_FOCUS_NAVIGATION_RIGHT: Int

Focus has moved right

Value: 4

FX_FOCUS_NAVIGATION_UP

static val FX_FOCUS_NAVIGATION_UP: Int

Focus has moved up

Value: 1

FX_KEYPRESS_DELETE

static val FX_KEYPRESS_DELETE: Int

IME delete keypress sound

Value: 7

FX_KEYPRESS_INVALID

static val FX_KEYPRESS_INVALID: Int

Invalid keypress sound

Value: 9

FX_KEYPRESS_RETURN

static val FX_KEYPRESS_RETURN: Int

IME return_keypress sound

Value: 8

FX_KEYPRESS_SPACEBAR

static val FX_KEYPRESS_SPACEBAR: Int

IME spacebar keypress sound

Value: 6

FX_KEYPRESS_STANDARD

static val FX_KEYPRESS_STANDARD: Int

IME standard keypress sound

Value: 5

FX_KEY_CLICK

static val FX_KEY_CLICK: Int

Keyboard and direction pad click sound

Value: 0

GET_DEVICES_ALL

static val GET_DEVICES_ALL: Int

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

Value: 3

GET_DEVICES_INPUTS

static val GET_DEVICES_INPUTS: Int

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

Value: 1

GET_DEVICES_OUTPUTS

static val GET_DEVICES_OUTPUTS: Int

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

Value: 2

MODE_CALL_REDIRECT

static val MODE_CALL_REDIRECT: Int

A telephony call is established and its audio is being redirected to another device.

Value: 5

MODE_CALL_SCREENING

static val MODE_CALL_SCREENING: Int

Call screening in progress. Call is connected and audio is accessible to call screening applications but other audio use cases are still possible.

Value: 4

MODE_COMMUNICATION_REDIRECT

static val MODE_COMMUNICATION_REDIRECT: Int

An audio/video chat or VoIP call is established and its audio is being redirected to another device.

Value: 6

MODE_CURRENT

static val MODE_CURRENT: Int

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

Value: -1

MODE_INVALID

static val MODE_INVALID: Int

Invalid audio mode.

Value: -2

MODE_IN_CALL

static val MODE_IN_CALL: Int

In call audio mode. A telephony call is established.

Value: 2

MODE_IN_COMMUNICATION

static val MODE_IN_COMMUNICATION: Int

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

Value: 3

MODE_NORMAL

static val MODE_NORMAL: Int

Normal audio mode: not ringing and no call established.

Value: 0

MODE_RINGTONE

static val MODE_RINGTONE: Int

Ringing audio mode. An incoming is being signaled.

Value: 1

NUM_STREAMS

static val NUM_STREAMS: Int

Deprecated: Do not iterate on volume stream type values.

Value: 5

PLAYBACK_OFFLOAD_GAPLESS_SUPPORTED

static val PLAYBACK_OFFLOAD_GAPLESS_SUPPORTED: Int

Return value for getPlaybackOffloadSupport(android.media.AudioFormat,android.media.AudioAttributes): offload playback supported with gapless transitions

Value: 2

PLAYBACK_OFFLOAD_NOT_SUPPORTED

static val PLAYBACK_OFFLOAD_NOT_SUPPORTED: Int

Return value for getPlaybackOffloadSupport(android.media.AudioFormat,android.media.AudioAttributes): offload playback not supported

Value: 0

PLAYBACK_OFFLOAD_SUPPORTED

static val PLAYBACK_OFFLOAD_SUPPORTED: Int

Return value for getPlaybackOffloadSupport(android.media.AudioFormat,android.media.AudioAttributes): offload playback supported

Value: 1

PROPERTY_OUTPUT_FRAMES_PER_BUFFER

static val PROPERTY_OUTPUT_FRAMES_PER_BUFFER: String

Used as a key for getProperty to request the native or optimal output buffer size for this device's low latency output stream, in decimal PCM frames. Latency-sensitive apps should use this value as a minimum, and offer the user the option to override it. The low latency output stream is typically either the device's primary output stream, or another output stream with smaller buffers.

Value: "android.media.property.OUTPUT_FRAMES_PER_BUFFER"

PROPERTY_OUTPUT_SAMPLE_RATE

static val PROPERTY_OUTPUT_SAMPLE_RATE: String

Used as a key for getProperty to request the native or optimal output sample rate for this device's low latency output stream, in decimal Hz. Latency-sensitive apps should use this value as a default, and offer the user the option to override it. The low latency output stream is typically either the device's primary output stream, or another output stream with smaller buffers.

Value: "android.media.property.OUTPUT_SAMPLE_RATE"

PROPERTY_SUPPORT_AUDIO_SOURCE_UNPROCESSED

static val PROPERTY_SUPPORT_AUDIO_SOURCE_UNPROCESSED: String

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

Value: "android.media.property.SUPPORT_AUDIO_SOURCE_UNPROCESSED"

PROPERTY_SUPPORT_MIC_NEAR_ULTRASOUND

static val PROPERTY_SUPPORT_MIC_NEAR_ULTRASOUND: String

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

Value: "android.media.property.SUPPORT_MIC_NEAR_ULTRASOUND"

PROPERTY_SUPPORT_SPEAKER_NEAR_ULTRASOUND

static val PROPERTY_SUPPORT_SPEAKER_NEAR_ULTRASOUND: String

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

Value: "android.media.property.SUPPORT_SPEAKER_NEAR_ULTRASOUND"

RINGER_MODE_CHANGED_ACTION

static val RINGER_MODE_CHANGED_ACTION: String

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

Value: "android.media.RINGER_MODE_CHANGED"

RINGER_MODE_NORMAL

static val RINGER_MODE_NORMAL: Int

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.

Value: 2

RINGER_MODE_SILENT

static val RINGER_MODE_SILENT: Int

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

Value: 0

RINGER_MODE_VIBRATE

static val RINGER_MODE_VIBRATE: Int

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

Value: 1

ROUTE_ALL

static val ROUTE_ALL: Int

Deprecated: Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

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

Value: -1

ROUTE_BLUETOOTH

static val ROUTE_BLUETOOTH: Int

Deprecated: Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Value: 4

ROUTE_BLUETOOTH_A2DP

static val ROUTE_BLUETOOTH_A2DP: Int

Deprecated: Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to bluetooth A2DP

Value: 16

ROUTE_BLUETOOTH_SCO

static val ROUTE_BLUETOOTH_SCO: Int

Deprecated: Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to bluetooth SCO

Value: 4

ROUTE_EARPIECE

static val ROUTE_EARPIECE: Int

Deprecated: Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to earpiece

Value: 1

ROUTE_HEADSET

static val ROUTE_HEADSET: Int

Deprecated: Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to headset

Value: 8

ROUTE_SPEAKER

static val ROUTE_SPEAKER: Int

Deprecated: Do not set audio routing directly, use setSpeakerphoneOn(), setBluetoothScoOn() methods instead.

Routing audio output to speaker

Value: 2

SCO_AUDIO_STATE_CONNECTED

static val SCO_AUDIO_STATE_CONNECTED: Int

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

Value: 1

SCO_AUDIO_STATE_CONNECTING

static val SCO_AUDIO_STATE_CONNECTING: Int

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

Value: 2

SCO_AUDIO_STATE_DISCONNECTED

static val SCO_AUDIO_STATE_DISCONNECTED: Int

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

Value: 0

SCO_AUDIO_STATE_ERROR

static val SCO_AUDIO_STATE_ERROR: Int

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

Value: -1

STREAM_ACCESSIBILITY

static val STREAM_ACCESSIBILITY: Int

Used to identify the volume of audio streams for accessibility prompts

Value: 10

STREAM_ALARM

static val STREAM_ALARM: Int

Used to identify the volume of audio streams for alarms

Value: 4

STREAM_DTMF

static val STREAM_DTMF: Int

Used to identify the volume of audio streams for DTMF Tones

Value: 8

STREAM_MUSIC

static val STREAM_MUSIC: Int

Used to identify the volume of audio streams for music playback

Value: 3

STREAM_NOTIFICATION

static val STREAM_NOTIFICATION: Int

Used to identify the volume of audio streams for notifications

Value: 5

STREAM_RING

static val STREAM_RING: Int

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

Value: 2

STREAM_SYSTEM

static val STREAM_SYSTEM: Int

Used to identify the volume of audio streams for system sounds

Value: 1

STREAM_VOICE_CALL

static val STREAM_VOICE_CALL: Int

Used to identify the volume of audio streams for phone calls

Value: 0

USE_DEFAULT_STREAM_TYPE

static val USE_DEFAULT_STREAM_TYPE: Int

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

Value: -2147483648

VIBRATE_SETTING_CHANGED_ACTION

static val VIBRATE_SETTING_CHANGED_ACTION: String

Deprecated: 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.

Value: "android.media.VIBRATE_SETTING_CHANGED"

VIBRATE_SETTING_OFF

static val VIBRATE_SETTING_OFF: Int

Deprecated: 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.

Value: 0

VIBRATE_SETTING_ON

static val VIBRATE_SETTING_ON: Int

Deprecated: 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.

Value: 1

VIBRATE_SETTING_ONLY_SILENT

static val VIBRATE_SETTING_ONLY_SILENT: Int

Deprecated: 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.

Value: 2

VIBRATE_TYPE_NOTIFICATION

static val VIBRATE_TYPE_NOTIFICATION: Int

Deprecated: Applications should maintain their own vibrate policy based on current ringer mode that can be queried via getRingerMode().

Vibrate type that corresponds to notifications.

Value: 1

VIBRATE_TYPE_RINGER

static val VIBRATE_TYPE_RINGER: Int

Deprecated: 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.

Value: 0

abandonAudioFocus

open fun abandonAudioFocus(l: AudioManager.OnAudioFocusChangeListener!): Int

Deprecated: use abandonAudioFocusRequest(android.media.AudioFocusRequest)

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

abandonAudioFocusRequest

open fun abandonAudioFocusRequest(focusRequest: AudioFocusRequest): Int

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

addOnCommunicationDeviceChangedListener

open fun addOnCommunicationDeviceChangedListener(
    executor: Executor, 
    listener: AudioManager.OnCommunicationDeviceChangedListener
): Unit

Adds a listener for being notified of changes to the communication audio device. See setCommunicationDevice(android.media.AudioDeviceInfo).

addOnModeChangedListener

open fun addOnModeChangedListener(
    executor: Executor, 
    listener: AudioManager.OnModeChangedListener
): Unit

Adds a listener to be notified of changes to the audio mode. See getMode()

addOnPreferredMixerAttributesChangedListener

open fun addOnPreferredMixerAttributesChangedListener(
    executor: Executor, 
    listener: AudioManager.OnPreferredMixerAttributesChangedListener
): Unit

Adds a listener for being notified of changes to the preferred mixer attributes.

adjustStreamVolume

open fun adjustStreamVolume(
    streamType: Int, 
    direction: Int, 
    flags: Int
): Unit

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.

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 NotificationManager#isNotificationPolicyAccessGranted().

adjustSuggestedStreamVolume

open fun adjustSuggestedStreamVolume(
    direction: Int, 
    suggestedStreamType: Int, 
    flags: Int
): Unit

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

open fun adjustVolume(
    direction: Int, 
    flags: Int
): Unit

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

adjustVolumeGroupVolume

open fun adjustVolumeGroupVolume(
    groupId: Int, 
    direction: Int, 
    flags: Int
): Unit

Adjusts the volume of a particular group associated to given id by one step in a direction.

If the volume group is associated to a stream type, it fallbacks on adjustStreamVolume(int,int,int) for compatibility reason.

Call first in prior getVolumeGroupIdForAttributes(android.media.AudioAttributes) to retrieve the volume group id supporting the given AudioAttributes.

clearCommunicationDevice

open fun clearCommunicationDevice(): Unit

Cancels previous communication device selection made with setCommunicationDevice(android.media.AudioDeviceInfo).

clearPreferredMixerAttributes

open fun clearPreferredMixerAttributes(
    attributes: AudioAttributes, 
    device: AudioDeviceInfo
): Boolean

Clears the current preferred mixer attributes that were previously set via setPreferredMixerAttributes(android.media.AudioAttributes,android.media.AudioDeviceInfo,android.media.AudioMixerAttributes)
Requires android.Manifest.permission#MODIFY_AUDIO_SETTINGS

dispatchMediaKeyEvent

open fun dispatchMediaKeyEvent(keyEvent: KeyEvent!): Unit

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

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

generateAudioSessionId

open fun generateAudioSessionId(): Int

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 android.media.audiofx.AudioEffect objects to define the audio session of the effect, or to specify a session for a speech synthesis utterance in android.speech.tts.TextToSpeech.Engine.

getActivePlaybackConfigurations

open fun getActivePlaybackConfigurations(): MutableList<AudioPlaybackConfiguration!>

Returns the current active audio playback configurations of the device

getActiveRecordingConfigurations

open fun getActiveRecordingConfigurations(): MutableList<AudioRecordingConfiguration!>

Returns the current active audio recording configurations of the device.

getAllowedCapturePolicy

open fun getAllowedCapturePolicy(): Int

Return the capture policy.

getAudioDevicesForAttributes

open fun getAudioDevicesForAttributes(attributes: AudioAttributes): MutableList<AudioDeviceInfo!>

Get the audio devices that would be used for the routing of the given audio attributes. These are the devices anticipated to play sound from an AudioTrack created with the specified AudioAttributes. The audio routing can change if audio devices are physically connected or disconnected or concurrently through AudioRouting or MediaRouter.

getAudioHwSyncForSession

open fun getAudioHwSyncForSession(sessionId: Int): Int

Retrieves the Hardware A/V synchronization ID corresponding to the given audio session ID. For more details on Hardware A/V synchronization please refer to media tunneling documentation.

getAvailableCommunicationDevices

open fun getAvailableCommunicationDevices(): MutableList<AudioDeviceInfo!>

Returns a list of audio devices that can be selected for communication use cases via setCommunicationDevice(android.media.AudioDeviceInfo).

getCommunicationDevice

open fun getCommunicationDevice(): AudioDeviceInfo?

Returns currently selected audio device for communication.

This API replaces the following deprecated APIs:

• isBluetoothScoOn()
• isSpeakerphoneOn()

getDevices

open fun getDevices(flags: Int): Array<AudioDeviceInfo!>!

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. Notes that Android audio framework only support one device per device type. In that case, if there are multiple audio device with the same device type connected to the Android device, only the last reported device will be known by Android audio framework and returned by this API.

getDirectPlaybackSupport

open static fun getDirectPlaybackSupport(
    format: AudioFormat, 
    attributes: AudioAttributes
): Int

Returns a bitfield representing the different forms of direct playback currently available for a given audio format.

Direct playback means that the audio stream is not altered by the framework. The audio stream will not be resampled, volume scaled, downmixed or mixed with other content by the framework. But it may be wrapped in a higher level protocol such as IEC61937 for passthrough.

Checking for direct support can help the app select the representation of audio content that most closely matches the capabilities of the device and peripherals (e.g. A/V receiver) connected to it. Note that the provided stream can still be re-encoded or mixed with other streams, if needed.

getDirectProfilesForAttributes

open fun getDirectProfilesForAttributes(attributes: AudioAttributes): MutableList<AudioProfile!>

Returns a list of direct AudioProfile that are supported for the specified AudioAttributes. This can be empty in case of an error or if no direct playback is possible.

Direct playback means that the audio stream is not resampled or downmixed by the framework. Checking for direct support can help the app select the representation of audio content that most closely matches the capabilities of the device and peripherals (e.g. A/V receiver) connected to it. Note that the provided stream can still be re-encoded or mixed with other streams, if needed.

When using this information to inform your application which audio format to play, query again whenever audio output devices change (see AudioDeviceCallback).

getEncodedSurroundMode

open fun getEncodedSurroundMode(): Int

Gets the surround sound mode.

getMicrophones

open fun getMicrophones(): MutableList<MicrophoneInfo!>!

Returns a list of MicrophoneInfo that corresponds to the characteristics of all available microphones. The list is empty when no microphones are available on the device. An error during the query will result in an IOException being thrown.

getMode

open fun getMode(): Int

Returns the current audio mode.

getParameters

open fun getParameters(keys: String!): String!

Gets a variable number of parameter values from audio hardware.

getPlaybackOffloadSupport

open static fun getPlaybackOffloadSupport(
    format: AudioFormat, 
    attributes: AudioAttributes
): Int

Deprecated: Use getDirectPlaybackSupport(android.media.AudioFormat,android.media.AudioAttributes) instead

Returns whether offloaded playback of an audio format is supported on the device or not and when supported whether gapless transitions are possible or not.

Offloaded playback is the feature where the decoding and playback of an audio stream is not competing with other software resources. In general, it is supported by dedicated hardware, such as audio DSPs.

Note that this query only provides information about the support of an audio format, it does not indicate whether the resources necessary for the offloaded playback are available at that instant.

getPreferredMixerAttributes

open fun getPreferredMixerAttributes(
    attributes: AudioAttributes, 
    device: AudioDeviceInfo
): AudioMixerAttributes?

Returns current preferred mixer attributes that is set via setPreferredMixerAttributes(android.media.AudioAttributes,android.media.AudioDeviceInfo,android.media.AudioMixerAttributes)

getProperty

open fun getProperty(key: String!): String!

Returns the value of the property with the specified key.

getRingerMode

open fun getRingerMode(): Int

Returns the current ringtone mode.

getRouting

open fun getRouting(mode: Int): Int

Deprecated: 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.

getSpatializer

open fun getSpatializer(): Spatializer

Return a handle to the optional platform's Spatializer

getStreamMaxVolume

open fun getStreamMaxVolume(streamType: Int): Int

Returns the maximum volume index for a particular stream.

getStreamMinVolume

open fun getStreamMinVolume(streamType: Int): Int

Returns the minimum volume index for a particular stream.

getStreamVolume

open fun getStreamVolume(streamType: Int): Int

Returns the current volume index for a particular stream.

getStreamVolumeDb

open fun getStreamVolumeDb(
    streamType: Int, 
    index: Int, 
    deviceType: Int
): Float

Returns the volume in dB (decibel) for the given stream type at the given volume index, on the given type of audio output device.

getSupportedDeviceTypes

open fun getSupportedDeviceTypes(direction: Int): MutableSet<Int!>

Returns a Set of unique Integers corresponding to audio device type identifiers that can potentially be connected to the system and meeting the criteria specified in the direction parameter. Note that this set contains AudioDeviceInfo device type identifiers for both devices currently available and those that can be available if the user connects an audio peripheral. Examples include TYPE_WIRED_HEADSET if the Android device supports an analog headset jack or TYPE_USB_DEVICE if the Android device supports a USB host-mode port. These are generally a superset of device type identifiers associated with the AudioDeviceInfo objects returned from AudioManager.getDevices().

getSupportedMixerAttributes

open fun getSupportedMixerAttributes(device: AudioDeviceInfo): MutableList<AudioMixerAttributes!>

Returns the AudioMixerAttributes that can be used to set as preferred mixer attributes via setPreferredMixerAttributes(android.media.AudioAttributes,android.media.AudioDeviceInfo,android.media.AudioMixerAttributes).

Note that only USB devices are guaranteed to expose configurable mixer attributes. An empty list may be returned for all other types of devices as they may not allow dynamic configuration.

getVibrateSetting

open fun getVibrateSetting(vibrateType: Int): Int

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