Skip to content

Most visited

Recently visited

navigation
Added in API level 16

AutomaticGainControl

public class AutomaticGainControl
extends AudioEffect

java.lang.Object
   ↳ android.media.audiofx.AudioEffect
     ↳ android.media.audiofx.AutomaticGainControl


Automatic Gain Control (AGC).

Automatic Gain Control (AGC) is an audio pre-processing which automatically normalizes the output of the captured signal by boosting or lowering input from the microphone to match a preset level so that the output signal level is virtually constant. AGC can be used by applications where the input signal dynamic range is not important but where a constant strong capture level is desired.

An application creates a AutomaticGainControl object to instantiate and control an AGC engine in the audio framework.

To attach the AutomaticGainControl to a particular AudioRecord, specify the audio session ID of this AudioRecord when creating the AutomaticGainControl. The audio session is retrieved by calling getAudioSessionId() on the AudioRecord instance.

On some devices, an AGC can be inserted by default in the capture path by the platform according to the MediaRecorder.AudioSource used. The application should call AutomaticGainControl.getEnable() after creating the AGC to check the default AGC activation state on a particular AudioRecord session.

See AudioEffect class for more details on controlling audio effects.

Summary

Inherited constants

From class android.media.audiofx.AudioEffect

Inherited fields

From class android.media.audiofx.AudioEffect

Public methods

static AutomaticGainControl create(int audioSession)

Creates an AutomaticGainControl and attaches it to the AudioRecord on the audio session specified.

static boolean isAvailable()

Checks if the device implements automatic gain control.

Inherited methods

From class android.media.audiofx.AudioEffect
From class java.lang.Object

Public methods

create

Added in API level 16
AutomaticGainControl create (int audioSession)

Creates an AutomaticGainControl and attaches it to the AudioRecord on the audio session specified.

Parameters
audioSession int: system wide unique audio session identifier. The AutomaticGainControl will be applied to the AudioRecord with the same audio session.
Returns
AutomaticGainControl AutomaticGainControl created or null if the device does not implement AGC.

isAvailable

Added in API level 16
boolean isAvailable ()

Checks if the device implements automatic gain control.

Returns
boolean true if the device implements automatic gain control, false otherwise.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.