AudioAttributesCompat

public class AudioAttributesCompat
extends Object implements VersionedParcelable

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

Returns the content type.

int getFlags()

Returns the flags.

int getLegacyStreamType()

Returns a stream type passed to AudioAttributesCompat.Builder.setLegacyStreamType(int), or best guessing from flags and usage, or -1 if there is no converting logic in framework side (API 21+).

int getUsage()

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

Creates an AudioAttributesCompat given an API 21 AudioAttributes object.

Inherited methods