LyricsMethods Interface

Signature

export interface LyricsMethods

No properties.

current(skipSource?: boolean): Promise<LyricsResult | null>;

Get the current lyrics for the current track.

The lyrics result or null if not found.

const player = manager.getPlayer("guildId");
const lyrics = await player.lyrics.current();

get(track: TrackStructure, skipSource?: boolean): Promise<LyricsResult | null>;

Get the lyrics for a specific track.

The lyrics result or null if not found.

const player = manager.getPlayer("guildId");
const track = player.queue.current;
const lyrics = await player.lyrics.get(track);

subscribe(skipSource?: boolean): Promise<void>;

Subscribe to the lyrics for a specific guild.

Let's start the sing session!

const player = manager.getPlayer("guildId");
await player.lyrics.subscribe();

unsubscribe(): Promise<void>;

Unsubscribe from the lyrics for a specific guild.

Let's stop the sing session!

const player = manager.getPlayer("guildId");
await player.lyrics.unsubscribe();