Roblox API Reference

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.

Tags: [NotCreatable, Service]

Inherits (1)

Member index (4)

Type Member History
bool EnableDefaultVoice 519 524
bool VoiceChatEnabledForPlaceOnRcc 520 521 521
bool VoiceChatEnabledForUniverseOnRcc 520 521 521
bool IsVoiceEnabledForUserIdAsync (int64 userId) 497
51 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

History

Members

EnableDefaultVoice On DevHub

History

IsVoiceEnabledForUserIdAsync On DevHub

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

History

Tags: [Yields]

VoiceChatEnabledForPlaceOnRcc On DevHub

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

History

Tags: [Hidden]

VoiceChatEnabledForUniverseOnRcc On DevHub

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

History

Tags: [Hidden]

Removed members

GenerateDefaultChannel

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

History

Tags: [NotBrowsable]

GetAndClearCallFailureMessage

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

History

Tags: [Deprecated]

GetAudioProcessingSettings

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

History

Tags: [Deprecated]

GetGroupId

Name Type Default
No parameters.

History

GetMicDevices

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

History

Tags: [Deprecated]

GetParticipants

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

History

Tags: [Deprecated]

GetSpeakerDevices

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

History

Tags: [Deprecated]

GetVoiceChatApiVersion

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

History

Tags: [Deprecated]

GetVoiceChatAvailable

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

History

Tags: [Deprecated]

IsContextVoiceEnabled

Name Type Default
No parameters.

History

IsPublishPaused

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

History

Tags: [Deprecated]

IsSubscribePaused

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

History

Tags: [Deprecated]

JoinByGroupId

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

History

Tags: [Deprecated]

JoinByGroupIdToken

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

History

Tags: [Deprecated]

Leave

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

History

Tags: [Deprecated]

ParticipantsStateChanged

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

History

Tags: [Deprecated]

PlayerMicActivitySignalChange

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

History

Tags: [Deprecated]

PublishPause

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

History

Tags: [Deprecated]

SetMicDevice

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

History

Tags: [Deprecated]

SetSpeakerDevice

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

History

Tags: [Deprecated]

StateChanged

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

History

Tags: [Deprecated]

SubscribePause

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

History

Tags: [Deprecated]

SubscribePauseAll

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

History

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.

History

Tags: [Hidden, ReadOnly, NotReplicated, Deprecated]