streamlink/docs/index.rst

Overview
--------

Streamlink is a :ref:`command-line utility <cli>` that pipes video streams
from various services into a video player, such as `VLC`_.
The main purpose of Streamlink is to allow the user to avoid buggy and CPU
heavy flash plugins but still be able to enjoy various streamed content.
There is also an :ref:`API <api_guide>` available for developers who want access
to the video stream data. This project was forked from Livestreamer, which is
no longer maintained.

- Latest release: |version| (https://github.com/streamlink/streamlink/releases/latest)
- GitHub: https://github.com/streamlink/streamlink
- Issue tracker: https://github.com/streamlink/streamlink/issues
- PyPI: https://pypi.org/project/streamlink/
- Free software: Simplified BSD license

Features
--------

Streamlink is built upon a plugin system which allows support for new services
to be easily added. Currently most of the big streaming services are supported,
such as:

- `Dailymotion <https://www.dailymotion.com/live>`_
- `Livestream <https://livestream.com/>`_
- `Twitch <https://www.twitch.tv/>`_
- `UStream <http://www.ustream.tv/explore/all>`_
- `YouTube <https://www.youtube.com/>`_

... and many more. A full list of plugins currently included can be found
on the :ref:`plugin_matrix` page.

Quickstart
----------

The default behaviour of Streamlink is to playback a stream in the default
player (`VLC <https://www.videolan.org/>`_).

.. sourcecode:: console

    # pip install streamlink
    $ streamlink twitch.tv/day9tv best
    [cli][info] Found matching plugin twitch for URL twitch.tv/day9tv
    [cli][info] Opening stream: source (hls)
    [cli][info] Starting player: vlc

For more in-depth usage and install instructions see the `User guide`_.

User guide
----------

Streamlink is made up of two parts, a :ref:`cli` and a library :ref:`API <api>`.
See their respective sections for more information on how to use them.

.. toctree::
    :maxdepth: 2

    install
    cli
    plugin_matrix
    players
    issues
    api_guide
    api
    changelog
    donate
    applications
    thirdparty
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00			`Overview`
			`--------`
Add some docs. 2012-08-24 02:28:42 +02:00
update references to livestreamer 2016-09-19 23:38:33 +02:00			Streamlink is a :ref:`command-line utility <cli>` that pipes video streams
docs: removed some notes, updated some urls removed hlsvariant:// documentation, hls:// is enough README.md - removed invalid note - update some URLs cli.rst - removed old note - added dash:// index.rst - update for https URLs install.rst - update for new Solus / Void URL - update for NixOS, found only this URL - update for Dependencies - PyPI URL update - removed old livestreamer issue ref 401 - use correct URL for Bintray changelog 2018-06-19 23:07:30 +02:00			from various services into a video player, such as `VLC`_.
update references to livestreamer 2016-09-19 23:38:33 +02:00			`The main purpose of Streamlink is to allow the user to avoid buggy and CPU`
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00			`heavy flash plugins but still be able to enjoy various streamed content.`
			There is also an :ref:`API <api_guide>` available for developers who want access
update references to livestreamer 2016-09-19 23:38:33 +02:00			`to the video stream data. This project was forked from Livestreamer, which is`
			`no longer maintained.`
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00
Modify the changelog link (#107) 2016-10-28 04:50:21 +02:00			`- Latest release: \|version\| (https://github.com/streamlink/streamlink/releases/latest)`
update references to livestreamer 2016-09-19 23:38:33 +02:00			`- GitHub: https://github.com/streamlink/streamlink`
			`- Issue tracker: https://github.com/streamlink/streamlink/issues`
docs: removed some notes, updated some urls removed hlsvariant:// documentation, hls:// is enough README.md - removed invalid note - update some URLs cli.rst - removed old note - added dash:// index.rst - update for https URLs install.rst - update for new Solus / Void URL - update for NixOS, found only this URL - update for Dependencies - PyPI URL update - removed old livestreamer issue ref 401 - use correct URL for Bintray changelog 2018-06-19 23:07:30 +02:00			`- PyPI: https://pypi.org/project/streamlink/`
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00			`- Free software: Simplified BSD license`
Add some docs. 2012-08-24 02:28:42 +02:00
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`Features`
			`--------`
Add some docs. 2012-08-24 02:28:42 +02:00
update references to livestreamer 2016-09-19 23:38:33 +02:00			`Streamlink is built upon a plugin system which allows support for new services`
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00			`to be easily added. Currently most of the big streaming services are supported,`
			`such as:`
Add some docs. 2012-08-24 02:28:42 +02:00
docs: removed some notes, updated some urls removed hlsvariant:// documentation, hls:// is enough README.md - removed invalid note - update some URLs cli.rst - removed old note - added dash:// index.rst - update for https URLs install.rst - update for new Solus / Void URL - update for NixOS, found only this URL - update for Dependencies - PyPI URL update - removed old livestreamer issue ref 401 - use correct URL for Bintray changelog 2018-06-19 23:07:30 +02:00			- `Dailymotion <https://www.dailymotion.com/live>`_
			- `Livestream <https://livestream.com/>`_
			- `Twitch <https://www.twitch.tv/>`_
			- `UStream <http://www.ustream.tv/explore/all>`_
			- `YouTube <https://www.youtube.com/>`_
Add some docs. 2012-08-24 02:28:42 +02:00
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00			`... and many more. A full list of plugins currently included can be found`
docs: Add a player page. 2014-07-19 16:48:07 +02:00			on the :ref:`plugin_matrix` page.
Add some docs. 2012-08-24 02:28:42 +02:00
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`Quickstart`
Add NixOS install instructions 2016-12-09 11:37:19 +01:00			`----------`
Add some docs. 2012-08-24 02:28:42 +02:00
update references to livestreamer 2016-09-19 23:38:33 +02:00			`The default behaviour of Streamlink is to playback a stream in the default`
docs: removed some notes, updated some urls removed hlsvariant:// documentation, hls:// is enough README.md - removed invalid note - update some URLs cli.rst - removed old note - added dash:// index.rst - update for https URLs install.rst - update for new Solus / Void URL - update for NixOS, found only this URL - update for Dependencies - PyPI URL update - removed old livestreamer issue ref 401 - use correct URL for Bintray changelog 2018-06-19 23:07:30 +02:00			player (`VLC <https://www.videolan.org/>`_).
Add some docs. 2012-08-24 02:28:42 +02:00
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`.. sourcecode:: console`
Add some docs. 2012-08-24 02:28:42 +02:00
update references to livestreamer 2016-09-19 23:38:33 +02:00			`# pip install streamlink`
			`$ streamlink twitch.tv/day9tv best`
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00			`[cli][info] Found matching plugin twitch for URL twitch.tv/day9tv`
docs: Make the tutorial a bit more noob friendly. 2014-09-05 20:23:06 +02:00			`[cli][info] Opening stream: source (hls)`
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`[cli][info] Starting player: vlc`
Add some docs. 2012-08-24 02:28:42 +02:00
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			For more in-depth usage and install instructions see the `User guide`_.
Add some docs. 2012-08-24 02:28:42 +02:00
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`User guide`
			`----------`
Add some docs. 2012-08-24 02:28:42 +02:00
update references to livestreamer 2016-09-19 23:38:33 +02:00			Streamlink is made up of two parts, a :ref:`cli` and a library :ref:`API <api>`.
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`See their respective sections for more information on how to use them.`
Add some docs. 2012-08-24 02:28:42 +02:00
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`.. toctree::`
			`:maxdepth: 2`
Add some docs. 2012-08-24 02:28:42 +02:00
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`install`
			`cli`
docs: Some tweaks and rewordings. 2014-07-12 13:12:40 +02:00			`plugin_matrix`
docs: Add a player page. 2014-07-19 16:48:07 +02:00			`players`
docs: Split common issues into a separate section. Also add info about a VLC bug. 2013-05-17 00:41:10 +02:00			`issues`
docs: Update to reflect API additions. 2014-06-06 18:18:01 +02:00			`api_guide`
Major restructuring of the docs. 2013-03-14 03:02:31 +01:00			`api`
Add a donation page (#578) * Add a donation page * Fix a typo that could cause tests to bomb * Switch to anonymous hyperlinks for typically duplicate links * Add beardypig * Fix underscore line length 2017-02-22 08:39:27 +01:00			`changelog`
			`donate`
docs: add an official streamlink applications list 2017-07-13 05:51:04 +02:00			`applications`
docs: add a third party applications list 2017-07-13 04:35:56 +02:00			`thirdparty`