mirror of
https://github.com/streamlink/streamlink
synced 2024-11-15 03:02:22 +01:00
Update docs.
This commit is contained in:
parent
977b890fb4
commit
c750c36f0e
27
docs/cli.rst
27
docs/cli.rst
@ -81,7 +81,7 @@ Player options
|
||||
The arguments passed to the player. These formatting
|
||||
variables are available: filename. Default is ``'{filename}'``
|
||||
|
||||
.. versionadded:: 1.6
|
||||
.. versionadded:: 1.6.0
|
||||
|
||||
.. cmdoption:: -q, --quiet-player
|
||||
|
||||
@ -103,17 +103,17 @@ Player options
|
||||
Make the player read the stream using HTTP
|
||||
(useful if your player can't read from stdin)
|
||||
|
||||
.. versionadded:: 1.6
|
||||
.. versionadded:: 1.6.0
|
||||
|
||||
.. cmdoption:: --player-continuous-http
|
||||
|
||||
Make the player read the stream using HTTP, but unlike
|
||||
--player-http will continuously try to open the stream
|
||||
``--player-http`` will continuously try to open the stream
|
||||
if the player requests it. This makes it possible to
|
||||
handle stream disconnects if your player is capable of
|
||||
reconnecting to a HTTP stream, e.g ``'vlc --repeat'``
|
||||
|
||||
.. versionadded:: 1.6
|
||||
.. versionadded:: 1.6.0
|
||||
|
||||
.. cmdoption:: --player-passthrough types
|
||||
|
||||
@ -122,7 +122,7 @@ Player options
|
||||
sure your player can handle the stream type when using this.
|
||||
Supported stream types are: ``hls``, ``http``, ``rtmp``
|
||||
|
||||
.. versionadded:: 1.6
|
||||
.. versionadded:: 1.6.0
|
||||
|
||||
|
||||
File output options
|
||||
@ -212,12 +212,23 @@ Plugin options
|
||||
expression with a comma. For example ``>480p,>mobile_medium``
|
||||
will exclude streams from two quality types.
|
||||
|
||||
.. cmdoption:: --jtv-cookie cookie, --twitch-cookie cookie
|
||||
|
||||
.. cmdoption:: --jtv-cookie cookie
|
||||
|
||||
Specify JustinTV cookie to allow access to
|
||||
Specify Twitch/Justin.tv cookies to allow access to
|
||||
subscription channels, e.g ``'_twitch_session_id=xxxxxx; persistent=xxxxx;'``
|
||||
|
||||
.. cmdoption:: --jtv-legacy-names, --twitch-legacy-names
|
||||
|
||||
Use the old stream names, e.g 720p, 1080p+.
|
||||
|
||||
.. versionadded:: 1.6.0
|
||||
|
||||
.. cmdoption:: --jtv-password password, --twitch-password password
|
||||
|
||||
Use this to access password protected streams.
|
||||
|
||||
.. versionadded:: 1.6.0
|
||||
|
||||
.. cmdoption:: --gomtv-cookie cookie
|
||||
|
||||
Specify GOMTV cookie to allow access to streams,
|
||||
|
@ -1,10 +1,10 @@
|
||||
.. _install:
|
||||
|
||||
Installation
|
||||
============
|
||||
Installing
|
||||
==========
|
||||
|
||||
Unix-like operating systems
|
||||
---------------------------
|
||||
Source
|
||||
------
|
||||
|
||||
The latest stable version is available to install using `pip <http://www.pip-installer.org/>`_:
|
||||
|
||||
@ -20,22 +20,18 @@ But you can also get the development version using `Git <http://git-scm.com/>`_:
|
||||
$ cd livestreamer
|
||||
# python setup.py install
|
||||
|
||||
Windows
|
||||
-------
|
||||
|
||||
Livestreamer is primarily developed for Unix-like operating systems where using a CLI is common. There is however an installer available for brave Windows users who don't mind using the command prompt.
|
||||
|
||||
The installer can be `downloaded from Github <https://github.com/chrippa/livestreamer/releases>`_. It contains a precompiled version of Livestreamer that does not require you to install any of the dependencies.
|
||||
`The Hitchhiker’s Guide to Python <http://docs.python-guide.org/>`_ has guides
|
||||
helping you install Python + pip on the most common operating systems.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
^^^^^^^^^^^^
|
||||
|
||||
Livestreamer currently depends on these libraries/programs to function.
|
||||
|
||||
To run the setup script you need:
|
||||
|
||||
- `Python <http://python.org/>`_ (at least version 2.6) or `PyPy <http://pypy.org/>`_
|
||||
- `python-setuptools <http://pypi.python.org/pypi/setuptools>`_ or `python-distribute <http://pypi.python.org/pypi/distribute>`_
|
||||
- `python-setuptools <http://pypi.python.org/pypi/setuptools>`_
|
||||
|
||||
|
||||
These will be installed automatically by the setup script if they are missing:
|
||||
@ -44,7 +40,7 @@ These will be installed automatically by the setup script if they are missing:
|
||||
- `python-requests <http://docs.python-requests.org/>`_ (at least version 1.0)
|
||||
|
||||
Optional dependencies
|
||||
---------------------
|
||||
^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
For RTMP based plugins:
|
||||
|
||||
@ -54,3 +50,20 @@ For decrypting encrypted HLS streams:
|
||||
|
||||
- `PyCrypto <https://www.dlitz.net/software/pycrypto/>`_
|
||||
|
||||
For full UStream.tv support:
|
||||
|
||||
- `python-librtmp <https://github.com/chrippa/python-librtmp>`_
|
||||
|
||||
Packages
|
||||
--------
|
||||
|
||||
Livestreamer is also available in the official package repositories for
|
||||
`Arch Linux <https://www.archlinux.org/packages/community/any/livestreamer/>`_
|
||||
and `OpenBSD <http://openports.se/multimedia/livestreamer>`_.
|
||||
|
||||
Windows
|
||||
^^^^^^^
|
||||
Livestreamer is primarily developed for Unix-like operating systems where using a CLI is common. There is however a installer available for brave Windows users who don't mind using the command prompt.
|
||||
|
||||
The installer can be `downloaded from Github <https://github.com/chrippa/livestreamer/releases>`_. It contains a precompiled version of Livestreamer that does not require you to install any of the dependencies.
|
||||
|
||||
|
@ -204,14 +204,14 @@ class Plugin(object):
|
||||
.. versionchanged:: 1.4.2
|
||||
Added *priority* parameter.
|
||||
|
||||
.. versionchanged:: 1.5
|
||||
.. versionchanged:: 1.5.0
|
||||
Renamed *priority* to *stream_types* and changed behaviour
|
||||
slightly.
|
||||
|
||||
.. versionchanged:: 1.5
|
||||
.. versionchanged:: 1.5.0
|
||||
Added *sorting_excludes* parameter.
|
||||
|
||||
.. versionchanged:: 1.6
|
||||
.. versionchanged:: 1.6.0
|
||||
*sorting_excludes* can now be a list of filter expressions
|
||||
or a function that is passed to filter().
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user