yt-dlp の API リファレンス

yt-dlp (yt-dlp/yt-dlp) の公開 API 119 件 —— クラス 68、関数 25、メソッド 26。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。

種別	件数
クラス	68
関数	25
メソッド	26

API 一覧

funcbundle.pyinstaller.exe(onedir)

@returns (name, path)

classyt_dlp.YoutubeDL.YoutubeDL

YoutubeDL class.

methodyt_dlp.YoutubeDL.YoutubeDL.add_post_hook(ph)

Add the post hook

methodyt_dlp.YoutubeDL.YoutubeDL.add_progress_hook(ph)

Add the download progress hook

methodyt_dlp.YoutubeDL.YoutubeDL.cookiejar()

Global cookiejar instance

methodyt_dlp.YoutubeDL.YoutubeDL.download(url_list)

Download a given list of URLs.

methodyt_dlp.YoutubeDL.YoutubeDL.prepare_filename(info_dict, dir_type='', *outtmpl=None, *warn=False)

Generate the output filename

methodyt_dlp.YoutubeDL.YoutubeDL.process_info(info_dict)

Process a single resolved IE result.

methodyt_dlp.YoutubeDL.YoutubeDL.proxies()

Global proxy configuration

methodyt_dlp.YoutubeDL.YoutubeDL.to_stderr(message, only_once=False)

Print message to stderr

methodyt_dlp.YoutubeDL.YoutubeDL.to_stdout(message, skip_eol=False, quiet=None)

Print message to stdout

methodyt_dlp.YoutubeDL.YoutubeDL.urlopen(req)

Start an HTTP download

methodyt_dlp.YoutubeDL.YoutubeDL.validate_outtmpl(outtmpl)

@return None or Exception object

funcyt_dlp.aes.aes_ecb_encrypt(data, key, iv=None)

Encrypt with aes in ECB mode.

classyt_dlp.cookies.LenientSimpleCookie

More lenient version of http.cookies.SimpleCookie

classyt_dlp.cookies.YoutubeDLCookieJar

See [1] for cookie file format.

methodyt_dlp.cookies.YoutubeDLCookieJar.load(filename=None, ignore_discard=True, ignore_expires=True)

Load cookies from a file.

methodyt_dlp.cookies.YoutubeDLCookieJar.save(filename=None, ignore_discard=True, ignore_expires=True)

Save cookies to a file.

classyt_dlp.downloader.common.FileDownloader

File Downloader class.

methodyt_dlp.downloader.common.FileDownloader.real_download(filename, info_dict)

Real download process.

methodyt_dlp.downloader.common.FileDownloader.report_destination(filename)

Report destination filename.

methodyt_dlp.downloader.common.FileDownloader.report_retry(err, count, retries, frag_index=NO_DEFAULT, fatal=True)

Report retry

classyt_dlp.downloader.dash.DashSegmentsFD

Download segments in a DASH manifest.

classyt_dlp.downloader.f4m.F4mFD

A downloader for f4m manifests or AdobeHDS.

funcyt_dlp.downloader.f4m.write_flv_header(stream)

Writes the FLV header to stream

classyt_dlp.downloader.fc2.FC2LiveFD

Downloads FC2 live without being stopped.

classyt_dlp.downloader.fragment.FragmentFD

A base file downloader class for fragmented media (e.g.

classyt_dlp.downloader.hls.HlsFD

Download segments in a m3u8 manifest.

classyt_dlp.downloader.ism.IsmFD

Download segments in a ISM manifest

classyt_dlp.downloader.niconico.NiconicoLiveFD

Downloads niconico live without being stopped

classyt_dlp.downloader.websocket.FFmpegSinkFD

A sink to ffmpeg for downloading fragments in any form

methodyt_dlp.downloader.websocket.FFmpegSinkFD.real_connection(sink, info_dict)

Override this in subclasses

classyt_dlp.downloader.youtube_live_chat.YoutubeLiveChatFD

Downloads YouTube live chats fragment by fragment

classyt_dlp.extractor.applepodcasts.AppleBaseIE

Subclasses must set _BASE_URL and _JWT_KEY_ID

classyt_dlp.extractor.common.InfoExtractor

Information Extractor class.

methodyt_dlp.extractor.common.InfoExtractor.age_limit()

Get age limit from the testcases

methodyt_dlp.extractor.common.InfoExtractor.report_age_confirmation()

Report attempt to confirm age.

methodyt_dlp.extractor.common.InfoExtractor.report_download_webpage(video_id, *note=None)

Report webpage download.

methodyt_dlp.extractor.common.InfoExtractor.report_extraction(id_or_name)

Report information extraction.

methodyt_dlp.extractor.common.InfoExtractor.report_login()

Report attempt to log in.

methodyt_dlp.extractor.common.InfoExtractor.working()

Getter method for _WORKING.

classyt_dlp.extractor.common.SearchInfoExtractor

Base class for paged search queries extractors.

classyt_dlp.extractor.dplay.DiscoveryPlusBaseIE

Subclasses must set _PRODUCT, _DISCO_API_PARAMS

classyt_dlp.extractor.floatplane.FloatplaneChannelBaseIE

Subclasses must set _RESULT_IE, _BASE_URL and _PAGE_SIZE

funcyt_dlp.extractor.gen_extractor_classes()

Return a list of supported extractors.

classyt_dlp.extractor.goplay.AuthenticationException

Something went wrong while logging in

classyt_dlp.extractor.goplay.AwsIdp

AWS Identity Provider

classyt_dlp.extractor.goplay.InvalidLoginException

The login credentials are invalid

classyt_dlp.extractor.openload.PhantomJSwrapper

PhantomJS wrapper class This class is experimental.

classyt_dlp.extractor.radiofrance.RadioFrancePlaylistBaseIE

Subclasses must set _METADATA_KEY

classyt_dlp.extractor.testurl.TestURLIE

Allows addressing of the test cases as test:yout.*be_1

classyt_dlp.extractor.vimeo.VimeoIE

Information extractor for vimeo.com.

classyt_dlp.extractor.volejtv.VolejTVPlaylistBaseIE

Subclasses must set _API_FILTER, _PAGE_SIZE

classyt_dlp.extractor.youtube._base.YoutubeBaseInfoExtractor

Provide base functions for Youtube extractors

classyt_dlp.extractor.youtube.jsc.provider.JsChallengeProviderError

An error occurred while solving the challenge

funcyt_dlp.extractor.youtube.jsc.provider.register_provider(provider:type[JsChallengeProvider])

classyt_dlp.extractor.youtube.pot.cache.PoTokenCacheProviderError

An error occurred while fetching a PO Token

funcyt_dlp.extractor.youtube.pot.cache.register_provider(provider:type[PoTokenCacheProvider])

classyt_dlp.extractor.youtube.pot.provider.PoTokenProviderError

An error occurred while fetching a PO Token

func

yt_dlp.extractor.youtube.pot.provider.register_preference(*providers:type[PoTokenProvider]) -> typing.Callable[[Preference], Preference]

funcyt_dlp.extractor.youtube.pot.provider.register_provider(provider:type[PoTokenProvider])

funcyt_dlp.networking._helper.get_redirect_method(method, status)

Unified redirect method handling

classyt_dlp.networking._requests.RequestsRH

Requests RequestHandler https://github.com/psf/requests

classyt_dlp.networking._requests.Urllib3LoggingHandler

Redirect urllib3 logs to our logger

classyt_dlp.networking._urllib.HTTPHandler

Handler for HTTP requests and responses.

classyt_dlp.networking.common.Request

Represents a request to be made.

classyt_dlp.networking.common.Response

Base class for HTTP response adapters.

methodyt_dlp.networking.common.Response.get_header(name, default=None)

Get header for name.

funcyt_dlp.networking.common.register_rh(handler)

classyt_dlp.networking.exceptions.CertificateVerifyError

Raised when certificate validated has failed

classyt_dlp.networking.exceptions.TransportError

Network related errors

classyt_dlp.networking.exceptions.UnsupportedRequest

raised when a handler cannot handle a request

classyt_dlp.networking.impersonate.ImpersonateTarget

A target for browser impersonation.

classyt_dlp.plugins.PluginFinder

This class provides one or multiple namespace packages.

classyt_dlp.plugins.PluginLoader

Dummy loader for virtual namespace packages

classyt_dlp.postprocessor.common.PostProcessor

Post Processor class.

methodyt_dlp.postprocessor.common.PostProcessor.run(information)

Run the PostProcessor.

funcyt_dlp.utils._legacy.platform_name()

Returns the platform name as a str

classyt_dlp.utils._utils.ContentTooShortError

Content Too Short exception.

classyt_dlp.utils._utils.DateRange

Represents a time interval between two dates

classyt_dlp.utils._utils.DownloadCancelled

Exception raised when the download queue should be interrupted

classyt_dlp.utils._utils.DownloadError

Download Error exception.

classyt_dlp.utils._utils.EntryNotInPlaylist

Entry not in playlist exception.

classyt_dlp.utils._utils.ExistingVideoReached

--break-on-existing triggered

classyt_dlp.utils._utils.ExtractorError

Error during info extraction.

classyt_dlp.utils._utils.GeoRestrictedError

Geographic restriction Error exception.

classyt_dlp.utils._utils.InAdvancePagedList

PagedList with total number of pages known in advance

methodyt_dlp.utils._utils.LazyList.exhaust()

Evaluate the entire iterable

classyt_dlp.utils._utils.MaxDownloadsReached

--max-downloads limit has been reached.

classyt_dlp.utils._utils.Namespace

Immutable namespace

classyt_dlp.utils._utils.OnDemandPagedList

Download pages until a page with less than maximum results

classyt_dlp.utils._utils.PostProcessingError

Post Processing exception.

classyt_dlp.utils._utils.ReExtractInfo

Video info needs to be re-extracted.

classyt_dlp.utils._utils.RegexNotFoundError

Error when a regex didn't match

classyt_dlp.utils._utils.RejectedVideoReached

--break-match-filter triggered

classyt_dlp.utils._utils.RetryManager

Usage: for retry in RetryManager(...): try: ...

classyt_dlp.utils._utils.SameFileError

Same File exception.

classyt_dlp.utils._utils.ThrottledDownload

Download speed below --throttled-rate.

classyt_dlp.utils._utils.UnavailableVideoError

Unavailable Format exception.

classyt_dlp.utils._utils.UserNotLive

Error when a channel/user is not live

classyt_dlp.utils._utils.YoutubeDLError

Base exception for YoutubeDL errors.

funcyt_dlp.utils._utils.cached_method(f)

Cache a method

classyt_dlp.utils._utils.classproperty

property access for class methods with optional caching

funcyt_dlp.utils._utils.decode_base_n(string, n=None, table=None)

Convert given base-n string to int

funcyt_dlp.utils._utils.encode_base_n(num, n=None, table=None)

Convert given int to a base-n string

funcyt_dlp.utils._utils.expand_path(s)

Expand shell variables and ~

funcyt_dlp.utils._utils.find_xpath_attr(node, xpath, key, val=None)

Find the xpath xpath[@key=val]

funcyt_dlp.utils._utils.fix_xml_ampersands(xml_str)

Replace all the '&' by '&' in XML

funcyt_dlp.utils._utils.frange(start=0, stop=None, step=1)

Float range

funcyt_dlp.utils._utils.get_windows_version()

Get Windows version.

funcyt_dlp.utils._utils.limit_length(s, length)

Add ellipses to overly long strings

funcyt_dlp.utils._utils.ohdave_rsa_encrypt(data, exponent, modulus)

Implement OHDave's RSA algorithm.

funcyt_dlp.utils._utils.preferredencoding()

Get preferred encoding.

funcyt_dlp.utils._utils.str_to_int(int_str)

A more relaxed version of int_or_none

funcyt_dlp.utils._utils.ytdl_is_updateable()

Returns if yt-dlp can be updated with -U

classyt_dlp.utils.networking.HTTPHeaderDict

Store and access keys case-insensitively.

funcyt_dlp.utils.networking.normalize_url(url)

Normalize URL as suggested by RFC 3986

classyt_dlp.webvtt.Block

An abstract WebVTT block.

classyt_dlp.webvtt.CueBlock

A cue block.

この情報について

掲載しているシグネチャは yt-dlp/yt-dlp の公開ソースコードを Python の ast モジュールで静的解析し、引数名・デフォルト値・型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。詳しくは仕組みの解説をご覧ください。

収録ライブラリ一覧（全 805 件）へ戻る