Skip to content

Enable Noise Suppression

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

Signature

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

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

Parameters

ParameterTypeRequiredDescription
callIdstringYesIdentifier of the active call

Return Type

Returns void when the operation completes.

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 TypeError CodeDescription
INTERNAL_ERRORvoice:error:no_call_foundNo active call found for provided callId
INTERNAL_ERRORMedia-layer errorsMedia operation failed while enabling suppression
UNKNOWN_ERRORN/AUnexpected failure

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

Notes

  • This action is available on Android and iOS
  • Web SDK does not currently expose noise suppression call actions
  • Apply this after call media is established for best effect

Built with VitePress.