Manager

Initialize Manager

Initializes the manager and connects to all configured nodes. This method sets up the database, initializes nodes, and prepares the manager for handling voice connections.

Parameters

Returns & Example

Returns • void

client.once('ready', () => {
  manager.init(client.user.id);
});

Search Tracks

Searches for tracks using the configured nodes or native sources (like Spotify). The search will be performed on the best available node or a specific node if provided. Supports fallback sources.

Parameters

Returns & Example

Returns • Promise<SearchResult> — Search results containing tracks and playlist info

const results = await manager.search({
  query: 'Never Gonna Give You Up',
  source: 'youtube',
  fallbackSources: ['soundcloud', 'deezer']
});

LavaSearch Tracks

Performs a search using the LavaSearch plugin, supporting multiple result types (tracks, albums, artists, playlists, text). Requires a NodeLink server with LavaSearch plugin.

Parameters

Returns & Example

Returns • Promise<SearchResult> — Search results containing various types of data.

const results = await manager.lavaSearch({
  query: 'Never Gonna Give You Up',
  source: 'youtube',
  types: 'track,artist'
});

if (results.tracks.length > 0) {
  console.log('Found tracks:', results.tracks.map(t => t.title));
}
if (results.artists && results.artists.length > 0) {
  console.log('Found artists:', results.artists.map(a => a.info.name));
}

Get Lyrics

Fetches lyrics for a track using available lyrics plugins. Supports fetching by player's current track, encoded track, or video ID. Prioritizes timed lyrics.

Parameters

Returns & Example

Returns • Promise<ILavaLyricsObject | null> — Lyrics data or null if not found.

// Get lyrics for current playing track
const lyrics = await manager.getLyrics({ player: myPlayer });
if (lyrics) {
  console.log(`Lyrics for ${lyrics.track.title}:
${lyrics.text}`);
}

// Get lyrics by video ID
const youtubeLyrics = await manager.getLyrics({ videoId: 'dQw4w9WgXcQ' });

Search Lyrics

Searches for lyrics based on a query using available lyrics plugins.

Parameters

Returns & Example

Returns • Promise<any[] | null> — An array of search results or null if no results found.

const searchResults = await manager.searchLyrics({ query: 'Never Gonna Give You Up Rick Astley' });
if (searchResults && searchResults.length > 0) {
  console.log('Found lyrics search results:', searchResults);
}

Subscribe to Live Lyrics

Subscribes to live lyrics updates for a specific guild. The provided callback will be invoked with each new lyrics line.

Parameters

Returns & Example

Returns • Promise<void>

manager.subscribeLyrics('123456789', (line) => {
  console.log(`Live Lyric: ${line.line} (at ${line.timestamp}ms)`);
});

Unsubscribe from Live Lyrics

Unsubscribes from live lyrics updates for a specific guild.

Parameters

Returns & Example

Returns • Promise<void>

manager.unsubscribeLyrics('123456789');
console.log('Unsubscribed from live lyrics.');

Create Player

Parameters

Returns & Example

Returns • Player — The created player instance

const player = manager.createPlayer({
  guildId: '123456789',
  voiceChannelId: '123456789',
  textChannelId: '123456789'
});

Get Player

Parameters

Returns & Example

Returns • Player — The player instance if it exists

const player = manager.getPlayer('123456789');

Has Player

Parameters

Returns & Example

Returns • boolean — Whether the player exists

const exists = manager.hasPlayer('123456789');

Delete Player

Parameters

Returns & Example

Returns • boolean — Whether the deletion was successful

manager.deletePlayer('123456789');

Get All Players

Returns & Example

Returns • Map<string, Player> — Map of all players

const players = manager.getAllPlayers();