Voice chat

Read the identifier of the voice channel Roblox currently assigned. It is useful for displaying current session status.

Take a snapshot of the voice playback service. Check state and error after play, and use position and duration for a progress display.

Ask Roblox whether the local user is eligible for voice chat. Check it before offering voice controls, since a working audio hook alone does not grant account eligibility.

Ask Roblox to join the assigned voice session. Read the returned status as a request result, then check the current channel later to observe the outcome.

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

Start loading a workspace audio file and mix its playback into the current voice capture path. The call returns while decoding continues, so inspect getstatus for progress or an error.

Set Kawaii's microphone-mute choice for the voice mixer. This is useful for a Push to Talk or mute control alongside file playback.

Set how quickly the file clip advances during playback. One is normal speed; smaller values slow it down and larger values speed it up.

Adjust the file audio mixed into voice capture. Zero silences the clip; one is its normal level.

Stop the current file playback and clear its path and progress. Use it when the user cancels a clip or starts a different activity.

Resume a paused clip from its current position. Use it after voicechat.pause when the user is ready to hear the rest.