AudioAttributes
class AudioAttributes : Parcelable
kotlin.Any | |
↳ | android.media.AudioAttributes |
A class to encapsulate a collection of attributes describing information about an audio stream.
AudioAttributes
supersede the notion of stream types (see for instance AudioManager#STREAM_MUSIC
or AudioManager#STREAM_ALARM
) for defining the behavior of audio playback. Attributes allow an application to specify more information than is conveyed in a stream type by allowing the application to define:
- usage: "why" you are playing a sound, what is this sound used for. This is achieved with the "usage" information. Examples of usage are
USAGE_MEDIA
andUSAGE_ALARM
. These two examples are the closest to stream types, but more detailed use cases are available. Usage information is more expressive than a stream type, and allows certain platforms or routing policies to use this information for more refined volume or routing decisions. Usage is the most important information to supply inAudioAttributes
and it is recommended to build any instance with this information supplied, seeAudioAttributes.Builder
for exceptions. - content type: "what" you are playing. The content type expresses the general category of the content. This information is optional. But in case it is known (for instance
CONTENT_TYPE_MOVIE
for a movie streaming service orCONTENT_TYPE_MUSIC
for a music playback application) this information might be used by the audio framework to selectively configure some audio post-processing blocks. - flags: "how" is playback to be affected, see the flag definitions for the specific playback behaviors they control.
AudioAttributes
are used for example in one of the AudioTrack
constructors (see AudioTrack#AudioTrack(AudioAttributes, AudioFormat, int, int, int)
), to configure a MediaPlayer
(see MediaPlayer#setAudioAttributes(AudioAttributes)
or a android.app.Notification
(see android.app.Notification#audioAttributes
). An AudioAttributes
instance is built through its builder, AudioAttributes.Builder
.
Summary
Nested classes | |
---|---|
Builder class for |
Constants | |
---|---|
static Int |
Indicates that the audio may be captured by any app. |
static Int |
Indicates that the audio is not to be recorded by any app, even if it is a system app. |
static Int |
Indicates that the audio may only be captured by system apps. |
static Int |
Content type value to use when the content type is a soundtrack, typically accompanying a movie or TV program. |
static Int |
Content type value to use when the content type is music. |
static 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. |
static Int |
Content type value to use when the content type is speech. |
static Int |
Content type value to use when the content type is unknown, or other than the ones defined. |
static Int |
Flag defining a behavior where the audibility of the sound will be ensured by the system. |
static Int |
Flag requesting the use of an output stream supporting hardware A/V synchronization. |
static Int |
Flag requesting a low latency path when creating an AudioTrack. |
static 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. |
static Int |
Constant indicating the audio content associated with these attributes should never be virtualized. |
static Int |
Usage value to use when the usage is an alarm (e.g. wake-up alarm). |
static Int |
Usage value to use when the usage is for accessibility, such as with a screen reader. |
static Int |
Usage value to use when the usage is driving or navigation directions. |
static Int |
Usage value to use when the usage is sonification, such as with user interface sounds. |
static Int |
Usage value to use for audio responses to user queries, audio instructions or help utterances. |
static Int |
Usage value to use when the usage is for game audio. |
static Int |
Usage value to use when the usage is media, such as music, or movie soundtracks. |
static Int |
Usage value to use when the usage is notification. |
static Int |
Usage value to use when the usage is notification for a non-immediate type of communication such as e-mail. |
static Int |
Usage value to use when the usage is notification for an "instant" communication such as a chat, or SMS. |
static Int |
Usage value to use when the usage is a request to enter/end a communication, such as a VoIP communication or video-conference. |
static Int |
Usage value to use when the usage is to attract the user's attention, such as a reminder or low battery warning. |
static Int |
Usage value to use when the usage is telephony ringtone. |
static Int |
Usage value to use when the usage is unknown. |
static Int |
Usage value to use when the usage is voice communications, such as telephony or VoIP. |
static Int |
Usage value to use when the usage is in-call signalling, such as with a "busy" beep, or DTMF tones. |
Inherited constants | |
---|---|
Public methods | |
---|---|
Boolean |
Return if haptic channels are muted. |
Int | |
Boolean | |
Int |
Return the capture policy. |
Int |
Return the content type. |
Int |
getFlags() Return the flags. |
Int |
Return the behavior affecting whether spatialization will be used. |
Int |
getUsage() Return the usage. |
Int |
Returns the stream type matching this |
Int |
hashCode() |
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. |
String |
toString() |
Unit |
writeToParcel(dest: Parcel, flags: Int) |
Properties | |
---|---|
static Parcelable.Creator<AudioAttributes!> |
Constants
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 valFLAG_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 valUSAGE_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 valUSAGE_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 valUSAGE_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
Public methods
areHapticChannelsMuted
fun areHapticChannelsMuted(): Boolean
Return if haptic channels are muted.
Return | |
---|---|
Boolean |
true if haptic channels are muted, false otherwise. |
describeContents
fun describeContents(): Int
Return | |
---|---|
Int |
a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR |
equals
fun equals(other: Any?): Boolean
Parameters | |
---|---|
obj |
the reference object with which to compare. |
Return | |
---|---|
Boolean |
true if this object is the same as the obj argument; false otherwise. |
getAllowedCapturePolicy
fun getAllowedCapturePolicy(): Int
Return the capture policy.
Return | |
---|---|
Int |
the capture policy set by Builder#setAllowedCapturePolicy(int) or the default if it was not called. Value is android.media.AudioAttributes#ALLOW_CAPTURE_BY_ALL , android.media.AudioAttributes#ALLOW_CAPTURE_BY_SYSTEM , or android.media.AudioAttributes#ALLOW_CAPTURE_BY_NONE |
getContentType
fun getContentType(): Int
Return the content type.
Return | |
---|---|
Int |
one of the values that can be set in Builder#setContentType(int) |
getFlags
fun getFlags(): Int
Return the flags.
Return | |
---|---|
Int |
a combined mask of all flags |
getSpatializationBehavior
fun getSpatializationBehavior(): Int
Return the behavior affecting whether spatialization will be used.
Return | |
---|---|
Int |
the spatialization behavior Value is android.media.AudioAttributes#SPATIALIZATION_BEHAVIOR_AUTO , or android.media.AudioAttributes#SPATIALIZATION_BEHAVIOR_NEVER |
getUsage
fun getUsage(): Int
Return the usage.
Return | |
---|---|
Int |
one of the values that can be set in Builder#setUsage(int) |
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.
Return | |
---|---|
Int |
a valid stream type for Activity or stream volume control that matches the attributes, or AudioManager#USE_DEFAULT_STREAM_TYPE if there isn't a direct match. Note that USE_DEFAULT_STREAM_TYPE is not a valid value for AudioManager#setStreamVolume(int, int, 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.
Return | |
---|---|
Boolean |
true if the content has been processed |
toString
fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |
writeToParcel
fun writeToParcel(
dest: Parcel,
flags: Int
): Unit
Parameters | |
---|---|
dest |
Parcel: The Parcel in which the object should be written. This value cannot be null . |
flags |
Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE . Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |