VoiceState

class VoiceState()

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

exported from lib.weeble.d

Properties

VoiceState.channelId

type: readonly string | null | undefined

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

VoiceState.deaf

type: readonly boolean | undefined

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

VoiceState.guildId

type: readonly string

Guild ID this voice state is for.

VoiceState.member

type: readonly GuildMember | null

Guild member object for this user, or null.

VoiceState.mute

type: readonly boolean | undefined

Indicates whether the user is server-muted.

VoiceState.requestToSpeakTimestamp

type: readonly number | null

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

VoiceState.selfDeaf

type: readonly boolean | undefined

Indicates whether the user has deafened themselves.

VoiceState.selfMute

type: readonly boolean | undefined

Indicates whether the user has muted themselves.

VoiceState.selfStream

type: readonly boolean | undefined

Indicates whether the user is streaming.

VoiceState.selfVideo

type: readonly boolean | undefined

Indicates whether the user’s camera is enabled.

VoiceState.sessionId

type: readonly string

Session ID for the voice connection.

VoiceState.suppress

type: readonly boolean | undefined

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

VoiceState.userId

type: readonly string

User ID of the connected user.