DisTube API Documentation
    Preparing search index...

    Type Alias DisTubeOptions

    DisTube options

    type DisTubeOptions = {
        customFilters?: Filters;
        emitAddListWhenCreatingQueue?: boolean;
        emitAddSongWhenCreatingQueue?: boolean;
        emitNewSongOnly?: boolean;
        ffmpeg?: { args?: Partial<FFmpegArgs>; path?: string };
        joinNewVoiceChannel?: boolean;
        nsfw?: boolean;
        plugins?: DisTubePlugin[];
        savePreviousSongs?: boolean;
    }
    Index

    Properties

    customFilters? emitAddListWhenCreatingQueue? emitAddSongWhenCreatingQueue? emitNewSongOnly? ffmpeg? joinNewVoiceChannel? nsfw? plugins? savePreviousSongs?

    Properties

    customFilters?: Filters

    Override defaultFilters or add more ffmpeg filters

    emitAddListWhenCreatingQueue?: boolean

    Whether or not emitting addList event when creating a new Queue

    emitAddSongWhenCreatingQueue?: boolean

    Whether or not emitting addSong event when creating a new Queue

    emitNewSongOnly?: boolean

    Whether or not emitting Events.PLAY_SONG event when looping a song or next song is the same as the previous one

    ffmpeg?: { args?: Partial<FFmpegArgs>; path?: string }

    FFmpeg options

    Type Declaration

    • Optionalargs?: Partial<FFmpegArgs>

      FFmpeg default arguments

    • Optionalpath?: string

      FFmpeg path

    joinNewVoiceChannel?: boolean

    Whether or not joining the new voice channel when using DisTube#play method

    nsfw?: boolean

    Whether or not playing age-restricted content and disabling safe search in non-NSFW channel

    plugins?: DisTubePlugin[]

    DisTube plugins. The order of this effects the priority of the plugins when verifying the input.

    savePreviousSongs?: boolean

    Whether or not saving the previous songs of the queue and enable DisTube#previous method. Disable it may help to reduce the memory usage

    Settings

    Member Visibility

    On This Page

    Properties