Reference API Roblox

Engine API

Website

Related

Reference API Roblox

VoiceChatInternal

Summary

This class is not creatable. Instances 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 class is not browsable. It is not visible in Studio's object browser.
Tags: [NotCreatable, Service, NotBrowsable]

Member index 33

HistoryMember
499GetAndClearCallFailureMessage(): string
499GetAudioProcessingSettings(): Tuple
541GetChannelId(): string
499GetGroupId(): string
499GetMicDevices(): Tuple
499GetParticipants(): Array
552GetSessionId(): string
499GetSpeakerDevices(): Tuple
499GetVoiceChatApiVersion(): int
499GetVoiceChatAvailable(): int
552GetVoiceExperienceId(): string
499IsContextVoiceEnabled(): bool
499IsPublishPaused(): bool
499IsSubscribePaused(userId: int64): bool
499IsVoiceEnabledForUserIdAsync(userId: int64): bool
499JoinByGroupId(groupId: string, isMicMuted: bool = false): bool
583JoinByGroupIdToken(groupId: string, isMicMuted: bool, isRetry: bool = false): bool
573Leave(): null
589LogPublisherWebRTCStats(): bool
589LogSubscriptionWebRTCStats(): bool
499PublishPause(paused: bool): bool
573SetMicDevice(micDeviceName: string, micDeviceGuid: string): null
573SetSpeakerDevice(speakerDeviceName: string, speakerDeviceGuid: string): null
506SubscribeBlock(userId: int64): bool
499SubscribePause(userId: int64, paused: bool): bool
499SubscribePauseAll(paused: bool): bool
512SubscribeRetry(userId: int64): bool
506SubscribeUnblock(userId: int64): bool
544LocalPlayerModerated()
499ParticipantsStateChanged(participantsLeft: Array, participantsJoined: Array, updatedStates: Array)
499PlayerMicActivitySignalChange(activityInfo: Dictionary)
536StateChanged(old: VoiceChatState, new: VoiceChatState)
inherited from Instance
553Archivable: bool
619Capabilities: SecurityCapabilities
553ClassName: string
553Name: string
553Parent: Instance
619Sandboxed: bool
616UniqueId: UniqueId
553className: string
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
486GetAttributes(): Dictionary
486GetChildren(): Objects
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
462GetPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsA(className: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
553children(): Objects
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
553getChildren(): Objects
462isA(className: string): bool
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462Changed(property: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)

History 41

Members 33

GetAndClearCallFailureMessage

Parameters (0)
No parameters.
Returns (1)
string
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

GetAudioProcessingSettings

Parameters (0)
No parameters.
Returns (1)
Tuple
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

GetChannelId

Parameters (0)
No parameters.
Returns (1)
string

History 1

GetGroupId

Parameters (0)
No parameters.
Returns (1)
string

History 1

GetMicDevices

Parameters (0)
No parameters.
Returns (1)
Tuple
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

GetParticipants

Parameters (0)
No parameters.
Returns (1)
Array
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

GetSessionId

Parameters (0)
No parameters.
Returns (1)
string

History 1

GetSpeakerDevices

Parameters (0)
No parameters.
Returns (1)
Tuple
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

GetVoiceChatApiVersion

Parameters (0)
No parameters.
Returns (1)
int
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

GetVoiceChatAvailable

Parameters (0)
No parameters.
Returns (1)
int
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

GetVoiceExperienceId

Parameters (0)
No parameters.
Returns (1)
string

History 1

IsContextVoiceEnabled

Parameters (0)
No parameters.
Returns (1)
bool

History 1

IsPublishPaused

Parameters (0)
No parameters.
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

IsSubscribePaused

Parameters (1)
userIdint64
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

IsVoiceEnabledForUserIdAsync

Parameters (1)
userIdint64
Returns (1)
bool
This function yields. It will block the calling thread until completion.

History 1

Tags: [Yields]

JoinByGroupId

Parameters (2)Default
groupIdstring
isMicMutedboolfalse
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

JoinByGroupIdToken

Parameters (3)Default
groupIdstring
isMicMutedbool
isRetryboolfalse
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

Leave

Parameters (0)
No parameters.
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

LocalPlayerModerated

Parameters (0)
No parameters.

History 1

LogPublisherWebRTCStats

Parameters (0)
No parameters.
Returns (1)
bool

History 1

LogSubscriptionWebRTCStats

Parameters (0)
No parameters.
Returns (1)
bool

History 1

ParticipantsStateChanged

Parameters (3)
participantsLeftArray
participantsJoinedArray
updatedStatesArray
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

PlayerMicActivitySignalChange

Parameters (1)
activityInfoDictionary
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

PublishPause

Parameters (1)
pausedbool
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

SetMicDevice

Parameters (2)
micDeviceNamestring
micDeviceGuidstring
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

SetSpeakerDevice

Parameters (2)
speakerDeviceNamestring
speakerDeviceGuidstring
Returns (1)
null
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

StateChanged

Parameters (2)
oldVoiceChatState
newVoiceChatState
This event is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 2

Tags: [Deprecated]

SubscribeBlock

Parameters (1)
userIdint64
Returns (1)
bool

History 1

SubscribePause

Parameters (2)
userIdint64
pausedbool
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

SubscribePauseAll

Parameters (1)
pausedbool
Returns (1)
bool
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 1

Tags: [Deprecated]

SubscribeRetry

Parameters (1)
userIdint64
Returns (1)
bool

History 1

SubscribeUnblock

Parameters (1)
userIdint64
Returns (1)
bool

History 1

Settings