VoiceChatService On DevHub

Summary

This class is not creatable. An object of this class cannot be created with Instance.new.

This class is a service. It is a singleton that may be acquired with GetService.

Memory Category	Instances
ExplorerImageIndex	136 ()
ExplorerOrder	520
ServiceVisibility	1

Tags: [NotCreatable, Service]

Inherits (1)

Instance

Member index (8)

Type	Member	History
bool	EnableDefaultVoice	519 524
AudioApiRollout	UseAudioApi	604 603 604
bool	UseNewAudioApi	590
bool	UseNewControlPaths	593
bool	UseNewJoinFlow	576 587 587 587
bool	VoiceChatEnabledForPlaceOnRcc	520 521 521
bool	VoiceChatEnabledForUniverseOnRcc	520 521 521
bool	IsVoiceEnabledForUserIdAsync (int64 userId)	497
57 members inherited from Instance

Removed member index (24)

Type	Member	History
bool	GenerateDefaultChannel	505 519
VoiceChatState	VoiceChatState	497 497 498 498 499
string	GetAndClearCallFailureMessage ()	497 498 499
Tuple	GetAudioProcessingSettings ()	497 499
string	GetGroupId ()	499
Tuple	GetMicDevices ()	497 499
Array	GetParticipants ()	497 499
Tuple	GetSpeakerDevices ()	497 499
int	GetVoiceChatApiVersion ()	497 499
int	GetVoiceChatAvailable ()	497 499
bool	IsContextVoiceEnabled ()	494 499
bool	IsPublishPaused ()	497 499
bool	IsSubscribePaused (int64 userId)	497 499
bool	JoinByGroupId (string groupId, bool isMicMuted = false)	497 499
bool	JoinByGroupIdToken (string groupId, bool isMicMuted = false)	497 499
void	Leave ()	497 499
bool	PublishPause (bool paused)	497 499
void	SetMicDevice (string micDeviceName, string micDeviceGuid)	497 499
void	SetSpeakerDevice (string speakerDeviceName, string speakerDeviceGuid)	497 499
bool	SubscribePause (int64 userId, bool paused)	497 499
bool	SubscribePauseAll (bool paused)	494 497 499
	ParticipantsStateChanged (Array participantsLeft, Array participantsJoined, Array updatedStates)	497 498 499
	PlayerMicActivitySignalChange (Dictionary activityInfo)	497 498 499
	StateChanged (VoiceChatState old, VoiceChatState new)	497 498 499

604 Add VoiceChatService.UseAudioApi
603 Remove VoiceChatService.UseAudioApi
604 Add VoiceChatService.UseAudioApi
593 Add VoiceChatService.UseNewControlPaths
590 Add VoiceChatService.UseNewAudioApi
587 Change CanLoad of VoiceChatService.UseNewJoinFlow from true to false
587 Change CanSave of VoiceChatService.UseNewJoinFlow from true to false
587 Change Tags of VoiceChatService.UseNewJoinFlow from [] to [Hidden]
576 Add VoiceChatService.UseNewJoinFlow
524 Change Tags of VoiceChatService.EnableDefaultVoice from [NotBrowsable] to []
521 Change CanSave of VoiceChatService.VoiceChatEnabledForPlaceOnRcc from true to false
521 Change Tags of VoiceChatService.VoiceChatEnabledForPlaceOnRcc from [ReadOnly, NotReplicated] to [Hidden]
521 Change CanSave of VoiceChatService.VoiceChatEnabledForUniverseOnRcc from true to false
521 Change Tags of VoiceChatService.VoiceChatEnabledForUniverseOnRcc from [ReadOnly, NotReplicated] to [Hidden]
520 Add VoiceChatService.VoiceChatEnabledForPlaceOnRcc
520 Add VoiceChatService.VoiceChatEnabledForUniverseOnRcc
519 Add VoiceChatService.EnableDefaultVoice
519 Remove VoiceChatService.GenerateDefaultChannel
506 Change Tags of VoiceChatService from [NotCreatable, Service, Deprecated] to [NotCreatable, Service]
505 Add VoiceChatService.GenerateDefaultChannel
504 Change Tags of VoiceChatService from [NotCreatable, Service] to [NotCreatable, Service, Deprecated]
502 Change Tags of VoiceChatService from [Service] to [NotCreatable, Service]
499 Change Tags of VoiceChatService from [NotCreatable, Service] to [Service]
499 Remove VoiceChatService.VoiceChatState
499 Remove VoiceChatService.GetAndClearCallFailureMessage
499 Remove VoiceChatService.GetAudioProcessingSettings
499 Remove VoiceChatService.GetGroupId
499 Remove VoiceChatService.GetMicDevices
499 Remove VoiceChatService.GetParticipants
499 Remove VoiceChatService.GetSpeakerDevices
499 Remove VoiceChatService.GetVoiceChatApiVersion
499 Remove VoiceChatService.GetVoiceChatAvailable
499 Remove VoiceChatService.IsContextVoiceEnabled
499 Remove VoiceChatService.IsPublishPaused
499 Remove VoiceChatService.IsSubscribePaused
499 Remove VoiceChatService.JoinByGroupId
499 Remove VoiceChatService.JoinByGroupIdToken
499 Remove VoiceChatService.Leave
499 Remove VoiceChatService.PublishPause
499 Remove VoiceChatService.SetMicDevice
499 Remove VoiceChatService.SetSpeakerDevice
499 Remove VoiceChatService.SubscribePause
499 Remove VoiceChatService.SubscribePauseAll
499 Remove VoiceChatService.ParticipantsStateChanged
499 Remove VoiceChatService.PlayerMicActivitySignalChange
499 Remove VoiceChatService.StateChanged
498 Change ReadSecurity of VoiceChatService.VoiceChatState from None to RobloxScriptSecurity
498 Change WriteSecurity of VoiceChatService.VoiceChatState from None to RobloxScriptSecurity
498 Change Security of VoiceChatService.GetAndClearCallFailureMessage from None to RobloxScriptSecurity
498 Change Security of VoiceChatService.ParticipantsStateChanged from None to RobloxScriptSecurity
498 Change Security of VoiceChatService.PlayerMicActivitySignalChange from None to RobloxScriptSecurity
498 Change Security of VoiceChatService.StateChanged from None to RobloxScriptSecurity
497 Change CanSave of VoiceChatService.VoiceChatState from true to false
497 Change Tags of VoiceChatService.VoiceChatState from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated, Deprecated]
497 Change Tags of VoiceChatService.GetAndClearCallFailureMessage from [] to [Deprecated]
497 Change Tags of VoiceChatService.GetAudioProcessingSettings from [] to [Deprecated]
497 Change Tags of VoiceChatService.GetMicDevices from [] to [Deprecated]
497 Change Tags of VoiceChatService.GetParticipants from [] to [Deprecated]
497 Change Tags of VoiceChatService.GetSpeakerDevices from [] to [Deprecated]
497 Change Tags of VoiceChatService.GetVoiceChatApiVersion from [] to [Deprecated]
497 Change Tags of VoiceChatService.GetVoiceChatAvailable from [] to [Deprecated]
497 Change Tags of VoiceChatService.IsPublishPaused from [] to [Deprecated]
497 Change Tags of VoiceChatService.IsSubscribePaused from [] to [Deprecated]
497 Add VoiceChatService.IsVoiceEnabledForUserIdAsync
497 Change Tags of VoiceChatService.JoinByGroupId from [] to [Deprecated]
497 Change Tags of VoiceChatService.JoinByGroupIdToken from [] to [Deprecated]
497 Change Tags of VoiceChatService.Leave from [] to [Deprecated]
497 Change Tags of VoiceChatService.PublishPause from [] to [Deprecated]
497 Change Tags of VoiceChatService.SetMicDevice from [] to [Deprecated]
497 Change Tags of VoiceChatService.SetSpeakerDevice from [] to [Deprecated]
497 Change Tags of VoiceChatService.SubscribePause from [] to [Deprecated]
497 Change Tags of VoiceChatService.SubscribePauseAll from [] to [Deprecated]
497 Change Tags of VoiceChatService.ParticipantsStateChanged from [] to [Deprecated]
497 Change Tags of VoiceChatService.PlayerMicActivitySignalChange from [] to [Deprecated]
497 Change Tags of VoiceChatService.StateChanged from [] to [Deprecated]
494 Add VoiceChatService.IsContextVoiceEnabled
494 Add VoiceChatService.SubscribePauseAll
490 Add VoiceChatService

Members

EnableDefaultVoice On DevHub

Value Type	bool
Security	PluginSecurity
Category	Behavior
Can Load	true
Can Save	true
FFlag	VoiceServiceEnableDefaultVoice

History

524 Change Tags of VoiceChatService.EnableDefaultVoice from [NotBrowsable] to []
519 Add VoiceChatService.EnableDefaultVoice

IsVoiceEnabledForUserIdAsync On DevHub

This function yields. It will block the calling thread until completion.

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool

History

497 Add VoiceChatService.IsVoiceEnabledForUserIdAsync

Tags: [Yields]

UseAudioApi On DevHub

This item is not browsable. It is not visible in Studio's object browser.

Value Type	AudioApiRollout
Security	PluginSecurity
Category	Behavior
Can Load	true
Can Save	true
FFlag	VoiceInputUseNewAudioApi5

History

Tags: [NotBrowsable]

UseNewAudioApi On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxScriptSecurity
Category	Data
Can Load	false
Can Save	false

History

590 Add VoiceChatService.UseNewAudioApi

Tags: [Hidden]

UseNewControlPaths On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxSecurity
Category	Data
Can Load	false
Can Save	false

History

593 Add VoiceChatService.UseNewControlPaths

Tags: [Hidden]

UseNewJoinFlow On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxSecurity
Category	Data
Can Load	false
Can Save	false

History

587 Change CanLoad of VoiceChatService.UseNewJoinFlow from true to false
587 Change CanSave of VoiceChatService.UseNewJoinFlow from true to false
587 Change Tags of VoiceChatService.UseNewJoinFlow from [] to [Hidden]
576 Add VoiceChatService.UseNewJoinFlow

Tags: [Hidden]

VoiceChatEnabledForPlaceOnRcc On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxScriptSecurity
Category	State
Can Load	false
Can Save	false

History

521 Change CanSave of VoiceChatService.VoiceChatEnabledForPlaceOnRcc from true to false
521 Change Tags of VoiceChatService.VoiceChatEnabledForPlaceOnRcc from [ReadOnly, NotReplicated] to [Hidden]
520 Add VoiceChatService.VoiceChatEnabledForPlaceOnRcc

Tags: [Hidden]

VoiceChatEnabledForUniverseOnRcc On DevHub

This member is hidden. It is not meant to be used, and may have unresolved issues.

Value Type	bool
Security	RobloxScriptSecurity
Category	State
Can Load	false
Can Save	false

History

521 Change CanSave of VoiceChatService.VoiceChatEnabledForUniverseOnRcc from true to false
521 Change Tags of VoiceChatService.VoiceChatEnabledForUniverseOnRcc from [ReadOnly, NotReplicated] to [Hidden]
520 Add VoiceChatService.VoiceChatEnabledForUniverseOnRcc

Tags: [Hidden]

Removed members

GenerateDefaultChannel

This item is not browsable. It is not visible in Studio's object browser.

Value Type	bool
Security	PluginSecurity
Category	Behavior
Can Load	true
Can Save	true

History

519 Remove VoiceChatService.GenerateDefaultChannel
505 Add VoiceChatService.GenerateDefaultChannel

Tags: [NotBrowsable]

GetAndClearCallFailureMessage

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

499 Remove VoiceChatService.GetAndClearCallFailureMessage
498 Change Security of VoiceChatService.GetAndClearCallFailureMessage from None to RobloxScriptSecurity
497 Change Tags of VoiceChatService.GetAndClearCallFailureMessage from [] to [Deprecated]

Tags: [Deprecated]

GetAudioProcessingSettings

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple

History

499 Remove VoiceChatService.GetAudioProcessingSettings
497 Change Tags of VoiceChatService.GetAudioProcessingSettings from [] to [Deprecated]

Tags: [Deprecated]

GetGroupId

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

499 Remove VoiceChatService.GetGroupId

GetMicDevices

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple

History

499 Remove VoiceChatService.GetMicDevices
497 Change Tags of VoiceChatService.GetMicDevices from [] to [Deprecated]

Tags: [Deprecated]

GetParticipants

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Array

History

499 Remove VoiceChatService.GetParticipants
497 Change Tags of VoiceChatService.GetParticipants from [] to [Deprecated]

Tags: [Deprecated]

GetSpeakerDevices

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	Tuple

History

499 Remove VoiceChatService.GetSpeakerDevices
497 Change Tags of VoiceChatService.GetSpeakerDevices from [] to [Deprecated]

Tags: [Deprecated]

GetVoiceChatApiVersion

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	int

History

499 Remove VoiceChatService.GetVoiceChatApiVersion
497 Change Tags of VoiceChatService.GetVoiceChatApiVersion from [] to [Deprecated]

Tags: [Deprecated]

GetVoiceChatAvailable

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	int

History

499 Remove VoiceChatService.GetVoiceChatAvailable
497 Change Tags of VoiceChatService.GetVoiceChatAvailable from [] to [Deprecated]

Tags: [Deprecated]

IsContextVoiceEnabled

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

History

499 Remove VoiceChatService.IsContextVoiceEnabled
494 Add VoiceChatService.IsContextVoiceEnabled

IsPublishPaused

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool

History

499 Remove VoiceChatService.IsPublishPaused
497 Change Tags of VoiceChatService.IsPublishPaused from [] to [Deprecated]

Tags: [Deprecated]

IsSubscribePaused

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool

History

499 Remove VoiceChatService.IsSubscribePaused
497 Change Tags of VoiceChatService.IsSubscribePaused from [] to [Deprecated]

Tags: [Deprecated]

JoinByGroupId

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
groupId	string	none
isMicMuted	bool	false

Return Type	bool

History

499 Remove VoiceChatService.JoinByGroupId
497 Change Tags of VoiceChatService.JoinByGroupId from [] to [Deprecated]

Tags: [Deprecated]

JoinByGroupIdToken

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
groupId	string	none
isMicMuted	bool	false

Return Type	bool

History

499 Remove VoiceChatService.JoinByGroupIdToken
497 Change Tags of VoiceChatService.JoinByGroupIdToken from [] to [Deprecated]

Tags: [Deprecated]

Leave

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	0

Name	Type	Default
No parameters.

Return Type	void

History

499 Remove VoiceChatService.Leave
497 Change Tags of VoiceChatService.Leave from [] to [Deprecated]

Tags: [Deprecated]

ParticipantsStateChanged

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	3

Name	Type	Default
participantsLeft	Array	none
participantsJoined	Array	none
updatedStates	Array	none

Security	RobloxScriptSecurity

History

499 Remove VoiceChatService.ParticipantsStateChanged
498 Change Security of VoiceChatService.ParticipantsStateChanged from None to RobloxScriptSecurity
497 Change Tags of VoiceChatService.ParticipantsStateChanged from [] to [Deprecated]

Tags: [Deprecated]

PlayerMicActivitySignalChange

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	1

Name	Type	Default
activityInfo	Dictionary	none

Security	RobloxScriptSecurity

History

499 Remove VoiceChatService.PlayerMicActivitySignalChange
498 Change Security of VoiceChatService.PlayerMicActivitySignalChange from None to RobloxScriptSecurity
497 Change Tags of VoiceChatService.PlayerMicActivitySignalChange from [] to [Deprecated]

Tags: [Deprecated]

PublishPause

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	1

Name	Type	Default
paused	bool	none

Return Type	bool

History

499 Remove VoiceChatService.PublishPause
497 Change Tags of VoiceChatService.PublishPause from [] to [Deprecated]

Tags: [Deprecated]

SetMicDevice

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
micDeviceName	string	none
micDeviceGuid	string	none

Return Type	void

History

499 Remove VoiceChatService.SetMicDevice
497 Change Tags of VoiceChatService.SetMicDevice from [] to [Deprecated]

Tags: [Deprecated]

SetSpeakerDevice

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
speakerDeviceName	string	none
speakerDeviceGuid	string	none

Return Type	void

History

499 Remove VoiceChatService.SetSpeakerDevice
497 Change Tags of VoiceChatService.SetSpeakerDevice from [] to [Deprecated]

Tags: [Deprecated]

StateChanged

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
old	VoiceChatState	none
new	VoiceChatState	none

Security	RobloxScriptSecurity

History

499 Remove VoiceChatService.StateChanged
498 Change Security of VoiceChatService.StateChanged from None to RobloxScriptSecurity
497 Change Tags of VoiceChatService.StateChanged from [] to [Deprecated]

Tags: [Deprecated]

SubscribePause

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	2

Name	Type	Default
userId	int64	none
paused	bool	none

Return Type	bool

History

499 Remove VoiceChatService.SubscribePause
497 Change Tags of VoiceChatService.SubscribePause from [] to [Deprecated]

Tags: [Deprecated]

SubscribePauseAll

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

Parameters	1

Name	Type	Default
paused	bool	none

Return Type	bool

History

499 Remove VoiceChatService.SubscribePauseAll
497 Change Tags of VoiceChatService.SubscribePauseAll from [] to [Deprecated]
494 Add VoiceChatService.SubscribePauseAll

Tags: [Deprecated]

VoiceChatState

This property is read-only. Its value can be read, but it cannot be modified.

This member is hidden. It is not meant to be used, and may have unresolved issues.

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.

This item is not replicated. Its interface does not cross the network boundary.

Value Type	VoiceChatState
Security	RobloxScriptSecurity
Category	State
Can Load	false
Can Save	false

History

499 Remove VoiceChatService.VoiceChatState
498 Change ReadSecurity of VoiceChatService.VoiceChatState from None to RobloxScriptSecurity
498 Change WriteSecurity of VoiceChatService.VoiceChatState from None to RobloxScriptSecurity
497 Change CanSave of VoiceChatService.VoiceChatState from true to false
497 Change Tags of VoiceChatService.VoiceChatState from [ReadOnly, NotReplicated] to [Hidden, ReadOnly, NotReplicated, Deprecated]

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

Relevant enums (1)

AudioApiRollout