Enable Noise Suppression

Enables noise suppression on an active call leg to improve microphone audio quality in noisy environments.

On Android and iOS this uses Vonage's on-device machine-learning noise suppression. On Web it enables the browser's built-in noiseSuppression audio processing on the call's microphone track.

Signature

// Callback version
fun enableNoiseSuppression(
  callId: String,
  callback: (Exception?) -> Unit
)

// Suspend version
suspend fun enableNoiseSuppression(
  callId: String
)

Parameters

Parameter	Type	Required	Description
callId	string	Yes	Identifier of the active call

Return Type

Returns void when the operation completes. On Web, returns a Promise that resolves once noise suppression has been applied.

Usage Example

// Callback
client.enableNoiseSuppression("callId") { err ->
    err?.let {
        println("Error enabling noise suppression: $it")
    } ?: println("Noise suppression successfully enabled")
}

// Coroutine
try {
    client.enableNoiseSuppression("callId")
} catch (e: Error) {
    println("Error enabling noise suppression: $e")
}

Errors

Error Type	Error Code	Description
INTERNAL_ERROR	voice:error:no_call_found	No active call found for provided callId
INTERNAL_ERROR	Media-layer errors	Media operation failed while enabling suppression
UNKNOWN_ERROR	N/A	Unexpected failure

For complete error reference and handling guidelines, see Error Reference.

Notes

• Available on Android, iOS and Web
• Apply this after call media is established for best effect
• To apply noise suppression to every call rather than per call, set enableNoiseSuppression (Android/iOS) or noiseSuppression (Web) on the client config. It defaults to false
• On Web this is currently marked experimental

Related Actions

• disableNoiseSuppression - Disable noise suppression for an active call
• enableAutoGainControl - Even out microphone input volume (Web)
• enableEchoCancellation - Cancel speaker feedback picked up by the microphone (Web)

Related Events

• onCallMediaError - Fired when media errors occur during a call