Class VoiceState

constructor

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

  Parameters

  • player: Player
  • node: string
  • guildId: string

  Returns VoiceState

ReadonlyguildId

Readonlyplayer

node

• get node(): Node

  Node of this voice connection

  Returns Node

ping

• get ping(): number

  Ping of the node with the voice server

  Returns number

regionId

• get regionId(): string

  Id of the voice region

  Returns string

channelId

• get channelId(): string

  Id of the voice channel

  Returns string

selfDeaf

• get selfDeaf(): boolean

  Whether the bot has deafened itself

  Returns boolean

selfMute

• get selfMute(): boolean

  Whether the bot has muted itself

  Returns boolean

serverDeaf

• get serverDeaf(): boolean

  Whether the bot is deafened by the guild

  Returns boolean

serverMute

• get serverMute(): boolean

  Whether the bot is muted by the guild

  Returns boolean

joined

• get joined(): boolean

  Whether the bot is in voice channel

  Returns boolean

suppressed

• get suppressed(): boolean

  Whether the bot is suppressed

  Returns boolean

destroyed

• get destroyed(): boolean

  Whether this voice state instance is destroyed

  Returns boolean

connected

• get connected(): boolean

  Whether the node is connected to the voice server

  Returns boolean

reconnecting

• get reconnecting(): boolean

  Whether a reconnect is in progress

  Returns boolean

disconnected

• get disconnected(): boolean

  Whether the node has disconnected from the voice server and no attempts are being made to reconnect

  Returns boolean

changingNode

• get changingNode(): boolean

  Whether the node for this connection is being changed

  Returns boolean

destroy

• destroy(reason?: string): Promise<void>

  Destroy this voice connection

  Parameters

  • Optionalreason: string

    Reason for destroying

  Returns Promise<void>

connect

• connect(channelId?: string): Promise<VoiceState>

  Connect to a voice channel by Id (default if not specified)

  Parameters

  • channelId: string = ...

    Id of the voice channel

  Returns Promise<VoiceState>

reconnect

• reconnect(): Promise<VoiceState>

  Rejoin the voice channel

  Returns Promise<VoiceState>

disconnect

• disconnect(): Promise<void>

  Disconnect from the voice channel

  Returns Promise<void>

changeNode

• changeNode(name: string): Promise<void>

  Change the node of this voice connection

  Parameters

  • name: string

    Name of the node

  Returns Promise<void>