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. |
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
public static final int AUDIO_ENCAPSULATION_TYPE_IEC61937
Encapsulation format is defined in standard IEC 61937.
Constant Value: 1 (0x00000001)
AUDIO_ENCAPSULATION_TYPE_NONE
public static final int AUDIO_ENCAPSULATION_TYPE_NONE
No encapsulation type is specified.
Constant Value: 0 (0x00000000)
Fields
Public methods
describeContents
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
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 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.
The equals method for class Object implements
the most discriminating possible equivalence relation on objects;
that is, for any non-null reference values x and
y, this method returns true if and only
if x and y refer to the same object
(x == y has the value true).
Note that it is generally necessary to override the hashCode
method whenever this method is overridden, so as to maintain the
general contract for the hashCode method, which states
that equal objects must have equal hash codes.
| 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
public int[] getChannelIndexMasks ()
| Returns | |
|---|---|
int[] |
an array of channel index masks that are associated with the encoding format.
This value cannot be null. |
getChannelMasks
public int[] getChannelMasks ()
| Returns | |
|---|---|
int[] |
an array of channel position masks that are associated with the encoding format.
This value cannot be null. |
getEncapsulationType
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, or AUDIO_ENCAPSULATION_TYPE_IEC61937 |
getFormat
public int getFormat ()
getSampleRates
public int[] getSampleRates ()
| Returns | |
|---|---|
int[] |
an array of sample rates that are associated with the encoding format.
This value cannot be null. |
hashCode
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
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
equals(Object)method, 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
equals(java.lang.Object)method, 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.
As much as is reasonably practical, the hashCode method defined by
class Object does return distinct integers for distinct
objects. (This is typically implemented by converting the internal
address of the object into an integer, but this implementation
technique is not required by the
Java™ programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
toString
public String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
writeToParcel
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 |