Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClusterNode

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly cluster

cluster: BaseCluster

connection

connection: null | Connection<BaseNode> = null

http

http: null | Http = null

password

password: string

players

players: PlayerStore<ClusterNode>

send

send: ClusterSend

Optional shardCount

shardCount?: number

stats

stats: null | Stats

tags

tags: Set<string>

userID

userID: string

voiceServers

voiceServers: Map<string, GatewayVoiceServerUpdateDispatchData> = ...

voiceStates

voiceStates: Map<string, GatewayVoiceState> = ...

Accessors

connected

  • get connected(): boolean

  • Whether or not the node is connected to the websocket.

    Returns boolean

Methods

addListener

connect

  • connect(): Promise<void>

decode

  • decode(track: string): Promise<TrackInfo>
  • decode(tracks: string[]): Promise<Track[]>

  • Decodes a track.

    example
    const identifier = 'QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==';

    const track = await http.decode(identifier);
    console.log(track);
    // Logs: {
    //   "identifier": "dQw4w9WgXcQ",
    //   "isSeekable": true,
    //   "author": "RickAstleyVEVO",
    //   "length": 212000,
    //   "isStream": false,
    //   "position": 0,
    //   "title": "Rick Astley - Never Gonna Give You Up",
    //   "uri": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    // }

    Parameters

    • track: string

      The track to be decoded.

    Returns Promise<TrackInfo>

  • Decodes multiple tracks.

    note

    This returns an array of Tracks, not a TrackInfo.

    Parameters

    • tracks: string[]

      The tracks to be decoded.

    Returns Promise<Track[]>

destroy

  • destroy(code?: number, data?: string): Promise<void>

disconnect

  • disconnect(code?: number, data?: string): Promise<boolean>

emit

load

  • Loads a song.

    example
    // Load from URL:

    const result = await node.load('https://www.youtube.com/watch?v=dQw4w9WgXcQ');
    console.log(result);
    // {
    //   "loadType": "TRACK_LOADED",
    //   "playlistInfo": {},
    //   "tracks": [
    //     {
    //       "track": "QAAAjQIAJVJpY2sgQXN0bGV5IC0gTmV2ZXIgR29ubmEgR2l2ZSBZb3UgVXAADlJpY2tBc3RsZXlWRVZPAAAAAAADPCAAC2RRdzR3OVdnWGNRAAEAK2h0dHBzOi8vd3d3LnlvdXR1YmUuY29tL3dhdGNoP3Y9ZFF3NHc5V2dYY1EAB3lvdXR1YmUAAAAAAAAAAA==",
    //       "info": {
    //         "identifier": "dQw4w9WgXcQ",
    //         "isSeekable": true,
    //         "author": "RickAstleyVEVO",
    //         "length": 212000,
    //         "isStream": false,
    //         "position": 0,
    //         "title": "Rick Astley - Never Gonna Give You Up",
    //         "uri": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    //       }
    //     }
    //   ]
    // }
    example
    // Load from YouTube search:

    const result = await node.load('ytsearch: Never Gonna Give You Up');
    console.log(result);
    // {
    //   "loadType": "SEARCH_RESULT",
    //   "playlistInfo": {},
    //   "tracks": [
    //     {
    //       "track": "...",
    //       "info": {
    //         "identifier": "dQw4w9WgXcQ",
    //         "isSeekable": true,
    //         "author": "RickAstleyVEVO",
    //         "length": 212000,
    //         "isStream": false,
    //         "position": 0,
    //         "title": "Rick Astley - Never Gonna Give You Up",
    //         "uri": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
    //       }
    //     },
    //     ...
    //   ]
    // }

    Parameters

    • identifier: string

      The track to be loaded.

    Returns Promise<TrackResponse>

off

on

once

removeListener

voiceServerUpdate

  • voiceServerUpdate(packet: GatewayVoiceServerUpdateDispatchData): Promise<boolean>

voiceStateUpdate

  • voiceStateUpdate(packet: GatewayVoiceState): Promise<boolean>

Generated using TypeDoc