Class VoiceManager

constructor

• new VoiceManager(player: Player): VoiceManager

  Parameters

  • player: Player

  Returns VoiceManager

Readonlyregions

size

• get size(): number

  Returns number

  the number of elements in the Map.

cache

• get cache(): Map<string, VoiceStateInfo>

  A map holding this manager's intrinsic data

  Returns Map<string, VoiceStateInfo>

get

• get(guildId: string): VoiceState | undefined

  Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

  Parameters

  • guildId: string

  Returns VoiceState | undefined

  Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

• has(guildId: string): boolean

  Parameters

  • guildId: string

  Returns boolean

  boolean indicating whether an element with the specified key exists or not.

keys

• keys(): MapIterator<string>

  Returns an iterable of keys in the map

  Returns MapIterator<string>

values

• values(): MapIterator<VoiceState>

  Returns an iterable of values in the map

  Returns MapIterator<VoiceState>

entries

• entries(): MapIterator<[string, VoiceState]>

  Returns an iterable of key, value pairs for every entry in the map.

  Returns MapIterator<[string, VoiceState]>

destroy

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

  Disconnects and destroys the state of a voice connection

  Parameters

  • guildId: string

    Id of the guild

  • reason: string = "destroyed"

    Reason for destroying

  Returns Promise<void>

connect

• connect(
      guildId: string,
      voiceId: string,
      options?: ConnectOptions,
  ): Promise<VoiceState>

  Connects to a voice channel and returns its state

  Parameters

  • guildId: string

    Id of the guild

  • voiceId: string

    Id of the voice channel

  • Optionaloptions: ConnectOptions

    Options for customization

  Returns Promise<VoiceState>

disconnect

• disconnect(guildId: string): Promise<void>

  Disconnects the voice connection of a guild

  Parameters

  • guildId: string

    Id of the guild

  Returns Promise<void>

handleDispatch

• handleDispatch(payload: unknown): void

  Handles payloads dispatched by Discord to the bot

  Parameters

  • payload: unknown

    'Dispatch' payload received from Discord

  Returns void

[iterator]

• "[iterator]"(): MapIterator<[string, VoiceState]>

  Returns MapIterator<[string, VoiceState]>