lightbulb_outline Help shape the future of the Google Play Console, Android Studio, and Firebase. Start survey

belongs to Maven artifact androidx.media:media:1.0.0-alpha3

AudioAttributesCompat

public class AudioAttributesCompat
extends Object

java.lang.Object
   ↳ androidx.media.AudioAttributesCompat


A class to encapsulate a collection of attributes describing information about an audio stream.

AudioAttributesCompat 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 and USAGE_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 in AudioAttributesCompat and it is recommended to build any instance with this information supplied, see AudioAttributesCompat.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 or CONTENT_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.

AudioAttributesCompat instance is built through its builder, AudioAttributesCompat.Builder. Also see AudioAttributes for the framework implementation of this class.

Summary

Nested classes

class AudioAttributesCompat.Builder

Builder class for AudioAttributesCompat objects. 

Constants

int CONTENT_TYPE_MOVIE

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

int CONTENT_TYPE_MUSIC

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

int CONTENT_TYPE_SONIFICATION

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.

int CONTENT_TYPE_SPEECH

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

int CONTENT_TYPE_UNKNOWN

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

int FLAG_AUDIBILITY_ENFORCED

Flag defining a behavior where the audibility of the sound will be ensured by the system.

int FLAG_HW_AV_SYNC

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

int USAGE_ALARM

Usage value to use when the usage is an alarm (e.g.

int USAGE_ASSISTANCE_ACCESSIBILITY

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

int USAGE_ASSISTANCE_NAVIGATION_GUIDANCE

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

int USAGE_ASSISTANCE_SONIFICATION

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

int USAGE_ASSISTANT

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

int USAGE_GAME

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

int USAGE_MEDIA

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

int USAGE_NOTIFICATION

Usage value to use when the usage is notification.

int USAGE_NOTIFICATION_COMMUNICATION_DELAYED

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

int USAGE_NOTIFICATION_COMMUNICATION_INSTANT

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

int USAGE_NOTIFICATION_COMMUNICATION_REQUEST

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

int USAGE_NOTIFICATION_EVENT

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

int USAGE_NOTIFICATION_RINGTONE

Usage value to use when the usage is telephony ringtone.

int USAGE_UNKNOWN

Usage value to use when the usage is unknown.

int USAGE_VOICE_COMMUNICATION

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

int USAGE_VOICE_COMMUNICATION_SIGNALLING

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

Public methods

boolean equals(Object o)
int getContentType()

Return the content type.

int getFlags()

Return the flags.

int getLegacyStreamType()

Return a stream type passed to AudioAttributesCompat.Builder.setLegacyStreamType(int), or -1 if no legacy stream is available

int getUsage()

Return the usage.

int getVolumeControlStream()

Returns the stream type matching the given attributes for volume control.

int hashCode()
String toString()
Object unwrap()

If the current SDK level is 21 or higher, return the AudioAttributes object inside this AudioAttributesCompat.

static AudioAttributesCompat wrap(Object aa)

Create an AudioAttributesCompat given an API 21 AudioAttributes object.

Inherited methods

Constants

CONTENT_TYPE_MOVIE

public static final int CONTENT_TYPE_MOVIE

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

Constant Value: 3 (0x00000003)

CONTENT_TYPE_MUSIC

public static final int CONTENT_TYPE_MUSIC

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

Constant Value: 2 (0x00000002)

CONTENT_TYPE_SONIFICATION

public static final int CONTENT_TYPE_SONIFICATION

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.

Constant Value: 4 (0x00000004)

CONTENT_TYPE_SPEECH

public static final int CONTENT_TYPE_SPEECH

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

Constant Value: 1 (0x00000001)

CONTENT_TYPE_UNKNOWN

public static final int CONTENT_TYPE_UNKNOWN

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

Constant Value: 0 (0x00000000)

FLAG_AUDIBILITY_ENFORCED

public static final int FLAG_AUDIBILITY_ENFORCED

Flag defining a behavior where the audibility of the sound will be ensured by the system.

Constant Value: 1 (0x00000001)

FLAG_HW_AV_SYNC

public static final int FLAG_HW_AV_SYNC

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

Constant Value: 16 (0x00000010)

USAGE_ALARM

public static final int USAGE_ALARM

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

Constant Value: 4 (0x00000004)

USAGE_ASSISTANCE_ACCESSIBILITY

public static final int USAGE_ASSISTANCE_ACCESSIBILITY

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

Constant Value: 11 (0x0000000b)

USAGE_ASSISTANCE_NAVIGATION_GUIDANCE

public static final int USAGE_ASSISTANCE_NAVIGATION_GUIDANCE

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

Constant Value: 12 (0x0000000c)

USAGE_ASSISTANCE_SONIFICATION

public static final int USAGE_ASSISTANCE_SONIFICATION

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

Constant Value: 13 (0x0000000d)

USAGE_ASSISTANT

public static final int USAGE_ASSISTANT

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

Constant Value: 16 (0x00000010)

USAGE_GAME

public static final int USAGE_GAME

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

Constant Value: 14 (0x0000000e)

USAGE_MEDIA

public static final int USAGE_MEDIA

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

Constant Value: 1 (0x00000001)

USAGE_NOTIFICATION

public static final int USAGE_NOTIFICATION

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

Constant Value: 5 (0x00000005)

USAGE_NOTIFICATION_COMMUNICATION_DELAYED

public static final int USAGE_NOTIFICATION_COMMUNICATION_DELAYED

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

Constant Value: 9 (0x00000009)

USAGE_NOTIFICATION_COMMUNICATION_INSTANT

public static final int USAGE_NOTIFICATION_COMMUNICATION_INSTANT

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

Constant Value: 8 (0x00000008)

USAGE_NOTIFICATION_COMMUNICATION_REQUEST

public static final int USAGE_NOTIFICATION_COMMUNICATION_REQUEST

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

Constant Value: 7 (0x00000007)

USAGE_NOTIFICATION_EVENT

public static final int USAGE_NOTIFICATION_EVENT

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

Constant Value: 10 (0x0000000a)

USAGE_NOTIFICATION_RINGTONE

public static final int USAGE_NOTIFICATION_RINGTONE

Usage value to use when the usage is telephony ringtone.

Constant Value: 6 (0x00000006)

USAGE_UNKNOWN

public static final int USAGE_UNKNOWN

Usage value to use when the usage is unknown.

Constant Value: 0 (0x00000000)

USAGE_VOICE_COMMUNICATION

public static final int USAGE_VOICE_COMMUNICATION

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

Constant Value: 2 (0x00000002)

USAGE_VOICE_COMMUNICATION_SIGNALLING

public static final int USAGE_VOICE_COMMUNICATION_SIGNALLING

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

Constant Value: 3 (0x00000003)

Public methods

equals

public boolean equals (Object o)

Parameters
o Object

Returns
boolean

getContentType

public int getContentType ()

Return the content type.

Returns
int one of the values that can be set in AudioAttributesCompat.Builder.setContentType(int)

getFlags

public int getFlags ()

Return the flags.

Returns
int a combined mask of all flags

getLegacyStreamType

public int getLegacyStreamType ()

Return a stream type passed to AudioAttributesCompat.Builder.setLegacyStreamType(int), or -1 if no legacy stream is available

Returns
int the stream type

getUsage

public int getUsage ()

Return the usage.

Returns
int one of the values that can be set in AudioAttributesCompat.Builder.setUsage(int)

getVolumeControlStream

public int getVolumeControlStream ()

Returns the stream type matching the given attributes for volume control. Use this method to derive the stream type needed to configure the volume control slider in an Activity with Activity.setVolumeControlStream(int).
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.

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

hashCode

public int hashCode ()

Returns
int

toString

public String toString ()

Returns
String

unwrap

public Object unwrap ()

If the current SDK level is 21 or higher, return the AudioAttributes object inside this AudioAttributesCompat. Otherwise null.

Returns
Object the underlying AudioAttributes object or null

wrap

public static AudioAttributesCompat wrap (Object aa)

Create an AudioAttributesCompat given an API 21 AudioAttributes object.

Parameters
aa Object: an instance of AudioAttributes

Returns
AudioAttributesCompat the new AudioAttributesCompat, or null on API < 21