Manager

The core class responsible for managing nodes, players, and audio search.

new Manager(options: ManagerOptions)

Constructor Options

Option	Type	Required	Description
`nodes`	array	Required	Array of Lavalink node configurations.
`send`	function	Required	Function to send voice data to Discord.
`autoPlay`	boolean	Optional	Automatically play the next track in queue.
`autoResume`	boolean	Optional	Resume playback after node reconnects.
`autoMove`	boolean	Optional	Move players to another node if node disconnects.
`shards`	number	Optional	Number of shards the bot is using.
`defaultSearchPlatform`	string	Optional	Default search platform (e.g. 'youtube music').
`trackPartial`	string[]	Optional	Array of track properties to keep after resolving.
`clientId`	string	Optional	Discord client ID.
`clientName`	string	Optional	Discord client name.
`plugins`	array	Optional	Array of plugins to load.

Properties

nodes

The map of all connected nodes.

Map<string, Node>

players

The map of all active players.

Map<string, Player>

options

The options passed to the constructor.

ManagerOptions

Methods

init(clientId)→ this

Initiates the Manager and connects to all configured nodes. Must be called once your Discord client is ready.

Parameter	Type	Required
`clientId`	string	Required

search(query, requester)→ Promise<SearchResult>

Searches the enabled sources based on the URL or search query. Supports YouTube, SoundCloud, Spotify, and more.

Parameter	Type	Required
`query`	string \| SearchQuery	Required
`requester`	unknown	Optional

create(options)→ Player

Creates a new player or returns an existing one for the specified guild.

Parameter	Type	Required
`options`	PlayerOptions	Required

get(guildId)→ Player | undefined

Returns a player for the specified guild, or undefined if it doesn't exist.

Parameter	Type	Required
`guildId`	string	Required

destroy(guildId)→ void

Destroys a player if it exists.

Parameter	Type	Required
`guildId`	string	Required

createNode(options)→ Node

Creates a node or returns one if it already exists.

Parameter	Type	Required
`options`	NodeOptions	Required

destroyNode(identifier)→ void

Destroys a node if it exists.

Parameter	Type	Required
`identifier`	string	Required

decodeTrack(track)→ Promise<TrackData>

Decodes a base64 encoded track string and returns TrackData.

Parameter	Type	Required
`track`	string	Required

decodeTracks(tracks)→ Promise<TrackData[]>

Decodes multiple base64 encoded track strings and returns a TrackData array.

Parameter	Type	Required
`tracks`	string[]	Required

updateVoiceState(data)→ void

Sends voice state data to the Lavalink server. This must be called on every raw Discord event.

Parameter	Type	Required
`data`	VoicePacket	Required

Events

Listen to Manager events using manager.on(event, callback)

nodeCreateNode

Emitted when a Node is created.

nodeDestroyNode

Emitted when a Node is destroyed.

nodeConnectNode

Emitted when a Node connects.

nodeReconnectNode

Emitted when a Node reconnects.

nodeDisconnectNode{ code, reason }

Emitted when a Node disconnects.

nodeErrorNodeError

Emitted when a Node has an error.

playerCreatePlayer

Emitted when a Player is created.

playerDestroyPlayer

Emitted when a Player is destroyed.

playerMovePlayeroldChannelnewChannel

Emitted when a Player moves to a new voice channel.

queueEndPlayer

Emitted when the player's queue ends.

trackStartPlayerTrackTrackStartEvent

Emitted when a track starts playing.

trackEndPlayerTrackTrackEndEvent

Emitted when a track ends.

trackStuckPlayerTrackTrackStuckEvent

Emitted when a track gets stuck during playback.

trackErrorPlayerTrackTrackExceptionEvent

Emitted when a track has a playback error.

socketClosedPlayerWebSocketClosedEvent

Emitted when a voice WebSocket connection closes.

nodeRawpayload

Emitted whenever any Lavalink event is received.