voicechat.pause Synchronous

Pause the current file without discarding its position. It can also mark a loading clip to start in the paused state.

Syntax

Luau

voicechat.pause() -> ()

Parameters

This function takes no arguments.

Returns

()

No values.

Usage notes

Microphone capture is a separate path; this pauses file playback.

Example

Luau

local status = voicechat.getstatus()
if status.available and (status.state == "playing" or status.state == "loading") then
    voicechat.pause()
    print("File playback paused")
end