public
final
class
AudioRecordingConfiguration
extends Object
implements
Parcelable
| java.lang.Object | |
| ↳ | android.media.AudioRecordingConfiguration |
The AudioRecordingConfiguration class collects the information describing an audio recording session.
Direct polling (see getActiveRecordingConfigurations()) or callback
(see registerAudioRecordingCallback(android.media.AudioManager.AudioRecordingCallback, android.os.Handler)
methods are ways to receive information about the current recording configuration of the device.
An audio recording configuration contains information about the recording format as used by
the application (getClientFormat(), as well as the recording format actually used by
the device (getFormat()). The two recording formats may, for instance, be at different
sampling rates due to hardware limitations (e.g. application recording at 44.1kHz whereas the
device always records at 48kHz, and the Android framework resamples for the application).
The configuration also contains the use case for which audio is recorded
(getClientAudioSource()), enabling the ability to distinguish between different
activities such as ongoing voice recognition or camcorder recording.
Inherited constants |
|---|
 From
interface
android.os.Parcelable
|
Fields | |
|---|---|
public
static
final
Creator<AudioRecordingConfiguration> |
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. |
AudioDeviceInfo
|
getAudioDevice()
Returns information about the audio input device used for this recording. |
int
|
getClientAudioSessionId()
Returns the session number of the recording, see |
int
|
getClientAudioSource()
Returns the audio source being used for the recording. |
AudioFormat
|
getClientFormat()
Returns the audio format at which the client application is recording audio. |
AudioFormat
|
getFormat()
Returns the audio format at which audio is recorded on this Android device. |
int
|
hashCode()
Returns a hash code value for the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
| |
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(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. |
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:
Developers
x, x.equals(x) should return
true.
x and y, x.equals(y)
should return true if and only if
y.equals(x) returns true.
x, y, and z, if
x.equals(y) returns true and
y.equals(z) returns true, then
x.equals(z) should return true.
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.
x,
x.equals(null) should return false.
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. |
AudioDeviceInfo getAudioDevice ()
Returns information about the audio input device used for this recording.
| Returns | |
|---|---|
AudioDeviceInfo |
the audio recording device or null if this information cannot be retrieved |
int getClientAudioSessionId ()
Returns the session number of the recording, see getAudioSessionId().
| Returns | |
|---|---|
int |
the session number. |
int getClientAudioSource ()
Returns the audio source being used for the recording.
| Returns | |
|---|---|
int |
one of DEFAULT,
MIC,
VOICE_UPLINK,
VOICE_DOWNLINK,
VOICE_CALL,
CAMCORDER,
VOICE_RECOGNITION,
VOICE_COMMUNICATION,
UNPROCESSED.
|
AudioFormat getClientFormat ()
Returns the audio format at which the client application is recording audio.
Note that it may differ from the actual recording format (see getFormat()).
| Returns | |
|---|---|
AudioFormat |
the recording format |
AudioFormat getFormat ()
Returns the audio format at which audio is recorded on this Android device.
Note that it may differ from the client application recording format
(see getClientFormat()).
| Returns | |
|---|---|
AudioFormat |
the device recording format |
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:
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.
equals(Object)
method, then calling the hashCode method on each of
the two objects must produce the same integer result.
equals(java.lang.Object)
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.
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
JavaTM programming language.)
| Returns | |
|---|---|
int |
a hash code value for this object. |
void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
| Parameters | |
|---|---|
dest |
Parcel:
The Parcel in which the object should be written. |
flags |
int:
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|