Class CustomPluginAbstract

constructor

• new CustomPlugin(): CustomPlugin

• Returns CustomPlugin

distube

client

• get client(): Client<boolean>

• Discord.js client

  Returns Client<boolean>

handler

• get handler(): DisTubeHandler

• DisTube handler

  Returns DisTubeHandler

options

• get options(): Options

• DisTube options

  Returns Options

queues

• get queues(): QueueManager

• The queue manager

  Returns QueueManager

voices

• get voices(): DisTubeVoiceManager

• The voice manager

  Returns DisTubeVoiceManager

emit

• emit(eventName, ...args): boolean

• Emit an event to the DisTube class

  Parameters

  • eventName: keyof DisTubeEvents

    Event name
  • Rest ...args: any

    arguments

  Returns boolean

emitError

• emitError(error, channel?): void

• Emit error event to the DisTube class

  Parameters

  • error: Error

    error
  • Optional channel: GuildTextBasedChannel

    Text channel where the error is encountered.

  Returns void

getRelatedSongs

• getRelatedSongs(_url): Awaitable<RelatedSong[]>

• Get related songs from a supported url. Song#member should be undefined. Not needed to add Song#related because it will be added with this function later.

  Parameters

  • _url: string

    Input url

  Returns Awaitable<RelatedSong[]>

getStreamURL

• getStreamURL(url): Awaitable<string>

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

  Parameters

  • url: string

    Input url

  Returns Awaitable<string>

init

• init(distube): void

• Parameters

  • distube: DisTube

  Returns void

validate

• validate(_string): Awaitable<boolean>

• Check if the string is working with this plugin

  Parameters

  • _string: string

    Input string

  Returns Awaitable<boolean>