You are reading the documentation for the in-development version of Streamlink.
Deprecations¶
streamlink 6.7.0¶
--plugin-dirs¶
The --plugin-dirs CLI argument for sideloading plugins from one or more custom directories, separated by commas,
has been deprecated in favor of the newly added --plugin-dir CLI argument, which only takes a single path,
but can be set multiple times for loading plugins from more than one path.
streamlink 6.6.0¶
HTTPSession and HTTPAdapters¶
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.{get,load}_plugins()¶
As a result of the code refactoring mentioned above, the following plugins-related methods
on the Streamlink session class have been deprecated:
Streamlink.get_plugins() has been deprecated in favor of
Streamlink.plugins.get_loaded().
Streamlink.load_plugins(path) has been deprecated in favor of
Streamlink.plugins.load_path(path).
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.
streamlink 5.4.0¶
--force-progress¶
The --force-progress CLI argument has been deprecated in favor of --progress=force.
streamlink 5.3.0¶
Global plugin arguments¶
The is_global=True plugin argument 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.
streamlink 5.2.0¶
plugin.api.validate.text¶
The plugin.api.validate.text alias for str has been marked as deprecated, as it is a remnant of the py2 implementation.
Simply replace validate.text with str in each validation schema.
streamlink 5.0.0¶
Plugin.__init__(self, url) compatibility wrapper¶
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.
streamlink 4.2.0¶
url_master in HLSStream¶
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.
streamlink 3.0.0¶
https-proxy option¶
HTTPS proxy CLI option and the respective Session options
have been deprecated in favor of a single --http-proxy that sets the proxy for all HTTP and
HTTPS requests, including WebSocket connections.
streamlink 2.4.0¶
streamlink 2.3.0¶
Plugin.can_handle_url() and Plugin.priority()¶
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.
Deprecated plugin URL matching
import re
from streamlink.plugin import Plugin
from streamlink.plugin.plugin import HIGH_PRIORITY, NORMAL_PRIORITY
class MyPlugin(Plugin):
_re_url_one = re.compile(
r"https?://pattern-(?P<param>one)"
)
_re_url_two = re.compile(r"""
https?://pattern-(?P<param>two)
""", re.VERBOSE)
@classmethod
def can_handle_url(cls, url: str) -> bool:
return cls._re_url_one.match(url) is not None \
or cls._re_url_two.match(url) is not None
@classmethod
def priority(cls, url: str) -> int:
if cls._re_url_two.match(url) is not None:
return HIGH_PRIORITY
else:
return NORMAL_PRIORITY
def _get_streams(self):
match_one = self._re_url_one.match(self.url)
match_two = self._re_url_two.match(self.url)
match = match_one or match_two
param = match.group("param")
if match_one:
yield ...
elif match_two:
yield ...
__plugin__ = MyPlugin
Migration
import re
from streamlink.plugin import HIGH_PRIORITY, Plugin, pluginmatcher
@pluginmatcher(re.compile(
r"https?://pattern-(?P<param>one)"
))
@pluginmatcher(priority=HIGH_PRIORITY, pattern=re.compile(r"""
https?://pattern-(?P<param>two)
""", re.VERBOSE))
class MyPlugin(Plugin):
def _get_streams(self):
param = self.match.group("param")
if self.matches[0]:
yield ...
elif self.matches[1]:
yield ...
__plugin__ = MyPlugin
Note
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 2.2.0¶
Config file paths¶
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).
Note
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.
Warning
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.
Deprecated paths
Platform |
Location |
|---|---|
Linux/BSD |
|
macOS |
|
Windows |
|
Migration
Platform |
Location |
|---|---|
Linux/BSD |
|
macOS |
|
Windows |
|
Custom plugins sideloading paths¶
Streamlink's default custom plugins directory path got updated and corrected on Linux/BSD and macOS. Old and deprecated paths will be dropped in the future.
Deprecated paths
Platform |
Location |
|---|---|
Linux/BSD |
|
macOS |
|
Migration
Platform |
Location |
|---|---|
Linux/BSD |
|
macOS |
|