v3.x.x

3.x.x

✨ Features

• Fluent API: Build yt-dlp commands with WithXxx() methods.
• Immutable & thread-safe: Each method returns a new instance, safe for parallel usage.
• Async & IAsyncDisposable: Automatic cleanup of child processes.
• Progress & Events: Real-time progress tracking and post-processing notifications.
• Format Listing: Retrieve and parse available formats.
• Batch Downloads: Sequential or parallel execution.
• Output Templates: Flexible naming with yt-dlp placeholders.
• Custom Command Injection: Add extra yt-dlp options safely.
• Cross-platform: Windows, macOS, Linux (where yt-dlp is supported).

---

🚀 New in v3.0

• Full support for IAsyncDisposable with await using.
• Immutable builder (WithXxx) for safe instance reuse.
• Updated examples for event-driven downloads.
• Simplified metadata fetching & format selection.
• High-performance probe methods with optional buffer size.
• Improved cancellation & error handling.

---

🛠 Methods

• VersionAsync(CancellationToken ct)
• UpdateAsync(UpdateChannel channel, CancellationToken ct)
• ExtractorsAsync(CancellationToken ct, int bufferKb)
• GetMetadataAsync(string url, CancellationToken ct, int bufferKb)
• GetMetadataRawAsync(string url, CancellationToken ct, int bufferKb)
• GetFormatsAsync(string url, CancellationToken ct, int bufferKb)
• GetMetadataLiteAsync(string url, CancellationToken ct, int bufferKb)
• GetMetadataLiteAsync(string url, IEnumerable<string> fields, CancellationToken ct, int bufferKb)
• GetBestAudioFormatIdAsync(string url, CancellationToken ct, int bufferKb)
• GetBestVideoFormatIdAsync(string url, int maxHeight, CancellationToken ct, int bufferKb)
• ExecuteAsync(string url, CancellationToken ct)
• ExecuteBatchAsync(IEnumerable<string> urls, int maxConcurrency, CancellationToken ct)

🔧 Thread Safety & Disposal

• Immutable & thread-safe: Each WithXxx() call returns a new instance.
• Async disposal: Ytdlp implements IAsyncDisposable.

Sequential download example:

await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe", new ConsoleLogger())
    .WithFormat("best")
    .WithOutputFolder("./downloads");

ytdlp.OnProgressDownload += (s, e) => Console.WriteLine($"Progress: {e.Percent:F2}%");
ytdlp.OnCompleteDownload += (s, msg) => Console.WriteLine($"Download complete: {msg}");

await ytdlp.DownloadAsync("https://www.youtube.com/watch?v=RGg-Qx1rL9U");

Parallel download example:

var urls = new[] { "https://youtu.be/video1", "https://youtu.be/video2" };

var tasks = urls.Select(async url =>
{
    await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe", new ConsoleLogger())
        .WithFormat("best")
        .WithOutputFolder("./batch");

    ytdlp.OnProgressDownload += (s, e) => Console.WriteLine($"[{url}] {e.Percent:F2}%");
    ytdlp.OnCompleteDownload += (s, msg) => Console.WriteLine($"[{url}] Download complete: {msg}");

    await ytdlp.DownloadAsync(url);
});

await Task.WhenAll(tasks);

Key points:

1. Always create a new instance per download for parallel operations.
2. Always use await using for proper resource cleanup.
3. Attach events after the WithXxx() call.

---

📦 Basic Usage

Download a Single Video

await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe", new ConsoleLogger())
    .WithFormat("best")
    .WithOutputFolder("./downloads")
    .WithEmbedMetadata()
    .WithEmbedThumbnail();

ytdlp.OnProgressDownload += (s, e) => Console.WriteLine($"Progress: {e.Percent:F2}%");
ytdlp.OnCompleteDownload += (s, msg) => Console.WriteLine($"Download complete: {msg}");

await ytdlp.DownloadAsync("https://www.youtube.com/watch?v=RGg-Qx1rL9U");

Extract Audio

await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe")
    .WithExtractAudio("mp3")
    .WithOutputFolder("./audio")
    .WithEmbedMetadata();

await ytdlp.DownloadAsync("https://www.youtube.com/watch?v=RGg-Qx1rL9U");

---

Fetch Metadata

await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe");

var metadata = await ytdlp.GetMetadataAsync("https://www.youtube.com/watch?v=abc123");

Console.WriteLine($"Title: {metadata?.Title}, Duration: {metadata?.Duration}");

---

Fetch Formats

await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe");

var formats = await ytdlp.GetFormatsAsync("https://www.youtube.com/watch?v=abc123");

foreach(var format in formats)
    Console.WriteLine($"Id: {metadata?.Id}, Extension: {metadata?.Extension}");

---

Best Format Selection

await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe");

string bestAudio = await ytdlp.GetBestAudioFormatIdAsync(url);
string bestVideo = await ytdlp.GetBestVideoFormatIdAsync(url, maxHeight: 720);

await ytdlp
    .WithFormat($"{bestVideo}+{bestAudio}/best")
    .WithOutputFolder("./downloads")
    .DownloadAsync(url);

---

Batch Downloads

var urls = new[] { "https://youtu.be/vid1", "https://youtu.be/vid2" };

var tasks = urls.Select(async url =>
{
    await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe")
        .WithFormat("best")
        .WithOutputFolder("./batch");

    await ytdlp.DownloadAsync(url);
});

await Task.WhenAll(tasks);

OR

var urls = new[] { "https://youtu.be/vid1", "https://youtu.be/vid2" };

 await using var ytdlp = new Ytdlp("tools\\yt-dlp.exe")
        .WithFormat("best")
        .WithOutputFolder("./batch");

await ytdlp.DownloadBatchAsync(urls, maxConcurrency: 3);

---

Fluent Methods (v3.0)

General Options

• .WithIgnoreErrors()
• .WithAbortOnError()
• .WithIgnoreConfig()
• .WithConfigLocations(string path)
• .WithPluginDirs(string path)
• .WithNoPluginDirs(string path)
• .WithJsRuntime(Runtime runtime, string runtimePath)
• .WithNoJsRuntime()
• .WithFlatPlaylist()
• WithLiveFromStart()
• .WithWaitForVideo(TimeSpan? maxWait = null)
• .WithMarkWatched()

Network Options

• .WithProxy(string? proxy)
• .WithSocketTimeout(TimeSpan timeout)
• .WithForceIpv4()
• .WithForceIpv6()
• .WithEnableFileUrls()

Geo-restriction Options

• .WithGeoVerificationProxy(string url)
• .WithGeoBypassCountry(string countryCode)

Video Selection

• .WithPlaylistItems(string items)
• .WithMinFileSize(string size)
• .WithMaxFileSize(string size)
• .WithDate(string date)
• .WithDateBefore(string date)
• .WithDateAfter(string date)
• .WithMatchFilter(string filterExpression)
• .WithNoPlaylist()
• .WithYesPlaylist()
• .WithAgeLimit(int years)
• .WithDownloadArchive(string archivePath = "archive.txt")
• .WithMaxDownloads(int count)
• .WithBreakOnExisting()

Download Options

• .WithConcurrentFragments(int count = 8)
• .WithLimitRate(string rate)
• .WithThrottledRate(string rate)
• .WithRetries(int maxRetries)
• .WithFileAccessRetries(int maxRetries)
• .WithFragmentRetries(int retries)
• .WithSkipUnavailableFragments()
• .WithAbortOnUnavailableFragments()
• .WithKeepFragments()
• .WithBufferSize(string size)
• .WithNoResizeBuffer()
• .WithPlaylistRandom()
• .WithHlsUseMpegts()
• .WithNoHlsUseMpegts()
• .WithDownloadSections(string regex)

Filesystem Options

• .WithHomeFolder(string path)
• .WithTempFolder(string path)
• .WithOutputFolder(string path)
• .WithFFmpegLocation(string path)
• .WithOutputTemplate(string template)
• .WithRestrictFilenames()
• .WithWindowsFilenames()
• .WithTrimFilenames(int length)
• .WithNoOverwrites()
• .WithForceOverwrites()
• .WithNoContinue()
• .WithNoPart()
• .WithMtime()
• .WithWriteDescription()
• .WithWriteInfoJson()
• .WithNoWritePlaylistMetafiles()
• .WithNoCleanInfoJson()
• .WriteComments()
• .WithNoWriteComments()
• .WithLoadInfoJson(string path)
• .WithCookiesFile(string path)
• .WithCookiesFromBrowser(string browser)
• .WithNoCacheDir()
• .WithRemoveCacheDir()

Thumbnail Options

• .WithThumbnails(bool allSizes = false)

Verbosity and Simulation Options

• .WithQuiet()
• .WithNoWarnings()
• .WithSimulate()
• .WithNoSimulate()
• .WithSkipDownload()
• .WithVerbose()

Workgrounds

• .WithAddHeader(string header, string value)
• .WithSleepInterval(double seconds, double? maxSeconds = null)
• .WithSleepSubtitles(double seconds)

Video Format Options

• .WithFormat(string format)
• .WithMergeOutputFormat(string format)

Subtitle Options

• .WithSubtitles(string languages = "all", bool auto = false)

Authentication Options

• .WithAuthentication(string username, string password)
• .WithTwoFactor(string code)

Post-Processing Options

• .WithExtractAudio(string format = "mp3", int quality = 5)
• .WithRemuxVideo(MediaFormat format = MediaFormat.Mp4)
• .WithRecodeVideo(MediaFormat format = MediaFormat.Mp4, string? videoCodec = null, string? audioCodec = null)
• .WithPostprocessorArgs(PostProcessors postprocessor, string args)
• .WithKeepVideo()
• .WithNoPostOverwrites()
• .WithEmbedSubtitles(string languages = "all", string? convertTo = null)
• .WithEmbedThumbnail()
• .WithEmbedMetadata()
• .WithEmbedChapters()
• .WithEmbedInfoJson()
• .WithNoEmbedInfoJson()
• .WithReplaceInMetadata(string field, string regex, string replacement)
• .WithConcatPlaylist(string policy = "always")
• .WithFFmpegLocation(string? ffmpegPath)
• .WithConvertThumbnails(string format = "jpg")
• .WithForceKeyframesAtCuts()

SponsorBlock Options

• .WithSponsorblockMark(string categories = "all")
• .WithSponsorblockRemove(string categories = "all")
• .WithNoSponsorblock()

Advanced Options

• .AddFlag(string flag)
• .AddOption(string key, string value)

Downloaders

• .WithExternalDownloader(string downloaderName, string? downloaderArgs = null)
• .WithAria2(int connections = 16)
• .WithHlsNative()
• .WithFfmpegAsLiveDownloader(string? extraFfmpegArgs = null)

AND MORE ...

---

Events

ytdlp.OnProgressDownload += (s, e) => Console.WriteLine($"Progress: {e.Percent:F2}%");
ytdlp.OnProgressMessage += (s, msg) => Console.WriteLine(msg);
ytdlp.OnCompleteDownload += (s, msg) => Console.WriteLine($"Done: {msg}");
ytdlp.OnPostProcessingComplete += (s, msg) => Console.WriteLine($"Post-processing: {msg}");
ytdlp.OnErrorMessage += (s, err) => Console.WriteLine($"Error: {err}");
ytdlp.OnOutputMessage += (s, msg) => Console.WriteLine(msg);
ytdlp.OnCommandCompleted += (s, e) => Console.WriteLine($"Command finished: {e.Command}");

---

🔄 Upgrade Guide (v2 → v3)

v3 introduces a new immutable fluent API.

Old mutable commands were removed.

---

❌ Old API (v2)

var ytdlp = new Ytdlp();

await ytdlp
    .SetFormat("best")
    .SetOutputFolder("./downloads")
    .ExecuteAsync(url);

---

✅ New API (v3)

await using var ytdlp = new Ytdlp()
    .WithFormat("best")
    .WithOutputFolder("./downloads");

await ytdlp.DownloadAsync(url);

---

Method changes

v2	v3
SetFormat()	WithFormat()
SetOutputFolder()	WithOutputFolder()
SetTempFolder()	WithTempFolder()
SetOutputTemplate()	WithOutputTemplate()
SetFFMpegLocation()	WithFFmpegLocation()
ExtractAudio()	WithExtractAudio()
UseProxy()	WithProxy()

---

Important behavior changes

Instances are immutable

Every WithXxx() call returns a new instance.

var baseYtdlp = new Ytdlp();

var download = baseYtdlp
    .WithFormat("best")
    .WithOutputFolder("./downloads");

---

Event subscription

Attach events to the configured instance.

var download = baseYtdlp.WithFormat("best");

download.OnProgressDownload += ...

---

Proper disposal

Use await using for automatic cleanup.

await using var ytdlp = new Ytdlp();

---

✅ Notes

• All commands now start with WithXxx().
• Immutable: no shared state; safe for parallel usage.
• Always await using for proper disposal.
• Deprecated old methods removed.
• Probe methods remain the same (GetMetadataAsync, GetFormatsAsync, GetBestVideoFormatIdAsync, etc.).

---

License

MIT License — see LICENSE

Author: Manojbabu (ManuHub)
Repository: Ytdlp.NET