Android APIs
public class

NoiseSuppressor

extends AudioEffect
java.lang.Object
   ↳ android.media.audiofx.AudioEffect
     ↳ android.media.audiofx.NoiseSuppressor

Class Overview

Noise Suppressor (NS).

Noise suppression (NS) is an audio pre-processing which removes background noise from the captured signal. The component of the signal considered as noise can be either stationary (car/airplane engine, AC system) or non-stationary (other peoples conversations, car horn) for more advanced implementations.

NS is mostly used by voice communication applications (voice chat, video conferencing, SIP calls).

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

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

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

See AudioEffect class for more details on controlling audio effects.

Summary

[Expand]
Inherited Constants
From class android.media.audiofx.AudioEffect
[Expand]
Inherited Fields
From class android.media.audiofx.AudioEffect
Public Methods
static NoiseSuppressor create(int audioSession)
Creates a NoiseSuppressor and attaches it to the AudioRecord on the audio session specified.
static boolean isAvailable()
Checks if the device implements noise suppression.
[Expand]
Inherited Methods
From class android.media.audiofx.AudioEffect
From class java.lang.Object

Public Methods

public static NoiseSuppressor create (int audioSession)

Added in API level 16

Creates a NoiseSuppressor and attaches it to the AudioRecord on the audio session specified.

Parameters
audioSession system wide unique audio session identifier. The NoiseSuppressor will be applied to the AudioRecord with the same audio session.
Returns
NoiseSuppressor NoiseSuppressor created or null if the device does not implement noise suppression.

public static boolean isAvailable ()

Added in API level 16

Checks if the device implements noise suppression.

Returns
boolean true if the device implements noise suppression, false otherwise.