9 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

VoiceChatService

Inherits from: Instance → Object

VoiceChatService is responsible for voice chat's high-level functionality. This mostly consists of configuration options, and functions that are not specifically-controlled by more-specific instances.

Inherits from: Instance

Memory category: Instances

Tags: NotCreatable, Service

Properties

Name	Type / Returns	Description
VoiceChatService.DefaultDistanceAttenuation	VoiceChatDistanceAttenuationType	Determines which distance attenuation curve the default voice chat setup uses when `AudioDeviceInput` and `AudioEmitter` objects are generated.
VoiceChatService.EnableDefaultVoice	boolean	Controls whether each voice-eligible player can be heard as though they were speaking through their character.
VoiceChatService.EnableVoiceVolumeControls	RolloutState	Controls whether Roblox's built-in voice chat volume controls are available to players.
VoiceChatService.UseAudioApi	AudioApiRollout	Controls whether voice chat is represented and controlled by `AudioDeviceInput` objects.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

VoiceChatService.DefaultDistanceAttenuation

This property controls the default distance attenuation curve assigned to any generated AudioEmitter instances in the default voice chat setup.

This property only has an effect if EnableDefaultVoice and UseAudioApi are both enabled, since no AudioEmitters are otherwise generated.

Field	Value
type	VoiceChatDistanceAttenuationType
security	{"read":"PluginSecurity","write":"PluginSecurity"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Chat"]

VoiceChatService.EnableDefaultVoice

When enabled, each voice-eligible player can be heard as though they were speaking through their character. The implementation details of the voice setup depend on UseAudioApi.

When UseAudioApi is Enabled, disabling this property disables the default setup, but AudioDeviceInput will still work. Conversely, when UseAudioApi is Disabled, disabling the default voice setup effectively disables voice chat altogether.

Field	Value
type	boolean
security	{"read":"PluginSecurity","write":"PluginSecurity"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Chat"]

VoiceChatService.EnableVoiceVolumeControls

This RolloutState property controls whether Roblox's built-in voice chat volume controls are available to players, including a global voice chat volume slider and per-user volume adjustments.

When set to Enabled, these controls are available to players. When set to Disabled, the built-in controls are hidden, though creators can still implement their own custom voice volume controls. Default follows the default for this feature.

If UseAudioApi is disabled, this property has no effect and built-in controls will be hidden.

Field	Value
type	RolloutState
security	{"read":"RobloxScriptSecurity","write":"RobloxScriptSecurity"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Chat"]

VoiceChatService.UseAudioApi

If Enabled, the voice chat setup is represented and controlled by AudioDeviceInput objects. More specifically:

An AudioDeviceInput will be created and parented to each voice-eligible Player.
An AudioEmitter will be created and parented to each voice-eligible player's Player.Character.
An AudioListener will be created and parented to Workspace.CurrentCamera.

You can disable the default setup by setting VoiceChatService.EnableDefaultVoice to false.

If Disabled, the voice chat setup is done through an internal-only system.

Currently, setting this to Automatic has the same meaning as Disabled. However, in the future, Automatic will become Enabled, so that new experiences can achieve greater customization over voice.

Field	Value
type	AudioApiRollout
security	{"read":"PluginSecurity","write":"PluginSecurity"}
thread safety	ReadSafe
category	Behavior
serialization	{"can_load":true,"can_save":true}
capabilities	["Audio","Chat"]

Methods

Name	Type / Returns	Description
VoiceChatService:GetChatGroupsAsync	Array	Returns chat group IDs that indicate which players can voice chat together.
VoiceChatService:IsVoiceEnabledForUserIdAsync	boolean	Returns whether or not the given user has voice enabled.

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

VoiceChatService:GetChatGroupsAsync

Returns a sorted array of arrays of chat group IDs for the given players. Each chat group ID is a string that represents a communication-compatible group within the current universe.

If two or more players share the same chat group ID, those players are eligible to voice chat with each other based on their age-check status, voice chat eligibility, and communication settings.

This method is server-side only and intended for real-time use cases such as matchmaking and teleporting. Chat group IDs are unique to the current universe, may change over time, and should not be stored once the user has left the experience. While you can hold onto the data returned for the purposes of gameplay while the user is in the experience, this data should not be stored after they've left.

To use this method, you must enable Chat & Voice Groups APIs in Experience Settings ⟩ Communication in Roblox Studio and agree to the Roblox Terms of Use.

In Roblox Studio this API is only available when the experience is running in Team Test.

Parameters

Name	Type	Default	Description
players	Instances		A list of `Players` currently in the experience to evaluate for voice chat compatibility.

Returns

Type	Description
Array	A sorted array of arrays of chat group ID strings. Players who share a matching chat group ID are eligible to voice chat with each other.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["Audio","Chat"]

Code samples: View on Creator Hub (VoiceChatService-Chat-Groups-Teleport, VoiceChatService-GetChatGroupsAsync).

VoiceChatService:IsVoiceEnabledForUserIdAsync

Returns whether or not the given user has voice enabled. On the client-side, this can only be used to check the voice status of the local player. On the server-side, this can only check the voice status for players in that server.

This function can throw an error if the HTTP call fails.

Parameters

Name	Type	Default	Description
userId	User		The `Player.UserId` to check.

Returns

Type	Description
boolean	If that user has voice enabled.

Field	Value
tags	["Yields"]
security	None
thread safety	Unsafe
capabilities	["Audio","Chat"]

Code samples: View on Creator Hub (VoiceChatService-IsVoiceEnabledForUserIdAsync).

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.