VoiceState

class VoiceState

Tracks a user’s current voice connection status in a guild, including channel, mute/deafen state, and stage suppression.

Properties

Property

Type

Description

channelId

string | null | undefined

Channel ID the user is connected to, or null if not in voice.

deaf

boolean | undefined

Indicates whether the user is server-deafened. undefined when the payload omitted it; false only when Discord sent false.

guildId

string

Guild ID this voice state is for.

member

GuildMember | null

Guild member object for this user, or null.

mute

boolean | undefined

Indicates whether the user is server-muted.

requestToSpeakTimestamp

number | null

Stage request-to-speak time as a Unix timestamp in milliseconds.

selfDeaf

boolean | undefined

Indicates whether the user has deafened themselves.

selfMute

boolean | undefined

Indicates whether the user has muted themselves.

selfStream

boolean | undefined

Indicates whether the user is streaming.

selfVideo

boolean | undefined

Indicates whether the user’s camera is enabled.

sessionId

string

Session ID for the voice connection.

suppress

boolean | undefined

Indicates whether the user is suppressed (in a stage).

userId

string

User ID of the connected user.