Contents Menu Expand Light mode Dark mode Auto light/dark mode
Streamlink 5.3.1 documentation
Streamlink

Streamlink

A command-line utility that extracts streams from various services and pipes them into a video player of choice.

5.3.1
Stable
Latest
  • Overview
  • Installation
  • Command-Line Interface
    • Command-line usage
    • Tutorial
    • Configuration file
    • Plugin sideloading
    • Streaming protocols
    • Proxy support
    • Metadata
    • Plugin specific usage
      • Crunchyroll
      • Twitch
  • Plugins
  • Players
  • Common issues
  • Deprecations
  • Developing
  • API Guide
  • API Reference
  • Changelog
  • Donating
  • Streamlink Applications
  • Third Party Applications
Github Issues
Back to top
Edit this page

Streamlink#

Overview#

Streamlink is a command-line utility which pipes video streams from various services into a video player, such as VLC. The main purpose of Streamlink is to avoid resource-heavy and unoptimized websites, while still allowing the user to enjoy various streamed content. There is also an API available for developers who want access to the stream data.

This project was forked from Livestreamer, which is no longer maintained.

Latest release (5.3.1)

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. Most of the big streaming services are supported, such as:

  • Twitch.tv

  • YouTube.com

  • Livestream.com

  • Dailymotion.com

... and many more. A full list of plugins currently included can be found on the Plugins page.

Quickstart#

The default behavior of Streamlink is to play back streams in the VLC player.

$ streamlink twitch.tv/day9tv best
[cli][info] Found matching plugin twitch for URL twitch.tv/day9tv
[cli][info] Available streams: audio_only, 160p (worst), 360p, 480p, 720p, 720p60, 1080p60 (best)
[cli][info] Opening stream: 1080p60 (hls)
[cli][info] Starting player: vlc

For more in-depth usage and install instructions, please refer to the User guide.

User guide#

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

Thank you#

  • Github, for hosting the git repo, docs, release assets and providing CI tools

  • Netlify, for hosting docs preview builds

  • Whatismybrowser, for the access to their user-agents API in our CI workflows

Table of contents#

  • Overview
  • Installation
    • Windows
    • macOS
    • Linux and BSD
    • Package maintainers
    • Package availability
    • PyPI package and source code
    • Virtual environment
    • Dependencies
    • Windows binaries
    • Linux AppImages
  • Command-Line Interface
    • Command-line usage
    • Tutorial
    • Configuration file
    • Plugin sideloading
    • Streaming protocols
    • Proxy support
    • Metadata
    • Plugin specific usage
    • Command-line usage
  • Plugins
    • abematv
    • adultswim
    • afreeca
    • albavision
    • aloula
    • app17
    • ard_live
    • ard_mediathek
    • artetv
    • atpchallenger
    • atresplayer
    • bbciplayer
    • bfmtv
    • bigo
    • bilibili
    • blazetv
    • bloomberg
    • booyah
    • brightcove
    • btv
    • cbsnews
    • cdnbg
    • ceskatelevize
    • cinergroup
    • clubbingtv
    • cmmedia
    • cnews
    • crunchyroll
    • dailymotion
    • delfi
    • deutschewelle
    • dlive
    • dogan
    • dogus
    • drdk
    • earthcam
    • euronews
    • facebook
    • filmon
    • foxtr
    • galatasaraytv
    • goltelevision
    • goodgame
    • googledrive
    • gulli
    • hiplayer
    • htv
    • huajiao
    • huya
    • idf1
    • invintus
    • kugou
    • linelive
    • livestream
    • lnk
    • lrt
    • ltv_lsm_lv
    • mdstrm
    • mediaklikk
    • mediavitrina
    • mildom
    • mitele
    • mixcloud
    • mjunoon
    • mrtmk
    • n13tv
    • nbcnews
    • nhkworld
    • nicolive
    • nimotv
    • nos
    • nownews
    • nrk
    • ntv
    • okru
    • olympicchannel
    • oneplusone
    • onetv
    • openrectv
    • pandalive
    • picarto
    • piczel
    • pixiv
    • pluto
    • pluzz
    • qq
    • radiko
    • radionet
    • raiplay
    • reuters
    • rtbf
    • rtpa
    • rtpplay
    • rtve
    • rtvs
    • ruv
    • sbscokr
    • showroom
    • sportal
    • sportschau
    • ssh101
    • stadium
    • steam
    • streamable
    • streann
    • stv
    • svtplay
    • swisstxt
    • telefe
    • tf1
    • trovo
    • turkuvaz
    • tv360
    • tv3cat
    • tv4play
    • tv5monde
    • tv8
    • tv999
    • tvibo
    • tviplayer
    • tvp
    • tvrby
    • tvrplus
    • tvtoya
    • twitcasting
    • twitch
    • useetv
    • ustreamtv
    • ustvnow
    • vidio
    • vimeo
    • vinhlongtv
    • vk
    • vkplay
    • vlive
    • vtvgo
    • wasd
    • webtv
    • welt
    • wwenetwork
    • youtube
    • yupptv
    • zattoo
    • zdf_mediathek
    • zeenews
    • zengatv
    • zhanqi
  • Players
    • Transport modes
    • Player compatibility
    • Known issues and workarounds
  • Common issues
    • Streams are buffering/lagging
  • Deprecations
    • streamlink 5.3.0
    • streamlink 5.2.0
    • streamlink 5.0.0
    • streamlink 4.2.0
    • streamlink 4.0.0
    • streamlink 3.0.0
    • streamlink 2.4.0
    • streamlink 2.3.0
    • streamlink 2.2.0
  • Developing
    • Setup
    • Validating changes
    • Code style
    • Plugins
  • API Guide
    • Extracting streams
    • Opening streams to read data
    • Inspecting streams
    • Session object
  • API Reference
    • Streamlink
    • Session
    • Plugins
    • Streams
    • Exceptions
  • Changelog
    • streamlink 5.3.1 (2023-02-25)
    • streamlink 5.3.0 (2023-02-18)
    • streamlink 5.2.1 (2023-01-23)
    • streamlink 5.2.0 (2023-01-23)
    • streamlink 5.1.2 (2022-12-03)
    • streamlink 5.1.1 (2022-11-23)
    • streamlink 5.1.0 (2022-11-14)
    • streamlink 5.0.1 (2022-09-22)
    • streamlink 5.0.0 (2022-09-16)
    • streamlink 4.3.0 (2022-08-15)
    • streamlink 4.2.0 (2022-07-09)
    • streamlink 4.1.0 (2022-05-30)
    • streamlink 4.0.1 (2022-05-01)
    • streamlink 4.0.0 (2022-05-01)
    • streamlink 3.2.0 (2022-03-05)
    • streamlink 3.1.1 (2022-01-25)
    • streamlink 3.1.0 (2022-01-22)
    • streamlink 3.0.3 (2021-11-27)
    • streamlink 3.0.2 (2021-11-25)
    • streamlink 3.0.1 (2021-11-17)
    • streamlink 3.0.0 (2021-11-17)
    • streamlink 2.4.0 (2021-09-07)
    • streamlink 2.3.0 (2021-07-26)
    • streamlink 2.2.0 (2021-06-19)
    • streamlink 2.1.2 (2021-05-20)
    • streamlink 2.1.1 (2021-03-25)
    • streamlink 2.1.0 (2021-03-22)
    • streamlink 2.0.0 (2020-12-22)
    • streamlink 1.7.0 (2020-10-18)
    • streamlink 1.6.0 (2020-09-22)
    • streamlink 1.5.0 (2020-07-07)
    • streamlink 1.4.1 (2020-04-24)
    • streamlink 1.4.0 (2020-04-22)
    • streamlink 1.3.1 (2020-01-27)
    • streamlink 1.3.0 (2019-11-22)
    • streamlink 1.2.0 (2019-08-18)
    • streamlink 1.1.1 (2019-04-02)
    • streamlink 1.1.0 (2019-03-31)
    • streamlink 1.0.0 (2019-01-30)
    • streamlink 0.14.2 (2018-06-28)
    • streamlink 0.14.0 (2018-06-26)
    • streamlink 0.13.0 (2018-06-06)
    • streamlink 0.12.1 (2018-05-07)
    • streamlink 0.12.0 (2018-05-07)
    • streamlink 0.11.0 (2018-03-08)
    • streamlink 0.10.0 (2018-01-23)
    • streamlink 0.9.0 (2017-11-14)
    • streamlink 0.8.1 (2017-09-12)
    • streamlink 0.7.0 (2017-06-30)
    • streamlink 0.6.0 (2017-05-11)
    • streamlink 0.5.0 (2017-04-04)
    • streamlink 0.4.0 (2017-03-09)
    • streamlink 0.3.2 (2017-02-10)
    • streamlink 0.3.1 (2017-02-03)
    • streamlink 0.3.0 (2017-01-24)
    • streamlink 0.2.0 (2016-12-16)
    • streamlink 0.1.0 (2016-11-21)
    • streamlink 0.0.2 (2016-10-12)
    • streamlink 0.0.1 (2016-09-23)
  • Donating
    • Team members
    • Useful links
  • Streamlink Applications
    • Streamlink Twitch GUI
  • Third Party Applications
    • LiveProxy
    • Wtwitch
    • OBS-Streamlink
Next
Installation
Copyright © 2023, Streamlink
Made with Sphinx and @pradyunsg's Furo
On this page
  • Streamlink
    • Overview
    • Features
    • Quickstart
    • User guide
    • Thank you
    • Table of contents