Youtubedl Android

https://github.com/yausername/youtubedl-android
Admin
Youtubedl Android is an Android library wrapper for yt-dlp that enables downloading and streaming...
Tokens:10,662
Snippets:80
Trust Score:6.5
Update:3 months ago
Show doc for...
Tokens:
Raw
### yt-dlp Config File Example

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Example of a config.txt file for yt-dlp. Use --config-location to specify the path to this file.

```bash
# /sdcard/Download/youtubedl-android/config.txt
--no-mtime
-o /sdcard/Download/youtubedl-android/%(title)s.%(ext)s
-f bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best
--merge-output-format mp4
```

--------------------------------

### youtubedl-android Configuration Example

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Example configuration file content for yt-dlp, specifying output format and location. This file should be named 'config.txt'.

```text
--no-mtime

-o /sdcard/Download/youtubedl-android/%(title)s.%(ext)s

-f "bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best"
```

--------------------------------

### Install youtubedl-android Library

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Add the library and its dependencies to your app's Gradle file. Ensure you have mavenCentral() configured.

```kotlin
val youtubedlAndroid = "0.18.1"

repositories {
    mavenCentral()
}

dependencies {
    implementation("io.github.junkfood02.youtubedl-android:library:$youtubedlAndroid")
    implementation("io.github.junkfood02.youtubedl-android:ffmpeg:$youtubedlAndroid")
    implementation("io.github.junkfood02.youtubedl-android:aria2c:$youtubedlAndroid") // optional
}
```

--------------------------------

### Initialize YoutubeDL, FFmpeg, and Aria2c

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Call `YoutubeDL.init(context)` before any other API calls. Initialize FFmpeg and Aria2c if you plan to use their respective features. This setup is idempotent.

```java
// Application.java or Activity.onCreate()
public class App extends Application {
    private static final String TAG = "App";

    @Override
    public void onCreate() {
        super.onCreate();
        try {
            YoutubeDL.getInstance().init(this);
            FFmpeg.getInstance().init(this);   // needed for --extract-audio, merging formats, etc.
            Aria2c.getInstance().init(this);   // needed for --downloader libaria2c.so
        } catch (YoutubeDLException e) {
            Log.e(TAG, "Failed to initialize youtubedl-android", e);
        }
    }
}
```

--------------------------------

### Execute Download and Get Response

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Java code demonstrating how to execute a download request with YoutubeDL and process the YoutubeDLResponse. Includes error handling for exceptions.

```java
YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/dQw4w9WgXcQ");
request.addOption("--print", "filename")
       .addOption("-o", "/sdcard/Download/%(title)s.%(ext)s")
       .addOption("-f", "best");

try {
    YoutubeDLResponse response = YoutubeDL.getInstance().execute(request, null, null);

    System.out.println("Exit code:    " + response.getExitCode());    // 0
    System.out.println("Elapsed ms:   " + response.getElapsedTime()); // 3241
    System.out.println("Stdout:       " + response.getOut());          // printed filename
    System.out.println("Stderr:       " + response.getErr());          // warnings/info lines
    System.out.println("Command:      " + response.getCommand());      // full arg list
} catch (YoutubeDLException e) {
    // e.getMessage() contains stderr from the failed process
    Log.e(TAG, "Execute failed: " + e.getMessage());
} catch (YoutubeDL.CanceledException e) {
    Log.i(TAG, "User cancelled");
}
```

--------------------------------

### Initialize Aria2c with YoutubeDL and FFmpeg

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Initialize Aria2c for external downloading alongside YoutubeDL and FFmpeg. This setup is for advanced download management.

```java
try {
    YoutubeDL.getInstance().init(this);
    FFmpeg.getInstance().init(this);
    Aria2c.getInstance().init(this);
} catch (YoutubeDLException e) {
    Log.e(TAG, "failed to initialize youtubedl-android", e);
}
```

--------------------------------

### Get Playable Link

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Retrieves a single playable link for a video, optionally with specified format options.

```APIDOC
## Get Playable Link

### Description
Retrieves a single playable link for a video, optionally with specified format options.

### Method
```java
YoutubeDL.getInstance().getInfo(YoutubeDLRequest request)
```

### Parameters
#### Path Parameters
- **request** (YoutubeDLRequest) - Required - The request object containing the URL and format options.

### Returns
- **VideoInfo** - An object containing the playable URL and other stream information.
```

--------------------------------

### Get Playable Link for Video+Audio

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Request a single playable link that includes both video and audio, using the '-f best' option. Useful for direct playback or download.

```java
YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/Pv61yEcOqpw");
request.addOption("-f", "best");
VideoInfo streamInfo = YoutubeDL.getInstance().getInfo(request);
System.out.println(streamInfo.getUrl());
```

--------------------------------

### Stop Download Process

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Stops a previously started download process using its unique process ID.

```APIDOC
## Stop Download Process

### Description
Stops a previously started download process using its unique process ID.

### Method
```java
YoutubeDL.getInstance().destroyProcessById(String processId)
```

### Parameters
#### Path Parameters
- **processId** (String) - Required - The unique identifier of the process to stop.
```

--------------------------------

### Clone Termux Packages

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_FFMPEG.md

Clone the Termux packages repository to access build scripts and package definitions. Ensure you have git installed.

```bash
git clone git@github.com:termux/termux-packages.git
cd termux-packages
```

--------------------------------

### Get Stream Info

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Retrieves detailed stream information for a given URL, equivalent to yt-dlp's --dump-json option.

```APIDOC
## Get Stream Info

### Description
Retrieves detailed stream information for a given URL, equivalent to yt-dlp's --dump-json option.

### Method
```java
YoutubeDL.getInstance().getInfo(String url)
```

### Parameters
#### Path Parameters
- **url** (String) - Required - The URL of the video.

### Returns
- **VideoInfo** - An object containing detailed information about the video stream.
```

--------------------------------

### Get Video Info and Formats

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Java code to fetch video information and available stream formats using YoutubeDL. The VideoInfo and VideoFormat objects provide parsed metadata.

```java
VideoInfo info = YoutubeDL.getInstance().getInfo("https://vimeo.com/22439234");

// Basic metadata
System.out.println(info.getTitle());           // "Big Buck Bunny"
System.out.println(info.getDuration());        // 596  (seconds)
System.out.println(info.getUploader());        // "Blender Foundation"
System.out.println(info.getUploadDate());      // "20080520"
System.out.println(info.getThumbnail());       // "https://..."
System.out.println(info.getDescription());     // full description string
System.out.println(info.getWebpageUrl());      // "https://vimeo.com/22439234"
System.out.println(info.getExtractor());       // "vimeo"
System.out.println(info.getViewCount());       // "12345678"

// Available formats sorted by quality
if (info.getFormats() != null) {
    for (VideoFormat fmt : info.getFormats()) {
        System.out.printf(
            "id=%-10s ext=%-5s %4dx%-4d vcodec=%-10s acodec=%-10s fps=%-3d size=%d%n",
            fmt.getFormatId(), fmt.getExt(),
            fmt.getWidth(), fmt.getHeight(),
            fmt.getVcodec(), fmt.getAcodec(),
            fmt.getFps(), fmt.getFileSize()
        );
    }
}

// Direct stream URL (populated when a format selector was used in the request)
System.out.println(info.getUrl());             // "https://player.vimeo.com/..." (direct stream)
System.out.println(info.getManifestUrl());     // HLS/DASH manifest if applicable
```

--------------------------------

### Get Stream Information

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Retrieve detailed information about a video stream, equivalent to yt-dlp's --dump-json option. Access specific details like the title.

```java
VideoInfo streamInfo = YoutubeDL.getInstance().getInfo("https://vimeo.com/22439234");
System.out.println(streamInfo.getTitle());
```

--------------------------------

### Execute YoutubeDL Download with Progress and Cancellation

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Shows how to execute a download using YoutubeDL.execute with real-time progress and ETA callbacks. It also demonstrates how to cancel a download using a process ID.

```java
// Kotlin lambda style (Java interop via Function3)
Function3<Float, Long, String, Unit> callback = (progress, etaInSeconds, line) -> {
    runOnUiThread(() -> {
        progressBar.setProgress(progress.intValue());
        tvStatus.setText(line);
    });
    return Unit.INSTANCE;
};
```

```java
File destDir = new File(
    Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS),
    "youtubedl-android"
);

YoutubeDLRequest request = new YoutubeDLRequest("https://vimeo.com/22439234");
request.addOption("--no-mtime")
       .addOption("--downloader", "libaria2c.so")   // use aria2c for parallel downloads
       .addOption("-f", "bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best")
       .addOption("-o", destDir.getAbsolutePath() + "/%(title)s.%(ext)s");

// Execute off the main thread
Disposable d = Observable
    .fromCallable(() -> YoutubeDL.getInstance().execute(request, PROCESS_ID, callback))
    .subscribeOn(Schedulers.newThread())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(
        response -> {
            Log.d(TAG, "Done in " + response.getElapsedTime() + "ms");
            Log.d(TAG, response.getOut());      // full stdout
        },
        error -> {
            if (error instanceof YoutubeDL.CanceledException) {
                Log.i(TAG, "Download was cancelled");
            } else {
                Log.e(TAG, "Download failed: " + error.getMessage());
            }
        }
    );
```

```java
// Cancel later from the UI thread
btnStop.setOnClickListener(v -> YoutubeDL.getInstance().destroyProcessById(PROCESS_ID));
```

--------------------------------

### Initialize FFmpeg with YoutubeDL

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Include and initialize the FFmpeg library for features like audio extraction. Ensure YoutubeDL is also initialized.

```java
try {
    YoutubeDL.getInstance().init(this);
    FFmpeg.getInstance().init(this);
} catch (YoutubeDLException e) {
    Log.e(TAG, "failed to initialize youtubedl-android", e);
}
```

--------------------------------

### FFmpeg.init

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Initializes FFmpeg support by unpacking the bundled `libffmpeg.zip.so` into the app's private files directory. This is required for any yt-dlp features that involve FFmpeg post-processing.

```APIDOC
## FFmpeg.init — Enabling FFmpeg Support

`FFmpeg.init(context)` unpacks the bundled `libffmpeg.zip.so` into the app's private files directory. Once initialized, yt-dlp automatically locates the binary via the `--ffmpeg-location` flag injected by `YoutubeDL.execute`. Required for any yt-dlp feature that invokes FFmpeg post-processing: `--extract-audio`, `--merge-output-format`, subtitle embedding, thumbnail embedding, and more.

### Method
```java
FFmpeg.init(Context context)
```

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.

### Usage
Initialize FFmpeg support, typically in your `Application.onCreate()` method, alongside other library initializations.

### Request Example
```java
// Initialize both core library and FFmpeg in Application.onCreate()
try {
    YoutubeDL.getInstance().init(this);
    FFmpeg.getInstance().init(this);
} catch (YoutubeDLException e) {
    Log.e(TAG, "Initialization failed", e);
}

// Then use FFmpeg-dependent yt-dlp options freely
YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/dQw4w9WgXcQ");
request.addOption("-x")                              // --extract-audio
       .addOption("--audio-format", "mp3")
       .addOption("--audio-quality", "0")            // best quality VBR
       .addOption("--embed-thumbnail")
       .addOption("-o", "/sdcard/Download/youtubedl-android/%(title)s.%(ext)s");

YoutubeDLResponse response = YoutubeDL.getInstance().execute(request, null, null);
```
```

--------------------------------

### Initialize FFmpeg Support

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Unpacks the bundled libffmpeg.zip.so into the app's private files directory. Required for any yt-dlp feature that invokes FFmpeg post-processing. Initialize both core library and FFmpeg in Application.onCreate().

```java
// Initialize both core library and FFmpeg in Application.onCreate()
try {
    YoutubeDL.getInstance().init(this);
    FFmpeg.getInstance().init(this);
} catch (YoutubeDLException e) {
    Log.e(TAG, "Initialization failed", e);
}

// Then use FFmpeg-dependent yt-dlp options freely
YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/dQw4w9WgXcQ");
request.addOption("-x")                              // --extract-audio
       .addOption("--audio-format", "mp3")
       .addOption("--audio-quality", "0")            // best quality VBR
       .addOption("--embed-thumbnail")
       .addOption("-o", "/sdcard/Download/youtubedl-android/%(title)s.%(ext)s");

YoutubeDLResponse response = YoutubeDL.getInstance().execute(request, null, null);
// Output: /sdcard/Download/youtubedl-android/Rick Astley - Never Gonna Give You Up.mp3
```

--------------------------------

### Build YoutubeDLRequest with Options

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Demonstrates creating a YoutubeDLRequest for a single URL with various options like format selection, output path, and retries. Options are added using a fluent API.

```java
YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/dQw4w9WgXcQ");
request.addOption("--no-mtime")                     // flag only
       .addOption("-f", "bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best")
       .addOption("-o", "/sdcard/Download/youtubedl-android/%(title)s.%(ext)s")
       .addOption("--merge-output-format", "mp4")
       .addOption("--retries", 3);                  // Number overload
```

```java
List<String> urls = Arrays.asList(
    "https://vimeo.com/22439234",
    "https://vimeo.com/22439235"
);
YoutubeDLRequest batchRequest = new YoutubeDLRequest(urls);
batchRequest.addOption("-o", "/sdcard/Download/%(uploader)s/%(title)s.%(ext)s");
```

```java
YoutubeDLRequest configRequest = new YoutubeDLRequest("https://youtu.be/dQw4w9WgXcQ");
configRequest.addOption("--config-location", "/sdcard/Download/youtubedl-android/config.txt");
```

```java
List<String> cmd = request.buildCommand();
Log.d("CMD", TextUtils.join(" ", cmd));
```

--------------------------------

### Execute Download with Config File

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Java code to execute a download using YoutubeDL, with support for an external configuration file. Falls back to inline options if the config file does not exist.

```java
File configFile = new File(
    Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS),
    "youtubedl-android/config.txt"
);

YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/dQw4w9WgXcQ");
if (configFile.exists()) {
    request.addOption("--config-location", configFile.getAbsolutePath());
} else {
    // fallback to inline options
    request.addOption("-f", "best")
           .addOption("-o", configFile.getParent() + "/%(title)s.%(ext)s");
}

YoutubeDL.getInstance().execute(request, "cfg_download", callback);
```

--------------------------------

### Download Video with Custom Options

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Execute a download request with custom options, such as output path. The progress and ETA are reported via a callback.

```java
File youtubeDLDir = new File(Environment.getExternalStoragePublicDirectory(Environment.DIRECTORY_DOWNLOADS), "youtubedl-android");
YoutubeDLRequest request = new YoutubeDLRequest("https://vimeo.com/22439234");
request.addOption("-o", youtubeDLDir.getAbsolutePath() + "/%(title)s.%(ext)s");
YoutubeDL.getInstance().execute(request, (progress, etaInSeconds) -> {
    System.out.println(String.valueOf(progress) + "% (ETA " + String.valueOf(etaInSeconds) + " seconds)");
});
```

--------------------------------

### Create FFmpeg Build Script

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_FFMPEG.md

Create a custom bash script to configure and build the FFmpeg package for a specific architecture (e.g., ARM). Set environment variables for Termux prefix and Android home.

```bash
#!/bin/bash
# use i686 for x86
export TERMUX_ARCH=arm
export TERMUX_PREFIX=/data/youtubedl-android/usr
export TERMUX_ANDROID_HOME=/data/youtubedl-android/home
./build-package.sh ffmpeg
```

--------------------------------

### Create FFmpeg Zip Archive

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_FFMPEG.md

After building, navigate to the 'debs' directory, extract the .deb files, and then create a zip archive containing the FFmpeg libraries for Android.

```bash
cd debs
find . -type f -exec dpkg-deb -xv {} . \;
cd data/youtubedl-android
zip --symlinks -r /tmp/ffmpeg_arm.zip usr/lib
```

--------------------------------

### Make Script Executable

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_PYTHON.md

Grant execute permissions to the build script.

```bash
chmod +x ./build-python.sh
```

--------------------------------

### Make Build Script Executable

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_FFMPEG.md

Grant execute permissions to the custom FFmpeg build script.

```bash
chmod +x ./build-ffmpeg.sh
```

--------------------------------

### Aria2c.init

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Initializes aria2c as an external downloader for yt-dlp by unpacking `libaria2c.zip.so`. This enables multi-connection parallel downloads for significantly faster speeds. After initialization, it can be activated per-request.

```APIDOC
## Aria2c.init — Enabling the Aria2c External Downloader

`Aria2c.init(context)` unpacks `libaria2c.zip.so` to use aria2c as yt-dlp's external downloader, enabling multi-connection parallel downloads for significantly faster speeds. After initialization, activate it per-request by passing `--downloader libaria2c.so`. The library automatically appends the required `--external-downloader-args` for `--summary-interval` and the SSL certificate path.

### Method
```java
Aria2c.init(Context context)
```

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.

### Usage
Initialize aria2c support, typically in your `Application.onCreate()` method, alongside other library initializations.

### Request Example
```java
// Initialize all three modules
try {
    YoutubeDL.getInstance().init(this);
    FFmpeg.getInstance().init(this);
    Aria2c.getInstance().init(this);
} catch (YoutubeDLException e) {
    Log.e(TAG, "Init failed", e);
}

// Use aria2c as the downloader for a specific request
YoutubeDLRequest request = new YoutubeDLRequest("https://vimeo.com/22439234");
request.addOption("--downloader", "libaria2c.so")
       .addOption("-f", "bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best")
       .addOption("-o", "/sdcard/Download/youtubedl-android/%(title)s.%(ext)s");

YoutubeDL.getInstance().execute(request, "aria2c_download", (progress, eta, line) -> {
    Log.d(TAG, progress + "% ETA " + eta + "s | " + line);
    return Unit.INSTANCE;
});
```
```

--------------------------------

### Initialize youtubedl-android Library

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Initialize the library once, preferably in your application's onCreate method. Handle potential initialization errors.

```java
try {
    YoutubeDL.getInstance().init(this);
} catch (YoutubeDLException e) {
    Log.e(TAG, "failed to initialize youtubedl-android", e);
}
```

--------------------------------

### Initialize Library

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Initializes the youtubedl-android library. This should be called once, preferably in your application's onCreate method.

```APIDOC
## Initialize Library

### Description
Initializes the youtubedl-android library. This should be called once, preferably in your application's onCreate method.

### Method
```java
YoutubeDL.getInstance().init(Context context)
```

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.

### Exception
- **YoutubeDLException** - Thrown if initialization fails.
```

--------------------------------

### Create build-python.sh Script

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_PYTHON.md

Define environment variables and the build command for the Python package.

```bash
#!/bin/bash
# use i686 for x86
export TERMUX_ARCH=arm
export TERMUX_PREFIX=/data/youtubedl-android/usr
export TERMUX_ANDROID_HOME=/data/youtubedl-android/home
./build-package.sh python
```

--------------------------------

### Execute Download Request

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Executes a download request with progress updates. This method allows for downloading videos with custom options and provides real-time progress feedback.

```APIDOC
## Execute Download Request

### Description
Executes a download request with progress updates. This method allows for downloading videos with custom options and provides real-time progress feedback.

### Method
```java
YoutubeDL.getInstance().execute(YoutubeDLRequest request, ProgressCallback callback)
```

### Parameters
#### Path Parameters
- **request** (YoutubeDLRequest) - Required - The request object containing the URL and options.
- **callback** (ProgressCallback) - Required - A callback interface to receive progress updates.

### Callback Interface
```java
interface ProgressCallback {
    void onProgressUpdate(long progress, long etaInSeconds);
}
```
```

--------------------------------

### Initialize Aria2c Downloader

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Unpacks libaria2c.zip.so to use aria2c as yt-dlp's external downloader, enabling multi-connection parallel downloads. After initialization, activate it per-request by passing --downloader libaria2c.so. The library automatically appends required arguments.

```java
// Initialize all three modules
try {
    YoutubeDL.getInstance().init(this);
    FFmpeg.getInstance().init(this);
    Aria2c.getInstance().init(this);
} catch (YoutubeDLException e) {
    Log.e(TAG, "Init failed", e);
}

// Use aria2c as the downloader for a specific request
YoutubeDLRequest request = new YoutubeDLRequest("https://vimeo.com/22439234");
request.addOption("--downloader", "libaria2c.so")
       .addOption("-f", "bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best")
       .addOption("-o", "/sdcard/Download/youtubedl-android/%(title)s.%(ext)s");

YoutubeDL.getInstance().execute(request, "aria2c_download", (progress, eta, line) -> {
    Log.d(TAG, progress + "% ETA " + eta + "s | " + line);
    return Unit.INSTANCE;
});
```

--------------------------------

### Stop a Download Process

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Initiate a download and then stop it using its process ID. Ensure the process ID is unique and managed correctly.

```java
YoutubeDLRequest request = new YoutubeDLRequest("https://vimeo.com/22439234");
final String processId = "MyProcessDownloadId";
YoutubeDL.getInstance().execute(request, (progress, etaInSeconds) -> {
    System.out.println(String.valueOf(progress) + "% (ETA " + String.valueOf(etaInSeconds) + " seconds)");
}, processId);
...
YoutubeDL.getInstance().destroyProcessById(processId);
```

--------------------------------

### YoutubeDL.updateYoutubeDL

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Fetches the latest yt-dlp release from GitHub, compares it with the stored version, and updates the on-device binary if a newer version is available. Supports STABLE, NIGHTLY, and MASTER update channels. Must be called off the main thread.

```APIDOC
## YoutubeDL.updateYoutubeDL — Updating the yt-dlp Binary

`updateYoutubeDL` fetches the latest yt-dlp release from GitHub, compares the tag against the stored version in SharedPreferences, and atomically replaces the on-device binary if a newer version is available. Supports three update channels: `STABLE`, `NIGHTLY`, and `MASTER`. Returns `UpdateStatus.DONE` or `UpdateStatus.ALREADY_UP_TO_DATE`. Must be called off the main thread.

### Method
```java
YoutubeDL.updateYoutubeDL(Context context, UpdateChannel channel)
```

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.
- **channel** (UpdateChannel) - Required - The update channel to use (`STABLE`, `NIGHTLY`, `MASTER`).

### Return Value
- **UpdateStatus** - Returns `UpdateStatus.DONE` if an update was performed, or `UpdateStatus.ALREADY_UP_TO_DATE` if no update was needed.

### Request Example
```java
// Example of prompting user for update channel and performing update
private void performUpdate(YoutubeDL.UpdateChannel channel) {
    Observable.fromCallable(() -> YoutubeDL.getInstance().updateYoutubeDL(this, channel))
        .subscribeOn(Schedulers.newThread())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(status -> {
            // Handle status update
        }, e -> {
            // Handle error
        });
}
```

### Related Methods
- **YoutubeDL.version(Context context)**: Returns the current cached version tag of yt-dlp.
- **YoutubeDL.versionName(Context context)**: Returns the full version name of yt-dlp.
```

--------------------------------

### Create Python Zip Archive

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_PYTHON.md

Create a zip archive of the extracted Python libraries and configuration files.

```bash
cd data/youtubedl-android
zip --symlinks -r /tmp/python3_7_arm.zip usr/lib usr/etc
```

--------------------------------

### Fetch Video Metadata with YoutubeDL.getInfo

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Fetches video metadata using a URL or a pre-configured request. Useful for displaying video details or obtaining direct stream URLs for playback. Ensure proper error handling for network or processing issues.

```java
try {
    VideoInfo info = YoutubeDL.getInstance().getInfo("https://vimeo.com/22439234");
    Log.d(TAG, "Title:    " + info.getTitle());
    Log.d(TAG, "Duration: " + info.getDuration() + "s");
    Log.d(TAG, "Uploader: " + info.getUploader());
    Log.d(TAG, "Views:    " + info.getViewCount());

    // Iterate available formats
    if (info.getFormats() != null) {
        for (VideoFormat fmt : info.getFormats()) {
            Log.d(TAG, fmt.getFormatId() + " | " + fmt.getExt()
                + " | " + fmt.getWidth() + "x" + fmt.getHeight()
                + " | " + fmt.getFileSize() + " bytes");
        }
    }
} catch (YoutubeDLException | InterruptedException e) {
    Log.e(TAG, "getInfo failed", e);
}
```

```java
Disposable d = Observable.fromCallable(() -> {
        YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/Pv61yEcOqpw");
        request.addOption("-f", "best");
        return YoutubeDL.getInstance().getInfo(request);
    })
    .subscribeOn(Schedulers.newThread())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(streamInfo -> {
        String videoUrl = streamInfo.getUrl();
        // Feed directly into ExoPlayer, MediaPlayer, or ExoMedia VideoView
        videoView.setMedia(Uri.parse(videoUrl));
        videoView.start();
    }, e -> Log.e(TAG, "Streaming failed", e));
```

--------------------------------

### Execute Download Request with Process ID

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Executes a download request with progress updates and a unique process ID. This allows for managing and stopping specific download processes.

```APIDOC
## Execute Download Request with Process ID

### Description
Executes a download request with progress updates and a unique process ID. This allows for managing and stopping specific download processes.

### Method
```java
YoutubeDL.getInstance().execute(YoutubeDLRequest request, ProgressCallback callback, String processId)
```

### Parameters
#### Path Parameters
- **request** (YoutubeDLRequest) - Required - The request object containing the URL and options.
- **callback** (ProgressCallback) - Required - A callback interface to receive progress updates.
- **processId** (String) - Required - A unique identifier for the download process.

### Callback Interface
```java
interface ProgressCallback {
    void onProgressUpdate(long progress, long etaInSeconds);
}
```
```

--------------------------------

### Build FFmpeg Package

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_FFMPEG.md

Execute the FFmpeg build process within the Termux Docker environment. This command cleans previous builds and then runs the custom build script.

```bash
./scripts/run-docker.sh ./clean.sh
./scripts/run-docker.sh ./build-ffmpeg.sh
```

--------------------------------

### Configure AndroidManifest.xml

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Add the required attributes to the application tag in your AndroidManifest.xml. `android:extractNativeLibs` is essential for loading native libraries.

```xml
<application
    android:extractNativeLibs="true"
    android:requestLegacyExternalStorage="true"> 
    <!-- required for Android 10 (API 29) -->
    ...
</application>
```

--------------------------------

### Build Python Package

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_PYTHON.md

Run the build script within the Termux Docker environment to compile the Python package.

```bash
./scripts/run-docker.sh ./clean.sh
./scripts/run-docker.sh ./build-python.sh
```

--------------------------------

### Configure Downloader to use Aria2c

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Set the downloader option in the request to use the 'libaria2c.so' library for downloads.

```kotlin
request.addOption("--downloader", "libaria2c.so");
```

--------------------------------

### Extract Debian Packages

Source: https://github.com/yausername/youtubedl-android/blob/master/BUILD_PYTHON.md

Extract the contents of the built .deb files to create a Python environment.

```bash
cd debs
dpkg-deb -xv python_3.7.2-1_arm.deb .
dpkg-deb -xv libandroid-support_24_arm.deb .
dpkg-deb -xv libutil_0.4_arm.deb .
dpkg-deb -xv libffi_3.2.1-2_arm.deb .
dpkg-deb -xv openssl_1.1.1a_arm.deb .
dpkg-deb -xv ca-certificates_20180124_all.deb .
```

--------------------------------

### YoutubeDL.getInfo

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Fetches video metadata by wrapping the execute method with --dump-json. It can accept a URL string or a YoutubeDLRequest object. The method returns a VideoInfo object containing details about the video, including a direct playable stream URL if a format selector is specified.

```APIDOC
## YoutubeDL.getInfo — Fetching Video Metadata

`getInfo` wraps `execute` with `--dump-json` and deserializes the JSON output into a `VideoInfo` POJO via Jackson. Accepts either a plain URL string or a pre-configured `YoutubeDLRequest` (useful for adding `--username`/`--password`, cookies, or format selectors before the metadata fetch). Returns a `VideoInfo` object. The `url` field on `VideoInfo` is the direct playable stream URL when a format selector is specified, making it the entry point for in-app streaming.

```java
// 1. Simple metadata fetch by URL
try {
    VideoInfo info = YoutubeDL.getInstance().getInfo("https://vimeo.com/22439234");
    Log.d(TAG, "Title:    " + info.getTitle());
    Log.d(TAG, "Duration: " + info.getDuration() + "s");
    Log.d(TAG, "Uploader: " + info.getUploader());
    Log.d(TAG, "Views:    " + info.getViewCount());

    // Iterate available formats
    if (info.getFormats() != null) {
        for (VideoFormat fmt : info.getFormats()) {
            Log.d(TAG, fmt.getFormatId() + " | " + fmt.getExt()
                + " | " + fmt.getWidth() + "x" + fmt.getHeight()
                + " | " + fmt.getFileSize() + " bytes");
        }
    }
} catch (YoutubeDLException | InterruptedException e) {
    Log.e(TAG, "getInfo failed", e);
}

// 2. Get a single direct playable URL for streaming (format: best combined stream)
Disposable d = Observable.fromCallable(() -> {
        YoutubeDLRequest request = new YoutubeDLRequest("https://youtu.be/Pv61yEcOqpw");
        request.addOption("-f", "best");
        return YoutubeDL.getInstance().getInfo(request);
    })
    .subscribeOn(Schedulers.newThread())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe(streamInfo -> {
        String videoUrl = streamInfo.getUrl();
        // Feed directly into ExoPlayer, MediaPlayer, or ExoMedia VideoView
        videoView.setMedia(Uri.parse(videoUrl));
        videoView.start();
    }, e -> Log.e(TAG, "Streaming failed", e));
```
```

--------------------------------

### Update yt-dlp Binary

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Updates the yt-dlp binary to either the latest stable or nightly version.

```APIDOC
## Update yt-dlp Binary

### Description
Updates the yt-dlp binary to either the latest stable or nightly version.

### Method
```java
YoutubeDL.getInstance().updateYoutubeDL(Context context, UpdateChannel channel)
```

### Parameters
#### Path Parameters
- **context** (Context) - Required - The application context.
- **channel** (UpdateChannel) - Required - The update channel to use (UpdateChannel.NIGHTLY or UpdateChannel.STABLE).
```

--------------------------------

### Update YoutubeDL Binary

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Fetches the latest yt-dlp release from GitHub and replaces the on-device binary if a newer version is available. Supports STABLE, NIGHTLY, and MASTER update channels. Must be called off the main thread. Query current cached version without network call.

```java
private void promptAndUpdate() {
    new AlertDialog.Builder(this)
        .setTitle("Select Update Channel")
        .setItems(
            new String[]{"Stable", "Nightly", "Master"},
            (dialog, which) -> {
                YoutubeDL.UpdateChannel channel = switch (which) {
                    case 1  -> YoutubeDL.UpdateChannel._NIGHTLY;
                    case 2  -> YoutubeDL.UpdateChannel._MASTER;
                    default -> YoutubeDL.UpdateChannel._STABLE;
                };
                performUpdate(channel);
            }
        ).show();
}

private void performUpdate(YoutubeDL.UpdateChannel channel) {
    progressBar.setVisibility(View.VISIBLE);
    Observable.fromCallable(() -> YoutubeDL.getInstance().updateYoutubeDL(this, channel))
        .subscribeOn(Schedulers.newThread())
        .observeOn(AndroidSchedulers.mainThread())
        .subscribe(status -> {
            progressBar.setVisibility(View.GONE);
            String version = YoutubeDL.getInstance().versionName(this);
            switch (status) {
                case DONE:
                    Toast.makeText(this, "Updated to " + version, Toast.LENGTH_SHORT).show();
                    break;
                case ALREADY_UP_TO_DATE:
                    Toast.makeText(this, "Already up to date: " + version, Toast.LENGTH_SHORT).show();
                    break;
            }
        }, e -> {
            progressBar.setVisibility(View.GONE);
            Log.e(TAG, "Update failed", e);
        });
}
```

```java
// Query current cached version without network call
String tag      = YoutubeDL.getInstance().version(context);      // e.g. "2024.03.10"
String fullName = YoutubeDL.getInstance().versionName(context);  // e.g. "yt-dlp 2024.03.10"
```

--------------------------------

### Restrict ABIs in app/build.gradle.kts

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Optimize your APK size by restricting the supported ABIs in your app's build.gradle.kts file. This prevents the inclusion of unnecessary native libraries.

```kotlin
android {
    defaultConfig {
        ndk {
            abiFilters += listOf("armeabi-v7a", "arm64-v8a", "x86", "x86_64")
        }
    }
    splits {
        abi {
            isEnable = true
            reset()
            include("armeabi-v7a", "arm64-v8a", "x86", "x86_64")
            isUniversalApk = false
        }
    }
}
```

--------------------------------

### Update yt-dlp Binary

Source: https://github.com/yausername/youtubedl-android/blob/master/README.md

Update the yt-dlp binary within the library to either the NIGHTLY or STABLE channel. This requires context and an UpdateChannel enum.

```java
YoutubeDL.getInstance().updateYoutubeDL(this, updateChannel); // UpdateChannel.NIGHTLY or UpdateChannel.STABLE
```

--------------------------------

### Cancel Running Download with YoutubeDL.destroyProcessById

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Cancels a running download process identified by a specific ID. This is useful for stopping downloads initiated by `execute` when they are no longer needed. The `execute` call awaiting the process will throw `CanceledException`.

```java
// Register a process ID when starting
final String processId = "batch_download_01";
YoutubeDL.getInstance().execute(request, processId, callback);
```

```java
// Cancel from any thread (e.g. button click or lifecycle event)
boolean wasStopped = YoutubeDL.getInstance().destroyProcessById(processId);
if (wasStopped) {
    Log.i(TAG, "Process " + processId + " stopped successfully");
} else {
    Log.w(TAG, "Process " + processId + " was not running");
}
```

```java
.subscribe(
    response -> { /* completed normally */ },
    error -> {
        if (error instanceof YoutubeDL.CanceledException) {
            tvStatus.setText("Download cancelled by user");
        } else {
            tvStatus.setText("Error: " + error.getMessage());
        }
    }
);
```

--------------------------------

### YoutubeDL.destroyProcessById

Source: https://context7.com/yausername/youtubedl-android/llms.txt

Cancels a running download process by its registered ID. It destroys the process and its children. Returns true if the process was found and alive, false otherwise. Subsequent calls to execute awaiting this process will throw a CanceledException.

```APIDOC
## YoutubeDL.destroyProcessById — Cancelling a Running Download

`destroyProcessById` looks up a running `Process` by its registered ID and destroys it along with any child processes (via `pstree`). Returns `true` if the process was found and alive, `false` otherwise. After destruction, the next `execute` call that was awaiting that process will throw `CanceledException`.

```java
// Register a process ID when starting
final String processId = "batch_download_01";
YoutubeDL.getInstance().execute(request, processId, callback);

// Cancel from any thread (e.g. button click or lifecycle event)
boolean wasStopped = YoutubeDL.getInstance().destroyProcessById(processId);
if (wasStopped) {
    Log.i(TAG, "Process " + processId + " stopped successfully");
} else {
    Log.w(TAG, "Process " + processId + " was not running");
}

// Catching CanceledException in the execute subscriber
.subscribe(
    response -> { /* completed normally */ },
    error -> {
        if (error instanceof YoutubeDL.CanceledException) {
            tvStatus.setText("Download cancelled by user");
        } else {
            tvStatus.setText("Error: " + error.getMessage());
        }
    }
);
```
```
Tokens:
Raw