AudioDescriptor
public
class
AudioDescriptor
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.media.AudioDescriptor |
The AudioDescriptor contains the information to describe the audio playback/capture capabilities. The capabilities are described by a byte array, which is defined by a particular standard. This is used when the format is unrecognized to the platform.
Summary
Constants | |
---|---|
int |
STANDARD_EDID
The Extended Display Identification Data (EDID) standard for a short audio descriptor. |
int |
STANDARD_NONE
The audio standard is not specified. |
int |
STANDARD_SADB
The standard for a Speaker Allocation Data Block (SADB). |
int |
STANDARD_VSADB
The standard for a Vendor-Specific Audio Data Block (VSADB). |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<AudioDescriptor> |
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. |
byte[]
|
getDescriptor()
|
int
|
getEncapsulationType()
The encapsulation type indicates what encapsulation type is required when the framework is using this extra audio descriptor for playing to a device exposing this audio profile. |
int
|
getStandard()
|
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
STANDARD_EDID
public static final int STANDARD_EDID
The Extended Display Identification Data (EDID) standard for a short audio descriptor.
Constant Value: 1 (0x00000001)
STANDARD_NONE
public static final int STANDARD_NONE
The audio standard is not specified.
Constant Value: 0 (0x00000000)
STANDARD_SADB
public static final int STANDARD_SADB
The standard for a Speaker Allocation Data Block (SADB).
Constant Value: 2 (0x00000002)
STANDARD_VSADB
public static final int STANDARD_VSADB
The standard for a Vendor-Specific Audio Data Block (VSADB).
Constant Value: 3 (0x00000003)
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
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons 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 | |
---|---|
o |
Object : the reference object with which to compare. |
Returns | |
---|---|
boolean |
true if this object is the same as the obj
argument; false otherwise. |
getDescriptor
public byte[] getDescriptor ()
Returns | |
---|---|
byte[] |
a byte array that describes audio playback/capture capabilities as encoded by the
standard for this AudioDescriptor.
This value cannot be null . |
getEncapsulationType
public int getEncapsulationType ()
The encapsulation type indicates what encapsulation type is required when the framework is
using this extra audio descriptor for 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 AudioProfile.AUDIO_ENCAPSULATION_TYPE_IEC61937.
Returns | |
---|---|
int |
an integer representing the encapsulation type
Value is AudioProfile.AUDIO_ENCAPSULATION_TYPE_NONE , AudioProfile.AUDIO_ENCAPSULATION_TYPE_IEC61937 , or AudioProfile.AUDIO_ENCAPSULATION_TYPE_PCM |
getStandard
public int getStandard ()
Returns | |
---|---|
int |
the standard that defines audio playback/capture capabilities.
Value is STANDARD_NONE , STANDARD_EDID , STANDARD_SADB , or STANDARD_VSADB |
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
hashCode
method must consistently return the same integer, provided no information used inequals
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 thehashCode
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 thehashCode
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
public String toString ()
Returns a string representation of the object.
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 |