youtube-dl

https://github.com/ytdl-org/youtube-dl
Admin
youtube-dl is a command-line program and Python library that allows users to download videos from...
Tokens:49,149
Snippets:687
Trust Score:6.7
License:Unlicense
Update:2 months ago
Show doc for...
Tokens:
Raw
### Output Template Examples

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Examples of configuring the outtmpl dictionary key to format output filenames.

```python
# Simple: title and extension
'outtmpl': '%(title)s.%(ext)s'
# Output: "Video Title.mp4"

# With channel: [channel] title.ext
'outtmpl': '[%(uploader)s] %(title)s.%(ext)s'
# Output: "[Channel Name] Video Title.mp4"

# Organized by upload date
'outtmpl': '%(upload_date)s - %(title)s.%(ext)s'
# Output: "20230515 - Video Title.mp4"

# Playlist organization
'outtmpl': '%(playlist)s/%(playlist_index)03d - %(title)s.%(ext)s'
# Output: "Playlist Name/001 - First Video.mp4"

# With resolution
'outtmpl': '%(title)s [%(resolution)s].%(ext)s'
# Output: "Video Title [1080p].mp4"
```

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

### Install youtube-dl via wget on UNIX

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Alternative installation method for UNIX systems using wget.

```bash
sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
sudo chmod a+rx /usr/local/bin/youtube-dl
```

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

### Format Selection Command Examples

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Common command-line examples for filtering and selecting specific video and audio formats. Note that Windows users may need to use double quotes instead of single quotes.

```bash
# Download best mp4 format available or any other best if no mp4 available
$ youtube-dl -f 'bestvideo[ext=mp4]+bestaudio[ext=m4a]/best[ext=mp4]/best'

# Download best format available but no better than 480p
$ youtube-dl -f 'bestvideo[height<=480]+bestaudio/best[height<=480]'

# Download best video only format but no bigger than 50 MB
$ youtube-dl -f 'best[filesize<50M]'

# Download best format available via direct link over HTTP/HTTPS protocol
$ youtube-dl -f '(bestvideo+bestaudio/best)[protocol^=http]'

# Download the best video format and the best audio format without merging them
$ youtube-dl -f 'bestvideo,bestaudio' -o '%(title)s.f%(format_id)s.%(ext)s'
```

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

### Install youtube-dl via Homebrew

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Installs the package on macOS using the Homebrew package manager.

```bash
brew install youtube-dl
```

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

### Manually invoke a PostProcessor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Example of manually instantiating and running the FFmpegExtractAudioPP post-processor.

```python
from youtube_dl import YoutubeDL
from youtube_dl.postprocessor import FFmpegExtractAudioPP

ydl = YoutubeDL({'quiet': False})
info = ydl.extract_info(url, download=True)

# Manually run post-processor
audio_pp = FFmpegExtractAudioPP(ydl, preferredcodec='mp3')
files_to_delete, info = audio_pp.run({
    'filepath': '/path/to/video.mp4',
    'title': 'Video Title'
})
```

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

### Configuration File Format

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Example content for a configuration file where each line represents a command-line option.

```text
# ~/.config/youtube-dl/config
--output %(title)s.%(ext)s
--format best
--no-color
--continue
--socket-timeout 30
```

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

### Install youtube-dl via MacPorts

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Installs the package on macOS using the MacPorts package manager.

```bash
sudo port install youtube-dl
```

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

### Execute file download

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Example workflow for extracting info and executing a download using a suitable downloader.

```python
from youtube_dl import YoutubeDL

ydl = YoutubeDL({'quiet': False})
info = ydl.extract_info(url, download=False)

# Get downloader for this format
from youtube_dl.downloader import get_suitable_downloader
downloader = get_suitable_downloader(info)

# Download
success = downloader.download('/tmp/video.mp4', info)
```

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

### YoutubeDL Usage Examples

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Demonstrates basic initialization, custom output templates, and the context manager pattern for downloading a video.

```python
from youtube_dl import YoutubeDL

# Basic initialization
ydl = YoutubeDL({'quiet': False, 'verbose': True})

# With custom output template
ydl = YoutubeDL({
    'outtmpl': '%(title)s.%(ext)s',
    'quiet': False
})

# Download a video
with ydl:
    info = ydl.extract_info('https://www.youtube.com/watch?v=dQw4w9WgXcQ', download=True)
```

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

### Configure Post-Processors

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Example of setting up post-processing tasks like audio extraction and metadata embedding using FFmpeg.

```python
ydl = YoutubeDL({
    'postprocessors': [
        {
            'key': 'FFmpegExtractAudio',
            'preferredcodec': 'mp3',
            'preferredquality': '192'
        },
        {
            'key': 'FFmpegMetadata'
        }
    ],
    'prefer_ffmpeg': True,
    'ffmpeg_location': '/usr/bin/ffmpeg'
})
```

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

### Example youtube-dl configuration file

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

A sample configuration file demonstrating common flags for audio extraction, proxy settings, and output paths.

```text
# Lines starting with # are comments

# Always extract audio
-x

# Do not copy the mtime
--no-mtime

# Use this proxy
--proxy 127.0.0.1:3128

# Save all videos under Movies directory in your home directory
-o ~/Movies/%(title)s.%(ext)s
```

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

### Install youtube-dl via pip

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Installs or upgrades the package using the Python package manager.

```bash
sudo -H pip install --upgrade youtube-dl
```

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

### FFmpegExtractAudioPP Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Example configuration for extracting audio to MP3 format using YoutubeDL.

```python
from youtube_dl import YoutubeDL
from youtube_dl.postprocessor import FFmpegExtractAudioPP

ydl = YoutubeDL({
    'format': 'bestaudio/best',
    'postprocessors': [{
        'key': 'FFmpegExtractAudio',
        'preferredcodec': 'mp3',
        'preferredquality': '192',
    }]
})
info = ydl.extract_info(url, download=True)
# Output file: audio.mp3
```

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

### Configure Output Templates

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Examples of using the -o flag to define custom output paths and filenames based on video metadata.

```bash
$ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc
youtube-dl test video ''_ä↭𝕐.mp4    # All kinds of weird characters

$ youtube-dl --get-filename -o '%(title)s.%(ext)s' BaW_jenozKc --restrict-filenames
youtube-dl_test_video_.mp4          # A simple file name

# Download YouTube playlist videos in separate directory indexed by video order in a playlist
$ youtube-dl -o '%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re

# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
$ youtube-dl -o '%(uploader)s/%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s' https://www.youtube.com/user/TheLinuxFoundation/playlists

# Download Udemy course keeping each chapter in separate directory under MyVideos directory in your home
$ youtube-dl -u user -p password -o '~/MyVideos/%(playlist)s/%(chapter_number)s - %(chapter)s/%(title)s.%(ext)s' https://www.udemy.com/java-tutorial/

# Download entire series season keeping each series and each season in separate directory under C:/MyVideos
$ youtube-dl -o "C:/MyVideos/%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" https://videomore.ru/kino_v_detalayah/5_sezon/367617

# Stream the video being downloaded to stdout
$ youtube-dl -o - BaW_jenozKc
```

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

### FFmpegMetadataPP Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Example configuration for adding metadata tags to a video file.

```python
ydl = YoutubeDL({
    'writethumbnail': True,
    'postprocessors': [{
        'key': 'FFmpegMetadata'
    }]
})
```

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

### Example .netrc entries

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Sample entries for YouTube and Twitch authentication.

```text
machine youtube login myaccount@gmail.com password my_youtube_password
machine twitch login my_twitch_account_name password my_twitch_password
```

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

### CLI Entry Execution Flow

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/module-index.md

Represents the initial entry point and setup sequence for the youtube-dl command-line interface.

```text
youtube_dl/__main__.py
  → youtube_dl.__init__._real_main(argv)
    → options.parseOpts(argv)
    → Create YoutubeDL(params)
    → Call YoutubeDL.download(urls)
```

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

### FFmpegConvertSubtitlesPP Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Example configuration for converting subtitles to SRT format.

```python
ydl = YoutubeDL({
    'writesubtitles': True,
    'postprocessors': [{
        'key': 'FFmpegConvertSubtitles',
        'format': 'srt'
    }]
})
```

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

### Configure File Size and Rate Limits

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Examples for setting file size constraints and download rate limits using either string-based units or raw byte values.

```python
# Minimum 50MB
'min_filesize': '50M'
# or
'min_filesize': 52428800  # bytes

# Maximum 5GB
'max_filesize': '5G'
# or
'max_filesize': 5368709120  # bytes

# Rate limit 500KB/s
'ratelimit': '500K'
# or
'ratelimit': 512000  # bytes per second
```

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

### Basic Python Library Integration

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/INDEX.md

Standard setup for initializing the YoutubeDL class and extracting video information.

```python
from youtube_dl import YoutubeDL

# Create downloader
ydl = YoutubeDL({
    'format': 'best',
    'outtmpl': '%(title)s.%(ext)s'
})

# Download
with ydl:
    info = ydl.extract_info('https://www.youtube.com/watch?v=video_id')
    print(info['title'])
```

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

### Usage of add_post_processor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Example of adding an FFmpegExtractAudioPP post-processor to convert downloaded files.

```python
from youtube_dl.postprocessor import FFmpegExtractAudioPP

ydl = YoutubeDL({'quiet': False})
audio_pp = FFmpegExtractAudioPP(ydl, preferredcodec='mp3')
ydl.add_post_processor(audio_pp)
```

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

### Install youtube-dl via curl on UNIX

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Downloads the latest binary and sets executable permissions for UNIX-based systems.

```bash
sudo curl -L https://yt-dl.org/downloads/latest/youtube-dl -o /usr/local/bin/youtube-dl
sudo chmod a+rx /usr/local/bin/youtube-dl
```

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

### FFmpegSubtitlesEmbedPP Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Example configuration for embedding subtitles into a video file.

```python
ydl = YoutubeDL({
    'writesubtitles': True,
    'postprocessors': [{
        'key': 'FFmpegSubtitlesEmbed'
    }]
})
```

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

### Configure Subtitle Downloads

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Example of initializing YoutubeDL with specific subtitle settings including language filtering and format selection.

```python
ydl = YoutubeDL({
    'writesubtitles': True,
    'subtitleslangs': ['en', 'es'],
    'subtitlesformat': 'srt'
})
```

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

### Usage of add_info_extractor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Example of adding a YoutubeIE instance to a YoutubeDL object.

```python
from youtube_dl.extractor import YoutubeIE
ydl = YoutubeDL({}, auto_init=False)
ydl.add_info_extractor(YoutubeIE())
```

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

### Download URLs Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Example of using the download method to process a list of URLs and handle the return code.

```python
ydl = YoutubeDL({'quiet': False})
return_code = ydl.download(['https://www.youtube.com/watch?v=video_id'])
print(f"Download finished with code: {return_code}")
```

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

### Invoke youtube-dl via Command Line

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/README.md

Use these commands to run youtube-dl as a module or installed console script.

```bash
python -m youtube_dl [options] url
```

```bash
youtube-dl [options] url
```

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

### Usage of add_progress_hook

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Example of defining and registering a progress hook function to monitor download status.

```python
def progress_hook(d):
    if d['status'] == 'downloading':
        percent = d.get('_percent_str', 'N/A')
        print(f"Downloading: {percent}")
    elif d['status'] == 'finished':
        print(f"Download complete: {d['filename']}")

ydl = YoutubeDL({'quiet': False})
ydl.add_progress_hook(progress_hook)
```

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

### Remove and reinstall youtube-dl

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Commands to remove a package-managed version and perform a manual installation.

```bash
sudo apt-get remove -y youtube-dl
```

```bash
sudo wget https://yt-dl.org/downloads/latest/youtube-dl -O /usr/local/bin/youtube-dl
sudo chmod a+rx /usr/local/bin/youtube-dl
hash -r
```

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

### Extract title from HTML

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Example HTML structure for title extraction.

```html
<span style="position: absolute; left: 910px; width: 90px; float: right; z-index: 9999;" class="title">some fancy title</span>
```

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

### Update youtube-dl via command line

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Commands for updating the software depending on the installation method.

```bash
youtube-dl -U
```

```bash
sudo youtube-dl -U
```

```bash
sudo pip install -U youtube-dl
```

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

### Define source dictionary layout

Source: https://github.com/ytdl-org/youtube-dl/blob/master/CONTRIBUTING.md

Example structure of a metadata dictionary containing a summary field.

```python
{
    ...
    "summary": "some fancy summary text",
    ...
}
```

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

### Use _extract_m3u8_formats for HLS playlists

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/InfoExtractor.md

Example of extracting formats from an m3u8 playlist URL.

```python
formats = ie._extract_m3u8_formats(
    'https://example.com/playlist.m3u8', 
    'video123',
    ext='mp4'
)
```

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

### Define Format Selection Criteria

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Examples for specifying video quality, codec, and container preferences using format codes.

```python
# Best overall quality
'format': 'best'

# Best video without audio
'format': 'best[vcodec!=none]'

# Best MP4 format
'format': 'best[ext=mp4]'

# Best 720p video
'format': 'best[height<=720]'

# Fallback chain: best, then best with height<=480
'format': 'best/worst[height<=480]'

# Best 1080p60 or fallback to best 720p
'format': 'best[height=1080,fps=60]/best[height=720]'
```

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

### Download a video starting with a hyphen

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Use the -- separator or a full URL to prevent the video ID from being interpreted as a command-line option.

```bash
youtube-dl -- -wNyEUrxzFU
youtube-dl "https://www.youtube.com/watch?v=-wNyEUrxzFU"
```

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

### Initialize Library Entry Point

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/README.md

Instantiate the YoutubeDL class and trigger a download.

```python
from youtube_dl import YoutubeDL

ydl = YoutubeDL(params)
ydl.download(urls)
```

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

### Initialize and Use FileDownloader

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Demonstrates importing the downloader factory and initializing it with video metadata and configuration parameters.

```python
from youtube_dl.downloader import get_suitable_downloader

info = {
    'url': 'https://example.com/video.mp4',
    'protocol': 'http',
    'ext': 'mp4'
}
downloader = get_suitable_downloader(info, {'quiet': False})

# Now use downloader.download(filename, info)
```

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

### Generate Filename with prepare_filename

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Defines the method signature for generating filenames based on metadata and provides a usage example for template-based naming.

```python
def prepare_filename(self, info_dict)
```

```python
ydl = YoutubeDL({'outtmpl': '%(title)s-%(id)s.%(ext)s'})
info = ydl.extract_info('https://www.youtube.com/watch?v=video_id', download=False)
filename = ydl.prepare_filename(info)
print(filename)  # Output: "Video Title-video_id.mp4"
```

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

### Example JSON structure for media extraction

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Sample JSON data structure representing media information.

```json
{
    "title": "Example video",
    "comment": "try extracting this",
    "media": [{
        "type": "bad",
        "size": 320,
        "url": "https://some.cdn.site/bad.mp4"
    }, {
        "type": "streaming",
        "url": "https://some.cdn.site/hls.m3u8"
    }, {
        "type": "super",
        "size": 1280,
        "url": "https://some.cdn.site/good.webm"
    }],
    "moreStuff": "more values",
    ...
}
```

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

### Configure DateRange for video downloads

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Use the DateRange class to restrict downloads to a specific timeframe by providing start and end dates.

```python
from youtube_dl.utils import DateRange
import datetime

# Download videos from specific date range
ydl = YoutubeDL({
    'daterange': DateRange(
        start=datetime.date(2023, 1, 1),
        end=datetime.date(2023, 12, 31)
    )
})
```

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

### Handle UnavailableVideoError

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/errors.md

Example of catching the UnavailableVideoError during the extraction process.

```python
from youtube_dl.utils import UnavailableVideoError

try:
    info = ydl.extract_info(url, download=True)
except UnavailableVideoError:
    print("Video is not available")
```

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

### Get Extractor Identifier

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/InfoExtractor.md

Retrieve the unique identifier for an extractor class.

```python
@classmethod
def ie_key(cls)
```

```python
from youtube_dl.extractor import YoutubeIE
key = YoutubeIE.ie_key()  # Returns 'youtube'
```

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

### Instantiate downloader via get_suitable_downloader

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Recommended approach for obtaining a downloader instance based on info_dict parameters.

```python
# Usually not instantiated directly; use get_suitable_downloader instead
from youtube_dl.downloader import get_suitable_downloader

info_dict = {
    'url': 'https://example.com/video.mp4',
    'format_id': 'best',
    'ext': 'mp4'
}
downloader = get_suitable_downloader(info_dict, params)
```

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

### Help and Version Commands

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Commands to display help information or the current program version.

```bash
youtube-dl -h, --help
```

```bash
youtube-dl --version
```

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

### Initialize YoutubeDL instance

Source: https://github.com/ytdl-org/youtube-dl/blob/master/docs/module_guide.md

Create a YoutubeDL instance and populate it with default extractors.

```python
>>> from youtube_dl import YoutubeDL
>>> ydl = YoutubeDL()
>>> ydl.add_default_info_extractors()
```

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

### Use _parse_json for JSON data

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/InfoExtractor.md

Example of parsing a JSON string into a dictionary.

```python
json_str = '{"title": "Video", "duration": 120}'
data = ie._parse_json(json_str, 'video123')
print(data['title'])  # "Video"
```

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

### Basic Command-Line Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/INDEX.md

Common CLI commands for downloading videos, selecting formats, and managing playlists.

```bash
# Download single video
youtube-dl "https://www.youtube.com/watch?v=video_id"

# Download best MP4
youtube-dl -f best[ext=mp4] URL

# Extract to MP3
youtube-dl -x --audio-format mp3 URL

# Download playlist with range
youtube-dl --playlist-start 5 --playlist-end 15 PLAYLIST_URL
```

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

### Basic Syntax

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

The standard command structure for invoking youtube-dl with options and target URLs.

```bash
youtube-dl [OPTIONS] URL [URL...]
```

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

### Basic Output Template Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Demonstrates the standard usage of the -o option for a single file download.

```bash
youtube-dl -o funny_video.flv "https://some/video"
```

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

### Retrieve PostProcessor class

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Use this function to get a post-processor class by its string key.

```python
def get_postprocessor(key)
```

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

### Advanced youtube-dl configuration with logging and post-processing

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Demonstrates using a custom logger to suppress debug/warning messages and a progress hook to trigger actions after download completion. Includes configuration for converting downloaded media to MP3 using FFmpeg.

```python
from __future__ import unicode_literals
import youtube_dl


class MyLogger(object):
    def debug(self, msg):
        pass

    def warning(self, msg):
        pass

    def error(self, msg):
        print(msg)


def my_hook(d):
    if d['status'] == 'finished':
        print('Done downloading, now converting ...')


ydl_opts = {
    'format': 'bestaudio/best',
    'postprocessors': [{
        'key': 'FFmpegExtractAudio',
        'preferredcodec': 'mp3',
        'preferredquality': '192',
    }],
    'logger': MyLogger(),
    'progress_hooks': [my_hook],
}
with youtube_dl.YoutubeDL(ydl_opts) as ydl:
    ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
```

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

### Handle XAttrMetadataError

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/errors.md

Example of catching XAttrMetadataError when attempting to set extended file attributes during download.

```python
from youtube_dl.utils import XAttrMetadataError

try:
    ydl = YoutubeDL({'xattr_set_filesize': True})
    ydl.download([url])
except XAttrMetadataError:
    print("Filesystem doesn't support extended attributes")
```

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

### Initialize .netrc file permissions

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Commands to create a .netrc file and restrict access to the current user.

```bash
touch $HOME/.netrc
chmod a-rwx,u+rw $HOME/.netrc
```

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

### Clone repository and create branch

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Commands to set up a local development environment for a new extractor.

```bash
git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git
```

```bash
cd youtube-dl
git checkout -b yourextractor
```

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

### Use _search_regex for data extraction

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/InfoExtractor.md

Examples of extracting single and multiple fields from HTML content.

```python
ie = YoutubeIE()
html = ie._download_webpage(url, video_id)

# Extract video ID from page
video_id = ie._search_regex(r'"videoId":"([^"]+)"', html, 'video id')

# Extract multiple fields
matches = ie._search_regex(
    [r'<h1>([^<]+)</h1>', r'<title>([^<]+)</title>'],
    html, 'title')
```

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

### Get preferred encoding

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/utils.md

Retrieves the system's preferred character encoding, typically UTF-8.

```python
def preferredencoding()
```

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

### Simple Download

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Basic command to download a single video.

```bash
youtube-dl "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
```

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

### Execute Command-Line Operations

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/README.md

Common command-line patterns for downloading videos, selecting specific formats, extracting audio, and downloading playlists.

```bash
# Download single video
youtube-dl "https://www.youtube.com/watch?v=video_id"

# Download best MP4 format
youtube-dl -f best[ext=mp4] URL

# Extract MP3 audio
youtube-dl -x --audio-format mp3 URL

# Download playlist
youtube-dl "https://www.youtube.com/playlist?list=PLxxx"
```

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

### Sanitize Filename Usage

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/utils.md

Examples of sanitizing filenames for standard, restricted, and video ID use cases.

```python
from youtube_dl.utils import sanitize_filename

# Normal sanitization
name = sanitize_filename('Video: "Best of" 2023')
print(name)  # Output: 'Video Best of 2023'

# Restricted mode (Windows-safe)
name = sanitize_filename('Video:Best of 2023', restricted=True)
print(name)  # Output: 'VideoBestof2023'

# For video IDs (preserve characters)
id_str = sanitize_filename('dQw4w9WgXcQ', is_id=True)
print(id_str)  # Output: 'dQw4w9WgXcQ'
```

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

### Initialize a PostProcessor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Constructor for the PostProcessor class requiring a YoutubeDL instance.

```python
def __init__(self, downloader)
```

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

### Handle ContentTooShortError

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/errors.md

Example of catching ContentTooShortError when resuming downloads, accessing the downloaded and expected byte counts.

```python
from youtube_dl.utils import ContentTooShortError

try:
    ydl = YoutubeDL({'continuedl': True})  # Resume partial downloads
    ydl.download([url])
except ContentTooShortError as e:
    print(f"Incomplete download: got {e.downloaded} of {e.expected} bytes")
```

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

### Define Configuration File Options

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/README.md

Specify options in a configuration file with one option per line.

```text
--format best[ext=mp4]
--output %(title)s.%(ext)s
--no-color
--socket-timeout 30
```

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

### Initialize FileDownloader constructor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Constructor signature for the FileDownloader class.

```python
def __init__(self, ydl, params)
```

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

### Get bug report message

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/utils.md

Retrieves the standard message directing users to the GitHub issues page.

```python
def bug_reports_message()
```

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

### Define download method

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Method signature for the main download entry point.

```python
def download(self, filename, info_dict)
```

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

### Command-Line Help and Debugging

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/README.md

Essential commands for accessing built-in documentation and troubleshooting.

```bash
youtube-dl --help
```

```bash
youtube-dl --list-extractors
```

```bash
youtube-dl -v --dump-json URL
```

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

### Filter videos by date with DateRange

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/utils.md

Defines a start and end date range for filtering video uploads.

```python
class DateRange(object):
    """Represents a date range for filtering"""
```

```python
DateRange(start=None, end=None)
```

```python
from youtube_dl.utils import DateRange
import datetime

# Download videos from 2023
dr = DateRange(
    start=datetime.date(2023, 1, 1),
    end=datetime.date(2023, 12, 31)
)

ydl = YoutubeDL({'daterange': dr})
```

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

### Basic youtube-dl download in Python

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Initializes the YoutubeDL class with default options to download a video from a URL.

```python
from __future__ import unicode_literals
import youtube_dl

ydl_opts = {}
with youtube_dl.YoutubeDL(ydl_opts) as ydl:
    ydl.download(['https://www.youtube.com/watch?v=BaW_jenozKc'])
```

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

### Instantiate PostProcessor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Import the registry function to retrieve and instantiate a post-processor class with specific parameters.

```python
from youtube_dl.postprocessor import get_postprocessor

# Get postprocessor class
pp_class = get_postprocessor('FFmpegExtractAudio')

# Instantiate with parameters
pp = pp_class(ydl, preferredcodec='mp3', preferredquality='192')
```

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

### Initialize YoutubeDL Class

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Constructor for the YoutubeDL class, accepting a configuration dictionary and an auto-initialization flag.

```python
YoutubeDL(params=None, auto_init=True)
```

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

### Configuring PostProcessors

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Methods for adding and configuring PostProcessors in the YoutubeDL instance.

```APIDOC
## Configuring PostProcessors

### Description
PostProcessors can be configured via the 'postprocessors' parameter in the YoutubeDL options dictionary or by manually adding an instance using 'add_post_processor'.

### Configuration via Options
```python
ydl = YoutubeDL({
    'postprocessors': [
        {
            'key': 'FFmpegExtractAudio',
            'preferredcodec': 'mp3',
            'preferredquality': '192'
        }
    ]
})
```

### Manual Addition
```python
from youtube_dl.postprocessor import FFmpegExtractAudioPP
pp = FFmpegExtractAudioPP(ydl, preferredcodec='mp3')
ydl.add_post_processor(pp)
```
```

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

### Configuration File Management

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Commands to specify custom configuration locations or ignore system defaults.

```bash
youtube-dl --config-location PATH
youtube-dl --ignore-config
```

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

### Run tests

Source: https://github.com/ytdl-org/youtube-dl/blob/master/CONTRIBUTING.md

Execute the test suite for your new extractor.

```bash
python test/test_download.py TestDownload.test_YourExtractor
```

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

### Get Suitable Downloader Function Signature

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Defines the function signature for retrieving a downloader instance based on video information.

```python
def get_suitable_downloader(info_dict, params={})
```

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

### Select Video Format

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Specifies the video format code or selection expression for downloads.

```bash
youtube-dl -f FORMAT, --format FORMAT
```

```bash
# Best overall quality
youtube-dl -f best URL

# Best video + best audio
youtube-dl -f bestvideo+bestaudio/best URL

# Best MP4 format
youtube-dl -f best[ext=mp4] URL

# Best 720p or lower
youtube-dl -f "best[height<=720]" URL

# Fallback: try 1080p60, then 720p
youtube-dl -f "best[height=1080,fps=60]/best[height=720]" URL

# Audio only (extract audio with -x)
youtube-dl -f bestaudio URL

# Specific format
youtube-dl -f 18 URL  # YouTube standard definition

# All formats (for inspection)
youtube-dl -f all URL
```

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

### Execute post-processing with run

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

The primary method for executing post-processing logic on a downloaded file.

```python
def run(self, information)
```

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

### List Available Formats

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Lists all available formats for a URL without initiating a download.

```bash
youtube-dl -F, --list-formats
```

```bash
youtube-dl -F https://www.youtube.com/watch?v=video_id
```

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

### Configure YoutubeDL via Options Dictionary

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/README.md

Pass a dictionary of parameters to the YoutubeDL constructor to customize behavior.

```python
params = {
    'outtmpl': '%(title)s.%(ext)s',
    'format': 'best',
    'quiet': False,
    'socket_timeout': 30,
    'ratelimit': None,
    'postprocessors': [],
    'progress_hooks': [],
    # ... many more options
}
ydl = YoutubeDL(params)
```

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

### Authenticate with Adobe Pass

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Configure TV provider credentials for Adobe Pass authentication.

```bash
youtube-dl --ap-mso MSO_NAME
youtube-dl --ap-username USERNAME
youtube-dl --ap-password PASSWORD
youtube-dl --ap-list-mso
```

```bash
youtube-dl --ap-list-mso  # List available providers
youtube-dl --ap-mso Charter --ap-username user --ap-password pass URL
```

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

### Configure Proxy Settings

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Set HTTP or SOCKS5 proxies for general traffic or IP verification.

```bash
youtube-dl --proxy URL
youtube-dl --geo-verification-proxy URL
```

```bash
youtube-dl --proxy http://proxy.example.com:8080 URL
youtube-dl --proxy socks5://proxy.example.com:1080 URL
```

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

### Implement Programmatic Control with Hooks

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/README.md

Advanced usage involving progress hooks for monitoring download status and post-processors for audio conversion.

```python
from youtube_dl import YoutubeDL

def progress_hook(d):
    if d['status'] == 'downloading':
        print(f"Downloading: {d.get('_percent_str', 'N/A')}")
    elif d['status'] == 'finished':
        print(f"Download complete: {d['filename']}")

ydl = YoutubeDL({
    'format': 'best',
    'progress_hooks': [progress_hook],
    'postprocessors': [{
        'key': 'FFmpegExtractAudio',
        'preferredcodec': 'mp3',
        'preferredquality': '192',
    }]
})

ydl.download(['https://www.youtube.com/watch?v=video_id'])
```

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

### Enable .netrc in YoutubeDL

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Initialize the YoutubeDL instance with the usenetrc option set to True.

```python
ydl = YoutubeDL({'usenetrc': True})
```

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

### Execute youtube-dl as a developer

Source: https://github.com/ytdl-org/youtube-dl/blob/master/CONTRIBUTING.md

Run the youtube-dl module directly using the Python interpreter.

```bash
python -m youtube_dl
```

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

### Manage Thumbnails

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Download thumbnail images or list available thumbnail options.

```bash
youtube-dl --write-thumbnail
youtube-dl --write-all-thumbnails
youtube-dl --list-thumbnails
```

```bash
youtube-dl --write-thumbnail URL
youtube-dl --write-all-thumbnails URL
```

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

### Authenticate with Username and Password

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Use these flags to provide credentials for sites requiring login.

```bash
youtube-dl -u USERNAME, --username USERNAME
youtube-dl -p PASSWORD, --password PASSWORD
```

```bash
youtube-dl -u user@gmail.com -p mypassword URL
```

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

### Visualize youtube-dl module dependencies

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/module-index.md

A tree-based representation of the internal module relationships and dependencies.

```text
YoutubeDL
  ├── InfoExtractor (from extractor.*)
  ├── FileDownloader (from downloader)
  ├── PostProcessor (from postprocessor)
  ├── options (parseOpts)
  ├── utils (all utilities)
  ├── version
  ├── cache
  ├── jsinterp (for JS signatures)
  ├── aes (for encryption)
  └── compat (Python 2/3)

InfoExtractor
  ├── utils
  ├── jsinterp
  ├── aes
  ├── compat
  └── traversal

FileDownloader
  ├── utils
  └── compat

PostProcessor
  ├── utils
  └── compat
```

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

### YoutubeDL Constructor Parameters

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/types.md

A dictionary defining configuration options for the YoutubeDL constructor, including format, filtering, authentication, and post-processing settings.

```python
{
    # Format and output
    'format': 'best',                 # Format selection
    'outtmpl': str,                   # Output template
    
    # Filtering
    'playliststart': int,
    'playlistend': int,
    'matchtitle': str or None,
    'rejecttitle': str or None,
    'min_views': int or None,
    'max_views': int or None,
    
    # Authentication
    'username': str or None,
    'password': str or None,
    'usenetrc': bool,
    
    # Network
    'proxy': str or None,
    'socket_timeout': int,
    'nocheckcertificate': bool,
    'cookiefile': str or None,
    
    # Download options
    'quiet': bool,
    'verbose': bool,
    'noprogress': bool,
    'ratelimit': int or None,
    'max_downloads': int or None,
    
    # Post-processing
    'postprocessors': list,           # List of {key, ...} dicts
    'progress_hooks': list,           # List of callables
    
    # ... many more options
}
```

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

### Recompile the executable

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Rebuild the youtube-dl executable from the source repository.

```bash
make youtube-dl
```

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

### Save Metadata Files

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Export video metadata, descriptions, or annotations to local files.

```bash
youtube-dl --write-info-json
youtube-dl --write-description
youtube-dl --write-annotations
```

```bash
youtube-dl --write-info-json URL    # Save video.info.json
youtube-dl --write-description URL  # Save video.description
```

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

### YoutubeDL Constructor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Initializes a new instance of the YoutubeDL class with optional configuration parameters.

```APIDOC
## YoutubeDL(params=None, auto_init=True)

### Description
Initializes the primary controller for video extraction and downloading.

### Parameters
- **params** (dict) - Optional - Configuration options dictionary. Default: {}
- **auto_init** (bool) - Optional - Whether to automatically initialize default extractors and print debug header. Default: True

### Returns
- **YoutubeDL** (instance) - A new YoutubeDL instance.
```

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

### Download new videos from a playlist

Source: https://github.com/ytdl-org/youtube-dl/blob/master/README.md

Use the --download-archive flag to track previously downloaded videos and skip them in future runs.

```bash
youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
youtube-dl --download-archive archive.txt "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"
```

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

### Configure Subtitle Options

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Specify target languages and file formats for subtitle downloads.

```bash
youtube-dl --sub-lang LANGUAGES
youtube-dl --sub-format FORMAT
```

```bash
youtube-dl --write-sub --sub-lang en,es --sub-format srt URL
```

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

### prepare_filename

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Generates an output filename based on the provided info dictionary and the configured outtmpl parameter.

```APIDOC
## prepare_filename(info_dict)

### Description
Generates the output filename based on the info dict and outtmpl parameter. Expands template variables like %(title)s, %(id)s, etc.

### Parameters
- **info_dict** (dict) - Required - Info dict from extractor with video metadata

### Returns
- **str** - Sanitized output filename (or None on error)
```

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

### Manually Add PostProcessor

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Instantiate a specific post-processor class and add it to the YoutubeDL instance manually.

```python
from youtube_dl.postprocessor import FFmpegExtractAudioPP

ydl = YoutubeDL({'quiet': False})
pp = FFmpegExtractAudioPP(ydl, preferredcodec='mp3')
ydl.add_post_processor(pp)
```

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

### YouTube-Specific Options

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Options for listing formats, dumping metadata, and managing watch status on YouTube.

```bash
youtube-dl -m, --list-formats
youtube-dl -j, --dump-json
youtube-dl --no-mark-watched
youtube-dl --mark-watched
youtube-dl --youtube-skip-dash-manifest
```

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

### Run youtube-dl with verbose output

Source: https://github.com/ytdl-org/youtube-dl/blob/master/CONTRIBUTING.md

Use the -v flag to generate detailed debugging information for issue reports.

```bash
$ youtube-dl -v <your command line>
[debug] System config: []
[debug] User config: []
[debug] Command-line args: [u'-v', u'https://www.youtube.com/watch?v=BaW_jenozKcj']
[debug] Encodings: locale cp1251, fs mbcs, out cp866, pref cp1251
[debug] youtube-dl version 2015.12.06
[debug] Git HEAD: 135392e
[debug] Python version 2.6.6 - Windows-2003Server-5.2.3790-SP2
[debug] exe versions: ffmpeg N-75573-g1d0487f, ffprobe N-75573-g1d0487f, rtmpdump 2.4
[debug] Proxy map: {}
...
```

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

### Clone the repository

Source: https://github.com/ytdl-org/youtube-dl/blob/master/CONTRIBUTING.md

Use this command to clone your fork of the youtube-dl repository.

```bash
git clone git@github.com:YOUR_GITHUB_USERNAME/youtube-dl.git
```

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

### YoutubeDL Constructor Parameters

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

The YoutubeDL class accepts a dictionary of options. Below are the available configuration keys for video extraction and output management.

```APIDOC
## YoutubeDL Configuration

### Description
Configuration options passed to the `YoutubeDL` constructor to control extraction logic and file output.

### Parameters

#### Video Extraction Options
- **force_generic_extractor** (bool) - Optional - Use generic extractor instead of site-specific ones.
- **default_search** (str) - Optional - Search provider (e.g., 'auto', 'youtube', 'gvsearch').
- **extract_flat** (bool/str) - Optional - Don't resolve playlist items.
- **age_limit** (int) - Optional - Skip videos with age rating above this limit.
- **playlist_items** (str) - Optional - Comma-separated video indices to download.
- **playliststart** (int) - Optional - Index of first playlist item to download.
- **playlistend** (int) - Optional - Index of last playlist item to download.
- **playlist_reverse** (bool) - Optional - Download playlist items in reverse order.
- **playlistrandom** (bool) - Optional - Download playlist items in random order.
- **noplaylist** (bool) - Optional - Download only single video, not entire playlist.
- **flat_playlist** (bool) - Optional - Only list videos in playlist, don't extract.

#### Output Template Options
- **outtmpl** (str) - Optional - Output filename template (e.g., '%(title)s.%(ext)s').
- **outtmpl_na_placeholder** (str) - Optional - Placeholder for unavailable metadata fields.
- **restrictfilenames** (bool) - Optional - Remove unsafe characters from filenames.
- **noupdate** (bool) - Optional - Don't update filename with actual info after download.
- **nooverwrites** (bool) - Optional - Don't overwrite existing files.
- **quiet** (bool) - Optional - Don't print anything to stdout.
- **verbose** (bool) - Optional - Print additional debug info.
- **no_color** (bool) - Optional - Disable colored output.
- **no_warnings** (bool) - Optional - Suppress warning messages.
```

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

### Download Playlist

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Download a playlist with a custom output filename template.

```bash
youtube-dl -o "%(playlist_index)03d - %(title)s.%(ext)s" \
  "https://www.youtube.com/playlist?list=PLxxx"
```

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

### FFmpeg Configuration Options

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Flags for specifying FFmpeg location and passing custom arguments to post-processors.

```bash
youtube-dl --ffmpeg-location PATH
youtube-dl --prefer-avconv
youtube-dl --postprocessor-args ARGS
```

```bash
youtube-dl --ffmpeg-location /usr/bin/ffmpeg URL
youtube-dl --postprocessor-args "-preset slower" URL
```

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

### download(filename, info_dict)

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Downloads a file from the URL specified in the info_dict. This is the main entry point for initiating a download.

```APIDOC
## download(filename, info_dict)

### Description
Downloads a file from the URL specified in info_dict. This is the main entry point for downloading.

### Parameters
- **filename** (str) - Required - Output filename path
- **info_dict** (dict) - Required - Info dict with 'url' and format information

### Returns
- **bool** - True if download succeeded, False if failed
```

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

### Configure PostProcessors via YoutubeDL

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/PostProcessor.md

Define post-processors directly within the YoutubeDL configuration dictionary.

```python
ydl = YoutubeDL({
    'postprocessors': [
        {
            'key': 'FFmpegExtractAudio',
            'preferredcodec': 'mp3',
            'preferredquality': '192'
        },
        {
            'key': 'FFmpegMetadata'
        }
    ]
})
```

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

### Configure External Downloaders

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/configuration.md

Integrate external tools like aria2c, curl, or ffmpeg by specifying the downloader name and optional command-line arguments.

```python
# Use aria2c (faster parallel downloads)
ydl = YoutubeDL({
    'external_downloader': 'aria2c',
    'external_downloader_args': '-x 4 -k 1M'  # 4 connections, 1MB chunks
})

# Use curl
ydl = YoutubeDL({
    'external_downloader': 'curl'
})

# Use FFmpeg for advanced codec support
ydl = YoutubeDL({
    'external_downloader': 'ffmpeg'
})
```

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

### Title Matching Filters

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Flags to filter downloads based on regex patterns in the video title.

```bash
youtube-dl --match-title REGEX
youtube-dl --reject-title REGEX
```

```bash
youtube-dl --match-title "official" URL
youtube-dl --reject-title "cover|remix" URL
```

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

### Define report_progress method

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/FileDownloader.md

Method signature for reporting download progress.

```python
def report_progress(self, progress_dict)
```

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

### Configure SSL/TLS Security

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Adjust certificate verification settings for network connections.

```bash
youtube-dl --no-check-certificate
youtube-dl --prefer-insecure
```

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

### Download Execution Flow

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/module-index.md

Represents the file downloading process, including protocol selection and progress reporting.

```text
YoutubeDL.extract_info()
  → For each format in info_dict['formats']:
    → get_suitable_downloader(info_dict)
      → Select FileDownloader subclass based on protocol
    → FileDownloader.download(filename, info_dict)
      → HTTP request for file
      → Write to disk
      → Call progress hooks
```

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

### Extracting video and playlist information

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/YoutubeDL.md

Demonstrates how to initialize YoutubeDL and extract metadata for both single videos and playlists without downloading the actual files.

```python
ydl = YoutubeDL({'quiet': False, 'simulate': True})  # Don't actually download

# Extract single video info
info = ydl.extract_info('https://www.youtube.com/watch?v=dQw4w9WgXcQ', download=False)
print(info['title'])
print(info['formats'])

# Extract playlist
info = ydl.extract_info('https://www.youtube.com/playlist?list=PLxxx', download=False)
# info is now a list of info dicts
for entry in info:
    print(entry['title'])
```

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

### Audio Extraction via Postprocessors

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/INDEX.md

Configure postprocessors to convert downloaded media to specific audio formats.

```python
from youtube_dl import YoutubeDL

ydl = YoutubeDL({
    'format': 'bestaudio/best',
    'postprocessors': [{
        'key': 'FFmpegExtractAudio',
        'preferredcodec': 'mp3',
        'preferredquality': '192',
    }]
})

ydl.download(['https://www.youtube.com/watch?v=video_id'])
```

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

### Download with Subtitles

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/command-line-interface.md

Download a video along with English subtitles.

```bash
youtube-dl --write-sub --sub-lang en \
  "https://www.youtube.com/watch?v=video_id"
```

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

### Expand file paths with expand_path

Source: https://github.com/ytdl-org/youtube-dl/blob/master/_autodocs/api-reference/utils.md

Resolves environment variables and user home directory shortcuts in a path string.

```python
def expand_path(path)
```

```python
from youtube_dl.utils import expand_path

path = expand_path('~/Downloads/youtube-dl')
print(path)  # Output: '/home/user/Downloads/youtube-dl'

path = expand_path('$HOME/Videos')
print(path)  # Output: '/home/user/Videos'
```
Tokens:
Raw