Class Plugin

Hierarchy (View Summary)

PlayerPlugin<
    {
        lyricsFound: [queue: Queue, lyrics: Lyrics];
        lyricsNotFound: [queue: Queue];
        lyricsLine: [
            queue: Queue,
            line: LyricsLine,
            index: number,
            skipped: boolean,
        ];
    },
>
- Plugin

Index

Constructors

Properties

name skipTrackSource _

Methods

init fetch fetchCurrent subscribe unsubscribe

Constructors

constructor

new Plugin(options?: PluginOptions): Plugin
Parameters
- Optionaloptions: PluginOptions
Returns Plugin
Overrides PlayerPlugin.constructor
- Defined in Plugins/LavaLyrics.ts:64

Properties

`Readonly`name

name: "lavalyrics"

skipTrackSource

skipTrackSource: boolean

`Protected`_

_: {
    lyricsFound: [
        queue: Queue<QueueContext>,
        lyrics: Lyrics<CommonPluginInfo>,
    ];
    lyricsNotFound: [queue: Queue<QueueContext>];
    lyricsLine: [
        queue: Queue<QueueContext>,
        line: LyricsLine<CommonPluginInfo>,
        index: number,
        skipped: boolean,
    ];
}

Methods

init

init(player: Player): void
Parameters
- player: Player
Returns void
Overrides PlayerPlugin.init
- Defined in Plugins/LavaLyrics.ts:69

fetch

fetch(
    track: string,
    node: string,
    skipTrackSource?: boolean,
): Promise<Lyrics<CommonPluginInfo> | null>
Parameters
- track: string
- node: string
- OptionalskipTrackSource: boolean
Returns Promise<Lyrics<CommonPluginInfo> | null>
- Defined in Plugins/LavaLyrics.ts:74

fetchCurrent

fetchCurrent(
guildId: string,
skipTrackSource?: boolean,
): Promise<Lyrics<CommonPluginInfo> | null>
Parameters
- guildId: string
- OptionalskipTrackSource: boolean
Returns Promise<Lyrics<CommonPluginInfo> | null>
- Defined in Plugins/LavaLyrics.ts:83

subscribe(guildId: string, skipTrackSource?: boolean): Promise<boolean>
Parameters
- guildId: string
- OptionalskipTrackSource: boolean
Returns Promise<boolean>
- Defined in Plugins/LavaLyrics.ts:95

unsubscribe

unsubscribe(guildId: string): Promise<boolean>
Parameters
- guildId: string
Returns Promise<boolean>
- Defined in Plugins/LavaLyrics.ts:107