API Reference

This is an incomplete reference of the relevant Streamlink APIs.

• Streamlink
  • streams()
• Session
  • Streamlink
    • Streamlink.http
    • Streamlink.options
    • Streamlink.plugins
    • Streamlink.set_option()
    • Streamlink.get_option()
    • Streamlink.resolve_url()
    • Streamlink.resolve_url_no_redirect()
    • Streamlink.streams()
    • Streamlink.get_plugins()
    • Streamlink.load_builtin_plugins()
    • Streamlink.load_plugins()
  • StreamlinkOptions
    • StreamlinkOptions.get()
    • StreamlinkOptions.set()
  • StreamlinkPlugins
    • StreamlinkPlugins.__getitem__()
    • StreamlinkPlugins.__setitem__()
    • StreamlinkPlugins.__delitem__()
    • StreamlinkPlugins.__contains__()
    • StreamlinkPlugins.get_names()
    • StreamlinkPlugins.get_loaded()
    • StreamlinkPlugins.load_builtin()
    • StreamlinkPlugins.load_path()
    • StreamlinkPlugins.update()
    • StreamlinkPlugins.clear()
    • StreamlinkPlugins.iter_arguments()
    • StreamlinkPlugins.iter_matchers()
    • StreamlinkPlugins.match_url()
• Plugin
  • Plugin
    • Plugin.matchers
    • Plugin.arguments
    • Plugin.matcher
    • Plugin.match
    • Plugin.id
    • Plugin.title
    • Plugin.author
    • Plugin.category
    • Plugin.options
    • Plugin.cache
    • Plugin.session
    • Plugin.matches
    • Plugin.url
    • Plugin.streams()
    • Plugin._get_streams()
    • Plugin.save_cookies()
    • Plugin.load_cookies()
    • Plugin.clear_cookies()
  • Plugin decorators
    • pluginmatcher()
    • pluginargument()
    • _PLUGINARGUMENT_TYPE_REGISTRY
• Options
  • Options
    • Options.clear()
    • Options.get()
    • Options.get_explicit()
    • Options.set()
    • Options.set_explicit()
    • Options.update()
    • Options._MAP_GETTERS
    • Options._MAP_SETTERS
  • Argument
  • Arguments
    • Arguments.requires()
• Cache
  • Cache
    • Cache.get()
    • Cache.get_all()
    • Cache.set()
• Validation schemas
  • Schema
    • Schema.validate()
  • validate()
  • _validate_type()
  • _validate_callable()
  • _validate_sequence()
  • _validate_dict()
  • _validate_pattern()
  • all
  • any
  • attr
  • contains()
  • endswith()
  • filter()
  • get
  • getattr()
  • hasattr()
  • length()
  • list
  • map()
  • none_or_all
  • optional
  • parse_html()
  • parse_json()
  • parse_qsd()
  • parse_xml()
  • regex
  • startswith()
  • transform
  • union
  • union_get
  • url()
  • xml_element
  • xml_find()
  • xml_findall()
  • xml_findtext()
  • xml_xpath()
  • xml_xpath_string()
  • AllSchema
  • AnySchema
  • NoneOrAllSchema
  • TransformSchema
  • OptionalSchema
  • ListSchema
  • AttrSchema
  • GetItemSchema
  • UnionSchema
  • UnionGetSchema
  • RegexSchema
  • XmlElementSchema
  • ValidationError
• Stream
  • Stream
    • Stream.open()
  • MuxedStream
  • HTTPStream
    • HTTPStream.args
    • HTTPStream.url
  • HLSStream
    • HLSStream.parse_variant_playlist()
    • HLSStream.url_master
  • MuxedHLSStream
    • MuxedHLSStream.url_master
  • DASHStream
    • DASHStream.parse_manifest()
• Webbrowser
  • CDPClient
    • CDPClient.launch()
    • CDPClient.session()
  • CDPClientSession
    • CDPClientSession.add_request_handler()
    • CDPClientSession.alter_request()
    • CDPClientSession.continue_request()
    • CDPClientSession.evaluate()
    • CDPClientSession.fail_request()
    • CDPClientSession.fulfill_request()
    • CDPClientSession.loaded()
    • CDPClientSession.navigate()
  • CMRequestProxy
  • CDPBase
    • CDPBase.listen()
    • CDPBase.send()
  • CDPConnection
    • CDPConnection.create()
    • CDPConnection.aclose()
    • CDPConnection.new_target()
  • CDPSession
  • CDPEventListener
    • CDPEventListener.receive()
  • Webbrowser
  • ChromiumWebbrowser
• Exceptions
  • StreamlinkError
  • PluginError
  • FatalPluginError
  • NoPluginError
  • NoStreamsError
  • StreamError
  • WebbrowserError
  • CDPError