AudioStats

const val AUDIO_AMPLITUDE_NONE = 0.0: Double

Should audio recording be disabled, any attempts to retrieve the amplitude will return this value.

const val AUDIO_STATE_ACTIVE = 0: Int

The recording is being recorded with audio data.

When audio is active, the recorded video file will contain audio data.

const val AUDIO_STATE_DISABLED = 1: Int

The recording of audio is disabled.

This audio state results from a PendingRecording that was started without calling withAudioEnabled.

const val AUDIO_STATE_ENCODER_ERROR = 3: Int

The recording is muted because the audio encoder encountered errors.

If the audio source encounters errors during recording, audio stats generated after the error will contain this audio state, and the recording will proceed without audio.

Use getErrorCause to get the error cause.

const val AUDIO_STATE_MUTED = 5: Int

The recording is muted by mute.

const val AUDIO_STATE_SOURCE_ERROR = 4: Int

The recording is muted because the audio source encountered errors.

If the audio source encounters errors during recording, audio stats generated after the error will contain this audio state, and the recording will proceed without audio.

Use getErrorCause to get the error cause.

const val AUDIO_STATE_SOURCE_SILENCED = 2: Int

The recording is muted because the audio source is silenced by the system.

If the audio source is occupied by a privilege application, such as the dialer, depending on the system version, the system may silence the application that are using the audio source. Use getErrorCause to get the error cause.

fun getAudioAmplitude(): Double

Returns the maximum absolute amplitude of the audio most recently sampled in the past 2 nanoseconds

The amplitude is the maximum absolute value over all channels which the audio was most recently sampled from.

Amplitude is a relative measure of the maximum sound pressure/voltage range of the device microphone.

Returns AUDIO_AMPLITUDE_NONE if audio is disabled.

The amplitude value returned will be a double between 0 and 1.

abstract fun getAudioState(): Int

Returns the state of audio in the recording.

The audio state describes whether audio is enabled for the recording and if audio is currently recording or is silenced due to system priority or errors.

abstract fun getErrorCause(): Throwable?

Gets the error cause.

Returns null if hasError returns false.

fun hasAudio(): Boolean

Indicates whether the recording is being recorded with audio.

fun hasError(): Boolean

Indicates whether an error occurred.

Returns true if the audio is muted due to unexpected error like audio source is occupied or audio encoder encountered errors, otherwise false.