AudioProfile

public class AudioProfile
extends Object implements Parcelable

java.lang.Object
   ↳ android.media.AudioProfile


An AudioProfile is specific to an audio format and lists supported sampling rates and channel masks for that format. An AudioDeviceInfo has a list of supported AudioProfiles. There can be multiple profiles whose encoding format is the same. This usually happens when an encoding format is only supported when it is encapsulated by some particular encapsulation types. If there are multiple encapsulation types that can carry this encoding format, they will be reported in different audio profiles. The application can choose any of the encapsulation types.

Summary

Constants

int AUDIO_ENCAPSULATION_TYPE_IEC61937

Encapsulation format is defined in standard IEC 61937.

int AUDIO_ENCAPSULATION_TYPE_NONE

No encapsulation type is specified.

int AUDIO_ENCAPSULATION_TYPE_PCM

Encapsulation format is PCM, which can be used by other formats that can be wrapped in a PCM frame, such as DSD(Direct Stream Digital).

Inherited constants

Fields

public static final Creator<AudioProfile> CREATOR

Public methods

int describeContents()

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

boolean equals(Object o)

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

int[] getChannelIndexMasks()
int[] getChannelMasks()
int getEncapsulationType()

The encapsulation type indicates what encapsulation type is required when the framework is using this format when playing to a device exposing this audio profile.

int getFormat()
int[] getSampleRates()
int hashCode()

Returns a hash code value for the object.

String toString()

Returns a string representation of the object.

void writeToParcel(Parcel dest, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

AUDIO_ENCAPSULATION_TYPE_IEC61937

Added in API level 31
public static final int AUDIO_ENCAPSULATION_TYPE_IEC61937

Encapsulation format is defined in standard IEC 61937.

Constant Value: 1 (0x00000001)

AUDIO_ENCAPSULATION_TYPE_NONE

Added in API level 31
public static final int AUDIO_ENCAPSULATION_TYPE_NONE

No encapsulation type is specified.

Constant Value: 0 (0x00000000)

AUDIO_ENCAPSULATION_TYPE_PCM

Added in API level 34
public static final int AUDIO_ENCAPSULATION_TYPE_PCM

Encapsulation format is PCM, which can be used by other formats that can be wrapped in a PCM frame, such as DSD(Direct Stream Digital).

Constant Value: 2 (0x00000002)

Fields

CREATOR

Added in API level 33
public static final Creator<AudioProfile> CREATOR

Public methods

describeContents

Added in API level 33
public int describeContents ()

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.

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

equals

Added in API level 31
public boolean equals (Object o)

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
o Object: the reference object with which to compare.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

getChannelIndexMasks

Added in API level 31
public int[] getChannelIndexMasks ()

Returns
int[] an array of channel index masks that are associated with the encoding format. This value cannot be null.

getChannelMasks

Added in API level 31
public int[] getChannelMasks ()

Returns
int[] an array of channel position masks that are associated with the encoding format. This value cannot be null.

getEncapsulationType

Added in API level 31
public int getEncapsulationType ()

The encapsulation type indicates what encapsulation type is required when the framework is using this format when playing to a device exposing this audio profile. When encapsulation is required, only playback with AudioTrack API is supported. But playback with MediaPlayer is not. When an encapsulation type is required, the AudioFormat encoding selected when creating the AudioTrack must match the encapsulation type, e.g AudioFormat.ENCODING_IEC61937 for AUDIO_ENCAPSULATION_TYPE_IEC61937.

Returns
int an integer representing the encapsulation type Value is AUDIO_ENCAPSULATION_TYPE_NONE, AUDIO_ENCAPSULATION_TYPE_IEC61937, or AUDIO_ENCAPSULATION_TYPE_PCM

getFormat

Added in API level 31
public int getFormat ()

Returns
int the encoding format for this AudioProfile. Value is AudioFormat.ENCODING_DEFAULT, AudioFormat.ENCODING_PCM_16BIT, AudioFormat.ENCODING_PCM_8BIT, AudioFormat.ENCODING_PCM_FLOAT, AudioFormat.ENCODING_AC3, AudioFormat.ENCODING_E_AC3, AudioFormat.ENCODING_DTS, AudioFormat.ENCODING_DTS_HD, AudioFormat.ENCODING_MP3, AudioFormat.ENCODING_AAC_LC, AudioFormat.ENCODING_AAC_HE_V1, AudioFormat.ENCODING_AAC_HE_V2, AudioFormat.ENCODING_IEC61937, AudioFormat.ENCODING_DOLBY_TRUEHD, AudioFormat.ENCODING_AAC_ELD, AudioFormat.ENCODING_AAC_XHE, AudioFormat.ENCODING_AC4, AudioFormat.ENCODING_E_AC3_JOC, AudioFormat.ENCODING_DOLBY_MAT, AudioFormat.ENCODING_OPUS, AudioFormat.ENCODING_PCM_24BIT_PACKED, AudioFormat.ENCODING_PCM_32BIT, AudioFormat.ENCODING_MPEGH_BL_L3, AudioFormat.ENCODING_MPEGH_BL_L4, AudioFormat.ENCODING_MPEGH_LC_L3, AudioFormat.ENCODING_MPEGH_LC_L4, AudioFormat.ENCODING_DTS_UHD_P1, AudioFormat.ENCODING_DRA, AudioFormat.ENCODING_DTS_HD_MA, AudioFormat.ENCODING_DTS_UHD_P2, or AudioFormat.ENCODING_DSD

getSampleRates

Added in API level 31
public int[] getSampleRates ()

Returns
int[] an array of sample rates that are associated with the encoding format. This value cannot be null.

hashCode

Added in API level 31
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by 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.

Returns
int a hash code value for this object.

toString

Added in API level 31
public String toString ()

Returns a string representation of the object.

Returns
String a string representation of the object.

writeToParcel

Added in API level 33
public void writeToParcel (Parcel dest, 
                int flags)

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.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES