Class ExtractorPluginAbstract

constructor

• new ExtractorPlugin(): ExtractorPlugin

  Returns ExtractorPlugin

Readonlytype

AbstractgetStreamURL

• getStreamURL<T>(song: Song<T>): Awaitable<string>

  Get the stream url from Song#url. Returns Song#url by default. Not needed if the plugin plays song from YouTube.

  Type Parameters

  • T

  Parameters

  • song: Song<T>

    Input song

  Returns Awaitable<string>

Abstractresolve

• resolve<T>(
      url: string,
      options: ResolveOptions<T>,
  ): Awaitable<Song<T> | Playlist<T>>

  Resolve the validated url to a Song or a Playlist.

  Type Parameters

  • T

  Parameters

  • url: string

    URL

  • options: ResolveOptions<T>

    Optional options

  Returns Awaitable<Song<T> | Playlist<T>>

AbstractsearchSong

• searchSong<T>(
      query: string,
      options: ResolveOptions<T>,
  ): Awaitable<Song<T> | null>

  Search for a Song which playable from this plugin's source

  Type Parameters

  • T

  Parameters

  • query: string

    Search query

  • options: ResolveOptions<T>

    Optional options

  Returns Awaitable<Song<T> | null>

Abstractvalidate

• validate(url: string): Awaitable<boolean>

  Check if the url is working with this plugin

  Parameters

  • url: string

    Input url

  Returns Awaitable<boolean>