Roblox API Reference

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.

Tags: [NotCreatable, Service, NotBrowsable]

Inherits (1)

Member index (27)

Type Member History
VoiceChatState VoiceChatState
string GetAndClearCallFailureMessage ()
Tuple GetAudioProcessingSettings ()
string GetGroupId ()
Tuple GetMicDevices ()
Array GetParticipants ()
Tuple GetSpeakerDevices ()
int GetVoiceChatApiVersion ()
int GetVoiceChatAvailable ()
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
ParticipantsStateChanged (Array participantsLeft, Array participantsJoined, Array updatedStates)
PlayerMicActivitySignalChange (Dictionary activityInfo)
StateChanged (VoiceChatState old, VoiceChatState new)
51 members inherited from Instance

History

Members

GetAndClearCallFailureMessage On DevHub

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

Tags: [Deprecated]

GetAudioProcessingSettings On DevHub

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

Tags: [Deprecated]

GetGroupId On DevHub

Name Type Default
No parameters.

GetMicDevices On DevHub

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

Tags: [Deprecated]

GetParticipants On DevHub

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

Tags: [Deprecated]

GetSpeakerDevices On DevHub

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

Tags: [Deprecated]

GetVoiceChatApiVersion On DevHub

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

Tags: [Deprecated]

GetVoiceChatAvailable On DevHub

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

Tags: [Deprecated]

IsContextVoiceEnabled On DevHub

Name Type Default
No parameters.

IsPublishPaused On DevHub

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

Tags: [Deprecated]

IsSubscribePaused On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
userId int64 none

Tags: [Deprecated]

IsVoiceEnabledForUserIdAsync On DevHub

This function yields. It will block the calling thread until completion.
Name Type Default
userId int64 none

Tags: [Yields]

JoinByGroupId On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
groupId string none
isMicMuted bool false

Tags: [Deprecated]

JoinByGroupIdToken On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
groupId string none
isMicMuted bool false

Tags: [Deprecated]

Leave On DevHub

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

Tags: [Deprecated]

ParticipantsStateChanged On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
participantsLeft Array none
participantsJoined Array none
updatedStates Array none

Tags: [Deprecated]

PlayerMicActivitySignalChange On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
activityInfo Dictionary none

Tags: [Deprecated]

PublishPause On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
paused bool none

Tags: [Deprecated]

SetMicDevice On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
micDeviceName string none
micDeviceGuid string none

Tags: [Deprecated]

SetSpeakerDevice On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
speakerDeviceName string none
speakerDeviceGuid string none

Tags: [Deprecated]

StateChanged On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
old VoiceChatState none
new VoiceChatState none

Tags: [Deprecated]

SubscribeBlock On DevHub

Name Type Default
userId int64 none

History

SubscribePause On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
userId int64 none
paused bool none

Tags: [Deprecated]

SubscribePauseAll On DevHub

This item is deprecated. It exists for backwards-compatibility only, and should not be used for new work.
Name Type Default
paused bool none

Tags: [Deprecated]

SubscribeRetry On DevHub

Name Type Default
userId int64 none

History

SubscribeUnblock On DevHub

Name Type Default
userId int64 none

History

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.

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]

Relevant enums (1)