Skip to content

DisTubeOptions

Type Parameter Default type
Target VoiceChannelTarget
Property Type Description
adapter Adapter<Target> -
connectionTimeoutMs? number Voice join timeout in milliseconds, up to 2147483647. Default 15000.
engine? object Built-in engine tuning; an engine plugin ignores it.
engine.bufferMs? number Read-ahead in milliseconds, a positive multiple of 20, default 500.
engine.opusComplexity? number Opus encoder complexity from 0 to 10, default 10.
filters? Readonly<Record<string, FilterDefinition<string>>> Built-in engine presets, merged over its defaults.
historySize? number Ended occurrences each queue remembers. Integer 0 or greater, default 10.
maxPlaylistSongs? number Songs a resolved Playlist keeps, the first ones in provider order. Positive integer, default 500.
onDiagnostic? (diagnostic) => void -
plugins readonly Plugin<unknown, unknown>[] Ordered for resolve, search and suggest. At most one may carry an engine, which replaces the built-in one.