Class DisTubeHandler

DisTube's Handler

Hierarchy (View Summary)

DisTubeBase
- DisTubeHandler

Index

Constructors

constructor

new DisTubeHandler(distube: DisTube): DisTubeHandler
Parameters
- distube: DisTube
Returns DisTubeHandler
Inherited from DisTubeBase.constructor
- Defined in src/core/DisTubeBase.ts:13

Properties

distube

distube: DisTube

Accessors

client

get client(): Client
Discord.js client

Returns Client
Inherited from DisTubeBase.client
- Defined in src/core/DisTubeBase.ts:58

handler

get handler(): DisTubeHandler
DisTube handler

Returns DisTubeHandler
Inherited from DisTubeBase.handler
- Defined in src/core/DisTubeBase.ts:70

options

get options(): Options
DisTube options

Returns Options
Inherited from DisTubeBase.options
- Defined in src/core/DisTubeBase.ts:64

plugins

get plugins(): DisTubePlugin[]
DisTube plugins

Returns DisTubePlugin[]
Inherited from DisTubeBase.plugins
- Defined in src/core/DisTubeBase.ts:76

queues

get queues(): QueueManager
The queue manager

Returns QueueManager
Inherited from DisTubeBase.queues
- Defined in src/core/DisTubeBase.ts:46

voices

get voices(): DisTubeVoiceManager
The voice manager

Returns DisTubeVoiceManager
Inherited from DisTubeBase.voices
- Defined in src/core/DisTubeBase.ts:52

Methods

_getPluginFromSong

_getPluginFromSong(song: Song): Promise<DisTubePlugin | null>
Parameters
- song: Song
Returns Promise<DisTubePlugin | null>
- Defined in src/core/DisTubeHandler.ts:58
_getPluginFromSong<T extends PluginType>(
    song: Song,
    types: T[],
    validate?: boolean,
): Promise<(DisTubePlugin & { type: T; }) | null>
Type Parameters
- T extends PluginType
Parameters
- song: Song
- types: T[]
- Optionalvalidate: boolean
Returns Promise<(DisTubePlugin & { type: T; }) | null>
- Defined in src/core/DisTubeHandler.ts:59

_getPluginFromURL

_getPluginFromURL(url: string): Promise<DisTubePlugin | null>
Parameters
- url: string
Returns Promise<DisTubePlugin | null>
- Defined in src/core/DisTubeHandler.ts:53

attachStreamInfo

attachStreamInfo(song: Song): Promise<void>
Get Song's stream info and attach it to the song.
Parameters
- song: Song
  A Song
Returns Promise<void>
- Defined in src/core/DisTubeHandler.ts:97

debug

debug(message: string): void
Emit debug event
Parameters
- message: string
  debug message
Returns void
Inherited from DisTubeBase.debug
- Defined in src/core/DisTubeBase.ts:40

emit

emit(eventName: keyof DisTubeEvents, ...args: any): boolean
Emit the DisTube of this base
Parameters
- eventName: keyof DisTubeEvents
  Event name
- ...args: any
  arguments
Returns boolean
Inherited from DisTubeBase.emit
- Defined in src/core/DisTubeBase.ts:24

emitError

emitError(error: Error, queue: Queue, song?: Song<unknown>): void
Emit error event
Parameters
- error: Error
  error
- queue: Queue
  The queue encountered the error
- Optionalsong: Song<unknown>
  The playing song when encountered the error
Returns void
Inherited from DisTubeBase.emitError
- Defined in src/core/DisTubeBase.ts:33

followRedirectLink

followRedirectLink(url: string, maxRedirect?: number): Promise<string>
Parameters
- url: string
- maxRedirect: number = MAX_REDIRECT_DEPTH
Returns Promise<string>
- Defined in src/core/DisTubeHandler.ts:120

resolve

resolve<T = unknown>(
song: Song<T>,
options?: Omit<ResolveOptions<unknown>, "metadata">,
): Promise<Song<T>>
Type Parameters
- T = unknown
Parameters
- song: Song<T>
- Optionaloptions: Omit<ResolveOptions<unknown>, "metadata">
Returns Promise<Song<T>>
- Defined in src/core/DisTubeHandler.ts:15
resolve<T = unknown>(
song: Playlist<T>,
options?: Omit<ResolveOptions<unknown>, "metadata">,
): Promise<Playlist<T>>
Type Parameters
- T = unknown
Parameters
- song: Playlist<T>
- Optionaloptions: Omit<ResolveOptions<unknown>, "metadata">
Returns Promise<Playlist<T>>
- Defined in src/core/DisTubeHandler.ts:16
resolve<T = unknown>(
song: string,
options?: ResolveOptions<T>,
): Promise<Song<T> | Playlist<T>>
Type Parameters
- T = unknown
Parameters
- song: string
- Optionaloptions: ResolveOptions<T>
Returns Promise<Song<T> | Playlist<T>>
- Defined in src/core/DisTubeHandler.ts:17
resolve<T = unknown>(song: Song, options: ResolveOptions<T>): Promise<Song<T>>
Type Parameters
- T = unknown
Parameters
- song: Song
- options: ResolveOptions<T>
Returns Promise<Song<T>>
- Defined in src/core/DisTubeHandler.ts:18
resolve<T = unknown>(
song: Playlist,
options: ResolveOptions<T>,
): Promise<Playlist<T>>
Type Parameters
- T = unknown
Parameters
- song: Playlist
- options: ResolveOptions<T>
Returns Promise<Playlist<T>>
- Defined in src/core/DisTubeHandler.ts:19
resolve(
song: string | Song<unknown> | Playlist<unknown>,
options?: ResolveOptions<unknown>,
): Promise<Song<unknown> | Playlist<unknown>>
Parameters
- song: string | Song<unknown> | Playlist<unknown>
- Optionaloptions: ResolveOptions<unknown>
Returns Promise<Song<unknown> | Playlist<unknown>>
- Defined in src/core/DisTubeHandler.ts:20

Class DisTubeHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DisTubeHandler

Properties

distube

Accessors

client

Returns Client

handler

Returns DisTubeHandler

options

Returns Options

plugins

Returns DisTubePlugin[]

queues

Returns QueueManager

voices

Returns DisTubeVoiceManager

Methods

_getPluginFromSong

Parameters

Returns Promise<DisTubePlugin | null>

Type Parameters

Parameters

Returns Promise<(DisTubePlugin & { type: T; }) | null>

_getPluginFromURL

Parameters

Returns Promise<DisTubePlugin | null>

attachStreamInfo

Parameters

Returns Promise<void>

debug

Parameters

Returns void

emit

Parameters

Returns boolean

emitError

Parameters

Returns void

followRedirectLink

Parameters

Returns Promise<string>

resolve

Type Parameters

Parameters

Returns Promise<Song<T>>

Type Parameters

Parameters

Returns Promise<Playlist<T>>

Type Parameters

Parameters

Returns Promise<Song<T> | Playlist<T>>

Type Parameters

Parameters

Returns Promise<Song<T>>

Type Parameters

Parameters

Returns Promise<Playlist<T>>

Parameters

Returns Promise<Song<unknown> | Playlist<unknown>>

Settings

On This Page