Most visited

Recently visited

Results for

Added in API level 16

Summary: Inherited Constants | Inherited Fields | Methods | Inherited Methods | [Expand All]

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

`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`AudioEffect.Descriptor`	`getDescriptor()` Get the effect descriptor.
`boolean`	`getEnabled()` Returns effect enabled state
`int`	`getId()` Returns effect unique identifier.
`boolean`	`hasControl()` Checks if this AudioEffect object is controlling the effect engine.
`static Descriptor[]`	`queryEffects()` Query all effects available on the platform.
`void`	`release()` Releases the native AudioEffect resources.
`void`	`setControlStatusListener(AudioEffect.OnControlStatusChangeListener listener)` Sets the listener AudioEffect notifies when the effect engine control is taken or returned.
`void`	`setEnableStatusListener(AudioEffect.OnEnableStatusChangeListener listener)` Sets the listener AudioEffect notifies when the effect engine is enabled or disabled.
`int`	`setEnabled(boolean enabled)` Enable or disable the effect.

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this 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.

Interfaces

Classes

Most visited

Recently visited

Results for

AutomaticGainControl

Summary

Inherited constants

Inherited fields

Public methods

Inherited methods

Public methods

create

isAvailable