AudioAttributes

ALLOW_CAPTURE_BY_ALL

static val ALLOW_CAPTURE_BY_ALL: Int

Indicates that the audio may be captured by any app. For privacy, the following usages cannot be recorded: VOICE_COMMUNICATION*, USAGE_NOTIFICATION*, USAGE_ASSISTANCE* and USAGE_ASSISTANT. On android.os.Build.VERSION_CODES#Q, this means only USAGE_UNKNOWN, USAGE_MEDIA and USAGE_GAME may be captured. See android.media.projection.MediaProjection and Builder#setAllowedCapturePolicy.

Value: 1

ALLOW_CAPTURE_BY_NONE

static val ALLOW_CAPTURE_BY_NONE: Int

Indicates that the audio is not to be recorded by any app, even if it is a system app. It is encouraged to use ALLOW_CAPTURE_BY_SYSTEM instead of this value as system apps provide significant and useful features for the user (such as live captioning and accessibility). See Builder#setAllowedCapturePolicy.

Value: 3

ALLOW_CAPTURE_BY_SYSTEM

static val ALLOW_CAPTURE_BY_SYSTEM: Int

Indicates that the audio may only be captured by system apps. System apps can capture for many purposes like accessibility, live captions, user guidance... but abide to the following restrictions: - the audio cannot leave the device - the audio cannot be passed to a third party app - the audio cannot be recorded at a higher quality than 16kHz 16bit mono See Builder#setAllowedCapturePolicy.

Value: 2

CONTENT_TYPE_MOVIE

static val CONTENT_TYPE_MOVIE: Int

Content type value to use when the content type is a soundtrack, typically accompanying a movie or TV program.

Value: 3

CONTENT_TYPE_MUSIC

static val CONTENT_TYPE_MUSIC: Int

Content type value to use when the content type is music.

Value: 2

CONTENT_TYPE_SONIFICATION

static val CONTENT_TYPE_SONIFICATION: Int

Content type value to use when the content type is a sound used to accompany a user action, such as a beep or sound effect expressing a key click, or event, such as the type of a sound for a bonus being received in a game. These sounds are mostly synthesized or short Foley sounds.

Value: 4

CONTENT_TYPE_SPEECH

static val CONTENT_TYPE_SPEECH: Int

Content type value to use when the content type is speech.

Value: 1

CONTENT_TYPE_UNKNOWN

static val CONTENT_TYPE_UNKNOWN: Int

Content type value to use when the content type is unknown, or other than the ones defined.

Value: 0

FLAG_AUDIBILITY_ENFORCED

static val FLAG_AUDIBILITY_ENFORCED: Int

Flag defining a behavior where the audibility of the sound will be ensured by the system. To ensure sound audibility, the system only uses built-in speakers or wired headphones and specifically excludes wireless audio devices.

Note this flag should only be used for sounds subject to regulatory behaviors in some countries, such as for camera shutter sound, and not for routing behaviors.

Value: 1

FLAG_HW_AV_SYNC

static val FLAG_HW_AV_SYNC: Int

Flag requesting the use of an output stream supporting hardware A/V synchronization.

Value: 16

FLAG_LOW_LATENCY

static val FLAG_LOW_LATENCY: Int

Deprecated: Use AudioTrack.Builder#setPerformanceMode(int) with AudioTrack#PERFORMANCE_MODE_LOW_LATENCY to control performance.

Flag requesting a low latency path when creating an AudioTrack. When using this flag, the sample rate must match the native sample rate of the device. Effects processing is also unavailable. Note that if this flag is used without specifying a bufferSizeInBytes then the AudioTrack's actual buffer size may be too small. It is recommended that a fairly large buffer should be specified when the AudioTrack is created. Then the actual size can be reduced by calling AudioTrack#setBufferSizeInFrames(int). The buffer size can be optimized by lowering it after each write() call until the audio glitches, which is detected by calling AudioTrack#getUnderrunCount(). Then the buffer size can be increased until there are no glitches. This tuning step should be done while playing silence. This technique provides a compromise between latency and glitch rate.

Value: 256

SPATIALIZATION_BEHAVIOR_AUTO

static val SPATIALIZATION_BEHAVIOR_AUTO: Int

Constant indicating the audio content associated with these attributes will follow the default platform behavior with regards to which content will be spatialized or not.

Value: 0

SPATIALIZATION_BEHAVIOR_NEVER

static val SPATIALIZATION_BEHAVIOR_NEVER: Int

Constant indicating the audio content associated with these attributes should never be virtualized.

Value: 1

USAGE_ALARM

static val USAGE_ALARM: Int

Usage value to use when the usage is an alarm (e.g. wake-up alarm).

Value: 4

USAGE_ASSISTANCE_ACCESSIBILITY

static val USAGE_ASSISTANCE_ACCESSIBILITY: Int

Usage value to use when the usage is for accessibility, such as with a screen reader.

Value: 11

USAGE_ASSISTANCE_NAVIGATION_GUIDANCE

static val USAGE_ASSISTANCE_NAVIGATION_GUIDANCE: Int

Usage value to use when the usage is driving or navigation directions.

Value: 12

USAGE_ASSISTANCE_SONIFICATION

static val USAGE_ASSISTANCE_SONIFICATION: Int

Usage value to use when the usage is sonification, such as with user interface sounds.

Value: 13

USAGE_ASSISTANT

static val USAGE_ASSISTANT: Int

Usage value to use for audio responses to user queries, audio instructions or help utterances.

Value: 16

USAGE_GAME

static val USAGE_GAME: Int

Usage value to use when the usage is for game audio.

Value: 14

USAGE_MEDIA

static val USAGE_MEDIA: Int

Usage value to use when the usage is media, such as music, or movie soundtracks.

Value: 1

USAGE_NOTIFICATION

static val USAGE_NOTIFICATION: Int

Usage value to use when the usage is notification. See other notification usages for more specialized uses.

Value: 5

USAGE_NOTIFICATION_COMMUNICATION_DELAYED

static val USAGE_NOTIFICATION_COMMUNICATION_DELAYED: Int

Deprecated: Use USAGE_NOTIFICATION which is handled the same way as this usage by the audio framework

Usage value to use when the usage is notification for a non-immediate type of communication such as e-mail.

Value: 9

USAGE_NOTIFICATION_COMMUNICATION_INSTANT

static val USAGE_NOTIFICATION_COMMUNICATION_INSTANT: Int

Deprecated: Use USAGE_NOTIFICATION which is handled the same way as this usage by the audio framework

Usage value to use when the usage is notification for an "instant" communication such as a chat, or SMS.

Value: 8

USAGE_NOTIFICATION_COMMUNICATION_REQUEST

static val USAGE_NOTIFICATION_COMMUNICATION_REQUEST: Int

Deprecated: Use USAGE_NOTIFICATION which is handled the same way as this usage by the audio framework

Usage value to use when the usage is a request to enter/end a communication, such as a VoIP communication or video-conference.

Value: 7

USAGE_NOTIFICATION_EVENT

static val USAGE_NOTIFICATION_EVENT: Int

Usage value to use when the usage is to attract the user's attention, such as a reminder or low battery warning.

Value: 10

USAGE_NOTIFICATION_RINGTONE

static val USAGE_NOTIFICATION_RINGTONE: Int

Usage value to use when the usage is telephony ringtone.

Value: 6

USAGE_UNKNOWN

static val USAGE_UNKNOWN: Int

Usage value to use when the usage is unknown.

Value: 0

USAGE_VOICE_COMMUNICATION

static val USAGE_VOICE_COMMUNICATION: Int

Usage value to use when the usage is voice communications, such as telephony or VoIP.

Value: 2

USAGE_VOICE_COMMUNICATION_SIGNALLING

static val USAGE_VOICE_COMMUNICATION_SIGNALLING: Int

Usage value to use when the usage is in-call signalling, such as with a "busy" beep, or DTMF tones.

Value: 3

areHapticChannelsMuted

fun areHapticChannelsMuted(): Boolean

Return if haptic channels are muted.

describeContents

fun describeContents(): Int

equals

fun equals(other: Any?): Boolean

getAllowedCapturePolicy

fun getAllowedCapturePolicy(): Int

Return the capture policy.

getContentType

fun getContentType(): Int

Return the content type.

getFlags

fun getFlags(): Int

Return the flags.

getSpatializationBehavior

fun getSpatializationBehavior(): Int

Return the behavior affecting whether spatialization will be used.

getUsage

fun getUsage(): Int

Return the usage.

getVolumeControlStream

fun getVolumeControlStream(): Int

Returns the stream type matching this AudioAttributes instance for volume control. Use this method to derive the stream type needed to configure the volume control slider in an android.app.Activity with android.app.Activity#setVolumeControlStream(int) for playback conducted with these attributes.
Do not use this method to set the stream type on an audio player object (e.g. AudioTrack, MediaPlayer) as this is deprecated, use AudioAttributes instead.

hashCode

fun hashCode(): Int

isContentSpatialized

fun isContentSpatialized(): Boolean

Return true if the audio content associated with these attributes has already been spatialized, that is it has already been processed to offer a binaural or transaural immersive audio experience.

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

CREATOR

static val CREATOR: Parcelable.Creator<AudioAttributes!>