Class Options

Constructors

constructor

new Options(options): Options
Parameters
- options: DisTubeOptions
Returns Options
- Defined in src/core/DisTubeOptions.ts:30

Properties

`Optional` customFilters

customFilters?: Filters

directLink

directLink: boolean

emitAddListWhenCreatingQueue

emitAddListWhenCreatingQueue: boolean

emitAddSongWhenCreatingQueue

emitAddSongWhenCreatingQueue: boolean

emitNewSongOnly

emitNewSongOnly: boolean

emptyCooldown

emptyCooldown: number

ffmpeg

ffmpeg: FFmpegOptions

ffmpegDefaultArgs

ffmpegDefaultArgs: undefined = undefined

Deprecated

ffmpegPath

ffmpegPath: undefined = undefined

Deprecated

joinNewVoiceChannel

joinNewVoiceChannel: boolean

leaveOnEmpty

leaveOnEmpty: boolean

leaveOnFinish

leaveOnFinish: boolean

leaveOnStop

leaveOnStop: boolean

nsfw

nsfw: boolean

plugins

plugins: (CustomPlugin | ExtractorPlugin)[]

savePreviousSongs

savePreviousSongs: boolean

searchCooldown

searchCooldown: number

searchSongs

searchSongs: number

streamType

streamType: StreamType

`Optional` youtubeCookie

youtubeCookie?: string | Cookie[]

ytdlOptions

ytdlOptions: getInfoOptions

Methods

`Private` #ffmpegOption

#ffmpegOption(opts): {
    args: {
        global: FFmpegArgs;
        input: FFmpegArgs;
        output: FFmpegArgs;
    };
    path: string;
}
Parameters
- opts: DisTubeOptions
Returns {
    args: {
        global: FFmpegArgs;
        input: FFmpegArgs;
        output: FFmpegArgs;
    };
    path: string;
}
- args: {
      global: FFmpegArgs;
      input: FFmpegArgs;
      output: FFmpegArgs;
  }
  - global: FFmpegArgs
  - input: FFmpegArgs
  - output: FFmpegArgs
- path: string
- Defined in src/core/DisTubeOptions.ts:104

`Private` #validateOptions

#validateOptions(options?): void
Parameters
- options: Options = ...
Returns void
- Defined in src/core/DisTubeOptions.ts:58

Class Options

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Options

Properties

Optional customFilters

directLink

emitAddListWhenCreatingQueue

emitAddSongWhenCreatingQueue

emitNewSongOnly

emptyCooldown

ffmpeg

ffmpegDefaultArgs

Deprecated

ffmpegPath

Deprecated

joinNewVoiceChannel

leaveOnEmpty

leaveOnFinish

leaveOnStop

nsfw

plugins

savePreviousSongs

searchCooldown

searchSongs

streamType

Optional youtubeCookie

ytdlOptions

Methods

Private #ffmpegOption

Parameters

Returns { args: { global: FFmpegArgs; input: FFmpegArgs; output: FFmpegArgs; }; path: string; }

args: { global: FFmpegArgs; input: FFmpegArgs; output: FFmpegArgs; }

global: FFmpegArgs

input: FFmpegArgs

output: FFmpegArgs

path: string

Private #validateOptions

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Optional` customFilters

`Optional` youtubeCookie

`Private` #ffmpegOption

Returns {
args: {
global: FFmpegArgs;
input: FFmpegArgs;
output: FFmpegArgs;
};
path: string;
}

args: {
global: FFmpegArgs;
input: FFmpegArgs;
output: FFmpegArgs;
}

`Private` #validateOptions