hoshimi
    Preparing search index...

    Class LyricsManager

    Class representing a LyricsManager. LyricsManager

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    node: Node

    The node instance.

    Methods

    • Get the current lyrics for the current track.

      Parameters

      • guildId: string
      • skipSource: boolean = false

        Whether to skip the track source or not.

      Returns Promise<LyricsResult | null>

      The lyrics result or null if not found.

      const player = manager.getPlayer("guildId");
      const lyrics = await player.lyricsManager.current();
    • Get the lyrics for a specific track.

      Parameters

      • track: Track

        The track to get the lyrics for.

      • skipSource: boolean = false

        Whether to skip the track source or not.

      Returns Promise<LyricsResult | null>

      The lyrics result or null if not found.

      const node = manager.nodeManager.get("nodeId");
      const lyrics = await node.lyricsManager.get(track);
    • Subscribe to the lyrics for a specific guild.

      Parameters

      • guildId: string

        The guild id to subscribe to.

      • skipSource: boolean = false

        Whether to skip the track source or not.

      Returns Promise<void>

      Let's start the sing session!

      const node = manager.nodeManager.get("nodeId");
      await node.lyricsManager.subscribe("guildId");
    • Unsubscribe from the lyrics for a specific guild.

      Parameters

      • guildId: string

        The guild id to unsubscribe from.

      Returns Promise<void>

      Let's stop the sing session!

      const node = manager.nodeManager.get("nodeId");
      await node.lyricsManager.unsubscribe("guildId");