Class DisTube

DisTube class

Hierarchy

TypedEmitter<TypedDisTubeEvents>
- DisTube

Constructors

constructor

new DisTube(client: Client, opts?: DisTubeOptions): DisTube
Create a new DisTube class.
Parameters
- client: Client
 Discord.JS client
- opts: DisTubeOptions = {}
 Custom DisTube options
Returns DisTube
Throws
DisTubeError
Overrides TypedEmitter<TypedDisTubeEvents>.constructor
- Defined in src/DisTube.ts:157

Properties

`Readonly`client

client: Client

Discord.js v14 client

`Readonly`filters

filters: Filters

DisTube ffmpeg audio filters

`Readonly`handler

handler: DisTubeHandler

DisTube internal handler

`Readonly`options

options: Options

DisTube options

`Readonly`plugins

plugins: DisTubePlugin[]

DisTube plugins

`Readonly`queues

queues: QueueManager

Queues manager

`Readonly`voices

voices: DisTubeVoiceManager

DisTube voice connections manager

`Static`defaultMaxListeners

defaultMaxListeners: number

Accessors

version

get version(): string
DisTube version

Returns string
- Defined in src/DisTube.ts:179

`Static`version

get version(): string
Returns string
- Defined in src/DisTube.ts:172

Methods

addListener

addListener(
event: U,
listener: TypedDisTubeEvents[U],
): this
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- listener: TypedDisTubeEvents[U]
Returns this
Inherited from TypedEmitter.addListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:11

addRelatedSong

addRelatedSong(guild: GuildIdResolvable): Promise<Song<unknown>>
Add related song to the queue
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
Returns Promise<Song<unknown>>
The guild queue

Deprecated
Use distube.getQueue(guild).addRelatedSong() instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:436

createCustomPlaylist

createCustomPlaylist(
songs: (string | Song<unknown>)[],
options?: CustomPlaylistOptions,
): Promise<Playlist<unknown>>
Create a custom playlist
Parameters
- songs: (string | Song<unknown>)[]
 Array of url or Song
- options: CustomPlaylistOptions = {}
 Optional options
Returns Promise<Playlist<unknown>>
- Defined in src/DisTube.ts:272

debug

debug(message: string): void
Emit debug event
Parameters
- message: string
  debug message
Returns void
- Defined in src/DisTube.ts:465

emit

emit(
event: U,
...args: Parameters<TypedDisTubeEvents[U]>,
): boolean
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- ...args: Parameters<TypedDisTubeEvents[U]>
Returns boolean
Inherited from TypedEmitter.emit
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:19

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
- Defined in src/DisTube.ts:457

eventNames

eventNames(): U[]
Type Parameters
- U extends keyof DisTubeEvents
Returns U[]
Inherited from TypedEmitter.eventNames
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:20

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from TypedEmitter.getMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:24

getQueue

getQueue(guild: GuildIdResolvable): Queue | undefined
Get the guild queue
Parameters
- guild: GuildIdResolvable
  The type can be resolved to give a Queue
Returns Queue | undefined
- Defined in src/DisTube.ts:312

jump

jump(
 guild: GuildIdResolvable,
 num: number,
 options?: JumpOptions,
): Promise<Song<unknown>>
Jump to the song number in the queue. The next one is 1, 2,... The previous one is -1, -2,...
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
- num: number
 The song number to play
- Optionaloptions: JumpOptions
Returns Promise<Song<unknown>>
The new Song will be played

Deprecated
Use distube.getQueue(guild).jump(num, options) instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:402

listenerCount

listenerCount(type: keyof DisTubeEvents): number
Parameters
- type: keyof DisTubeEvents
Returns number
Inherited from TypedEmitter.listenerCount
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:21

listeners

listeners(type: U): TypedDisTubeEvents[U][]
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- type: U
Returns TypedDisTubeEvents[U][]
Inherited from TypedEmitter.listeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:22

off

off(
event: U,
listener: TypedDisTubeEvents[U],
): this
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- listener: TypedDisTubeEvents[U]
Returns this
Inherited from TypedEmitter.off
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:18

on

on(
event: U,
listener: TypedDisTubeEvents[U],
): this
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- listener: TypedDisTubeEvents[U]
Returns this
Inherited from TypedEmitter.on
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:17

once

once(
event: U,
listener: TypedDisTubeEvents[U],
): this
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- listener: TypedDisTubeEvents[U]
Returns this
Inherited from TypedEmitter.once
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:16

pause

pause(guild: GuildIdResolvable): Promise<Queue>
Pause the guild stream
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
Returns Promise<Queue>
The guild queue

Deprecated
Use distube.getQueue(guild).pause() instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:328

play

play<T = unknown>(
 voiceChannel: VoiceBasedChannel,
 song: string | Song<unknown> | Playlist<unknown>,
 options?: PlayOptions<T>,
): Promise<void>
Play / add a song or playlist from url. Search and play a song (with ExtractorPlugin) if it is not a valid url.
Type Parameters
- T = unknown
Parameters
- voiceChannel: VoiceBasedChannel
 The channel will be joined if the bot isn't in any channels, the bot will be moved to this channel if DisTubeOptions.joinNewVoiceChannel is true
- song: string | Song<unknown> | Playlist<unknown>
 URL | Search string | Song | Playlist
- options: PlayOptions<T> = {}
 Optional options
Returns Promise<void>
Throws
DisTubeError
- Defined in src/DisTube.ts:192

prependListener

prependListener(
event: U,
listener: TypedDisTubeEvents[U],
): this
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- listener: TypedDisTubeEvents[U]
Returns this
Inherited from TypedEmitter.prependListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:12

prependOnceListener

prependOnceListener(
event: U,
listener: TypedDisTubeEvents[U],
): this
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- listener: TypedDisTubeEvents[U]
Returns this
Inherited from TypedEmitter.prependOnceListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:13

previous(guild: GuildIdResolvable): Promise<Song<unknown>>
Play the previous song
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
Returns Promise<Song<unknown>>
The new Song will be played

Deprecated
Use distube.getQueue(guild).previous() instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:380

rawListeners

rawListeners(type: U): TypedDisTubeEvents[U][]
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- type: U
Returns TypedDisTubeEvents[U][]
Inherited from TypedEmitter.rawListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:23

removeAllListeners

removeAllListeners(event?: keyof DisTubeEvents): this
Parameters
- Optionalevent: keyof DisTubeEvents
Returns this
Inherited from TypedEmitter.removeAllListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:15

removeListener

removeListener(
event: U,
listener: TypedDisTubeEvents[U],
): this
Type Parameters
- U extends keyof DisTubeEvents
Parameters
- event: U
- listener: TypedDisTubeEvents[U]
Returns this
Inherited from TypedEmitter.removeListener
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:14

resume

resume(guild: GuildIdResolvable): Promise<Queue>
Resume the guild stream
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
Returns Promise<Queue>
The guild queue

Deprecated
Use distube.getQueue(guild).resume() instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:338

seek

seek(guild: GuildIdResolvable, time: number): Promise<Queue>
Set the playing time to another position
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
- time: number
 Time in seconds
Returns Promise<Queue>
Seeked queue

Deprecated
Use distube.getQueue(guild).seek(time) instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:447

setMaxListeners

setMaxListeners(n: number): this
Parameters
- n: number
Returns this
Inherited from TypedEmitter.setMaxListeners
- Defined in node_modules/tiny-typed-emitter/lib/index.d.ts:25

setRepeatMode

setRepeatMode(guild: GuildIdResolvable, mode?: RepeatMode): RepeatMode
Set the repeat mode of the guild queue. Toggle mode (Disabled -> Song -> Queue -> Disabled ->...) if mode is undefined
Parameters
- guild: GuildIdResolvable
  The type can be resolved to give a Queue
- Optionalmode: RepeatMode
  The repeat modes (toggle if undefined)
Returns RepeatMode
The new repeat mode

Deprecated
Use distube.getQueue(guild).setRepeatMode(mode) instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:414

setVolume

setVolume(guild: GuildIdResolvable, percent: number): Queue
Set the guild stream's volume
Parameters
- guild: GuildIdResolvable
  The type can be resolved to give a Queue
- percent: number
  The percentage of volume you want to set
Returns Queue
The guild queue

Deprecated
Use distube.getQueue(guild).setVolume(percent) instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:358

shuffle

shuffle(guild: GuildIdResolvable): Promise<Queue>
Shuffle the guild queue songs
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
Returns Promise<Queue>
The guild queue

Deprecated
Use distube.getQueue(guild).shuffle() instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:390

skip

skip(guild: GuildIdResolvable, options?: JumpOptions): Promise<Song<unknown>>
Skip the playing song if there is a next song in the queue. If Queue#autoplay is true and there is no up next song, DisTube will add and play a related song.
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
- Optionaloptions: JumpOptions
Returns Promise<Song<unknown>>
The new Song will be played

Deprecated
Use distube.getQueue(guild).skip(options) instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:370

stop

stop(guild: GuildIdResolvable): Promise<void>
Stop the guild stream
Parameters
- guild: GuildIdResolvable
 The type can be resolved to give a Queue
Returns Promise<void>
Deprecated
Use distube.getQueue(guild).stop() instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:347

toggleAutoplay

toggleAutoplay(guild: GuildIdResolvable): boolean
Toggle autoplay mode
Parameters
- guild: GuildIdResolvable
  The type can be resolved to give a Queue
Returns boolean
Autoplay mode state

Deprecated
Use distube.getQueue(guild).toggleAutoplay() instead. Will be removed in v6.0.
- Defined in src/DisTube.ts:424

Events

`Static` `Readonly`addList

addList: (queue: Queue, playlist: Playlist) => any

Emitted after DisTube add a new playlist to the playing Queue.

Type Declaration

- (queue: Queue, playlist: Playlist): any
- Parameters
  - queue: Queue
    The guild queue
  - playlist: Playlist
    Playlist info
  Returns any

`Static` `Readonly`addSong

addSong: (queue: Queue, song: Song) => any

Emitted after DisTube add a new song to the playing Queue.

Type Declaration

- (queue: Queue, song: Song): any
- Parameters
  - queue: Queue
    The guild queue
  - song: Song
    Added song
  Returns any

`Static` `Readonly`debug

debug: (debug: string) => any

Emitted to provide debug information from DisTube's operation. Useful for troubleshooting or logging purposes.

Type Declaration

- (debug: string): any
- Parameters
  - debug: string
    Debug message string.
  Returns any

`Static` `Readonly`deleteQueue

deleteQueue: (queue: Queue) => any

Emitted when a Queue is deleted with any reasons.

Type Declaration

- (queue: Queue): any
- Parameters
  - queue: Queue
    The guild queue
  Returns any

`Static` `Readonly`disconnect

disconnect: (queue: Queue) => any

Emitted when the bot is disconnected to a voice channel.

Type Declaration

- (queue: Queue): any
- Parameters
  - queue: Queue
    The guild queue
  Returns any

`Static` `Readonly`error

error: (error: Error, queue: Queue, song?: Song<unknown>) => any

Emitted when DisTube encounters an error while playing songs.

Type Declaration

- (error: Error, queue: Queue, song?: Song<unknown>): any
- Parameters
 - error: Error
 error
 - queue: Queue
 The queue encountered the error
 - Optionalsong: Song<unknown>
 The playing song when encountered the error
 Returns any

`Static` `Readonly`ffmpegDebug

ffmpegDebug: (debug: string) => any

Emitted for logging FFmpeg debug information.

Type Declaration

- (debug: string): any
- Parameters
  - debug: string
    Debug message string.
  Returns any

`Static` `Readonly`finish

finish: (queue: Queue) => any

Emitted when there is no more song in the queue and Queue#autoplay is false.

Type Declaration

- (queue: Queue): any
- Parameters
  - queue: Queue
    The guild queue
  Returns any

`Static` `Readonly`finishSong

finishSong: (queue: Queue, song: Song) => any

Emitted when DisTube finished a song.

Type Declaration

- (queue: Queue, song: Song): any
- Parameters
  - queue: Queue
    The guild queue
  - song: Song
    Finished song
  Returns any

`Static` `Readonly`initQueue

initQueue: (queue: Queue) => any

Emitted when DisTube initialize a queue to change queue default properties.

Type Declaration

- (queue: Queue): any
- Parameters
  - queue: Queue
    The guild queue
  Returns any

`Static` `Readonly`noRelated

noRelated: (queue: Queue) => any

Emitted when Queue#autoplay is true, Queue#songs is empty, and DisTube cannot find related songs to play.

Type Declaration

- (queue: Queue): any
- Parameters
  - queue: Queue
    The guild queue
  Returns any

`Static` `Readonly`playSong

playSong: (queue: Queue, song: Song) => any

Emitted when DisTube play a song. If DisTubeOptions.emitNewSongOnly is true, this event is not emitted when looping a song or next song is the previous one.

Type Declaration

- (queue: Queue, song: Song): any
- Parameters
  - queue: Queue
    The guild queue
  - song: Song
    Playing song
  Returns any

Class DisTube

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

constructor

Parameters

Returns DisTube

Throws

Properties

Readonlyclient

Readonlyfilters

Readonlyhandler

Readonlyoptions

Readonlyplugins

Readonlyqueues

Readonlyvoices

StaticdefaultMaxListeners

Accessors

version

Returns string

Staticversion

Returns string

Methods

addListener

Type Parameters

Parameters

Returns this

addRelatedSong

Parameters

Returns Promise<Song<unknown>>

Deprecated

createCustomPlaylist

Parameters

Returns Promise<Playlist<unknown>>

debug

Parameters

Returns void

emit

Type Parameters

Parameters

Returns boolean

emitError

Parameters

Returns void

eventNames

Type Parameters

Returns U[]

getMaxListeners

Returns number

getQueue

Parameters

Returns Queue | undefined

jump

Parameters

Returns Promise<Song<unknown>>

Deprecated

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns TypedDisTubeEvents[U][]

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

`Readonly`client

`Readonly`filters

`Readonly`handler

`Readonly`options

`Readonly`plugins

`Readonly`queues

`Readonly`voices

`Static`defaultMaxListeners

`Static`version

`Static` `Readonly`addList