Skip to content

DisTubeOptions

Type Parameter Default type
Target VoiceChannelTarget
Property Type Description
adapter Adapter<Target> -
autoplayAttempts? number Autoplay items in a row that may fail to prepare or play for one seed before autoplay stops. Each retry asks for a Song related to the same seed and skips the failed ones. Positive integer, default 1.
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.
prefetchAutoplay? boolean While autoplay is on, looks up a related Song at each item start and holds it in queue.related, so the queue plays it next without adding it to upcoming. Default false: autoplay looks up only when the queue runs out.
reconnectTimeoutMs? number How long a dropped voice may take to connect again, in milliseconds, up to 2147483647. Default 60000.