Class VoiceState

constructor

• new VoiceState(player, node, guildId): VoiceState

• Parameters

  • player: Player<QueueContext, []>
  • node: string
  • guildId: string

  Returns VoiceState

Readonly guildId

Readonly player

node

• get node(): LavalinkNode

• Current node for this voice connection

  Returns LavalinkNode

ping

• get ping(): number

• Ping to the voice server in milliseconds

  Returns number

regionId

• get regionId(): null | string

• Voice region ID (e.g., "us-west", "eu-central")

  Returns null | string

channelId

• get channelId(): string

• Voice channel ID

  Returns string

selfDeaf

• get selfDeaf(): boolean

• Whether the bot is self-deafened

  Returns boolean

selfMute

• get selfMute(): boolean

• Whether the bot is self-muted

  Returns boolean

serverDeaf

• get serverDeaf(): boolean

• Whether the bot is server-deafened

  Returns boolean

serverMute

• get serverMute(): boolean

• Whether the bot is server-muted

  Returns boolean

suppressed

• get suppressed(): boolean

• Whether the bot is suppressed (priority speaker)

  Returns boolean

destroyed

• get destroyed(): boolean

• Whether this voice state has been destroyed

  Returns boolean

connected

• get connected(): boolean

• Whether the voice connection is fully connected

  Returns boolean

reconnecting

• get reconnecting(): boolean

• Whether the voice connection is reconnecting

  Returns boolean

disconnected

• get disconnected(): boolean

• Whether the voice connection is disconnected

  Returns boolean

changingNode

• get changingNode(): boolean

• Whether the voice connection is changing nodes

  Returns boolean

sessionId

• get sessionId(): null | string

• Session ID for the voice connection

  Returns null | string

token

• get token(): null | string

• Voice server token

  Returns null | string

endpoint

• get endpoint(): null | string

• Voice server endpoint

  Returns null | string

nodeSessionId

• get nodeSessionId(): null | string

• Node session ID this voice state is connected to

  Returns null | string

destroy

• destroy(reason?): Promise<void>

• Destroy this voice connection

  Parameters

  • Optional reason: string

    Optional reason for destruction

  Returns Promise<void>

connect

• connect(channelId?): Promise<void>

• Connect to a voice channel

  Parameters

  • channelId: string = ...

    Voice channel ID (defaults to current channel)

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

• Disconnect from the voice channel

  Returns Promise<void>

changeNode

• changeNode(name): Promise<void>

• Change to a different Lavalink node Preserves playback state and filters

  Parameters

  • name: string

    Name of the node to change to

  Returns Promise<void>

toString

• toString(): string

• String representation of the voice state

  Returns string