2 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

VoiceChatState

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.

Items

NameValueDescription
Idle0The player is not connected to voice chat and no join attempt is in progress.
Joining1A voice chat join attempt is in progress for the first time.
JoiningRetry2A voice chat join is being retried after a previous attempt did not succeed.
Joined3The player has successfully joined the voice chat session and is actively connected.
Leaving4The player is in the process of disconnecting from the voice chat session.
Ended5The voice chat session has ended normally.
Failed6The voice chat session ended due to an error, such as a failure to join or a mid-session error.

Idle

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

FieldValue
value0

Joining

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

FieldValue
value1

JoiningRetry

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

FieldValue
value2

Joined

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

FieldValue
value3

Leaving

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

FieldValue
value4

Ended

The voice chat session has ended normally.

FieldValue
value5

Failed

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

FieldValue
value6