The module structure of the Streamlink session implementation and related classes
like the HTTPSession has been re-organized.
Importing HTTPSession from either streamlink.plugin.api or streamlink.plugin.api.http_session is now deprecated.
It was never intended to import this class directly. Plugin implementors should always reference the session's HTTPSession
instance via the Streamlink.http attribute.
In addition, importing TLSNoDHAdapter or TLSSecLevel1Adapter from streamlink.plugin.api.http_session is now also
deprecated. Import from the streamlink.session.http module instead, if actually necessary.
Streamlink.load_builtin_plugins() has been deprecated in favor of using
the plugins_builtin Streamlink session keyword argument.
The old method was never publicly documented and was only used internally upon initialization.
The is_global=Truepluginargument parameter has been deprecated.
Instead of defining a global plugin argument to set a key-value pair on the plugin's options, use the respective option on
the plugin's Streamlink session instance instead.
With the removal of the Plugin.bind() class method which was used for setting up the
Streamlink session instance and module name in each plugin class,
the Plugin constructor's signature was changed and it now requires
the session and url arguments. Implementors of custom plugins should define variable positional arguments and keyword
arguments when subclassing and adding a custom constructor (*args,**kwargs), and the url should be accessed via
self.url after calling the constructor of the super class.
Compatibility wrappers were added for old custom plugin implementations, and a deprecation message will be shown until
the compatibility wrappers will get removed in a future release.
The url_master parameter and attribute of the HLSStream
and MuxedHLSStream classes have been deprecated in favor of
the multivariant parameter and attribute. multivariant is an M3U8 reference of the parsed
HLS multivariant playlist.
A new plugin URL matching API was introduced in 2.3.0 which will help Streamlink with static code analysis and an improved
plugin loading mechanism in the future. Plugins now define their matching URLs and priorities declaratively.
The old can_handle_url and priority classmethods have therefore been deprecated and will be removed in the future.
When side-loading plugins which don't implement the new @pluginmatcher but implement the old classmethods, a deprecation
message will be written to the info log output for the first plugin that gets resolved this way.
Plugins which have more sophisticated logic in their can_handle_url() classmethod need to be rewritten with
multiple @pluginmatcher decorators and/or an improved _get_streams() method which returns None or raises a
NoStreamsError when there are no streams to be found on that particular URL.
Streamlink's default config file paths got updated and corrected on Linux/BSD, macOS and Windows.
Old and deprecated paths will be dropped in the future.
Only the first existing config file will be loaded. If a config file gets loaded from a deprecated path,
a deprecation message will be written to the info log output.
To resolve this, move the config file(s) to the correct location or copy the contents of the old file(s) to the new one(s).
Please note that this also affects all plugin config files, as they use the same path as the primary config file but with
.pluginname appended to the file name, eg. config.twitch.
On Windows, when installing Streamlink via the Windows installer, a default config file gets created automatically due
to technical reasons (bundled ffmpeg and rtmpdump dependencies). This means that the Windows installer will create a
config file with the new name when upgrading from an earlier version to Streamlink 2.2.0+, and the old config file won't be
loaded as a result of this.
This is unfortunately a soft breaking change, as the Windows installer is not supposed to touch user config data and the
users are required to update this by themselves.