Noise removal is beneficial when the PSTN caller lacks access to noise removal technology. Once enabled, SDK users will experience clearer incoming audio without background noise.

anchorEnable or Disable Noise Removal

The call.enableReceivingNoiseRemoval() method toggles the noise removal feature during an active call. The outcome is relayed via the onReceivingNoiseInfoChanged callback, confirming the action's success:

call.enableReceivingNoiseRemoval(enable, callback)

anchorHandle the Noise Information Callback

The CallObserver.onReceivingNoiseInfoChanged() callback provides updates regarding noise detection and the status of the noise removal feature. This callback is part of the CallObserver interface, which is set up using the Call.setObserver() method.

The ReceivingNoiseInfo object contains two important properties:

• isNoiseDetected: This boolean indicates if any background noise is detected in the incoming call. When noise is detected, the enableReceivingNoiseRemoval method should be invoked to activate noise removal.
• isNoiseRemovalEnabled: This boolean signifies whether the noise removal feature is currently active. If true, any noise detected in the incoming call will be filtered out.

The onReceivingNoiseInfoChanged callback is triggered under two circumstances:

1. When the call is initially connected, signaling the availability of the noise removal feature for the call with both isNoiseDetected and isNoiseRemovalEnabled set to false.
2. Whenever there is a change in the isNoiseDetected or isNoiseRemovalEnabled values. For example, the callback fires when noise removal is activated or deactivated, or when new background noise is detected.

Here is an example of setting the call observer:

val mediaOption = MediaOption.audioOnly()
webex.phone.dial("+1800123456", mediaOption, CompletionHandler { result ->
    if (result.isSuccessful) {
        // Dial method successful.
        val call = result.data
        call?.setObserver(object : CallObserver {
            override fun onReceivingNoiseInfoChanged(info: ReceivingNoiseInfo) {
                // Use the info object to take further action.
            }
        })
    } else {
        // Dial failed
    }
})

To obtain the current ReceivingNoiseInfo object, use the getReceivingNoiseInfo() method:

val infoObject = call.getReceivingNoiseInfo()
logDebug("$tag ReceivingNoiseRemoval : ", info.toString())