VoiceChatInternal 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.

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

Memory Category	Instances
Insertable	false

Tags: [NotCreatable, Service, NotBrowsable]

Inherits (1)

Instance

Member index (31)

Type	Member	History
VoiceChatState	VoiceChatState
string	GetAndClearCallFailureMessage ()
Tuple	GetAudioProcessingSettings ()
string	GetChannelId ()	541
string	GetGroupId ()
Tuple	GetMicDevices ()
Array	GetParticipants ()
string	GetSessionId ()	552
Tuple	GetSpeakerDevices ()
int	GetVoiceChatApiVersion ()
int	GetVoiceChatAvailable ()
string	GetVoiceExperienceId ()	552
bool	IsContextVoiceEnabled ()
bool	IsPublishPaused ()
bool	IsSubscribePaused (int64 userId)
bool	IsVoiceEnabledForUserIdAsync (int64 userId)
bool	JoinByGroupId (string groupId, bool isMicMuted = false)
bool	JoinByGroupIdToken (string groupId, bool isMicMuted = false)
void	Leave ()
bool	PublishPause (bool paused)
void	SetMicDevice (string micDeviceName, string micDeviceGuid)
void	SetSpeakerDevice (string speakerDeviceName, string speakerDeviceGuid)
bool	SubscribeBlock (int64 userId)	506
bool	SubscribePause (int64 userId, bool paused)
bool	SubscribePauseAll (bool paused)
bool	SubscribeRetry (int64 userId)	512
bool	SubscribeUnblock (int64 userId)	506
	LocalPlayerModerated ()	544
	ParticipantsStateChanged (Array participantsLeft, Array participantsJoined, Array updatedStates)
	PlayerMicActivitySignalChange (Dictionary activityInfo)
	StateChanged (VoiceChatState old, VoiceChatState new)	536
51 members inherited from Instance

552 Add VoiceChatInternal.GetSessionId
552 Add VoiceChatInternal.GetVoiceExperienceId
544 Add VoiceChatInternal.LocalPlayerModerated
541 Add VoiceChatInternal.GetChannelId
536 Change Security of VoiceChatInternal.StateChanged from RobloxScriptSecurity to None
516 Change Tags of VoiceChatInternal from [NotCreatable, Service] to [NotCreatable, Service, NotBrowsable]
512 Add VoiceChatInternal.SubscribeRetry
506 Add VoiceChatInternal.SubscribeBlock
506 Add VoiceChatInternal.SubscribeUnblock
499 Add VoiceChatInternal

Members

GetAndClearCallFailureMessage On DevHub

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

Tags: [Deprecated]

GetAudioProcessingSettings On DevHub

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

Tags: [Deprecated]

GetChannelId On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

541 Add VoiceChatInternal.GetChannelId

GetGroupId On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

GetMicDevices On DevHub

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

Tags: [Deprecated]

GetParticipants On DevHub

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

Tags: [Deprecated]

GetSessionId On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

552 Add VoiceChatInternal.GetSessionId

GetSpeakerDevices On DevHub

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

Tags: [Deprecated]

GetVoiceChatApiVersion On DevHub

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

Tags: [Deprecated]

GetVoiceChatAvailable On DevHub

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

Tags: [Deprecated]

GetVoiceExperienceId On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	string
Security	RobloxScriptSecurity

History

552 Add VoiceChatInternal.GetVoiceExperienceId

IsContextVoiceEnabled On DevHub

Parameters	0

Name	Type	Default
No parameters.

Return Type	bool
Security	RobloxScriptSecurity

IsPublishPaused On DevHub

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

Tags: [Deprecated]

IsSubscribePaused On DevHub

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

Tags: [Deprecated]

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

Tags: [Yields]

JoinByGroupId On DevHub

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

Tags: [Deprecated]

JoinByGroupIdToken On DevHub

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

Tags: [Deprecated]

Leave On DevHub

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

Tags: [Deprecated]

LocalPlayerModerated On DevHub

Parameters	0

Name	Type	Default
No parameters.

Security	RobloxScriptSecurity

History

544 Add VoiceChatInternal.LocalPlayerModerated

ParticipantsStateChanged On DevHub

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

Tags: [Deprecated]

PlayerMicActivitySignalChange On DevHub

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

Tags: [Deprecated]

PublishPause On DevHub

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

Tags: [Deprecated]

SetMicDevice On DevHub

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

Tags: [Deprecated]

SetSpeakerDevice On DevHub

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

Tags: [Deprecated]

StateChanged On DevHub

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

History

536 Change Security of VoiceChatInternal.StateChanged from RobloxScriptSecurity to None

Tags: [Deprecated]

SubscribeBlock On DevHub

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool
Security	RobloxScriptSecurity

History

506 Add VoiceChatInternal.SubscribeBlock

SubscribePause On DevHub

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

Tags: [Deprecated]

SubscribePauseAll On DevHub

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

Tags: [Deprecated]

SubscribeRetry On DevHub

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool
Security	RobloxScriptSecurity

History

512 Add VoiceChatInternal.SubscribeRetry

SubscribeUnblock On DevHub

Parameters	1

Name	Type	Default
userId	int64	none

Return Type	bool
Security	RobloxScriptSecurity

History

506 Add VoiceChatInternal.SubscribeUnblock

VoiceChatState On DevHub

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
Category	State
Can Load	false
Can Save	false

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

Relevant enums (1)

VoiceChatState