Skip to content

[VoiceChatLib] Getting the data

Sh1zok edited this page Apr 25, 2026 · 1 revision

GET

Obtaining any information occurs through voiceChat.get


hostVoiceVolume

Host's ACCURATE microphone volume level. Float number between 0 and 1. The library itself updates this value for the non-host using pings. More suitable for collecting statistics.

local currentVoiceLevel = voiceChat.get.hostVoiceVolume

smoothHostVoiceVolume

Host's SMOOTH microphone volume level. Float number between 0 and 1. This value is not updated via pings, but rather transitions smoothly from the old hostVoiceVolume to the new hostVoiceVolume. It's more suitable for use in implementing mouth opening.

local smoothVoiceLevel = voiceChat.get.smoothHostVoiceVolume

rawAudioStream

Raw audio data. This is a table with indices from 0 to 959, which comes directly from the addon. This table is not synchronized for non-hosts because it contains too much information to transmit via ping (for non-hosts, every table value is 0). It is best suited for advanced audio data processing.

local rawAudio = voiceChat.get.rawAudioStream

isMicrophoneActive

A Boolean value that determines whether the microphone is active or is not. True if the microphone is active. This thing is automatically detected on the non-host side. This thing is determined on the host and non-host side and does not need ping synchronization.

local isMicActive = voiceChat.get.isMicrophoneActive

ticksUntilRefreshPing

This number determines how many ticks remain until sending/receiving a ping synchronizing the hostVoiceVolume

local ticksUntilPing = voiceChat.get.ticksUntilRefreshPing

Clone this wiki locally