microphone.cancel

Stop and discard an active microphone capture.

Syntax

ue.microphone.cancel(capture_id: integer) -> boolean

Returns true when the capture belonged to the current session. No completion callback is delivered.

if capture_id then
    ue.microphone.cancel(capture_id)
    capture_id = nil
end

Use cancel when an interaction is abandoned or a session no longer needs the recorded audio.

On this page