AudioProfile
open class AudioProfile : Parcelable
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
| static Int |
Encapsulation format is defined in standard IEC 61937. |
| static Int |
No encapsulation type is specified. |
| static Int |
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 | |
|---|---|
| Public methods | |
|---|---|
| open Int |
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
| open Boolean |
Indicates whether some other object is "equal to" this one. |
| open IntArray | |
| open IntArray | |
| open Int |
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. |
| open Int | |
| open IntArray | |
| open Int |
hashCode()Returns a hash code value for the object. |
| open String |
toString()Returns a string representation of the object. |
| open Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<AudioProfile!> | |
Constants
AUDIO_ENCAPSULATION_TYPE_IEC61937
static val AUDIO_ENCAPSULATION_TYPE_IEC61937: Int
Encapsulation format is defined in standard IEC 61937.
Value: 1AUDIO_ENCAPSULATION_TYPE_NONE
static val AUDIO_ENCAPSULATION_TYPE_NONE: Int
No encapsulation type is specified.
Value: 0AUDIO_ENCAPSULATION_TYPE_PCM
static val AUDIO_ENCAPSULATION_TYPE_PCM: Int
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).
Value: 2Public methods
describeContents
open 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
open 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 returntrue. - It is symmetric: for any non-null reference values
xandy,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any non-null reference values
x,y, andz, ifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue. - It is consistent: for any non-null reference values
xandy, multiple invocations ofx.equals(y)consistently returntrueor consistently returnfalse, provided no information used inequalscomparisons on the objects is modified. - For any non-null reference value
x,x.equals(null)should returnfalse.
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. |
getChannelIndexMasks
open fun getChannelIndexMasks(): IntArray
| Return | |
|---|---|
IntArray |
an array of channel index masks that are associated with the encoding format. This value cannot be null. |
getChannelMasks
open fun getChannelMasks(): IntArray
| Return | |
|---|---|
IntArray |
an array of channel position masks that are associated with the encoding format. This value cannot be null. |
getEncapsulationType
open fun getEncapsulationType(): Int
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 android.media.AudioTrack API is supported. But playback with android.media.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.
| Return | |
|---|---|
Int |
an integer representing the encapsulation type. Value is one of the following: |
getFormat
open fun getFormat(): Int
getSampleRates
open fun getSampleRates(): IntArray
| Return | |
|---|---|
IntArray |
an array of sample rates that are associated with the encoding format. This value cannot be null. |
hashCode
open 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
hashCodemethod must consistently return the same integer, provided no information used inequalscomparisons 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
equalsmethod, then calling thehashCodemethod 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
equalsmethod, then calling thehashCodemethod 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
open fun toString(): String
Returns a string representation of the object.
| Return | |
|---|---|
String |
a string representation of the object. |
writeToParcel
open 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:
|