Class VoiceRegion

constructor

• new VoiceRegion(player, regionId): VoiceRegion

• Parameters

  • player: Player<QueueContext, []>
  • regionId: string

  Returns VoiceRegion

Readonly id

Readonly player

nodeCount

• get nodeCount(): number

• Get the number of nodes with ping data

  Returns number

inSync

• inSync(): boolean

• Check if all ready nodes have ping data for this region

  Returns boolean

  true if all nodes are synced, false otherwise

forgetNode

• forgetNode(name): boolean

• Remove ping data for a node

  Parameters

  • name: string

    Node name

  Returns boolean

  true if data was removed, false if it didn't exist

getAveragePing

• getAveragePing(name): null | number

• Get the average ping for a node in this region

  Parameters

  • name: string

    Node name

  Returns null | number

  Average ping in milliseconds, or null if no data

getAllPings

• getAllPings(): [string, null | number][]

• Get all nodes with their average pings

  Returns [string, null | number][]

  Array of [nodeName, averagePing] tuples

getRelevantNode

• getRelevantNode(): LavalinkNode

• Get the most relevant node for this region Selects based on lowest average ping

  Returns LavalinkNode

  The node with lowest ping, or first relevant node if no ping data

[OnPingUpdateSymbol]

• [OnPingUpdateSymbol](name, state): void
• Internal

  Internal method to update ping statistics Called by the voice manager when player state updates

  Parameters

  • name: string

    Node name
  • state: PlayerState

    Player state with ping information

  Returns void

clear

• clear(): void

• Clear all ping data for this region

  Returns void

toString

• toString(): string

• String representation of the voice region

  Returns string

toJSON

• toJSON(): {
      id: string;
      inSync: boolean;
      nodeCount: number;
      pings: {
          node: string;
          averagePing: null | number;
          samples: number;
      }[];
  }

• JSON representation of the voice region

  Returns {
      id: string;
      inSync: boolean;
      nodeCount: number;
      pings: {
          node: string;
          averagePing: null | number;
          samples: number;
      }[];
  }

  • id: string

  • inSync: boolean

  • nodeCount: number

  • pings: {
        node: string;
        averagePing: null | number;
        samples: number;
    }[]