Added in API level 24

AudioRecordingConfiguration

class AudioRecordingConfiguration : Parcelable
kotlin.Any
   ↳ android.media.AudioRecordingConfiguration

The AudioRecordingConfiguration class collects the information describing an audio recording session.

Direct polling (see AudioManager.getActiveRecordingConfigurations()) or callback (see AudioManager.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.

Summary

Inherited constants
Public methods
Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
Boolean
equals(other: Any?)

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

Returns information about the audio input device used for this recording.
Int

Returns the audio source currently used to configure the capture path.
Int

Returns the session number of the recording, see AudioRecord.getAudioSessionId().
Int

Returns the audio source selected by the client.
MutableList<AudioEffect.Descriptor!>

Returns the list of AudioEffect.Descriptor for all effects currently enabled on the audio capture client (e.g. 
AudioFormat!

Returns the audio format at which the client application is recording audio.
MutableList<AudioEffect.Descriptor!>

Returns the list of AudioEffect.Descriptor for all effects currently enabled on the capture stream.
AudioFormat!

Returns the audio format at which audio is recorded on this Android device.
Int

Returns a hash code value for the object.
Boolean

Returns true if the audio returned to the client is currently being silenced by the audio framework due to concurrent capture policy (e.g the capturing application does not have an active foreground process or service anymore).
Unit
writeToParcel(dest: Parcel, flags: Int)

Flatten this object in to a Parcel.
Properties
static Parcelable.Creator<AudioRecordingConfiguration!>

Public methods

describeContents

Added in API level 24
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

Added in API level 24
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 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
obj the reference object with which to compare.
Return
Boolean true if this object is the same as the obj argument; false otherwise.

getAudioDevice

Added in API level 24
fun getAudioDevice(): AudioDeviceInfo!

Returns information about the audio input device used for this recording.

Return
AudioDeviceInfo! the audio recording device or null if this information cannot be retrieved

getAudioSource

Added in API level 29
fun getAudioSource(): Int

Returns the audio source currently used to configure the capture path. It can be different from the source returned by getClientAudioSource() if another capture is active.

Return
Int the audio source active on the capture path.
Value is one of the following:

getClientAudioSessionId

Added in API level 24
fun getClientAudioSessionId(): Int

Returns the session number of the recording, see AudioRecord.getAudioSessionId().

Return
Int the session number.

getClientAudioSource

Added in API level 24
fun getClientAudioSource(): Int

Returns the audio source selected by the client.

Return
Int the audio source selected by the client.
Value is one of the following:

getClientEffects

Added in API level 29
fun getClientEffects(): MutableList<AudioEffect.Descriptor!>

Returns the list of AudioEffect.Descriptor for all effects currently enabled on the audio capture client (e.g. AudioRecord or MediaRecorder).

Return
MutableList<AudioEffect.Descriptor!> List of AudioEffect.Descriptor containing all effects enabled for the client.
This value cannot be null.

getClientFormat

Added in API level 24
fun getClientFormat(): AudioFormat!

Returns the audio format at which the client application is recording audio. Note that it may differ from the actual recording format (see getFormat()).

Return
AudioFormat! the recording format

getEffects

Added in API level 29
fun getEffects(): MutableList<AudioEffect.Descriptor!>

Returns the list of AudioEffect.Descriptor for all effects currently enabled on the capture stream.

Return
MutableList<AudioEffect.Descriptor!> List of AudioEffect.Descriptor containing all effects enabled on the capture stream. This can be different from the list returned by getClientEffects() if another capture is active.
This value cannot be null.

getFormat

Added in API level 24
fun getFormat(): AudioFormat!

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()).

Return
AudioFormat! the device recording format

hashCode

Added in API level 24
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 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.
Return
Int a hash code value for this object.

isClientSilenced

Added in API level 29
fun isClientSilenced(): Boolean

Returns true if the audio returned to the client is currently being silenced by the audio framework due to concurrent capture policy (e.g the capturing application does not have an active foreground process or service anymore).

Return
Boolean true if captured audio is silenced, false otherwise .

writeToParcel

Added in API level 24
fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest Parcel: The Parcel in which the object should be written.
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:

Properties

CREATOR

Added in API level 24
static val CREATOR: Parcelable.Creator<AudioRecordingConfiguration!>