YT-DLX: The Ultimate Multimedia Downloader

YT-DLX is a powerful and versatile tool that allows you to download audio and video content from a wide range of sources, including YouTube, Vimeo, and many more.

logo
Documentation

YtDlx.Audio.Custom()

Downloads or streams audio from YouTube with customizable options for quality, filters, and output formats.

Audio Processing

Customize audio downloads with flexible options and filters

Parameters

options

An object containing the configuration options.

options.query

The search query or video URL. Required.

options.output

(Optional) The directory to save the output file.Cannot be used with metadata: true.

options.useTor

(Optional) Whether to use Tor.

options.stream

(Optional) Whether to stream the output.Cannot be used with metadata: true.

options.verbose

(Optional) Enable verbose logging.

options.metadata

(Optional) Only fetch metadata.Cannot be used with output,stream, orfilter.

options.resolution

The desired audio resolution/quality. Required.

Available: highmediumlowultralow

options.filter

(Optional) An audio filter to apply.Cannot be used with metadata: true.

Available: echoslowspeedphaserflangerpanningreversevibratosubboost

Return Value

An EventEmitter instance for handling events during the audio processing.

Emits "start"

FFmpeg command started.

Emits "progress"

Download/stream progress.

Emits "end"

Process complete (path or stream path).

Emits "metadata"

Video metadata, formats, suggested filename.(if metadata: true)

Emits "stream"

Streamable filename/path and FFmpeg instance.(if stream: true)

Emits "error"

Error occurred.