Classes
LyricsManager
Class representing a LyricsManager.
Signature
export declare class LyricsManagerJSDoc
@classLyricsManager
Properties
1Methods
5Properties
readonly node: NodeStructure;The node instance.
@type{NodeStructure}@readonly
Methods
constructorConstructorconstructor(node: NodeStructure);current(guildId: string, skipSource?: boolean): Promise<LyricsResult | null>;Get the current lyrics for the current track.
Parameters
guildId- The guild id to get the current lyrics for.
skipSource- Whether to skip the track source or not.
Returns
The lyrics result or null if not found.
Examples
const node = manager.nodeManager.get("nodeId");
const lyrics = await node.lyricsManager.current("guildId");get(track: TrackStructure, skipSource?: boolean): Promise<LyricsResult | null>;Get the lyrics for a specific track.
Parameters
track- The track to get the lyrics for.
skipSource- Whether to skip the track source or not.
Returns
The lyrics result or null if not found.
Examples
const node = manager.nodeManager.get("nodeId");
const lyrics = await node.lyricsManager.get(track);subscribe(guildId: string, skipSource?: boolean): Promise<void>;Subscribe to the lyrics for a specific guild.
Parameters
guildId- The guild id to subscribe to.
skipSource- Whether to skip the track source or not.
Returns
Let's start the sing session!
Examples
const node = manager.nodeManager.get("nodeId");
await node.lyricsManager.subscribe("guildId");unsubscribe(guildId: string): Promise<void>;Unsubscribe from the lyrics for a specific guild.
Parameters
guildId- The guild id to unsubscribe from.
Returns
Let's stop the sing session!
Examples
const node = manager.nodeManager.get("nodeId");
await node.lyricsManager.unsubscribe("guildId");