2021-07-01 12:02:49 +02:00
|
|
|
|
Deprecations
|
|
|
|
|
|
============
|
|
|
|
|
|
|
2021-10-28 16:33:21 +02:00
|
|
|
|
streamlink next
|
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
|
|
Removal of separate https-proxy option
|
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
|
|
:ref:`HTTPS proxy CLI option <cli:HTTP options>` and the respective :ref:`Session options <api:Session>`
|
|
|
|
|
|
have been deprecated in favor of a single :option:`--http-proxy` that sets the proxy for all HTTP and
|
|
|
|
|
|
HTTPS requests, including WebSocket connections.
|
|
|
|
|
|
|
session: deprecate options for spec. stream types
Having multiple session options and CLI arguments for different stream
types which are already covered by generic options/arguments is not only
redundant, but also confusing.
A distinction between different stream types does only make sense when
multiple different stream types are available and the user needs to
explicitly set different values for each of them, but since it's not
always clear which stream type is returned when a stream is selected
via the "best" stream name synonym for example, this makes it even more
confusing. And it's redundant as well, since only one stream can be
selected anyway.
- deprecate `{dash,hds,hls}-segment-attempts`
in favor of `stream-segment-attempts`
- deprecate `{dash,hds,hls}-segment-threads`
in favor of `stream-segment-threads`
- deprecate `{dash,hds,hls}-segment-timeout`
in favor of `stream-segment-timeout`
- deprecate `{dash,hds,hls,rtmp,http-stream}-timeout`
in favor of `stream-timeout` (dash/http-stream were never used)
- fix `HTTPStream` and use `stream-timeout` instead of `http-timeout`
- suppress deprecated CLI arguments
- update help texts of generic CLI arguments
- fix docs and add entry to deprecations page
2021-07-30 22:34:22 +02:00
|
|
|
|
streamlink 2.4.0
|
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
|
|
Stream-type related CLI arguments
|
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
|
|
:ref:`Stream-type related CLI arguments <cli:Stream transport options>` and the respective :ref:`Session options <api:Session>`
|
|
|
|
|
|
have been deprecated in favor of existing generic arguments/options, to avoid redundancy and potential confusion.
|
|
|
|
|
|
|
|
|
|
|
|
- use :option:`--stream-segment-attempts` instead of ``--{dash,hds,hls}-segment-attempts``
|
|
|
|
|
|
- use :option:`--stream-segment-threads` instead of ``--{dash,hds,hls}-segment-threads``
|
|
|
|
|
|
- use :option:`--stream-segment-timeout` instead of ``--{dash,hds,hls}-segment-timeout``
|
|
|
|
|
|
- use :option:`--stream-timeout` instead of ``--{dash,hds,hls,rtmp,http-stream}-timeout``
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-07-18 19:10:37 +02:00
|
|
|
|
streamlink 2.3.0
|
|
|
|
|
|
----------------
|
2021-07-01 12:02:49 +02:00
|
|
|
|
|
|
|
|
|
|
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**
|
|
|
|
|
|
|
|
|
|
|
|
.. code-block:: python
|
|
|
|
|
|
|
|
|
|
|
|
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**
|
|
|
|
|
|
|
|
|
|
|
|
.. code-block:: python
|
|
|
|
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
|
|
2021-07-18 19:10:37 +02:00
|
|
|
|
streamlink 2.2.0
|
|
|
|
|
|
----------------
|
2021-07-01 12:02:49 +02:00
|
|
|
|
|
|
|
|
|
|
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**
|
|
|
|
|
|
|
|
|
|
|
|
.. rst-class:: table-custom-layout table-custom-layout-platform-locations
|
|
|
|
|
|
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Platform Location
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Linux/BSD - ``${HOME}/.streamlinkrc``
|
|
|
|
|
|
macOS - ``${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config``
|
|
|
|
|
|
- ``${HOME}/.streamlinkrc``
|
|
|
|
|
|
Windows - ``%APPDATA%\streamlink\streamlinkrc``
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
|
|
|
|
|
|
**Migration**
|
|
|
|
|
|
|
|
|
|
|
|
.. rst-class:: table-custom-layout table-custom-layout-platform-locations
|
|
|
|
|
|
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Platform Location
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Linux/BSD ``${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config``
|
|
|
|
|
|
macOS ``${HOME}/Library/Application Support/streamlink/config``
|
|
|
|
|
|
Windows ``%APPDATA%\streamlink\config``
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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**
|
|
|
|
|
|
|
|
|
|
|
|
.. rst-class:: table-custom-layout table-custom-layout-platform-locations
|
|
|
|
|
|
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Platform Location
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Linux/BSD ``${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins``
|
|
|
|
|
|
macOS ``${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins``
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
|
|
|
|
|
|
**Migration**
|
|
|
|
|
|
|
|
|
|
|
|
.. rst-class:: table-custom-layout table-custom-layout-platform-locations
|
|
|
|
|
|
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Platform Location
|
|
|
|
|
|
========= ========
|
|
|
|
|
|
Linux/BSD ``${XDG_DATA_HOME:-${HOME}/.local/share}/streamlink/plugins``
|
|
|
|
|
|
macOS ``${HOME}/Library/Application Support/streamlink/plugins``
|
|
|
|
|
|
========= ========
|