yt-dlp - 追加の機能と修正を含むyoutube-dlフォーク

(A youtube-dl fork with additional features and fixes)

Created at: 2020-10-26 12:22:55
Language: Python
License: Unlicense

YT-DLP

リリースバージョン パイパイ 寄付する 行列 不和 サポートされているサイト ライセンス: ライセンス解除 CI ステータス コミット 最後のコミット

yt-dlp は、現在非アクティブな youtube-dlc に基づく youtube-dl フォークです。このプロジェクトの主な焦点は、元のプロジェクトを最新の状態に保ちながら、新しい機能とパッチを追加することです

新機能

  • youtube-dl v2021.12.17+ commit/ed5c44e と youtube-dlc v2020.11.11-3+ commit/f9401f2 とマージ: 最新の youtube-dl に加えて、youtube-dlc のすべての機能とパッチを利用できます。

  • スポンサーブロック統合:スポンサーブロックAPIを利用して、YouTube動画のスポンサーセクションをマーク/削除できます

  • フォーマットソート: デフォルトのフォーマットソートオプションが変更され、単に大きなビットレートを使用するのではなく、より高い解像度とより良いコーデックが好まれるようになりました。さらに、 を使用して並べ替え順序を指定できるようになりました。これにより、単に(

    -S
    --format
    )

  • animelover1984/youtube-dlとマージ:あなたは、 、、 mp4 / ogg / opus、プレイリストinfojsonなどにサムネイルを埋め込むなど、 animelover1984 / youtube-dlからほとんどの機能と改善点を得ます。ニコニコのライブストリームはご利用いただけませんのでご注意ください。詳細については、#31を参照してください。

    --write-comments
    BiliBiliSearch
    BilibiliChannel

  • ユーチューブの改善:

    • クリップ、ストーリーズ()、検索(フィルターを含む)*、YouTube ミュージック検索、チャンネル固有の検索、検索プレフィックス (, )*、ミックス、YouTube ミュージック アルバム/チャンネル(自己アップロードした音楽を除く)、フィード(、、、
      ytstories:<channel UCID>
      ytsearch:
      ytsearchdate:
      :ytfav
      :ytwatchlater
      :ytsubs
      :ythistory
      :ytrec
      :ytnotif
      )
    • n-sigベースの調整の修正 *
    • クッキーなしで一部の(すべてではない)年齢制限付きコンテンツをサポート
    • ライブストリームを最初からダウンロードする(実験的)
      --live-from-start
      )
    • 255kbps
      プレミアムクッキーが提供されると、YouTubeミュージックからオーディオが抽出されます(利用可能な場合)。
    • チャンネルのホームURLを自動的にリダイレクトして、古い動作を維持する
      /video
  • ブラウザからのクッキー:クッキーは、すべての主要なウェブブラウザから自動的に抽出することができます。

    --cookies-from-browser BROWSER[+KEYRING][:PROFILE]

  • ダウンロード時間範囲:ビデオは、タイムスタンプまたはチャプターのいずれかに基づいて部分的にダウンロードできます。

    --download-sections

  • チャプターでビデオを分割する: チャプターに基づいてビデオを複数のファイルに分割できます。

    --split-chapters

  • マルチスレッドフラグメントのダウンロード:m3u8 / mpdビデオの複数のフラグメントを並行してダウンロードします。() オプションを使用して、使用するスレッドの数を設定します。

    --concurrent-fragments
    -N

  • HLS/DASH を搭載した Aria2c : DASH(mpd) および HLS(m3u8) 形式の外部ダウンローダーとして使用できます。

    aria2c

  • 新規および固定エクストラクター: 多くの新規エクストラクターが追加され、多くの既存のエクストラクターが修正されました。変更履歴またはサポートされているサイトのリストを参照してください。

  • 新しいMSO:フィロ、スペクトラム、スリングTV、ケーブルビジョン、RCNなど

  • マニフェストからの字幕抽出: ストリーミングメディアマニフェストから字幕を抽出できます。詳細は commit/be6202f を参照してください。

  • 複数のパスと出力テンプレート: 異なる種類のファイルの異なる出力テンプレートとダウンロード パスを指定できます。また、中間ファイルがダウンロードされる一時パスを設定することもできます

    --paths
    (
    -P
    )

  • 移植可能な構成: 構成ファイルは、ホーム・ディレクトリーおよびルート・ディレクトリーから自動的にロードされます。詳細については、「構成」を参照してください。

  • 出力テンプレートの改善:出力テンプレートは、日時の書式設定、数値オフセット、オブジェクトトラバーサルなどを持つことができるようになりました。詳細については、出力テンプレートを参照してください。さらに高度な操作は、

    --parse-metadata
    --replace-in-metadata

  • その他の新しいオプション: 、 、 、 など、多くの新しいオプションが追加されました

    --alias
    --print
    --concat-playlist
    --wait-for-video
    --retry-sleep
    --sleep-requests
    --convert-thumbnails
    --force-download-archive
    --force-overwrites
    --break-on-reject

  • 改善点:正規表現と/の他の演算子、複数および、より高速なアーカイブチェック、より多くのフォーマット選択オプション、マルチビデオ/オーディオのマージ、複数の、異なる段階でのマージなど

    --format
    --match-filter
    --postprocessor-args
    --downloader-args
    --config-locations
    --exec

  • プラグイン: エクストラクタとポストプロセッサは、外部ファイルからロードできます。詳細については、プラグインを参照してください。

  • セルフアップデーター: リリースは、

    yt-dlp -U

変更の完全なリストについては変更履歴またはコミットを参照してください。

* が付いた機能は youtube-dl にバックポートされています

既定の動作の違い

yt-dlp のデフォルトオプションのいくつかは、youtube-dl や youtube-dlc のデフォルトオプションとは異なります。

  • オプション ()、() および () は機能しなくなりました。詳細については、削除されたオプションを参照してください。
    --auto-number
    -A
    --title
    -t
    --literal
    -l
  • avconv
    の代替手段としてはサポートされていません
    ffmpeg
  • yt-dlp は設定ファイルを youtube-dl とはわずかに異なる場所に保存します。正しい場所のリストについては、CONFIGURATION を参照してください。
  • デフォルトの出力テンプレートは です。この変更の本当の理由はありません。これは yt-dlp が公開される前に変更されており、現在は に戻す予定はありません。代わりに、
    %(title)s [%(id)s].%(ext)s
    %(title)s-%(id)s.%(ext)s
    --compat-options filename
  • デフォルトのフォーマットソートはyoutube-dlとは異なり、より高いビットレートよりも高解像度とより良いコーデックを好みます。このオプションを使用して、これを任意の順序に変更したり、youtube-dl の並べ替え順序を使用したりすることができます。
    --format-sort
    --compat-options format-sort
  • デフォルトのフォーマットセレクタは です。つまり、最適なビデオのみの形式よりも優れたビデオ+オーディオの組み合わせ形式が見つかった場合、前者が優先されます。これを使用するか、またはこれを元に戻します
    bv*+ba/b
    -f bv+ba/b
    --compat-options format-spec
  • youtube-dlc とは異なり、yt-dlp ではデフォルトで複数のオーディオ/ビデオストリームを 1 つのファイルにマージすることはできません (これは の使用と競合するため)。必要に応じて、この機能は と を使用して有効にする必要があります。両方を有効にして使用することもできます
    -f bv*+ba
    --audio-multistreams
    --video-multistreams
    --compat-options multistreams
  • --no-abort-on-error
    はデフォルトで有効になっています。代わりにエラー時に中止するかを使用する
    --abort-on-error
    --compat-options abort-on-error
  • サムネイル、説明、infojsonなどのメタデータファイルを書き込む場合、プレイリストにも同じ情報(利用可能な場合)が書き込まれます。これらのファイルを使用する、または書き込まないようにする
    --no-write-playlist-metafiles
    --compat-options no-playlist-metafiles
  • --add-metadata
    で使用した場合、メタデータの書き込みに加えて、 をファイルにアタッチします。これを使用するか、またはこれを元に戻します
    infojson
    mkv
    --write-info-json
    --no-embed-info-json
    --compat-options no-attach-info-json
  • 一部のメタデータは、youtube-dlと比較して、使用時に異なるフィールドに埋め込まれています。最も顕著なのは、フィールドには と が含まれ、.--parse-metadata を使用してこれを好みに合わせて変更したり、これを元に戻すために使用したりできます。
    --add-metadata
    comment
    webpage_url
    synopsis
    description
    --compat-options embed-metadata
  • playlist_index
    や のようなオプションと一緒に使用すると、動作が異なります。詳細については、#302を参照してください。以前の動作を維持したい場合に使用できます
    --playlist-reverse
    --playlist-items
    --compat-options playlist-index
  • の出力が新しい形式でリストされます。これを元に戻すために使用します
    -F
    --compat-options list-formats
  • ライブチャット(利用可能な場合)は字幕と見なされます。ライブチャットを除くすべての字幕をダウンロードするために使用します。また、ライブチャット/danmakがダウンロードされないようにすることもできます
    --sub-langs all,-live_chat
    --compat-options no-live-chat
  • YouTube チャンネルの URL は自動的に にリダイレクトされます。URL に a を追加すると、ホーム ページ内のビデオのみがダウンロードされます。チャンネルに [動画] タブがない場合は、代わりに同等の再生リストをダウンロードしようとします。他のすべてのタブでは、チャネルに要求されたタブが表示されない場合、エラーが発生します。また、チャンネル全体を静かにダウンロードするのではなく、ライブ動画がない場合、URLはエラーを発生させます。これらすべてのリダイレクトを元に戻すために使用できます
    /video
    /featured
    UU
    /live
    --compat-options no-youtube-channel-redirect
  • 利用できない動画は、YouTubeプレイリストにも表示されます。これを削除するために使用します
    --compat-options no-youtube-unavailable-videos
  • YouTube から抽出されたアップロード日は、利用可能な場合は UTC です。UTC 以外のアップロード日を優先する場合に使用します。
    --compat-options no-youtube-prefer-utc-upload-date
  • がダウンローダーとして使用される場合、フォーマットのダウンロードとマージは、可能な場合は 1 つのステップで行われます。これを元に戻すために使用します
    ffmpeg
    --compat-options no-direct-merge
  • サムネイルの埋め込みは、可能であれば変異原で行われます。代わりにアトミックパセリの使用を強制するために使用する
    mp4
    --compat-options embed-thumbnail-atomicparsley
  • ファイル名などの一部のプライベートフィールドは、デフォルトで infojson から削除されます。これを使用するか、またはこれを元に戻します
    --no-clean-infojson
    --compat-options no-clean-infojson
  • 一緒に使用すると、字幕はディスクに書き込まれ、メディアファイルに埋め込まれます。サブを埋め込み、別のファイルを自動的に削除するためだけに使用できます。詳細は #630 (コメント) を参照してください。 これを元に戻すために使用できます
    --embed-subs
    --write-subs
    --embed-subs
    --compat-options no-keep-subs
  • certifi
    がインストールされている場合は、SSL ルート証明書に使用されます。システム証明書(自己署名など)を使用する場合は、
    --compat-options no-certifi
  • yt-dlpのファイル名の無効な文字のサニタイズ化は、youtube-dlとは異なる/スマートです。あなたはyoutube-dlの動作に戻すために使用することができます
    --compat-options filename-sanitization

使いやすさのために、さらにいくつかの互換性オプションが利用可能です:

  • --compat-options all
    : すべての互換オプションを使用する (使用しないでください)
  • --compat-options youtube-dl
    : 同じ
    --compat-options all,-multistreams
  • --compat-options youtube-dlc
    : 同じ
    --compat-options all,-no-live-chat,-no-youtube-channel-redirect

取り付け

ウィンドウズ ユニックス マックOS パイパイ ソース ターボール その他の亜種 すべてのバージョン

yt-dlp は、バイナリPIP またはサードパーティのパッケージマネージャを使用してインストールできます。詳細な手順については、Wiki を参照してください。

更新

リリースバイナリを使用している場合は、更新に使用できます

yt-dlp -U

PIPを使用してインストールした場合は、プログラムのインストールに使用したのと同じコマンドを再実行するだけです

他のサードパーティのパッケージマネージャについては、wikiを参照するか、そのドキュメントを参照してください。

ファイルのリリース

推奨

ファイル 説明: __________
yt-dlp プラットフォームに依存しないzipimportバイナリ。Needs Python (Linux / BSD に推奨))
yt-dlp.exe ウィンドウズ (Win7 SP1+) スタンドアロン x64 バイナリ (ウィンドウズに推奨))
yt-dlp_macos ユニバーサル MacOS (10.15 以降) スタンドアロン実行可能ファイル (MacOS に推奨))

選択肢

ファイル 説明: __________
yt-dlp_x86.exe ウィンドウズ (ビスタ SP2+) スタンドアロン x86 (32 ビット) バイナリ
yt-dlp_min.exe ウィンドウズ (Win7 SP1+) スタンドアロンのx64バイナリで
構築 (非推奨
py2exe
)
yt-dlp_linux Linux スタンドアロン x64 バイナリ
yt-dlp_linux.zip パッケージ化されていないLinux実行可能ファイル(自動更新なし)
yt-dlp_win.zip パッケージ化されていない Windows 実行可能ファイル (自動更新なし)
yt-dlp_macos.zip パッケージ化されていない MacOS (10.15 以降) 実行可能ファイル (自動更新なし)
yt-dlp_macos_legacy MacOS (10.9 以降) スタンドアロン x64 実行可能ファイル

雑貨

ファイル 説明: __________
yt-dlp.tar.gz ソースタールボール
SHA2-512サム GNU スタイルの SHA512 合計
SHA2-256サム GNU スタイルの SHA256 合計

注意: マニュアルページ、シェル補完ファイルなどはソースの tarball で利用できます。

依存 関係

Python バージョン 3.7 以降 (CPython と PyPy) がサポートされています。他のバージョンや実装は、正しく動作する場合と動作しない場合があります。

他のすべての依存関係はオプションであり、強くお勧めしますが

ffmpeg
ffprobe

強くお勧めします

ネットワーキング

  • certifi* - Mozilla のルート証明書バンドルを提供します。MPLv2 でライセンスされています。
  • brotli* または brotlicffi - Brotli コンテンツエンコーディングのサポート。どちらもMIT 1 2の下でライセンスされています
  • ウェブソケット* - ウェブソケット経由でダウンロードする場合。BSD-3-Clauseの下でライセンスされています

メタデータ

雑貨

  • pycryptodomex* - AES-128 HLSストリームやその他のさまざまなデータを復号化するため。BSD-2-条項の下でライセンスされています
  • phantomjs - javascript を実行する必要があるエクストラクタで使用されます。BSD-3-Clauseの下でライセンスされています
  • secretstorage - Linux上でChromiumベースのブラウザのクッキーを復号化しながらGnomeキーリングにアクセスするためのものです。BSD-3-Clauseの下でライセンスされています
    --cookies-from-browser
  • 使用する外部ダウンローダー
    --downloader

廃止

依存関係を使用または再配布するには、それぞれのライセンス条項に同意する必要があります。

スタンドアロンのリリースバイナリは、Python インタプリタと * でマークされたパッケージでビルドされます。

試行しているタスクに必要な依存関係がない場合、yt-dlp は警告を表示します。現在利用可能なすべての依存関係が出力の上部に表示されます。

--verbose

コンパイル

スタンドアロンのPyInstallerビルド

スタンドアロンの実行可能ファイルをビルドするには、Python と (および必要に応じて yt-dlp のオプションの依存関係のいずれか) が必要です。必要な依存関係がすべてインストールされたら、 を実行するだけです。実行可能ファイルは、Python が使用するのと同じアーキテクチャ (x86/ARM、32/64 ビット) 用にビルドされます。

pyinstaller
pyinst.py

python3 -m pip install -U pyinstaller -r requirements.txt
python3 devscripts/make_lazy_extractors.py
python3 pyinst.py

一部のシステムでは、 の代わりに or を使用する必要があります。

py
python
python3

4.4 より前のバージョンの pyinstaller は、仮想環境を使用せずに Windows ストアからインストールされた Python をサポートしていないことに注意してください。

重要: 使用せずに直接実行することは、正式にはサポートされていません。これは正しく動作する場合と動作しない場合があります。

pyinstaller
pyinst.py

プラットフォームに依存しないバイナリ (UNIX)

ビルドツール (3.7+), , (GNU), * と * が必要になります。

python
zip
make
pandoc
pytest

これらをインストールしたら、単に を実行します。

make

代わりに実行して、追加のファイルを更新せずにバイナリのみをコンパイルすることもできます。(*でマークされたビルドツールはこれには必要ありません)

make yt-dlp

スタンドアロン Py2Exe ビルド (ウィンドウズ)

py2exeでビルドするオプションを提供していますが、py2exeビルドにはpycryptodomex / certifiを含めることができず、実行するにはターゲットコンピュータ上のVC ++ 14が必要なため、代わりにPyInstallerを使用してビルドすることをお勧めします。

とにかくビルドしたい場合は、Pythonとpy2exeをインストールしてから、単に実行してください

setup.py py2exe

py -m pip install -U py2exe -r requirements.txt
py devscripts/make_lazy_extractors.py
py setup.py py2exe

関連スクリプト

  • devscripts/update-version.py [revision] - 現在の日付に基づいてバージョン番号を更新する
  • devscripts/set-variant.py variant [-M update_message] - 実行可能ファイルのビルドバリアントを設定する
  • devscripts/make_lazy_extractors.py - 怠惰な抽出器を作成します。バイナリ(任意のバリアント)をビルドする前にこれを実行すると、起動時のパフォーマンスが向上します。遅延抽出器の読み込みを強制的に無効にする場合は、環境変数を設定します。
    YTDLP_NO_LAZY_EXTRACTORS=1

githubでプロジェクトをフォークし、フォークのビルドワークフローを実行してフルリリースを自動的にビルドすることもできます

使用法とオプション

yt-dlp [OPTIONS] [--] URL [URL...]

Ctrl+F
あなたの友人:D

一般オプション:

-h, --help                      Print this help text and exit
--version                       Print program version and exit
-U, --update                    Update this program to the latest version
--no-update                     Do not check for updates (default)
-i, --ignore-errors             Ignore download and postprocessing errors.
                                The download will be considered successful
                                even if the postprocessing fails
--no-abort-on-error             Continue with next video on download errors;
                                e.g. to skip unavailable videos in a
                                playlist (default)
--abort-on-error                Abort downloading of further videos if an
                                error occurs (Alias: --no-ignore-errors)
--dump-user-agent               Display the current user-agent and exit
--list-extractors               List all supported extractors and exit
--extractor-descriptions        Output descriptions of all supported
                                extractors and exit
--use-extractors NAMES          Extractor names to use separated by commas.
                                You can also use regexes, "all", "default"
                                and "end" (end URL matching); e.g. --ies
                                "holodex.*,end,youtube". Prefix the name
                                with a "-" to exclude it, e.g. --ies
                                default,-generic. Use --list-extractors for
                                a list of extractor names. (Alias: --ies)
--default-search PREFIX         Use this prefix for unqualified URLs. E.g.
                                "gvsearch2:python" downloads two videos from
                                google videos for the search term "python".
                                Use the value "auto" to let yt-dlp guess
                                ("auto_warning" to emit a warning when
                                guessing). "error" just throws an error. The
                                default value "fixup_error" repairs broken
                                URLs, but emits an error if this is not
                                possible instead of searching
--ignore-config                 Don't load any more configuration files
                                except those given by --config-locations.
                                For backward compatibility, if this option
                                is found inside the system configuration
                                file, the user configuration is not loaded.
                                (Alias: --no-config)
--no-config-locations           Do not load any custom configuration files
                                (default). When given inside a configuration
                                file, ignore all previous --config-locations
                                defined in the current file
--config-locations PATH         Location of the main configuration file;
                                either the path to the config or its
                                containing directory ("-" for stdin). Can be
                                used multiple times and inside other
                                configuration files
--flat-playlist                 Do not extract the videos of a playlist,
                                only list them
--no-flat-playlist              Extract the videos of a playlist
--live-from-start               Download livestreams from the start.
                                Currently only supported for YouTube
                                (Experimental)
--no-live-from-start            Download livestreams from the current time
                                (default)
--wait-for-video MIN[-MAX]      Wait for scheduled streams to become
                                available. Pass the minimum number of
                                seconds (or range) to wait between retries
--no-wait-for-video             Do not wait for scheduled streams (default)
--mark-watched                  Mark videos watched (even with --simulate)
--no-mark-watched               Do not mark videos watched (default)
--no-colors                     Do not emit color codes in output (Alias:
                                --no-colours)
--compat-options OPTS           Options that can help keep compatibility
                                with youtube-dl or youtube-dlc
                                configurations by reverting some of the
                                changes made in yt-dlp. See "Differences in
                                default behavior" for details
--alias ALIASES OPTIONS         Create aliases for an option string. Unless
                                an alias starts with a dash "-", it is
                                prefixed with "--". Arguments are parsed
                                according to the Python string formatting
                                mini-language. E.g. --alias get-audio,-X
                                "-S=aext:{0},abr -x --audio-format {0}"
                                creates options "--get-audio" and "-X" that
                                takes an argument (ARG0) and expands to
                                "-S=aext:ARG0,abr -x --audio-format ARG0".
                                All defined aliases are listed in the --help
                                output. Alias options can trigger more
                                aliases; so be careful to avoid defining
                                recursive options. As a safety measure, each
                                alias may be triggered a maximum of 100
                                times. This option can be used multiple times

ネットワークオプション:

--proxy URL                     Use the specified HTTP/HTTPS/SOCKS proxy. To
                                enable SOCKS proxy, specify a proper scheme,
                                e.g. socks5://user:pass@127.0.0.1:1080/.
                                Pass in an empty string (--proxy "") for
                                direct connection
--socket-timeout SECONDS        Time to wait before giving up, in seconds
--source-address IP             Client-side IP address to bind to
-4, --force-ipv4                Make all connections via IPv4
-6, --force-ipv6                Make all connections via IPv6

地理的制限:

--geo-verification-proxy URL    Use this proxy to verify the IP address for
                                some geo-restricted sites. The default proxy
                                specified by --proxy (or none, if the option
                                is not present) is used for the actual
                                downloading
--geo-bypass                    Bypass geographic restriction via faking
                                X-Forwarded-For HTTP header (default)
--no-geo-bypass                 Do not bypass geographic restriction via
                                faking X-Forwarded-For HTTP header
--geo-bypass-country CODE       Force bypass geographic restriction with
                                explicitly provided two-letter ISO 3166-2
                                country code
--geo-bypass-ip-block IP_BLOCK  Force bypass geographic restriction with
                                explicitly provided IP block in CIDR notation

ビデオの選択:

-I, --playlist-items ITEM_SPEC  Comma separated playlist_index of the videos
                                to download. You can specify a range using
                                "[START]:[STOP][:STEP]". For backward
                                compatibility, START-STOP is also supported.
                                Use negative indices to count from the right
                                and negative STEP to download in reverse
                                order. E.g. "-I 1:3,7,-5::2" used on a
                                playlist of size 15 will download the videos
                                at index 1,2,3,7,11,13,15
--min-filesize SIZE             Do not download any videos smaller than
                                SIZE, e.g. 50k or 44.6M
--max-filesize SIZE             Do not download any videos larger than SIZE,
                                e.g. 50k or 44.6M
--date DATE                     Download only videos uploaded on this date.
                                The date can be "YYYYMMDD" or in the format 
                                [now|today|yesterday][-N[day|week|month|year]].
                                E.g. --date today-2weeks
--datebefore DATE               Download only videos uploaded on or before
                                this date. The date formats accepted is the
                                same as --date
--dateafter DATE                Download only videos uploaded on or after
                                this date. The date formats accepted is the
                                same as --date
--match-filters FILTER          Generic video filter. Any "OUTPUT TEMPLATE"
                                field can be compared with a number or a
                                string using the operators defined in
                                "Filtering Formats". You can also simply
                                specify a field to match if the field is
                                present, use "!field" to check if the field
                                is not present, and "&" to check multiple
                                conditions. Use a "\" to escape "&" or
                                quotes if needed. If used multiple times,
                                the filter matches if atleast one of the
                                conditions are met. E.g. --match-filter
                                !is_live --match-filter "like_count>?100 &
                                description~='(?i)\bcats \& dogs\b'" matches
                                only videos that are not live OR those that
                                have a like count more than 100 (or the like
                                field is not available) and also has a
                                description that contains the phrase "cats &
                                dogs" (caseless). Use "--match-filter -" to
                                interactively ask whether to download each
                                video
--no-match-filter               Do not use generic video filter (default)
--no-playlist                   Download only the video, if the URL refers
                                to a video and a playlist
--yes-playlist                  Download the playlist, if the URL refers to
                                a video and a playlist
--age-limit YEARS               Download only videos suitable for the given
                                age
--download-archive FILE         Download only videos not listed in the
                                archive file. Record the IDs of all
                                downloaded videos in it
--no-download-archive           Do not use archive file (default)
--max-downloads NUMBER          Abort after downloading NUMBER files
--break-on-existing             Stop the download process when encountering
                                a file that is in the archive
--break-on-reject               Stop the download process when encountering
                                a file that has been filtered out
--break-per-input               --break-on-existing, --break-on-reject,
                                --max-downloads, and autonumber resets per
                                input URL
--no-break-per-input            --break-on-existing and similar options
                                terminates the entire download queue
--skip-playlist-after-errors N  Number of allowed failures until the rest of
                                the playlist is skipped

ダウンロードオプション:

-N, --concurrent-fragments N    Number of fragments of a dash/hlsnative
                                video that should be downloaded concurrently
                                (default is 1)
-r, --limit-rate RATE           Maximum download rate in bytes per second,
                                e.g. 50K or 4.2M
--throttled-rate RATE           Minimum download rate in bytes per second
                                below which throttling is assumed and the
                                video data is re-extracted, e.g. 100K
-R, --retries RETRIES           Number of retries (default is 10), or
                                "infinite"
--file-access-retries RETRIES   Number of times to retry on file access
                                error (default is 3), or "infinite"
--fragment-retries RETRIES      Number of retries for a fragment (default is
                                10), or "infinite" (DASH, hlsnative and ISM)
--retry-sleep [TYPE:]EXPR       Time to sleep between retries in seconds
                                (optionally) prefixed by the type of retry
                                (http (default), fragment, file_access,
                                extractor) to apply the sleep to. EXPR can
                                be a number, linear=START[:END[:STEP=1]] or
                                exp=START[:END[:BASE=2]]. This option can be
                                used multiple times to set the sleep for the
                                different retry types, e.g. --retry-sleep
                                linear=1::2 --retry-sleep fragment:exp=1:20
--skip-unavailable-fragments    Skip unavailable fragments for DASH,
                                hlsnative and ISM downloads (default)
                                (Alias: --no-abort-on-unavailable-fragment)
--abort-on-unavailable-fragment
                                Abort download if a fragment is unavailable
                                (Alias: --no-skip-unavailable-fragments)
--keep-fragments                Keep downloaded fragments on disk after
                                downloading is finished
--no-keep-fragments             Delete downloaded fragments after
                                downloading is finished (default)
--buffer-size SIZE              Size of download buffer, e.g. 1024 or 16K
                                (default is 1024)
--resize-buffer                 The buffer size is automatically resized
                                from an initial value of --buffer-size
                                (default)
--no-resize-buffer              Do not automatically adjust the buffer size
--http-chunk-size SIZE          Size of a chunk for chunk-based HTTP
                                downloading, e.g. 10485760 or 10M (default
                                is disabled). May be useful for bypassing
                                bandwidth throttling imposed by a webserver
                                (experimental)
--playlist-random               Download playlist videos in random order
--lazy-playlist                 Process entries in the playlist as they are
                                received. This disables n_entries,
                                --playlist-random and --playlist-reverse
--no-lazy-playlist              Process videos in the playlist only after
                                the entire playlist is parsed (default)
--xattr-set-filesize            Set file xattribute ytdl.filesize with
                                expected file size
--hls-use-mpegts                Use the mpegts container for HLS videos;
                                allowing some players to play the video
                                while downloading, and reducing the chance
                                of file corruption if download is
                                interrupted. This is enabled by default for
                                live streams
--no-hls-use-mpegts             Do not use the mpegts container for HLS
                                videos. This is default when not downloading
                                live streams
--download-sections REGEX       Download only chapters whose title matches
                                the given regular expression. Time ranges
                                prefixed by a "*" can also be used in place
                                of chapters to download the specified range.
                                Needs ffmpeg. This option can be used
                                multiple times to download multiple
                                sections, e.g. --download-sections
                                "*10:15-inf" --download-sections "intro"
--downloader [PROTO:]NAME       Name or path of the external downloader to
                                use (optionally) prefixed by the protocols
                                (http, ftp, m3u8, dash, rstp, rtmp, mms) to
                                use it for. Currently supports native,
                                aria2c, avconv, axel, curl, ffmpeg, httpie,
                                wget. You can use this option multiple times
                                to set different downloaders for different
                                protocols. E.g. --downloader aria2c
                                --downloader "dash,m3u8:native" will use
                                aria2c for http/ftp downloads, and the
                                native downloader for dash/m3u8 downloads
                                (Alias: --external-downloader)
--downloader-args NAME:ARGS     Give these arguments to the external
                                downloader. Specify the downloader name and
                                the arguments separated by a colon ":". For
                                ffmpeg, arguments can be passed to different
                                positions using the same syntax as
                                --postprocessor-args. You can use this
                                option multiple times to give different
                                arguments to different downloaders (Alias:
                                --external-downloader-args)

ファイルシステムオプション:

-a, --batch-file FILE           File containing URLs to download ("-" for
                                stdin), one URL per line. Lines starting
                                with "#", ";" or "]" are considered as
                                comments and ignored
--no-batch-file                 Do not read URLs from batch file (default)
-P, --paths [TYPES:]PATH        The paths where the files should be
                                downloaded. Specify the type of file and the
                                path separated by a colon ":". All the same
                                TYPES as --output are supported.
                                Additionally, you can also provide "home"
                                (default) and "temp" paths. All intermediary
                                files are first downloaded to the temp path
                                and then the final files are moved over to
                                the home path after download is finished.
                                This option is ignored if --output is an
                                absolute path
-o, --output [TYPES:]TEMPLATE   Output filename template; see "OUTPUT
                                TEMPLATE" for details
--output-na-placeholder TEXT    Placeholder for unavailable fields in
                                "OUTPUT TEMPLATE" (default: "NA")
--restrict-filenames            Restrict filenames to only ASCII characters,
                                and avoid "&" and spaces in filenames
--no-restrict-filenames         Allow Unicode characters, "&" and spaces in
                                filenames (default)
--windows-filenames             Force filenames to be Windows-compatible
--no-windows-filenames          Make filenames Windows-compatible only if
                                using Windows (default)
--trim-filenames LENGTH         Limit the filename length (excluding
                                extension) to the specified number of
                                characters
-w, --no-overwrites             Do not overwrite any files
--force-overwrites              Overwrite all video and metadata files. This
                                option includes --no-continue
--no-force-overwrites           Do not overwrite the video, but overwrite
                                related files (default)
-c, --continue                  Resume partially downloaded files/fragments
                                (default)
--no-continue                   Do not resume partially downloaded
                                fragments. If the file is not fragmented,
                                restart download of the entire file
--part                          Use .part files instead of writing directly
                                into output file (default)
--no-part                       Do not use .part files - write directly into
                                output file
--mtime                         Use the Last-modified header to set the file
                                modification time (default)
--no-mtime                      Do not use the Last-modified header to set
                                the file modification time
--write-description             Write video description to a .description file
--no-write-description          Do not write video description (default)
--write-info-json               Write video metadata to a .info.json file
                                (this may contain personal information)
--no-write-info-json            Do not write video metadata (default)
--write-playlist-metafiles      Write playlist metadata in addition to the
                                video metadata when using --write-info-json,
                                --write-description etc. (default)
--no-write-playlist-metafiles   Do not write playlist metadata when using
                                --write-info-json, --write-description etc.
--clean-info-json               Remove some private fields such as filenames
                                from the infojson. Note that it could still
                                contain some personal information (default)
--no-clean-info-json            Write all fields to the infojson
--write-comments                Retrieve video comments to be placed in the
                                infojson. The comments are fetched even
                                without this option if the extraction is
                                known to be quick (Alias: --get-comments)
--no-write-comments             Do not retrieve video comments unless the
                                extraction is known to be quick (Alias:
                                --no-get-comments)
--load-info-json FILE           JSON file containing the video information
                                (created with the "--write-info-json" option)
--cookies FILE                  Netscape formatted file to read cookies from
                                and dump cookie jar in
--no-cookies                    Do not read/dump cookies from/to file
                                (default)
--cookies-from-browser BROWSER[+KEYRING][:PROFILE][::CONTAINER]
                                The name of the browser to load cookies
                                from. Currently supported browsers are:
                                brave, chrome, chromium, edge, firefox,
                                opera, safari, vivaldi. Optionally, the
                                KEYRING used for decrypting Chromium cookies
                                on Linux, the name/path of the PROFILE to
                                load cookies from, and the CONTAINER name
                                (if Firefox) ("none" for no container) can
                                be given with their respective seperators.
                                By default, all containers of the most
                                recently accessed profile are used.
                                Currently supported keyrings are: basictext,
                                gnomekeyring, kwallet
--no-cookies-from-browser       Do not load cookies from browser (default)
--cache-dir DIR                 Location in the filesystem where yt-dlp can
                                store some downloaded information (such as
                                client ids and signatures) permanently. By
                                default $XDG_CACHE_HOME/yt-dlp or
                                ~/.cache/yt-dlp
--no-cache-dir                  Disable filesystem caching
--rm-cache-dir                  Delete all filesystem cache files

サムネイルオプション:

--write-thumbnail               Write thumbnail image to disk
--no-write-thumbnail            Do not write thumbnail image to disk (default)
--write-all-thumbnails          Write all thumbnail image formats to disk
--list-thumbnails               List available thumbnails of each video.
                                Simulate unless --no-simulate is used

インターネットショートカットオプション:

--write-link                    Write an internet shortcut file, depending
                                on the current platform (.url, .webloc or
                                .desktop). The URL may be cached by the OS
--write-url-link                Write a .url Windows internet shortcut. The
                                OS caches the URL based on the file path
--write-webloc-link             Write a .webloc macOS internet shortcut
--write-desktop-link            Write a .desktop Linux internet shortcut

詳細度とシミュレーションのオプション:

-q, --quiet                     Activate quiet mode. If used with --verbose,
                                print the log to stderr
--no-warnings                   Ignore warnings
-s, --simulate                  Do not download the video and do not write
                                anything to disk
--no-simulate                   Download the video even if printing/listing
                                options are used
--ignore-no-formats-error       Ignore "No video formats" error. Useful for
                                extracting metadata even if the videos are
                                not actually available for download
                                (experimental)
--no-ignore-no-formats-error    Throw error when no downloadable video
                                formats are found (default)
--skip-download                 Do not download the video but write all
                                related files (Alias: --no-download)
-O, --print [WHEN:]TEMPLATE     Field name or output template to print to
                                screen, optionally prefixed with when to
                                print it, separated by a ":". Supported
                                values of "WHEN" are the same as that of
                                --use-postprocessor, and "video" (default).
                                Implies --quiet. Implies --simulate unless
                                --no-simulate or later stages of WHEN are
                                used. This option can be used multiple times
--print-to-file [WHEN:]TEMPLATE FILE
                                Append given template to the file. The
                                values of WHEN and TEMPLATE are same as that
                                of --print. FILE uses the same syntax as the
                                output template. This option can be used
                                multiple times
-j, --dump-json                 Quiet, but print JSON information for each
                                video. Simulate unless --no-simulate is
                                used. See "OUTPUT TEMPLATE" for a
                                description of available keys
-J, --dump-single-json          Quiet, but print JSON information for each
                                url or infojson passed. Simulate unless
                                --no-simulate is used. If the URL refers to
                                a playlist, the whole playlist information
                                is dumped in a single line
--force-write-archive           Force download archive entries to be written
                                as far as no errors occur, even if -s or
                                another simulation option is used (Alias:
                                --force-download-archive)
--newline                       Output progress bar as new lines
--no-progress                   Do not print progress bar
--progress                      Show progress bar, even if in quiet mode
--console-title                 Display progress in console titlebar
--progress-template [TYPES:]TEMPLATE
                                Template for progress outputs, optionally
                                prefixed with one of "download:" (default),
                                "download-title:" (the console title),
                                "postprocess:",  or "postprocess-title:".
                                The video's fields are accessible under the
                                "info" key and the progress attributes are
                                accessible under "progress" key. E.g.
                                --console-title --progress-template
                                "download-title:%(info.id)s-%(progress.eta)s"
-v, --verbose                   Print various debugging information
--dump-pages                    Print downloaded pages encoded using base64
                                to debug problems (very verbose)
--write-pages                   Write downloaded intermediary pages to files
                                in the current directory to debug problems
--print-traffic                 Display sent and read HTTP traffic

回避策:

--encoding ENCODING             Force the specified encoding (experimental)
--legacy-server-connect         Explicitly allow HTTPS connection to servers
                                that do not support RFC 5746 secure
                                renegotiation
--no-check-certificates         Suppress HTTPS certificate validation
--prefer-insecure               Use an unencrypted connection to retrieve
                                information about the video (Currently
                                supported only for YouTube)
--add-header FIELD:VALUE        Specify a custom HTTP header and its value,
                                separated by a colon ":". You can use this
                                option multiple times
--bidi-workaround               Work around terminals that lack
                                bidirectional text support. Requires bidiv
                                or fribidi executable in PATH
--sleep-requests SECONDS        Number of seconds to sleep between requests
                                during data extraction
--sleep-interval SECONDS        Number of seconds to sleep before each
                                download. This is the minimum time to sleep
                                when used along with --max-sleep-interval
                                (Alias: --min-sleep-interval)
--max-sleep-interval SECONDS    Maximum number of seconds to sleep. Can only
                                be used along with --min-sleep-interval
--sleep-subtitles SECONDS       Number of seconds to sleep before each
                                subtitle download

ビデオフォーマットオプション:

-f, --format FORMAT             Video format code, see "FORMAT SELECTION"
                                for more details
-S, --format-sort SORTORDER     Sort the formats by the fields given, see
                                "Sorting Formats" for more details
--format-sort-force             Force user specified sort order to have
                                precedence over all fields, see "Sorting
                                Formats" for more details (Alias: --S-force)
--no-format-sort-force          Some fields have precedence over the user
                                specified sort order (default)
--video-multistreams            Allow multiple video streams to be merged
                                into a single file
--no-video-multistreams         Only one video stream is downloaded for each
                                output file (default)
--audio-multistreams            Allow multiple audio streams to be merged
                                into a single file
--no-audio-multistreams         Only one audio stream is downloaded for each
                                output file (default)
--prefer-free-formats           Prefer video formats with free containers
                                over non-free ones of same quality. Use with
                                "-S ext" to strictly prefer free containers
                                irrespective of quality
--no-prefer-free-formats        Don't give any special preference to free
                                containers (default)
--check-formats                 Make sure formats are selected only from
                                those that are actually downloadable
--check-all-formats             Check all formats for whether they are
                                actually downloadable
--no-check-formats              Do not check that the formats are actually
                                downloadable
-F, --list-formats              List available formats of each video.
                                Simulate unless --no-simulate is used
--merge-output-format FORMAT    Containers that may be used when merging
                                formats, separated by "/", e.g. "mp4/mkv".
                                Ignored if no merge is required. (currently
                                supported: avi, flv, mkv, mov, mp4, webm)

字幕オプション:

--write-subs                    Write subtitle file
--no-write-subs                 Do not write subtitle file (default)
--write-auto-subs               Write automatically generated subtitle file
                                (Alias: --write-automatic-subs)
--no-write-auto-subs            Do not write auto-generated subtitles
                                (default) (Alias: --no-write-automatic-subs)
--list-subs                     List available subtitles of each video.
                                Simulate unless --no-simulate is used
--sub-format FORMAT             Subtitle format; accepts formats preference,
                                e.g. "srt" or "ass/srt/best"
--sub-langs LANGS               Languages of the subtitles to download (can
                                be regex) or "all" separated by commas, e.g.
                                --sub-langs "en.*,ja". You can prefix the
                                language code with a "-" to exclude it from
                                the requested languages, e.g. --sub-langs
                                all,-live_chat. Use --list-subs for a list
                                of available language tags

認証オプション:

-u, --username USERNAME         Login with this account ID
-p, --password PASSWORD         Account password. If this option is left
                                out, yt-dlp will ask interactively
-2, --twofactor TWOFACTOR       Two-factor authentication code
-n, --netrc                     Use .netrc authentication data
--netrc-location PATH           Location of .netrc authentication data;
                                either the path or its containing directory.
                                Defaults to ~/.netrc
--video-password PASSWORD       Video password (vimeo, youku)
--ap-mso MSO                    Adobe Pass multiple-system operator (TV
                                provider) identifier, use --ap-list-mso for
                                a list of available MSOs
--ap-username USERNAME          Multiple-system operator account login
--ap-password PASSWORD          Multiple-system operator account password.
                                If this option is left out, yt-dlp will ask
                                interactively
--ap-list-mso                   List all supported multiple-system operators
--client-certificate CERTFILE   Path to client certificate file in PEM
                                format. May include the private key
--client-certificate-key KEYFILE
                                Path to private key file for client
                                certificate
--client-certificate-password PASSWORD
                                Password for client certificate private key,
                                if encrypted. If not provided, and the key
                                is encrypted, yt-dlp will ask interactively

後処理オプション:

-x, --extract-audio             Convert video files to audio-only files
                                (requires ffmpeg and ffprobe)
--audio-format FORMAT           Format to convert the audio to when -x is
                                used. (currently supported: best (default),
                                aac, alac, flac, m4a, mp3, opus, vorbis,
                                wav). You can specify multiple rules using
                                similar syntax as --remux-video
--audio-quality QUALITY         Specify ffmpeg audio quality to use when
                                converting the audio with -x. Insert a value
                                between 0 (best) and 10 (worst) for VBR or a
                                specific bitrate like 128K (default 5)
--remux-video FORMAT            Remux the video into another container if
                                necessary (currently supported: avi, flv,
                                mkv, mov, mp4, webm, aac, aiff, alac, flac,
                                m4a, mka, mp3, ogg, opus, vorbis, wav). If
                                target container does not support the
                                video/audio codec, remuxing will fail. You
                                can specify multiple rules; e.g.
                                "aac>m4a/mov>mp4/mkv" will remux aac to m4a,
                                mov to mp4 and anything else to mkv
--recode-video FORMAT           Re-encode the video into another format if
                                necessary. The syntax and supported formats
                                are the same as --remux-video
--postprocessor-args NAME:ARGS  Give these arguments to the postprocessors.
                                Specify the postprocessor/executable name
                                and the arguments separated by a colon ":"
                                to give the argument to the specified
                                postprocessor/executable. Supported PP are:
                                Merger, ModifyChapters, SplitChapters,
                                ExtractAudio, VideoRemuxer, VideoConvertor,
                                Metadata, EmbedSubtitle, EmbedThumbnail,
                                SubtitlesConvertor, ThumbnailsConvertor,
                                FixupStretched, FixupM4a, FixupM3u8,
                                FixupTimestamp and FixupDuration. The
                                supported executables are: AtomicParsley,
                                FFmpeg and FFprobe. You can also specify
                                "PP+EXE:ARGS" to give the arguments to the
                                specified executable only when being used by
                                the specified postprocessor. Additionally,
                                for ffmpeg/ffprobe, "_i"/"_o" can be
                                appended to the prefix optionally followed
                                by a number to pass the argument before the
                                specified input/output file, e.g. --ppa
                                "Merger+ffmpeg_i1:-v quiet". You can use
                                this option multiple times to give different
                                arguments to different postprocessors.
                                (Alias: --ppa)
-k, --keep-video                Keep the intermediate video file on disk
                                after post-processing
--no-keep-video                 Delete the intermediate video file after
                                post-processing (default)
--post-overwrites               Overwrite post-processed files (default)
--no-post-overwrites            Do not overwrite post-processed files
--embed-subs                    Embed subtitles in the video (only for mp4,
                                webm and mkv videos)
--no-embed-subs                 Do not embed subtitles (default)
--embed-thumbnail               Embed thumbnail in the video as cover art
--no-embed-thumbnail            Do not embed thumbnail (default)
--embed-metadata                Embed metadata to the video file. Also
                                embeds chapters/infojson if present unless
                                --no-embed-chapters/--no-embed-info-json are
                                used (Alias: --add-metadata)
--no-embed-metadata             Do not add metadata to file (default)
                                (Alias: --no-add-metadata)
--embed-chapters                Add chapter markers to the video file
                                (Alias: --add-chapters)
--no-embed-chapters             Do not add chapter markers (default) (Alias:
                                --no-add-chapters)
--embed-info-json               Embed the infojson as an attachment to
                                mkv/mka video files
--no-embed-info-json            Do not embed the infojson as an attachment
                                to the video file
--parse-metadata FROM:TO        Parse additional metadata like title/artist
                                from other fields; see "MODIFYING METADATA"
                                for details
--replace-in-metadata FIELDS REGEX REPLACE
                                Replace text in a metadata field using the
                                given regex. This option can be used
                                multiple times
--xattrs                        Write metadata to the video file's xattrs
                                (using dublin core and xdg standards)
--concat-playlist POLICY        Concatenate videos in a playlist. One of
                                "never", "always", or "multi_video"
                                (default; only when the videos form a single
                                show). All the video files must have same
                                codecs and number of streams to be
                                concatable. The "pl_video:" prefix can be
                                used with "--paths" and "--output" to set
                                the output filename for the concatenated
                                files. See "OUTPUT TEMPLATE" for details
--fixup POLICY                  Automatically correct known faults of the
                                file. One of never (do nothing), warn (only
                                emit a warning), detect_or_warn (the
                                default; fix file if we can, warn
                                otherwise), force (try fixing even if file
                                already exists)
--ffmpeg-location PATH          Location of the ffmpeg binary; either the
                                path to the binary or its containing directory
--exec [WHEN:]CMD               Execute a command, optionally prefixed with
                                when to execute it (after_move if
                                unspecified), separated by a ":". Supported
                                values of "WHEN" are the same as that of
                                --use-postprocessor. Same syntax as the
                                output template can be used to pass any
                                field as arguments to the command. After
                                download, an additional field "filepath"
                                that contains the final path of the
                                downloaded file is also available, and if no
                                fields are passed, %(filepath)q is appended
                                to the end of the command. This option can
                                be used multiple times
--no-exec                       Remove any previously defined --exec
--convert-subs FORMAT           Convert the subtitles to another format
                                (currently supported: ass, lrc, srt, vtt)
                                (Alias: --convert-subtitles)
--convert-thumbnails FORMAT     Convert the thumbnails to another format
                                (currently supported: jpg, png, webp). You
                                can specify multiple rules using similar
                                syntax as --remux-video
--split-chapters                Split video into multiple files based on
                                internal chapters. The "chapter:" prefix can
                                be used with "--paths" and "--output" to set
                                the output filename for the split files. See
                                "OUTPUT TEMPLATE" for details
--no-split-chapters             Do not split video based on chapters (default)
--remove-chapters REGEX         Remove chapters whose title matches the
                                given regular expression. The syntax is the
                                same as --download-sections. This option can
                                be used multiple times
--no-remove-chapters            Do not remove any chapters from the file
                                (default)
--force-keyframes-at-cuts       Force keyframes at cuts when
                                downloading/splitting/removing sections.
                                This is slow due to needing a re-encode, but
                                the resulting video may have fewer artifacts
                                around the cuts
--no-force-keyframes-at-cuts    Do not force keyframes around the chapters
                                when cutting/splitting (default)
--use-postprocessor NAME[:ARGS]
                                The (case sensitive) name of plugin
                                postprocessors to be enabled, and
                                (optionally) arguments to be passed to it,
                                separated by a colon ":". ARGS are a
                                semicolon ";" delimited list of NAME=VALUE.
                                The "when" argument determines when the
                                postprocessor is invoked. It can be one of
                                "pre_process" (after video extraction),
                                "after_filter" (after video passes filter),
                                "before_dl" (before each video download),
                                "post_process" (after each video download;
                                default), "after_move" (after moving video
                                file to it's final locations), "after_video"
                                (after downloading and processing all
                                formats of a video), or "playlist" (at end
                                of playlist). This option can be used
                                multiple times to add different postprocessors

スポンサーブロックオプション:

SponsorBlock API を使用して、ダウンロードした YouTube 動画のチャプター エントリを作成したり、ダウンロードした YouTube 動画からさまざまなセグメント(スポンサー、紹介など)を削除したりします。

--sponsorblock-mark CATS        SponsorBlock categories to create chapters
                                for, separated by commas. Available
                                categories are sponsor, intro, outro,
                                selfpromo, preview, filler, interaction,
                                music_offtopic, poi_highlight, all and
                                default (=all). You can prefix the category
                                with a "-" to exclude it. See [1] for
                                description of the categories. E.g.
                                --sponsorblock-mark all,-preview
                                [1] https://wiki.sponsor.ajay.app/w/Segment_Categories
--sponsorblock-remove CATS      SponsorBlock categories to be removed from
                                the video file, separated by commas. If a
                                category is present in both mark and remove,
                                remove takes precedence. The syntax and
                                available categories are the same as for
                                --sponsorblock-mark except that "default"
                                refers to "all,-filler" and poi_highlight is
                                not available
--sponsorblock-chapter-title TEMPLATE
                                An output template for the title of the
                                SponsorBlock chapters created by
                                --sponsorblock-mark. The only available
                                fields are start_time, end_time, category,
                                categories, name, category_names. Defaults
                                to "[SponsorBlock]: %(category_names)l"
--no-sponsorblock               Disable both --sponsorblock-mark and
                                --sponsorblock-remove
--sponsorblock-api URL          SponsorBlock API location, defaults to
                                https://sponsor.ajay.app

抽出器オプション:

--extractor-retries RETRIES     Number of retries for known extractor errors
                                (default is 3), or "infinite"
--allow-dynamic-mpd             Process dynamic DASH manifests (default)
                                (Alias: --no-ignore-dynamic-mpd)
--ignore-dynamic-mpd            Do not process dynamic DASH manifests
                                (Alias: --no-allow-dynamic-mpd)
--hls-split-discontinuity       Split HLS playlists to different formats at
                                discontinuities such as ad breaks
--no-hls-split-discontinuity    Do not split HLS playlists to different
                                formats at discontinuities such as ad breaks
                                (default)
--extractor-args IE_KEY:ARGS    Pass ARGS arguments to the IE_KEY extractor.
                                See "EXTRACTOR ARGUMENTS" for details. You
                                can use this option multiple times to give
                                arguments for different extractors

構成

yt-dlp を構成するには、サポートされているコマンドラインオプションを構成ファイルに配置します。構成は、次の場所からロードされます。

  1. メイン構成: によって指定されたファイル

    --config-location

  2. ポータブル構成:バンドルされたバイナリと同じディレクトリ内。ソースコード()から実行している場合は、代わりにルートディレクトリが使用されます。

    yt-dlp.conf
    <root dir>/yt_dlp/__main__.py

  3. ホーム設定: によって指定されたホームパス内、またはそのようなパスが指定されていない場合は現在のディレクトリ内

    yt-dlp.conf
    -P

  4. ユーザー構成:

    • $XDG_CONFIG_HOME/yt-dlp/config
      (Linux/macOSで推奨)
    • $XDG_CONFIG_HOME/yt-dlp.conf
    • $APPDATA/yt-dlp/config
      (ウィンドウズで推奨)
    • $APPDATA/yt-dlp/config.txt
    • ~/yt-dlp.conf
    • ~/yt-dlp.conf.txt

    $XDG_CONFIG_HOME
    デフォルトは未定義の場合です。ウィンドウでは、通常、 を指し、存在する場合は (通常は)、または を指します。
    ~/.config
    $APPDATA
    C:\Users\<user name>\AppData\Roaming
    ~
    $HOME
    $USERPROFILE
    C:\Users\<user name>
    ${HOMEDRIVE}${HOMEPATH}

  5. システム構成:

    /etc/yt-dlp.conf

たとえば、次の設定ファイルを使用すると、yt-dlpは常にオーディオを抽出し、mtimeをコピーし、プロキシを使用してホームディレクトリのディレクトリにすべてのビデオを保存します。

YouTube

# 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 YouTube directory in your home directory
-o ~/YouTube/%(title)s.%(ext)s

設定ファイルのオプションは、通常のコマンドライン呼び出しで使用されるスイッチと同じオプションであることに注意してください。したがって、 または の後に空白があってはなりません。 または、または.また、必要に応じて、UNIXシェルの場合と同様に引用符で囲む必要があります。

-
--
-o
--proxy
- o
-- proxy

特定の yt-dlp 実行のすべての構成ファイルを無効にする場合に使用できます。が設定されている場合、それ以上の設定はロードされません。たとえば、ポータブル構成ファイルにこのオプションを指定すると、ホーム、ユーザー、およびシステム構成の読み込みが防止されます。さらに、(下位互換性のために) システム構成ファイル内で見つかった場合、ユーザー構成はロードされません。

--ignore-config
--ignore-config
--ignore-config

設定ファイルのエンコーディング

設定ファイルは、UTF BOM が存在する場合はそれに従ってデコードされ、それ以外の場合はシステムロケールからのエンコーディングでデコードされます。

ファイルのデコード方法を異なる方法で行う場合は、ファイルの先頭に追加します (例: )。その前には、スペースやBOMでさえも文字があってはなりません。

# coding: ENCODING
# coding: shift-jis

ファイルによる認証
.netrc

また、認証をサポートするエクストラクター用に自動資格情報ストレージを構成することもできます (login とパスワードを指定することにより、 と を指定することによって)、すべての yt-dlp 実行時に資格情報をコマンド行引数として渡さず、シェル・コマンド・ヒストリーでプレーン・テキスト・パスワードを追跡できないようにすることもできます。これは、エクストラクターごとに .netrc ファイルを使用して実現できます。そのためには、ファイルを作成し、あなただけが読み取り/書き込みする権限を制限する必要があります。

--username
--password
.netrc
--netrc-location

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

その後、エクストラクターの資格情報を次の形式で追加できます (エクストラクターはエクストラクターの名前を小文字で表します)。

machine <extractor> login <username> password <password>

例えば。

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

ファイルで認証を有効にするには、yt-dlp に渡すか、構成ファイルに配置する必要があります。

.netrc
--netrc

.netrc ファイルのデフォルトの場所は () です。Windows では、存在しない場合、(通常は) または使用されます。

$HOME
~
$HOME
$USERPROFILE
C:\Users\<user name>
${HOMEDRIVE}${HOMEPATH}

出力テンプレート

このオプションは出力ファイル名のテンプレートを示すために使用され、オプションは各タイプのファイルの保存先のパスを指定するために使用されます。

-o
-P

dr:例に移動します

最も簡単な使い方は、のように単一のファイルをダウンロードするときにテンプレート引数を設定しないことです(このようなハードコーディングされたファイル拡張子は推奨されず、後処理が中断される可能性があります)。

-o
yt-dlp -o funny_video.flv "https://some/video"

ただし、各ビデオをダウンロードするときに置き換えられる特別なシーケンスが含まれている場合があります。特別なシーケンスは、Pythonの文字列フォーマット操作に従ってフォーマットすることができます。 又は。明確にするために、これはパーセント記号の後に括弧内の名前が続き、その後に書式設定操作が続きます。

%(NAME)s
%(NAME)05d

フィールド名自体 (括弧内の部分) には、特別な書式設定を付けることもできます。

  1. オブジェクトのトラバーサル: メタデータで使用可能なディクショナリとリストは、ドット区切り記号を使用してトラバースできます。例えば。。あなたはコロンでPythonスライスを行うことができます。例えば。。中括弧は、特定のキーのみを持つ辞書を作成するために使用できます。例えば。。空のフィールド名は、インフォディクト全体を参照します。例えば。。このメソッドを使用して使用可能になるすべてのフィールドは、以下にリストされていないことに注意してください。このようなフィールドを表示するために使用する

    .
    %(tags.0)s
    %(subtitles.en.-1.ext)s
    :
    %(id.3:7:-1)s
    %(formats.:.format_id)s
    {}
    %(formats.:.{format_id,height})#j
    %()s
    %(.{id,title})s
    -j

  2. 追加: 数値フィールドの加算と減算は、それぞれ と を使用して行うことができます。例えば。

    +
    -
    %(playlist_index+10)03d
    %(n_entries+1-playlist_index)d

  3. 日付/時刻の書式設定: 日付/時刻フィールドは、 を使用してフィールド名から区切って指定することで、strftime 書式に従って書式設定できます。例えば。

    >
    %(duration>%H-%M-%S)s
    %(upload_date>%Y-%m-%d)s
    %(epoch-3600>%H-%M-%S)s

  4. 代替フィールド: 代替フィールドは、 で区切って指定できます。例えば。

    ,
    %(release_date>%Y,upload_date>%Y|Unknown)s

  5. 置換: 置換値は区切り記号を使用して指定できます。フィールドが空でない場合は、実際のフィールドの内容の代わりにこの置換値が使用されます。これは、代替フィールドが考慮された後に行われます。したがって、代替フィールドのいずれかが空でない場合、置換が使用されます。

    &

  6. デフォルト: リテラルのデフォルト値は、区切り記号を使用してフィールドが空の場合に指定できます。これは をオーバーライドします。例えば。

    |
    --output-na-placeholder
    %(uploader|Unknown)s

  7. より多くの変換:通常のフォーマットタイプに加えて、 yt-dlpはさらに= Bytes、= json(きれいな印刷のためのフラグ)、= HTMLエスケープ、=カンマ区切りのl ist(改行区切りフラグ)、=端末用の文字列q(リストを異なる引数に分割するフラグ)、= Dエシマルサフィックス(例えば10M)(1024を因子として使用するフラグ)への変換をサポートしています。 および = Sはファイル名として anitize (制限付きフラグ)

    diouxXeEfFgGcrs
    B
    j
    #
    h
    l
    #
    \n
    q
    #
    D
    #
    S
    #

  8. ユニコード正規化: 形式タイプは、NFC ユニコード正規化に使用できます。代替形式フラグ () は正規化を NFD に変更し、変換フラグは NFKC/NFKD 互換性の等価正規化に使用できます。例えば。 はNFKCです

    U
    #
    +
    %(title)+.100U

要約すると、フィールドの一般的な構文は次のとおりです。

%(name[.keys][addition][>strf][,alternate][&replacement][|default])[flags][width][.precision][length]type

さらに、ファイルのタイプを指定し、その後にコロンで区切られたテンプレートを指定することにより、一般的な出力テンプレートとは別に、さまざまなメタデータ・ファイルに異なる出力テンプレートを設定できます。サポートされているさまざまなファイルの種類は、(非推奨)、、、、、、です。例えば。 サムネイルをビデオと同じ名前のフォルダに配置します。テンプレートのいずれかが空の場合、その種類のファイルは書き込まれません。例えば。 サムネイルはプレイリストに対してのみ書き込み、ビデオには書き込みません。

:
subtitle
thumbnail
description
annotation
infojson
link
pl_thumbnail
pl_description
pl_infojson
chapter
pl_video
-o "%(title)s.%(ext)s" -o "thumbnail:%(title)s\%(title)s.%(ext)s"
--write-thumbnail -o "thumbnail:"

使用可能なフィールドは次のとおりです。

  • id
    (文字列): ビデオ識別子
  • title
    (文字列): ビデオのタイトル
  • fulltitle
    (文字列): ライブタイムスタンプと汎用タイトルを無視する動画タイトル
  • ext
    (文字列): ビデオファイル名拡張子
  • alt_title
    (文字列): ビデオのセカンダリ タイトル
  • description
    (文字列): ビデオの説明
  • display_id
    (文字列): 動画の代替識別子
  • uploader
    (文字列): 動画アップローダーのフルネーム
  • license
    (文字列): 動画のライセンス取得元であるライセンス名
  • creator
    (文字列): 動画の作成者
  • timestamp
    (数値): ビデオが利用可能になった瞬間の UNIX タイムスタンプ
  • upload_date
    (文字列): UTC でのビデオのアップロード日 (YYYYMMDD)
  • release_timestamp
    (数値): ビデオがリリースされた瞬間の UNIX タイムスタンプ
  • release_date
    (文字列): ビデオがUTCでリリースされた日付(YYYYMMDD)
  • modified_timestamp
    (数値): ビデオが最後に変更された瞬間の UNIX タイムスタンプ
  • modified_date
    (文字列): 動画がUTCで最後に変更された日付(YYYYMMDD)
  • uploader_id
    (文字列): 動画アップローダーのニックネームまたは ID
  • channel
    (文字列): 動画がアップロードされるチャンネルのフルネーム
  • channel_id
    (文字列): チャネルの ID
  • channel_follower_count
    (数値): チャンネルのフォロワー数
  • location
    (文字列): ビデオが撮影された物理的な場所
  • duration
    (数値): ビデオの長さ (秒単位)
  • duration_string
    (文字列): ビデオの長さ (HH:mm:ss)
  • view_count
    (数値): プラットフォームでビデオを視聴したユーザーの数
  • like_count
    (数値): 動画の肯定的な評価の数
  • dislike_count
    (数値): 動画の否定的な評価の数
  • repost_count
    (数値): 動画の再投稿回数
  • average_rating
    (数値):ユーザーによる平均評価、使用されるスケールはWebページによって異なります
  • comment_count
    (数値): ビデオのコメント数 (一部のエクストラクターでは、コメントは最後にのみダウンロードされるため、このフィールドは使用できません)
  • age_limit
    (数値): ビデオの年齢制限 (年)
  • live_status
    (文字列): "not_live"、"is_live"、"is_upcoming"、"was_live"、"post_live" のいずれか (ライブだったが、VOD はまだ処理されていない)
  • is_live
    (ブール値): この動画がライブ ストリームか固定長動画か
  • was_live
    (ブール値): この動画がもともとライブ ストリームだったかどうか
  • playable_in_embed
    (文字列): このビデオが他のサイトの埋め込みプレーヤーでの再生を許可されているかどうか
  • availability
    (文字列): 動画が「非公開」、「premium_only」、「subscriber_only」、「needs_auth」、「公開」のいずれであるか
  • start_time
    (数値): URL で指定されているように、再生が開始される秒単位の時間
  • end_time
    (数値): URL で指定されているように、再生が終了する秒単位の時間
  • extractor
    (文字列): エクストラクタの名前
  • extractor_key
    (文字列): 抽出プログラムのキー名
  • epoch
    (数値): 情報抽出が完了した時点の Unix エポック
  • autonumber
    (数値): ダウンロードのたびに増加する数値 (
    --autonumber-start
  • video_autonumber
    (数値): 動画ごとに増加する数値
  • n_entries
    (数値): プレイリスト内の抽出されたアイテムの合計数
  • playlist_id
    (文字列): 動画を含むプレイリストの識別子
  • playlist_title
    (文字列): 動画を含むプレイリストの名前
  • playlist
    (文字列): または
    playlist_id
    playlist_title
  • playlist_count
    (数値): プレイリスト内のアイテムの合計数。プレイリスト全体が抽出されていない場合、わからない場合があります
  • playlist_index
    (数値): プレイリスト内の動画のインデックスで、最終インデックスに従って先行ゼロが埋め込まれます
  • playlist_autonumber
    (数値): プレイリストの全長に応じて、先行ゼロが埋め込まれたプレイリストダウンロードキュー内のビデオの位置
  • playlist_uploader
    (文字列): プレイリストアップローダーのフルネーム
  • playlist_uploader_id
    (文字列): プレイリストアップローダーのニックネームまたはID
  • webpage_url
    (文字列): yt-dlp に指定すると、同じ結果を再度取得できるビデオ Web ページへの URL
  • webpage_url_basename
    (文字列): ウェブページの URL のベース名
  • webpage_url_domain
    (文字列): ウェブページの URL のドメイン
  • original_url
    (文字列): ユーザーが指定した URL (またはプレイリストエントリの場合と同じ)
    webpage_url

フィルタリング形式のすべてのフィールドも使用できます

論理的な章またはセクションに属するビデオで使用できます。

  • chapter
    (文字列): ビデオが属するチャプターの名前またはタイトル
  • chapter_number
    (数値): ビデオが属するチャプターの番号
  • chapter_id
    (文字列): 動画が属するチャプターの ID

一部のシリーズまたはプログラムのエピソードであるビデオで利用可能:

  • series
    (文字列): ビデオエピソードが属するシリーズまたはプログラムのタイトル
  • season
    (文字列): ビデオエピソードが属するシーズンのタイトル
  • season_number
    (数値): ビデオエピソードが属するシーズンの数
  • season_id
    (文字列): 動画エピソードが属するシーズンの ID
  • episode
    (文字列): ビデオエピソードのタイトル
  • episode_number
    (数値): シーズン内の動画エピソードの数
  • episode_id
    (文字列): ビデオエピソードの ID

トラックまたは音楽アルバムの一部であるメディアで使用できます。

  • track
    (文字列): トラックのタイトル
  • track_number
    (数値): アルバムまたはディスク内のトラックの番号
  • track_id
    (文字列): トラックの ID
  • artist
    (文字列): トラックのアーティスト
  • genre
    (文字列): トラックのジャンル
  • album
    (文字列): トラックが属するアルバムのタイトル
  • album_type
    (文字列): アルバムの種類
  • album_artist
    (文字列): アルバムに登場したすべてのアーティストのリスト
  • disc_number
    (数値): トラックが属するディスクまたはその他の物理メディアの数
  • release_year
    (数値): アルバムがリリースされた年 (YYYY)

使用時のみ使用可能で、内部チャプターを含むビデオに使用する場合は接頭辞として使用できます。

--download-sections
chapter:
--split-chapters

  • section_title
    (文字列): 章のタイトル
  • section_number
    (数値): ファイル内のチャプターの番号
  • section_start
    (numeric): Start time of the chapter in seconds
  • section_end
    (numeric): End time of the chapter in seconds

Available only when used in :

--print

  • urls
    (string): The URLs of all requested formats, one in each line
  • filename
    (string): Name of the video file. Note that the actual filename may be different due to post-processing. Use to get the name after all postprocessing is complete
    --exec echo
  • formats_table
    (table): The video format table as printed by
    --list-formats
  • thumbnails_table
    (table): The thumbnail format table as printed by
    --list-thumbnails
  • subtitles_table
    (table): The subtitle format table as printed by
    --list-subs
  • automatic_captions_table
    (table): The automatic subtitle format table as printed by
    --list-subs

Available only in :

--sponsorblock-chapter-title

  • start_time
    (numeric): Start time of the chapter in seconds
  • end_time
    (numeric): End time of the chapter in seconds
  • categories
    (list): The SponsorBlock categories the chapter belongs to
  • category
    (string): The smallest SponsorBlock category the chapter belongs to
  • category_names
    (list): Friendly names of the categories
  • name
    (string): Friendly name of the smallest category

Each aforementioned sequence when referenced in an output template will be replaced by the actual value corresponding to the sequence name. E.g. for and an mp4 video with title and id , this will result in a file created in the current directory.

-o %(title)s-%(id)s.%(ext)s
yt-dlp test video
BaW_jenozKc
yt-dlp test video-BaW_jenozKc.mp4

Note that some of the sequences are not guaranteed to be present since they depend on the metadata obtained by a particular extractor. Such sequences will be replaced with placeholder value provided with ( by default).

--output-na-placeholder
NA

Tip: Look at the output to identify which fields are available for the particular URL

-j

For numeric sequences you can use numeric related formatting; e.g. will result in a string with view count padded with zeros up to 5 characters, like in .

%(view_count)05d
00042

Output templates can also contain arbitrary hierarchical path, e.g. which will result in downloading each video in a directory corresponding to this path template. Any missing directory will be automatically created for you.

-o "%(playlist)s/%(playlist_index)s - %(title)s.%(ext)s"

To use percent literals in an output template use . To output to stdout use .

%%
-o -

The current default template is .

%(title)s [%(id)s].%(ext)s

In some cases, you don't want special characters such as 中, spaces, or &, such as when transferring the downloaded filename to a Windows system or the filename through an 8bit-unsafe channel. In these cases, add the flag to get a shorter title.

--restrict-filenames

Output template examples

$ yt-dlp --print filename -o "test video.%(ext)s" BaW_jenozKc
test video.webm    # Literal name with correct extension

$ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc
youtube-dl test video ''_ä↭𝕐.webm    # All kinds of weird characters

$ yt-dlp --print filename -o "%(title)s.%(ext)s" BaW_jenozKc --restrict-filenames
youtube-dl_test_video_.webm    # Restricted file name

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

# Download YouTube playlist videos in separate directories according to their uploaded year
$ yt-dlp -o "%(upload_date>%Y)s/%(title)s.%(ext)s" "https://www.youtube.com/playlist?list=PLwiyx1dc3P2JR9N8gQaQN_BCvlSlap7re"

# Prefix playlist index with " - " separator, but only if it is available
$ yt-dlp -o '%(playlist_index|)s%(playlist_index& - |)s%(title)s.%(ext)s' BaW_jenozKc "https://www.youtube.com/user/TheLinuxFoundation/playlists"

# Download all playlists of YouTube channel/user keeping each playlist in separate directory:
$ yt-dlp -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
$ yt-dlp -u user -p password -P "~/MyVideos" -o "%(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
$ yt-dlp -P "C:/MyVideos" -o "%(series)s/%(season_number)s - %(season)s/%(episode_number)s - %(episode)s.%(ext)s" "https://videomore.ru/kino_v_detalayah/5_sezon/367617"

# Download video as "C:\MyVideos\uploader\title.ext", subtitles as "C:\MyVideos\subs\uploader\title.ext"
# and put all temporary files in "C:\MyVideos\tmp"
$ yt-dlp -P "C:/MyVideos" -P "temp:tmp" -P "subtitle:subs" -o "%(uploader)s/%(title)s.%(ext)s" BaW_jenoz --write-subs

# Download video as "C:\MyVideos\uploader\title.ext" and subtitles as "C:\MyVideos\uploader\subs\title.ext"
$ yt-dlp -P "C:/MyVideos" -o "%(uploader)s/%(title)s.%(ext)s" -o "subtitle:%(uploader)s/subs/%(title)s.%(ext)s" BaW_jenozKc --write-subs

# Stream the video being downloaded to stdout
$ yt-dlp -o - BaW_jenozKc

FORMAT SELECTION

By default, yt-dlp tries to download the best available quality if you don't pass any options. This is generally equivalent to using . However, if multiple audiostreams is enabled (), the default format changes to . Similarly, if ffmpeg is unavailable, or if you use yt-dlp to stream to (), the default becomes .

-f bestvideo*+bestaudio/best
--audio-multistreams
-f bestvideo+bestaudio/best
stdout
-o -
-f best/bestvideo+bestaudio

Deprecation warning: Latest versions of yt-dlp can stream multiple formats to the stdout simultaneously using ffmpeg. So, in future versions, the default for this will be set to similar to normal downloads. If you want to preserve the setting, it is recommended to explicitly specify it in the configuration options.

-f bv*+ba/b
-f b/bv+ba

The general syntax for format selection is (or ) where is a selector expression, i.e. an expression that describes format or formats you would like to download.

-f FORMAT
--format FORMAT
FORMAT

tl;dr: navigate me to examples.

The simplest case is requesting a specific format; e.g. with you can download the format with format code equal to 22. You can get the list of available format codes for particular video using or . Note that these format codes are extractor specific.

-f 22
--list-formats
-F

You can also use a file extension (currently , , , , , , , , are supported) to download the best quality format of a particular file extension served as a single file, e.g. will download the best quality format with the extension served as a single file.

3gp
aac
flv
m4a
mp3
mp4
ogg
wav
webm
-f webm
webm

You can use to interactively provide the format selector for each video

-f -

You can also use special names to select particular edge case formats:

  • all
    : Select all formats separately
  • mergeall
    : Select and merge all formats (Must be used with , or both)
    --audio-multistreams
    --video-multistreams
  • b*
    , : Select the best quality format that contains either a video or an audio or both (ie;
    best*
    vcodec!=none or acodec!=none
    )
  • b
    , : Select the best quality format that contains both video and audio. Equivalent to
    best
    best*[vcodec!=none][acodec!=none]
  • bv
    , : Select the best quality video-only format. Equivalent to
    bestvideo
    best*[acodec=none]
  • bv*
    , : Select the best quality format that contains video. It may also contain audio. Equivalent to
    bestvideo*
    best*[vcodec!=none]
  • ba
    , : Select the best quality audio-only format. Equivalent to
    bestaudio
    best*[vcodec=none]
  • ba*
    , : Select the best quality format that contains audio. It may also contain video. Equivalent to (Do not use!
    bestaudio*
    best*[acodec!=none]
    )
  • w*
    , : Select the worst quality format that contains either a video or an audio
    worst*
  • w
    , : Select the worst quality format that contains both video and audio. Equivalent to
    worst
    worst*[vcodec!=none][acodec!=none]
  • wv
    , : Select the worst quality video-only format. Equivalent to
    worstvideo
    worst*[acodec=none]
  • wv*
    , : Select the worst quality format that contains video. It may also contain audio. Equivalent to
    worstvideo*
    worst*[vcodec!=none]
  • wa
    , : Select the worst quality audio-only format. Equivalent to
    worstaudio
    worst*[vcodec=none]
  • wa*
    , : Select the worst quality format that contains audio. It may also contain video. Equivalent to
    worstaudio*
    worst*[acodec!=none]

For example, to download the worst quality video-only format you can use . It is however recommended not to use and related options. When your format selector is , the format which is worst in all respects is selected. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use or more rigorously, instead of . See Sorting Formats for more details.

-f worstvideo
worst
worst
-S +size
-S +size,+br,+res,+fps
-f worst

You can select the n'th best format of a type by using . For example, will select the 2nd best combined format. Similarly, will select the 3rd best format that contains a video stream.

best<type>.<n>
best.2
bv*.3

If you want to download multiple videos and they don't have the same formats available, you can specify the order of preference using slashes. Note that formats on the left hand side are preferred; e.g. will download format 22 if it's available, otherwise it will download format 17 if it's available, otherwise it will download format 18 if it's available, otherwise it will complain that no suitable formats are available for download.

-f 22/17/18

If you want to download several formats of the same video use a comma as a separator, e.g. will download all these three formats, of course if they are available. Or a more sophisticated example combined with the precedence feature: .

-f 22,17,18
-f 136/137/mp4/bestvideo,140/m4a/bestaudio

You can merge the video and audio of multiple formats into a single file using (requires ffmpeg installed); e.g. will download the best video-only format, the best audio-only format and mux them together with ffmpeg.

-f <format1>+<format2>+...
-f bestvideo+bestaudio

Deprecation warning: Since the below described behavior is complex and counter-intuitive, this will be removed and multistreams will be enabled by default in the future. A new operator will be instead added to limit formats to single audio/video

Unless is used, all formats with a video stream except the first one are ignored. Similarly, unless is used, all formats with an audio stream except the first one are ignored. E.g. will download and merge all 3 given formats. The resulting file will have 2 video streams and 2 audio streams. But will download and merge only and . is ignored since another format containing a video stream () has already been selected. The order of the formats is therefore important. will download and merge both formats while will ignore and download only .

--video-multistreams
--audio-multistreams
-f bestvideo+best+bestaudio --video-multistreams --audio-multistreams
-f bestvideo+best+bestaudio --no-video-multistreams
bestvideo
bestaudio
best
bestvideo
-f best+bestaudio --no-audio-multistreams
-f bestaudio+best --no-audio-multistreams
best
bestaudio

Filtering Formats

You can also filter the video formats by putting a condition in brackets, as in (or ).

-f "best[height=720]"
-f "[filesize>10M]"

The following numeric meta fields can be used with comparisons , , , , (equals), (not equals):

<
<=
>
>=
=
!=

  • filesize
    : The number of bytes, if known in advance
  • filesize_approx
    : An estimate for the number of bytes
  • width
    : Width of the video, if known
  • height
    : Height of the video, if known
  • tbr
    : Average bitrate of audio and video in KBit/s
  • abr
    : Average audio bitrate in KBit/s
  • vbr
    : Average video bitrate in KBit/s
  • asr
    : Audio sampling rate in Hertz
  • fps
    : Frame rate
  • audio_channels
    : The number of audio channels
  • stretched_ratio
    : of the video's pixels, if not square
    width:height

Also filtering work for comparisons (equals), (starts with), (ends with), (contains), (matches regex) and following string meta fields:

=
^=
$=
*=
~=

  • url
    : Video URL
  • ext
    : File extension
  • acodec
    : Name of the audio codec in use
  • vcodec
    : Name of the video codec in use
  • container
    : Name of the container format
  • protocol
    : The protocol that will be used for the actual download, lower-case (, , , , , , , , , , or
    http
    https
    rtsp
    rtmp
    rtmpe
    mms
    f4m
    ism
    http_dash_segments
    m3u8
    m3u8_native
    )
  • language
    : Language code
  • dynamic_range
    : The dynamic range of the video
  • format_id
    : A short description of the format
  • format
    : A human-readable description of the format
  • format_note
    : Additional info about the format
  • resolution
    : Textual description of width and height

Any string comparison may be prefixed with negation in order to produce an opposite comparison, e.g. (does not contain). The comparand of a string comparison needs to be quoted with either double or single quotes if it contains spaces or special characters other than .

!
!*=
._-

Note that none of the aforementioned meta fields are guaranteed to be present since this solely depends on the metadata obtained by particular extractor, i.e. the metadata offered by the website. Any other field made available by the extractor can also be used for filtering.

Formats for which the value is not known are excluded unless you put a question mark () after the operator. You can combine format filters, so selects up to 720p videos (or videos where the height is not known) with a bitrate of at least 500 KBit/s. You can also use the filters with to download all formats that satisfy the filter, e.g. selects all audio-only formats.

?
-f "[height<=?720][tbr>500]"
all
-f "all[vcodec=none]"

Format selectors can also be grouped using parentheses; e.g. will download the best pre-merged mp4 and webm formats with a height lower than 480.

-f "(mp4,webm)[height<480]"

Sorting Formats

You can change the criteria for being considered the by using (). The general format for this is .

best
-S
--format-sort
--format-sort field1,field2...

The available fields are:

  • hasvid
    : Gives priority to formats that has a video stream
  • hasaud
    : Gives priority to formats that has a audio stream
  • ie_pref
    : The format preference
  • lang
    : The language preference
  • quality
    : The quality of the format
  • source
    : The preference of the source
  • proto
    : Protocol used for download (
    https
    /
    ftps
    >
    http
    /
    ftp
    >
    m3u8_native
    /
    m3u8
    >
    http_dash_segments
    >
    websocket_frag
    >
    mms
    /
    rtsp
    >
    f4f
    /
    f4m
    )
  • vcodec
    : Video Codec ( > > > > > > > > other)
    av01
    vp9.2
    vp9
    h265
    h264
    vp8
    h263
    theora
  • acodec
    : Audio Codec (/ > / > > > > > > > > > other)
    flac
    alac
    wav
    aiff
    opus
    vorbis
    aac
    mp4a
    mp3
    eac3
    ac3
    dts
  • codec
    : Equivalent to
    vcodec,acodec
  • vext
    : Video Extension ( > > > other). If is used, is preferred.
    mp4
    webm
    flv
    --prefer-free-formats
    webm
  • aext
    : Audio Extension ( > > > > > > other). If is used, the order changes to
    m4a
    aac
    mp3
    ogg
    opus
    webm
    --prefer-free-formats
    ogg
    >
    opus
    >
    webm
    >
    mp3
    >
    m4a
    >
    aac
  • ext
    : Equivalent to
    vext,aext
  • filesize
    : Exact filesize, if known in advance
  • fs_approx
    : Approximate filesize calculated from the manifests
  • size
    : Exact filesize if available, otherwise approximate filesize
  • height
    : Height of video
  • width
    : Width of video
  • res
    : Video resolution, calculated as the smallest dimension.
  • fps
    : Framerate of video
  • hdr
    : The dynamic range of the video (
    DV
    >
    HDR12
    >
    HDR10+
    >
    HDR10
    >
    HLG
    >
    SDR
    )
  • channels
    : The number of audio channels
  • tbr
    : Total average bitrate in KBit/s
  • vbr
    : Average video bitrate in KBit/s
  • abr
    : Average audio bitrate in KBit/s
  • br
    : Equivalent to using
    tbr,vbr,abr
  • asr
    : Audio sample rate in Hz

Deprecation warning: Many of these fields have (currently undocumented) aliases, that may be removed in a future version. It is recommended to use only the documented field names.

All fields, unless specified otherwise, are sorted in descending order. To reverse this, prefix the field with a . E.g. prefers format with the smallest resolution. Additionally, you can suffix a preferred value for the fields, separated by a . E.g. prefers larger videos, but no larger than 720p and the smallest video if there are no videos less than 720p. For and , you can provide two preferred values, the first for video and the second for audio. E.g. (equivalent to ) sets the video codec preference to > > > > > > > and audio codec preference to > > > > > > . You can also make the sorting prefer the nearest values to the provided by using as the delimiter. E.g. prefers the format with filesize closest to 1 GiB.

+
+res
:
res:720
codec
ext
+codec:avc:m4a
+vcodec:avc,+acodec:m4a
h264
h265
vp9
vp9.2
av01
vp8
h263
theora
mp4a
aac
vorbis
opus
mp3
ac3
dts
~
filesize~1G

The fields and are always given highest priority in sorting, irrespective of the user-defined order. This behaviour can be changed by using . Apart from these, the default order used is: . The extractors may override this default order, but they cannot override the user-provided order.

hasvid
ie_pref
--format-sort-force
lang,quality,res,fps,hdr:12,vcodec:vp9.2,channels,acodec,size,br,asr,proto,ext,hasaud,source,id

Note that the default has ; i.e. is not preferred. Similarly, the default for hdr is ; i.e. dolby vision is not preferred. These choices are made since DV and AV1 formats are not yet fully compatible with most devices. This may be changed in the future as more devices become capable of smoothly playing back these formats.

vcodec:vp9.2
av1
hdr:12

If your format selector is , the last item is selected after sorting. This means it will select the format that is worst in all respects. Most of the time, what you actually want is the video with the smallest filesize instead. So it is generally better to use .

worst
-f best -S +size,+br,+res,+fps

Tip: You can use the to see how the formats have been sorted (worst to best).

-v -F

Format Selection examples

# Download and merge the best video-only format and the best audio-only format,
# or download the best combined format if video-only format is not available
$ yt-dlp -f "bv+ba/b"

# Download best format that contains video,
# and if it doesn't already have an audio stream, merge it with best audio-only format
$ yt-dlp -f "bv*+ba/b"

# Same as above
$ yt-dlp

# Download the best video-only format and the best audio-only format without merging them
# For this case, an output template should be used since
# by default, bestvideo and bestaudio will have the same file name.
$ yt-dlp -f "bv,ba" -o "%(title)s.f%(format_id)s.%(ext)s"

# Download and merge the best format that has a video stream,
# and all audio-only formats into one file
$ yt-dlp -f "bv*+mergeall[vcodec=none]" --audio-multistreams

# Download and merge the best format that has a video stream,
# and the best 2 audio-only formats into one file
$ yt-dlp -f "bv*+ba+ba.2" --audio-multistreams


# The following examples show the old method (without -S) of format selection
# and how to use -S to achieve a similar but (generally) better result

# Download the worst video available (old method)
$ yt-dlp -f "wv*+wa/w"

# Download the best video available but with the smallest resolution
$ yt-dlp -S "+res"

# Download the smallest video available
$ yt-dlp -S "+size,+br"



# Download the best mp4 video available, or the best video if no mp4 available
$ yt-dlp -f "bv*[ext=mp4]+ba[ext=m4a]/b[ext=mp4] / bv*+ba/b"

# Download the best video with the best extension
# (For video, mp4 > webm > flv. For audio, m4a > aac > mp3 ...)
$ yt-dlp -S "ext"



# Download the best video available but no better than 480p,
# or the worst video if there is no video under 480p
$ yt-dlp -f "bv*[height<=480]+ba/b[height<=480] / wv*+ba/w"

# Download the best video available with the largest height but no better than 480p,
# or the best video with the smallest resolution if there is no video under 480p
$ yt-dlp -S "height:480"

# Download the best video available with the largest resolution but no better than 480p,
# or the best video with the smallest resolution if there is no video under 480p
# Resolution is determined by using the smallest dimension.
# So this works correctly for vertical videos as well
$ yt-dlp -S "res:480"



# Download the best video (that also has audio) but no bigger than 50 MB,
# or the worst video (that also has audio) if there is no video under 50 MB
$ yt-dlp -f "b[filesize<50M] / w"

# Download largest video (that also has audio) but no bigger than 50 MB,
# or the smallest video (that also has audio) if there is no video under 50 MB
$ yt-dlp -f "b" -S "filesize:50M"

# Download best video (that also has audio) that is closest in size to 50 MB
$ yt-dlp -f "b" -S "filesize~50M"



# Download best video available via direct link over HTTP/HTTPS protocol,
# or the best video available via any protocol if there is no such video
$ yt-dlp -f "(bv*+ba/b)[protocol^=http][protocol!*=dash] / (bv*+ba/b)"

# Download best video available via the best protocol
# (https/ftps > http/ftp > m3u8_native > m3u8 > http_dash_segments ...)
$ yt-dlp -S "proto"



# Download the best video with either h264 or h265 codec,
# or the best video if there is no such video
$ yt-dlp -f "(bv*[vcodec~='^((he|a)vc|h26[45])']+ba) / (bv*+ba/b)"

# Download the best video with best codec no better than h264,
# or the best video with worst codec if there is no such video
$ yt-dlp -S "codec:h264"

# Download the best video with worst codec no worse than h264,
# or the best video with best codec if there is no such video
$ yt-dlp -S "+codec:h264"



# More complex examples

# Download the best video no better than 720p preferring framerate greater than 30,
# or the worst video (still preferring framerate greater than 30) if there is no such video
$ yt-dlp -f "((bv*[fps>30]/bv*)[height<=720]/(wv*[fps>30]/wv*)) + ba / (b[fps>30]/b)[height<=720]/(w[fps>30]/w)"

# Download the video with the largest resolution no better than 720p,
# or the video with the smallest resolution available if there is no such video,
# preferring larger framerate for formats with the same resolution
$ yt-dlp -S "res:720,fps"



# Download the video with smallest resolution no worse than 480p,
# or the video with the largest resolution available if there is no such video,
# preferring better codec and then larger total bitrate for the same resolution
$ yt-dlp -S "+res:480,codec,br"

MODIFYING METADATA

The metadata obtained by the extractors can be modified by using and

--parse-metadata
--replace-in-metadata

--replace-in-metadata FIELDS REGEX REPLACE
is used to replace text in any metadata field using python regular expression. Backreferences can be used in the replace string for advanced use.

The general syntax of is to give the name of a field or an output template to extract data from, and the format to interpret it as, separated by a colon . Either a python regular expression with named capture groups or a similar syntax to the output template (only formatting is supported) can be used for . The option can be used multiple times to parse and modify various fields.

--parse-metadata FROM:TO
:
%(field)s
TO

Note that any field created by this can be used in the output template and will also affect the media file's metadata added when using .

--embed-metadata

This option also has a few special uses:

  • You can download an additional URL based on the metadata of the currently downloaded video. To do this, set the field to the URL that you want to download. E.g. will download the first vimeo video found in the description

    additional_urls
    --parse-metadata "description:(?P<additional_urls>https?://www\.vimeo\.com/\d+)

  • You can use this to change the metadata that is embedded in the media file. To do this, set the value of the corresponding field with a prefix. For example, any value you set to field will be added to the field in the file - you can use this to set a different "description" and "synopsis". To modify the metadata of individual streams, use the prefix (e.g. ). Any value set to the field will overwrite all default values.

    meta_
    meta_description
    description
    meta<n>_
    meta1_language
    meta_

Note: Metadata modification happens before format selection, post-extraction and other post-processing operations. Some fields may be added or changed during these steps, overriding your changes.

For reference, these are the fields yt-dlp adds by default to the file metadata:

Metadata fields From
title
track
or
title
date
upload_date
description
,
synopsis
description
purl
,
comment
webpage_url
track
track_number
artist
artist
, , or
creator
uploader
uploader_id
genre
genre
album
album
album_artist
album_artist
disc
disc_number
show
series
season_number
season_number
episode_id
episode
or
episode_id
episode_sort
episode_number
language
of each stream
the format's
language

Note: The file format may not support some of these fields

Modifying metadata examples

# Interpret the title as "Artist - Title"
$ yt-dlp --parse-metadata "title:%(artist)s - %(title)s"

# Regex example
$ yt-dlp --parse-metadata "description:Artist - (?P<artist>.+)"

# Set title as "Series name S01E05"
$ yt-dlp --parse-metadata "%(series)s S%(season_number)02dE%(episode_number)02d:%(title)s"

# Prioritize uploader as the "artist" field in video metadata
$ yt-dlp --parse-metadata "%(uploader|)s:%(meta_artist)s" --embed-metadata

# Set "comment" field in video metadata using description instead of webpage_url,
# handling multiple lines correctly
$ yt-dlp --parse-metadata "description:(?s)(?P<meta_comment>.+)" --embed-metadata

# Do not set any "synopsis" in the video metadata
$ yt-dlp --parse-metadata ":(?P<meta_synopsis>)"

# Remove "formats" field from the infojson by setting it to an empty string
$ yt-dlp --parse-metadata ":(?P<formats>)" -j

# Replace all spaces and "_" in title and uploader with a `-`
$ yt-dlp --replace-in-metadata "title,uploader" "[ _]" "-"

EXTRACTOR ARGUMENTS

Some extractors accept additional arguments which can be passed using . is a (semicolon) separated string of . E.g.

--extractor-args KEY:ARGS
ARGS
;
ARG=VAL1,VAL2
--extractor-args "youtube:player-client=android_embedded,web;include_live_dash" --extractor-args "funimation:version=uncut"

The following extractors use this feature:

youtube

  • lang
    : Language code to prefer translated metadata of this language (case-sensitive). By default, the video primary language metadata is preferred, with a fallback to translated. See youtube.py for list of supported content language codes
    en
  • skip
    : One or more of , or to skip extraction of the m3u8 manifests, dash manifests and auto-translated subtitles respectively
    hls
    dash
    translated_subs
  • player_client
    : Clients to extract video data from. The main clients are , and with variants , , , (e.g. ); and and (agegate bypass) with no variants. By default, is used, but and variants are added as required for age-gated videos. Similarly the music variants are added for urls. You can use to use all the clients, and for the default clients.
    web
    android
    ios
    _music
    _embedded
    _embedscreen
    _creator
    web_embedded
    mweb
    tv_embedded
    android,web
    tv_embedded
    creator
    music.youtube.com
    all
    default
  • player_skip
    : Skip some network requests that are generally needed for robust extraction. One or more of (skip client configs), (skip initial webpage), (skip js player). While these options can help reduce the number of requests needed or avoid some rate-limiting, they could cause some issues. See #860 for more details
    configs
    webpage
    js
  • comment_sort
    : or (default) - choose comment sorting mode (on YouTube's side)
    top
    new
  • max_comments
    : Limit the amount of comments to gather. Comma-separated list of integers representing . Default is
    max-comments,max-parents,max-replies,max-replies-per-thread
    all,all,all,all
    • E.g. will get a maximum of 1000 replies total, with up to 10 replies per thread. will get a maximum of 1000 comments, with a maximum of 100 replies total
      all,all,1000,10
      1000,all,100
  • include_incomplete_formats
    : Extract formats that cannot be downloaded completely (live dash and post-live m3u8)
  • innertube_host
    : Innertube API host to use for all API requests; e.g. , . Note that cookies exported from one subdomain will not work on others
    studio.youtube.com
    youtubei.googleapis.com
  • innertube_key
    : Innertube API key to use for all API requests

youtubetab (YouTube playlists, channels, feeds, etc.)

  • skip
    : One or more of (skip initial webpage download), (allow the download of playlists requiring authentication when no initial webpage is downloaded. This may cause unwanted behavior, see #1122 for more details)
    webpage
    authcheck
  • approximate_date
    : Extract approximate in flat-playlist. This may cause date-based filters to be slightly off
    upload_date

funimation

  • language
    : Languages to extract, e.g.
    funimation:language=english,japanese
  • version
    : The video version to extract - or
    uncut
    simulcast

crunchyroll

  • language
    : Languages to extract, e.g.
    crunchyroll:language=jaJp
  • hardsub
    : Which hard-sub versions to extract, e.g.
    crunchyroll:hardsub=None,enUS

crunchyrollbeta

  • format
    : Which stream type(s) to extract (default: ). Potentially useful values include , , , , , ,
    adaptive_hls
    adaptive_hls
    adaptive_dash
    vo_adaptive_hls
    vo_adaptive_dash
    download_hls
    download_dash
    multitrack_adaptive_hls_v2
  • hardsub
    : Preference order for which hardsub versions to extract, or (default: = no hardsubs), e.g.
    all
    None
    crunchyrollbeta:hardsub=en-US,None

vikichannel

  • video_types
    : Types of videos to download - one or more of , , ,
    episodes
    movies
    clips
    trailers

niconico

  • segment_duration
    : Segment duration in milliseconds for HLS-DMC formats. Use it at your own risk since this feature may result in your account termination.

youtubewebarchive

  • check_all
    : Try to check more at the cost of more requests. One or more of ,
    thumbnails
    captures

gamejolt

  • comment_sort
    : (default), (cookies needed), , - choose comment sorting mode (on GameJolt's side)
    hot
    you
    top
    new

hotstar

  • res
    : resolution to ignore - one or more of , ,
    sd
    hd
    fhd
  • vcodec
    : vcodec to ignore - one or more of , ,
    h264
    h265
    dvh265
  • dr
    : dynamic range to ignore - one or more of , ,
    sdr
    hdr10
    dv

tiktok

  • app_version
    : App version to call mobile APIs with - should be set along with , e.g.
    manifest_app_version
    20.2.1
  • manifest_app_version
    : Numeric app version to call mobile APIs with, e.g.
    221

rokfinchannel

  • tab
    : Which tab to download - one of , , , , ,
    new
    top
    videos
    podcasts
    streams
    stacks

NOTE: These options may be changed/removed in the future without concern for backward compatibility

PLUGINS

Plugins are loaded from ; where is the directory of the binary (), or the root directory of the module if you are running directly from source-code (). Plugins are currently not supported for the version

<root-dir>/ytdlp_plugins/<type>/__init__.py
<root-dir>
<root-dir>/yt-dlp
<root dir>/yt_dlp/__main__.py
pip

Plugins can be of s or . Extractor plugins do not need to be enabled from the CLI and are automatically invoked when the input URL is suitable for it. Postprocessor plugins can be invoked using .

<type>
extractor
postprocessor
--use-postprocessor NAME

See ytdlp_plugins for example plugins.

Note that all plugins are imported even if not invoked, and that there are no checks performed on plugin code. Use plugins at your own risk and only if you trust the code

If you are a plugin author, add ytdlp-plugins as a topic to your repository for discoverability

See the wiki for some known plugins

EMBEDDING YT-DLP

yt-dlp makes the best effort to be a good command-line program, and thus should be callable from any programming language.

Your program should avoid parsing the normal stdout since they may change in future versions. Instead they should use options such as , , , etc to create console output that you can reliably reproduce and parse.

-J
--print
--progress-template
--exec

From a Python program, you can embed yt-dlp in a more powerful fashion, like this:

from yt_dlp import YoutubeDL

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']
with YoutubeDL() as ydl:
    ydl.download(URLS)

Most likely, you'll want to use various options. For a list of options available, have a look at

yt_dlp/YoutubeDL.py
.

Tip: If you are porting your code from youtube-dl to yt-dlp, one important point to look out for is that we do not guarantee the return value of to be json serializable, or even be a dictionary. It will be dictionary-like, but if you want to ensure it is a serializable dictionary, pass it through as shown in the example below

YoutubeDL.extract_info
YoutubeDL.sanitize_info

Embedding examples

Extracting information

import json
import yt_dlp

URL = 'https://www.youtube.com/watch?v=BaW_jenozKc'

# ℹ️ See help(yt_dlp.YoutubeDL) for a list of available options and public functions
ydl_opts = {}
with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    info = ydl.extract_info(URL, download=False)

    # ℹ️ ydl.sanitize_info makes the info json-serializable
    print(json.dumps(ydl.sanitize_info(info)))

Download using an info-json

import yt_dlp

INFO_FILE = 'path/to/video.info.json'

with yt_dlp.YoutubeDL() as ydl:
    error_code = ydl.download_with_info_file(INFO_FILE)

print('Some videos failed to download' if error_code
      else 'All videos successfully downloaded')

Extract audio

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

ydl_opts = {
    'format': 'm4a/bestaudio/best',
    # ℹ️ See help(yt_dlp.postprocessor) for a list of available Postprocessors and their arguments
    'postprocessors': [{  # Extract audio using ffmpeg
        'key': 'FFmpegExtractAudio',
        'preferredcodec': 'm4a',
    }]
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    error_code = ydl.download(URLS)

Filter videos

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

def longer_than_a_minute(info, *, incomplete):
    """Download only videos longer than a minute (or with unknown duration)"""
    duration = info.get('duration')
    if duration and duration < 60:
        return 'The video is too short'

ydl_opts = {
    'match_filter': longer_than_a_minute,
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    error_code = ydl.download(URLS)

Adding logger and progress hook

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

class MyLogger:
    def debug(self, msg):
        # For compatibility with youtube-dl, both debug and info are passed into debug
        # You can distinguish them by the prefix '[debug] '
        if msg.startswith('[debug] '):
            pass
        else:
            self.info(msg)

    def info(self, msg):
        pass

    def warning(self, msg):
        pass

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


# ℹ️ See "progress_hooks" in help(yt_dlp.YoutubeDL)
def my_hook(d):
    if d['status'] == 'finished':
        print('Done downloading, now post-processing ...')


ydl_opts = {
    'logger': MyLogger(),
    'progress_hooks': [my_hook],
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    ydl.download(URLS)

Add a custom PostProcessor

import yt_dlp

URLS = ['https://www.youtube.com/watch?v=BaW_jenozKc']

# ℹ️ See help(yt_dlp.postprocessor.PostProcessor)
class MyCustomPP(yt_dlp.postprocessor.PostProcessor):
    def run(self, info):
        self.to_screen('Doing stuff')
        return [], info


with yt_dlp.YoutubeDL() as ydl:
    # ℹ️ "when" can take any value in yt_dlp.utils.POSTPROCESS_WHEN
    ydl.add_post_processor(MyCustomPP(), when='pre_process')
    ydl.download(URLS)

Use a custom format selector

import yt_dlp

URL = ['https://www.youtube.com/watch?v=BaW_jenozKc']

def format_selector(ctx):
    """ Select the best video and the best audio that won't result in an mkv.
    NOTE: This is just an example and does not handle all cases """

    # formats are already sorted worst to best
    formats = ctx.get('formats')[::-1]

    # acodec='none' means there is no audio
    best_video = next(f for f in formats
                      if f['vcodec'] != 'none' and f['acodec'] == 'none')

    # find compatible audio extension
    audio_ext = {'mp4': 'm4a', 'webm': 'webm'}[best_video['ext']]
    # vcodec='none' means there is no video
    best_audio = next(f for f in formats if (
        f['acodec'] != 'none' and f['vcodec'] == 'none' and f['ext'] == audio_ext))

    # These are the minimum required fields for a merged format
    yield {
        'format_id': f'{best_video["format_id"]}+{best_audio["format_id"]}',
        'ext': best_video['ext'],
        'requested_formats': [best_video, best_audio],
        # Must be + separated list of protocols
        'protocol': f'{best_video["protocol"]}+{best_audio["protocol"]}'
    }


ydl_opts = {
    'format': format_selector,
}

with yt_dlp.YoutubeDL(ydl_opts) as ydl:
    ydl.download(URLS)

DEPRECATED OPTIONS

These are all the deprecated options and the current alternative to achieve the same effect

Almost redundant options

While these options are almost the same as their new counterparts, there are some differences that prevents them being redundant

-j, --dump-json                  --print "%()j"
-F, --list-formats               --print formats_table
--list-thumbnails                --print thumbnails_table --print playlist:thumbnails_table
--list-subs                      --print automatic_captions_table --print subtitles_table

Redundant options

While these options are redundant, they are still expected to be used due to their ease of use

--get-description                --print description
--get-duration                   --print duration_string
--get-filename                   --print filename
--get-format                     --print format
--get-id                         --print id
--get-thumbnail                  --print thumbnail
-e, --get-title                  --print title
-g, --get-url                    --print urls
--match-title REGEX              --match-filter "title ~= (?i)REGEX"
--reject-title REGEX             --match-filter "title !~= (?i)REGEX"
--min-views COUNT                --match-filter "view_count >=? COUNT"
--max-views COUNT                --match-filter "view_count <=? COUNT"
--user-agent UA                  --add-header "User-Agent:UA"
--referer URL                    --add-header "Referer:URL"
--playlist-start NUMBER          -I NUMBER:
--playlist-end NUMBER            -I :NUMBER
--playlist-reverse               -I ::-1
--no-playlist-reverse            Default

Not recommended

While these options still work, their use is not recommended since there are other alternatives to achieve the same

--force-generic-extractor        --ies generic,default
--exec-before-download CMD       --exec "before_dl:CMD"
--no-exec-before-download        --no-exec
--all-formats                    -f all
--all-subs                       --sub-langs all --write-subs
--print-json                     -j --no-simulate
--autonumber-size NUMBER         Use string formatting, e.g. %(autonumber)03d
--autonumber-start NUMBER        Use internal field formatting like %(autonumber+NUMBER)s
--id                             -o "%(id)s.%(ext)s"
--metadata-from-title FORMAT     --parse-metadata "%(title)s:FORMAT"
--hls-prefer-native              --downloader "m3u8:native"
--hls-prefer-ffmpeg              --downloader "m3u8:ffmpeg"
--list-formats-old               --compat-options list-formats (Alias: --no-list-formats-as-table)
--list-formats-as-table          --compat-options -list-formats [Default] (Alias: --no-list-formats-old)
--youtube-skip-dash-manifest     --extractor-args "youtube:skip=dash" (Alias: --no-youtube-include-dash-manifest)
--youtube-skip-hls-manifest      --extractor-args "youtube:skip=hls" (Alias: --no-youtube-include-hls-manifest)
--youtube-include-dash-manifest  Default (Alias: --no-youtube-skip-dash-manifest)
--youtube-include-hls-manifest   Default (Alias: --no-youtube-skip-hls-manifest)

Developer options

These options are not intended to be used by the end-user

--test                           Download only part of video for testing extractors
--load-pages                     Load pages dumped by --write-pages
--youtube-print-sig-code         For testing youtube signatures
--allow-unplayable-formats       List unplayable formats also
--no-allow-unplayable-formats    Default

Old aliases

These are aliases that are no longer documented for various reasons

--avconv-location                --ffmpeg-location
--clean-infojson                 --clean-info-json
--cn-verification-proxy URL      --geo-verification-proxy URL
--dump-headers                   --print-traffic
--dump-intermediate-pages        --dump-pages
--force-write-download-archive   --force-write-archive
--load-info                      --load-info-json
--no-clean-infojson              --no-clean-info-json
--no-split-tracks                --no-split-chapters
--no-write-srt                   --no-write-subs
--prefer-unsecure                --prefer-insecure
--rate-limit RATE                --limit-rate RATE
--split-tracks                   --split-chapters
--srt-lang LANGS                 --sub-langs LANGS
--trim-file-names LENGTH         --trim-filenames LENGTH
--write-srt                      --write-subs
--yes-overwrites                 --force-overwrites

Sponskrub Options

SponSkrubのサポートは、オプションのために非推奨になりました

--sponsorblock

--sponskrub                      --sponsorblock-mark all
--no-sponskrub                   --no-sponsorblock
--sponskrub-cut                  --sponsorblock-remove all
--no-sponskrub-cut               --sponsorblock-remove -all
--sponskrub-force                Not applicable
--no-sponskrub-force             Not applicable
--sponskrub-location             Not applicable
--sponskrub-args                 Not applicable

サポート終了

これらのオプションは意図したとおりに動作しなくなる可能性があります

--prefer-avconv                  avconv is not officially supported by yt-dlp (Alias: --no-prefer-ffmpeg)
--prefer-ffmpeg                  Default (Alias: --no-prefer-avconv)
-C, --call-home                  Not implemented
--no-call-home                   Default
--include-ads                    No longer supported
--no-include-ads                 Default
--write-annotations              No supported site has annotations now
--no-write-annotations           Default
--compat-options seperate-video-versions  No longer needed

削除

これらのオプションは 2014 年以降非推奨となり、現在は完全に削除されています。

-A, --auto-number                -o "%(autonumber)s-%(id)s.%(ext)s"
-t, -l, --title, --literal       -o "%(title)s-%(id)s.%(ext)s"

貢献

案件のオープンプロジェクトへのコードの貢献に関する手順については、「CONTRIBUTING.md」を参照してください。

ウィキ

詳細については、Wiki を参照してください。