Skip to content

Unmute

Unmutes local audio for your leg in an active call, restoring outgoing microphone audio to other participants.

Signature

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

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

Parameters

ParameterTypeRequiredDescription
callIdstringYesIdentifier of the active call

Return Type

Returns void (or Promise<void> for Web).

Usage Example


 // Callback
 client.unmute("callId") {
     it?.let { err ->
         // Handle Error in unmuting call
         println("Error in unmuting call: $err")
     }
 }

 // Coroutine
 try {
     client.unmute("callId")
 } catch (e: Error) {
     // Handle Error in unmuting call
 }

Errors

Error TypeError CodeDescription
INTERNAL_ERRORvoice:error:no_call_foundNo active call found for provided callId
INTERNAL_ERRORMedia-layer errorsMedia operation failed while unmuting
UNKNOWN_ERRORN/AUnexpected failure

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

Notes

  • Unmute restores only outgoing audio
  • Incoming audio remains unchanged by mute/unmute
  • mute - Mute local audio
  • onMute - Fired when mute state changes for a leg

Built with VitePress.