hoshimi
    Preparing search index...

    Interface LyricsMethods

    The lyrics methods for the player.

    interface LyricsMethods {
        current(skipSource?: boolean): Promise<LyricsResult | null>;
        get(track: Track, skipSource?: boolean): Promise<LyricsResult | null>;
        subscribe(skipSource?: boolean): Promise<void>;
        unsubscribe(): Promise<void>;
    }
    Index

    Methods

    current get subscribe unsubscribe

    Methods

    • Get the current lyrics for the current track.

      Parameters

      • OptionalskipSource: boolean

        Whether to skip the source or not.

      Returns Promise<LyricsResult | null>

      The lyrics result or null if not found.

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

    • Get the lyrics for a specific track.

      Parameters

      • track: Track

        The track to get the lyrics for.

      • OptionalskipSource: boolean

        Whether to skip the source or not.

      Returns Promise<LyricsResult | null>

      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 to the lyrics for a specific guild.

      Parameters

      • OptionalskipSource: boolean

        Whether to skip the source or not.

      Returns Promise<void>

      Let's start the sing session!

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

    • Unsubscribe from the lyrics for a specific guild.

      Returns Promise<void>

      Let's stop the sing session!

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

    Settings

    Member Visibility

    On This Page

    Methods