Class Plugin

constructor

• new Plugin(options?: PluginOptions): Plugin

  Parameters

  • Optionaloptions: PluginOptions

  Returns Plugin

name

eventMap

skipTrackSource

init

• init(player: Player): void

  Parameters

  • player: Player

  Returns void

fetch

• fetch(
      track: string,
      node: string,
      skipTrackSource?: boolean,
  ): Promise<Lyrics<EmptyObject> | null>

  Parameters

  • track: string
  • node: string
  • OptionalskipTrackSource: boolean

  Returns Promise<Lyrics<EmptyObject> | null>

fetchCurrent

• fetchCurrent(
      guildId: string,
      skipTrackSource?: boolean,
  ): Promise<Lyrics<EmptyObject> | null>

  Parameters

  • guildId: string
  • OptionalskipTrackSource: boolean

  Returns Promise<Lyrics<EmptyObject> | null>

subscribe

• subscribe(guildId: string, skipTrackSource?: boolean): Promise<boolean>

  Parameters

  • guildId: string
  • OptionalskipTrackSource: boolean

  Returns Promise<boolean>

unsubscribe

• unsubscribe(guildId: string): Promise<boolean>

  Parameters

  • guildId: string

  Returns Promise<boolean>