Class InfoExtractorPlugin`Abstract`

This plugin only can extract the info from supported links, but not play song directly from its source

Hierarchy (view full)

Plugin
- InfoExtractorPlugin

Index

Constructors

Properties

Methods

createSearchQuery getRelatedSongs init resolve validate

Constructors

constructor

new InfoExtractorPlugin(): InfoExtractorPlugin
Returns InfoExtractorPlugin
Inherited from Plugin.constructor

Properties

distube

distube: DisTube

DisTube

`Readonly`type

type: INFO_EXTRACTOR = PluginType.INFO_EXTRACTOR

Type of the plugin

Methods

`Abstract`createSearchQuery

createSearchQuery<T>(song): Awaitable<string>
Create a search query to be used in ExtractorPlugin#searchSong
Type Parameters
- T
Parameters
- song: Song<T>
  Input song
Returns Awaitable<string>
- Defined in src/struct/InfoExtratorPlugin.ts:26

`Abstract`getRelatedSongs

getRelatedSongs(song): Awaitable<Song<unknown>[]>
Get related songs from a supported url.
Parameters
- song: Song<unknown>
  Input song
Returns Awaitable<Song<unknown>[]>
Inherited from Plugin.getRelatedSongs
- Defined in src/struct/Plugin.ts:22

init

init(distube): void
Parameters
- distube: DisTube
Returns void
Inherited from Plugin.init
- Defined in src/struct/Plugin.ts:15

`Abstract`resolve

resolve<T>(url, options): 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>>
- Defined in src/struct/InfoExtratorPlugin.ts:20

`Abstract`validate

validate(url): Awaitable<boolean>
Check if the url is working with this plugin
Parameters
- url: string
  Input url
Returns Awaitable<boolean>
- Defined in src/struct/InfoExtratorPlugin.ts:14