Skip to main content
Version: v2.10.0

Interface: VoiceState

warning

There are two different interfaces named VoiceState used in different parts of the system:

  • One from Discord, received through the gateway.
  • One used internally by the Lavalink client to propagate voice connection updates.

This naming conflict is resolved in v2.10.1.

VoiceState (Discord Gateway)

Payload received from Discord's VOICE_STATE_UPDATE event.

Property Type Description Optional
guild_idstringID of the guild the voice state belongs to.
user_idstringID of the user whose voice state is updated.
session_idstringSession ID used to identify the voice connection.
channel_idstring | nullID of the voice channel the user is in, or null if they have disconnected.

Internal structure used by the Lavalink manager to send voice update payloads to the node.

Property Type Description Optional
opstring = "voiceUpdate"Operation type identifying this as a voice update payload.
guildIdstringThe guild ID associated with the voice update.
eventVoiceServerThe voice server event containing the endpoint and token.
sessionIdstringThe session ID for the voice connection.
channelIdstringThe voice channel ID.