Reference API Roblox

Engine API

Website

Related

Reference API Roblox

VoiceChatState

Describes the connection state of a local player's voice chat session.

Items 7

HistoryNameValueDescription
490Idle0

The player is not connected to voice chat and no join attempt is in progress.

490Joining1

A voice chat join attempt is in progress for the first time.

490JoiningRetry2

A voice chat join is being retried after a previous attempt did not succeed.

490Joined3

The player has successfully joined the voice chat session and is actively connected.

490Leaving4

The player is in the process of disconnecting from the voice chat session.

490Ended5

The voice chat session has ended normally.

490Failed6

The voice chat session ended due to an error, such as a failure to join or a mid-session error.

Description

Describes the connection state of a local player's voice chat session. The session progresses through the VoiceChatState items from idle, through joining, to joined, and then to leaving, ended, or failed when the session concludes.

History 8

Settings