Type Alias DisTubeOptions

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

DisTube options

Type declaration

  • OptionalcustomFilters?: Filters

    Override defaultFilters or add more ffmpeg filters

  • OptionalemitAddListWhenCreatingQueue?: boolean

    Whether or not emitting addList event when creating a new Queue

  • OptionalemitAddSongWhenCreatingQueue?: boolean

    Whether or not emitting addSong event when creating a new Queue

  • OptionalemitNewSongOnly?: boolean

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

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

    FFmpeg options

    • Optionalargs?: Partial<FFmpegArgs>

      FFmpeg default arguments

    • Optionalpath?: string

      FFmpeg path

  • OptionaljoinNewVoiceChannel?: boolean

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

  • Optionalnsfw?: boolean

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

  • Optionalplugins?: DisTubePlugin[]

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

  • OptionalsavePreviousSongs?: 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