Added in API level 28

AudioPresentation


class AudioPresentation : Parcelable
kotlin.Any
   ↳ android.media.AudioPresentation

The AudioPresentation class encapsulates the information that describes an audio presentation which is available in next generation audio content. Used by MediaExtractor MediaExtractor.getAudioPresentations(int) and AudioTrack AudioTrack.setPresentation(AudioPresentation) to query available presentations and to select one, respectively. A list of available audio presentations in a media source can be queried using MediaExtractor.getAudioPresentations(int). This list can be presented to a user for selection. An AudioPresentation can be passed to an offloaded audio decoder via AudioTrack.setPresentation(AudioPresentation) to request decoding of the selected presentation. An audio stream may contain multiple presentations that differ by language, accessibility, end point mastering and dialogue enhancement. An audio presentation may also have a set of description labels in different languages to help the user to make an informed selection. Applications that parse media streams and extract presentation information on their own can create instances of AudioPresentation by using AudioPresentation.Builder class.

Summary

Nested classes

A builder class for creating AudioPresentation objects.

Constants
static Int

Audio presentation content classifier: Commentary.

static Int

Audio presentation content classifier: Dialog.

static Int

Audio presentation content classifier: Emergency.

static Int

Audio presentation content classifier: Hearing impaired.

static Int

Audio presentation classifier: Complete main.

static Int

Audio presentation content classifier: Music and effects.

static Int

Audio presentation classifier: Unknown.

static Int

Audio presentation content classifier: Visually impaired.

static Int

Audio presentation content classifier: Voice over.

static Int

Three-dimensional (e.g. 5.1.2) speaker layout.

static Int

Prerendered for headphone playback.

static Int

Stereo speaker layout.

static Int

Two-dimensional (e.g. 5.1) speaker layout.

static Int

No preferred reproduction channel layout.

static Int

Unknown audio presentation ID, this indicates audio presentation ID is not selected.

static Int

Unknown audio program ID, this indicates audio program ID is not selected.

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

Boolean
equals(other: Any?)

Indicates whether some other object is "equal to" this one.

MutableMap<Locale!, String!>!

Locale!

Int

Int

Returns presentation ID used by the framework to select an audio presentation rendered by a decoder.

Int

Returns program ID used by the framework to select an audio presentation rendered by a decoder.

Boolean

Indicates whether an audio description for the visually impaired is available.

Boolean

Indicates whether dialogue enhancement is available.

Boolean

Indicates whether spoken subtitles for the visually impaired are available.

Int

Returns a hash code value for the object.

String

Returns a string representation of the object.

Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<AudioPresentation!>

Constants

CONTENT_COMMENTARY

Added in API level 31
static val CONTENT_COMMENTARY: Int

Audio presentation content classifier: Commentary.

Value: 5

CONTENT_DIALOG

Added in API level 31
static val CONTENT_DIALOG: Int

Audio presentation content classifier: Dialog.

Value: 4

CONTENT_EMERGENCY

Added in API level 31
static val CONTENT_EMERGENCY: Int

Audio presentation content classifier: Emergency.

Value: 6

CONTENT_HEARING_IMPAIRED

Added in API level 31
static val CONTENT_HEARING_IMPAIRED: Int

Audio presentation content classifier: Hearing impaired.

Value: 3

CONTENT_MAIN

Added in API level 31
static val CONTENT_MAIN: Int

Audio presentation classifier: Complete main.

Value: 0

CONTENT_MUSIC_AND_EFFECTS

Added in API level 31
static val CONTENT_MUSIC_AND_EFFECTS: Int

Audio presentation content classifier: Music and effects.

Value: 1

CONTENT_UNKNOWN

Added in API level 31
static val CONTENT_UNKNOWN: Int

Audio presentation classifier: Unknown.

Value: -1

CONTENT_VISUALLY_IMPAIRED

Added in API level 31
static val CONTENT_VISUALLY_IMPAIRED: Int

Audio presentation content classifier: Visually impaired.

Value: 2

CONTENT_VOICEOVER

Added in API level 31
static val CONTENT_VOICEOVER: Int

Audio presentation content classifier: Voice over.

Value: 7

MASTERED_FOR_3D

Added in API level 28
static val MASTERED_FOR_3D: Int

Three-dimensional (e.g. 5.1.2) speaker layout.

Value: 3

MASTERED_FOR_HEADPHONE

Added in API level 28
static val MASTERED_FOR_HEADPHONE: Int

Prerendered for headphone playback.

Value: 4

MASTERED_FOR_STEREO

Added in API level 28
static val MASTERED_FOR_STEREO: Int

Stereo speaker layout.

Value: 1

MASTERED_FOR_SURROUND

Added in API level 28
static val MASTERED_FOR_SURROUND: Int

Two-dimensional (e.g. 5.1) speaker layout.

Value: 2

MASTERING_NOT_INDICATED

Added in API level 28
static val MASTERING_NOT_INDICATED: Int

No preferred reproduction channel layout.

Value: 0

PRESENTATION_ID_UNKNOWN

Added in API level 34
static val PRESENTATION_ID_UNKNOWN: Int

Unknown audio presentation ID, this indicates audio presentation ID is not selected.

Value: -1

PROGRAM_ID_UNKNOWN

Added in API level 34
static val PROGRAM_ID_UNKNOWN: Int

Unknown audio program ID, this indicates audio program ID is not selected.

Value: -1

Public methods

describeContents

Added in API level 34
fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Return
Int a bitmask indicating the set of special object types marshaled by this Parcelable object instance.
Value is either 0 or

equals

Added in API level 28
fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getLabels

Added in API level 28
fun getLabels(): MutableMap<Locale!, String!>!
Return
MutableMap<Locale!, String!>! a map of available text labels for this presentation. Each label is indexed by its locale corresponding to the language code as specified by ISO 639-2. Either ISO 639-2/B or ISO 639-2/T could be used.

getLocale

Added in API level 28
fun getLocale(): Locale!
Return
Locale! the locale corresponding to audio presentation's ISO 639-1/639-2 language code.

getPresentationId

Added in API level 29
fun getPresentationId(): Int

Returns presentation ID used by the framework to select an audio presentation rendered by a decoder. Presentation ID is typically sequential, but does not have to be.

getProgramId

Added in API level 29
fun getProgramId(): Int

Returns program ID used by the framework to select an audio presentation rendered by a decoder. Program ID can be used to further uniquely identify the presentation to a decoder.

hasAudioDescription

Added in API level 28
fun hasAudioDescription(): Boolean

Indicates whether an audio description for the visually impaired is available.

Return
Boolean true if audio description is available.

hasDialogueEnhancement

Added in API level 28
fun hasDialogueEnhancement(): Boolean

Indicates whether dialogue enhancement is available.

Return
Boolean true if dialogue enhancement is available.

hasSpokenSubtitles

Added in API level 28
fun hasSpokenSubtitles(): Boolean

Indicates whether spoken subtitles for the visually impaired are available.

Return
Boolean true if spoken subtitles are available.

hashCode

Added in API level 28
fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Return
Int a hash code value for this object.

toString

Added in API level 28
fun toString(): String

Returns a string representation of the object.

Return
String a string representation of the object.

writeToParcel

Added in API level 34
fun writeToParcel(
    dest: Parcel,
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: 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 the following:

Properties

CREATOR

Added in API level 34
static val CREATOR: Parcelable.Creator<AudioPresentation!>