Voice chat
Playback, microphone controls, and voice status.
18 functions
What the icons meanvoicechat.getcomchannelSynchronousRead the identifier of the voice channel Roblox currently assigned. It is useful for displaying current session status.
voicechat.getstatusSynchronousTake a snapshot of the voice playback service. Check state and error after play, and use position and duration for a progress display.
voicechat.hasvoicechatAsynchronousAsk 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.
voicechat.incomingpacket:ConnectAsynchronousSubscribe to inbound culling messages and decrypted WebRTC RTP packets. The callback runs on a deferred Luau task.
voicechat.incomingpacket:OnceAsynchronousSubscribe to one inbound culling or RTP packet and automatically disconnect after it is queued for delivery.
voicechat.joincomchannelAsynchronousAsk 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.
voicechat.outgoingpacket:ConnectAsynchronousSubscribe to outbound culling data and WebRTC RTP packet attempts. The callback receives an owned packet snapshot on a deferred Luau task.
voicechat.outgoingpacket:OnceAsynchronousSubscribe to one outbound packet attempt and automatically disconnect after the event is queued for delivery.
voicechat.pauseSynchronousPause the current file without discarding its position. It can also mark a loading clip to start in the paused state.
voicechat.playAsynchronousStart loading an audio file from the workspace, or one the user picks with openfiledialog, and mix its playback into the current voice capture path. The call returns while decoding continues, so inspect getstatus for progress or an error.
voicechat.sendaudiopacketsAsynchronousGenerate a sine tone and submit a burst of 10 ms audio frames through the active voice sender. Use this to test an audible frequency without preparing a file.
voicechat.senddatapacketAsynchronousPass a raw buffer to a voice-related WebRTC channel. The default channel carries culling messages; choose rtp only for a complete encoded RTP packet.
voicechat.setmicmutedSynchronousSet Kawaii's microphone-mute choice for the voice mixer. This is useful for a Push to Talk or mute control alongside file playback.
voicechat.setspeedSynchronousSet how quickly the file clip advances during playback. One is normal speed; smaller values slow it down and larger values speed it up.
voicechat.setvolumeSynchronousAdjust the file audio mixed into voice capture. Zero silences the clip; one is its normal level.
voicechat.stopSynchronousStop the current file playback and clear its path and progress. Use it when the user cancels a clip or starts a different activity.
voicechat.unpauseSynchronousResume a paused clip from its current position. Use it after voicechat.pause when the user is ready to hear the rest.
VoicePacketConnection:DisconnectSynchronousStop receiving voice packet observations for this connection.