1STREAMLINK(1) Streamlink STREAMLINK(1)
2
6 streamlink - extracts streams from various services and pipes them into
7 a video player of choice
8
10 streamlink [OPTIONS] <URL> [STREAM]
11
13 streamlink --loglevel debug youtu.be/VIDEO-ID best
14 streamlink --player mpv --player-args '--no-border --no-keepaspect-window' twitch.tv/CHANNEL 1080p60
15 streamlink --player-external-http --player-external-http-port 8888 URL STREAM
16 streamlink --output /path/to/file --http-timeout 60 URL STREAM
17 streamlink --stdout URL STREAM | ffmpeg -i pipe:0 ...
18 streamlink --http-header 'Authorization=OAuth TOKEN' --http-header 'Referer=URL' URL STREAM
19 streamlink --hls-live-edge 5 --stream-segment-threads 5 'hls://https://host/playlist.m3u8' best
20 streamlink --twitch-low-latency -p mpv -a '--cache=yes --demuxer-max-back-bytes=2G' twitch.tv/CHANNEL best
21
23 Positional arguments
24 URL A URL to attempt to extract streams from.
25 Usually, the protocol of http(s) URLs can be omitted (https://),
27 depending on the implementation of the plugin being used.
28 Alternatively, the URL can also be specified by using the --url
30 option.
31 STREAM Stream to play.
33 Use best or worst for selecting the highest or lowest available
35 quality.
36 Fallback streams can be specified by using a comma-separated
38 list:
39 "720p,480p,best"
41 If no stream is specified and --default-stream is not used, then
43 a list of available streams will be printed.
44 General options
46 -h
47 --help Show this help message and exit.
49 -V
51 --version
53 Show version number and exit.
54 --plugins
56 Print a list of all currently installed plugins.
57 --plugin-dirs DIRECTORY
59 Attempts to load plugins from these directories.
60 Multiple directories can be used by separating them with a
62 comma.
63 --can-handle-url URL
65 Check if Streamlink has a plugin that can handle the specified
66 URL.
67 Returns status code 1 for false and 0 for true.
69 Useful for external scripting.
71 --can-handle-url-no-redirect URL
73 Same as --can-handle-url but without following redirects when
74 looking up the URL.
75 --config FILENAME
77 Load options from this config file.
78 Can be repeated to load multiple files, in which case the op‐
80 tions are merged on top of each other where the last config has
81 highest priority.
82 -l LEVEL
84 --loglevel LEVEL
86 Set the log message threshold.
87 Valid levels are: none, error, warning, info, debug, trace, all
89 --logfile FILE
91 Append log output to FILE instead of writing to stdout/stderr.
92 User prompts and download progress won't be written to FILE.
94 A value of - (dash) will set the file name to an ISO8601-like
96 string and will choose the following default log directories.
97 Windows:
99 %TEMP%\streamlink\logs
101 macOS:
103 ${HOME}/Library/Logs/streamlink
105 Linux/BSD:
107 ${XDG_STATE_HOME:-${HOME}/.local/state}/streamlink/logs
109 -Q
111 --quiet
113 Hide all log output.
114 Alias for --loglevel none.
116 -j
118 --json Output JSON representations instead of the normal text output.
120 Useful for external scripting.
122 --auto-version-check {yes,true,1,on,no,false,0,off}
124 Enable or disable the automatic check for a new version of
125 Streamlink.
126 Default is: "no".
128 --version-check
130 Runs a version check and exits.
131 --locale LOCALE
133 The preferred locale setting, for selecting the preferred subti‐
134 tle and audio language.
135 The locale is formatted as [language_code]_[country_code], eg.
137 en_US or es_ES.
138 Default is: system locale.
140 --interface INTERFACE
142 Set the network interface.
143 -4
145 --ipv4 Resolve address names to IPv4 only. This option overrides
147 --ipv6.
148 -6
150 --ipv6 Resolve address names to IPv6 only. This option overrides
152 --ipv4.
153 Player options
155 -p COMMAND
156 --player COMMAND
158 Player to feed stream data to. By default, VLC will be used if
159 it can be found in its default location.
160 This is a shell-like syntax to support using a specific player:
162 streamlink --player=vlc <url> [stream]
164 Absolute or relative paths can also be passed via this option in
166 the event the player's executable can not be resolved:
167 streamlink --player=/path/to/vlc <url> [stream]
169 streamlink --player=./vlc-player/vlc <url> [stream]
170 To use a player that is located in a path with spaces you must
172 quote the parameter or its value:
173 streamlink "--player=/path/with spaces/vlc" <url> [stream]
175 streamlink --player "C:\path\with spaces\mpc-hc64.exe" <url> [stream]
176 Options may also be passed to the player. For example:
178 streamlink --player "vlc --file-caching=5000" <url> [stream]
180 As an alternative to this, see the --player-args parameter,
182 which does not log any custom player arguments.
183 -a ARGUMENTS
185 --player-args ARGUMENTS
187 This option allows you to customize the default arguments which
188 are put together with the value of --player to create a command
189 to execute.
190 It's usually enough to only use --player instead of this unless
192 you need to add arguments after the player's input argument or
193 if you don't want any of the player arguments to be logged.
194 The value can contain formatting variables surrounded by curly
196 braces, { and }. If you need to include a brace character, it
197 can be escaped by doubling, e.g. {{ and }}.
198 Formatting variables available:
200 {playerinput}
202 This is the input that the player will use. For standard
203 input (stdin), it is - (dash), but it can also be a URL,
204 depending on the options used.
205 {filename}
207 The old fallback variable name with the same functional‐
208 ity.
209 Example:
211 streamlink -p vlc -a "--play-and-exit {playerinput}" <url> [stream]
213 NOTE:
215 When neither of the variables are found, {playerinput} will
216 be appended to the whole parameter value, to ensure that the
217 player always receives an input argument.
218 -v
220 --verbose-player
222 Allow the player to display its console output.
223 -n
225 --player-fifo
227 --fifo Make the player read the stream through a named pipe instead of
229 the stdin pipe.
230 --player-http
232 Make the player read the stream through HTTP instead of the
233 stdin pipe.
234 --player-continuous-http
236 Make the player read the stream through HTTP, but unlike
237 --player-http it will continuously try to open the stream if the
238 player requests it.
239 This makes it possible to handle stream disconnects if your
241 player is capable of reconnecting to a HTTP stream. This is usu‐
242 ally done by setting your player to a "repeat mode".
243 --player-external-http
245 Serve stream data through HTTP without running any player. This
246 is useful to allow external devices like smartphones or stream‐
247 ing boxes to watch streams they wouldn't be able to otherwise.
248 The default behavior is similar to the --player-continuous-http
250 option, but no player program will be started, and the server
251 will listen on all available connections instead of just in the
252 local (loopback) interface.
253 Optionally, the --player-external-http-continuous option allows
255 for disabling the continuous run-mode, so that Streamlink will
256 stop when the stream ends.
257 The URLs that can be used to access the stream will be printed
259 to the console, and the server can be interrupted using CTRL-C.
260 --player-external-http-continuous {yes,true,1,on,no,false,0,off}
262 Set the run-mode of --player-external-http to continuous or
263 non-continuous.
264 In the continuous run-mode, Streamlink will keep running after
266 the stream has ended and will wait for the next HTTP request be‐
267 ing made unless it gets shut down via CTRL-C.
268 If set to non-continuous, Streamlink will stop once the stream
270 has ended.
271 Default is: true.
273 --player-external-http-port PORT
275 A fixed port to use for the external HTTP server if that mode is
276 enabled. Omit or set to 0 to use a random high ( >1024) port.
277 --player-passthrough TYPES
279 A comma-delimited list of stream types to pass to the player as
280 a URL to let it handle the transport of the stream instead.
281 Stream types that can be converted into a playable URL are:
283 • hls
285 • http
287 Make sure your player can handle the stream type when using
289 this.
290 --player-no-close
292 By default Streamlink will close the player when the stream
293 ends. This is to avoid "dead" GUI players lingering after a
294 stream ends.
295 It does however have the side-effect of sometimes closing a
297 player before it has played back all of its cached data.
298 This option will instead let the player decide when to exit.
300 -t TITLE
302 --title TITLE
304 Change the title of the video player's window.
305 Please see the "Metadata variables" section of Streamlink's CLI
307 documentation for all available metadata variables.
308 This option is only supported for the following players: mpv,
310 potplayer, vlc
311 VLC specific information:
313 VLC does support special formatting variables on its own:
314 https://wiki.videolan.org/Documentation:Format_String/
315 These variables are accessible in the --title option by
317 adding a backslash in front of the dollar sign which VLC
318 uses as its formatting character.
319 For example, to put the current date in your VLC window
321 title, the string \$A could be inserted inside the
322 --title string.
323 Example:
325 streamlink -p mpv --title "{author} - {category} - {title}" <URL> [STREAM]
327 File output options
329 -o FILENAME
330 --output FILENAME
332 Write stream data to FILENAME instead of playing it. If FILENAME
333 is set to - (dash), then the stream data will be written to std‐
334 out, similar to the --stdout argument.
335 Non-existent directories and subdirectories will be created if
337 they do not exist, if filesystem permissions allow.
338 You will be prompted if the file already exists.
340 Please see the "Metadata variables" section of Streamlink's CLI
342 documentation for all available metadata variables.
343 Unsupported characters in substituted variables will be replaced
345 with an underscore.
346 Example:
348 streamlink --output "~/recordings/{author}/{category}/{id}-{time:%Y%m%d%H%M%S}.ts" <URL> [STREAM]
350 -f
352 --force
354 When using --output or --record, always write to file even if it
355 already exists (overwrite).
356 --force-progress
358 When using --output or --record, show the download progress bar
359 even if there is no terminal.
360 -O
362 --stdout
364 Write stream data to stdout instead of playing it.
365 -r FILENAME
367 --record FILENAME
369 Open the stream in the player, while at the same time writing it
370 to FILENAME. If FILENAME is set to - (dash), then the stream
371 data will be written to stdout, similar to the --stdout argu‐
372 ment, while still opening the player.
373 Non-existent directories and subdirectories will be created if
375 they do not exist, if filesystem permissions allow.
376 You will be prompted if the file already exists.
378 Please see the "Metadata variables" section of Streamlink's CLI
380 documentation for all available metadata variables.
381 Unsupported characters in substituted variables will be replaced
383 with an underscore.
384 Example:
386 streamlink --record "~/recordings/{author}/{category}/{id}-{time:%Y%m%d%H%M%S}.ts" <URL> [STREAM]
388 -R FILENAME
390 --record-and-pipe FILENAME
392 Write stream data to stdout, while at the same time writing it
393 to FILENAME.
394 Non-existent directories and subdirectories will be created if
396 they do not exist, if filesystem permissions allow.
397 You will be prompted if the file already exists.
399 Please see the "Metadata variables" section of Streamlink's CLI
401 documentation for all available metadata variables.
402 Unsupported characters in substituted variables will be replaced
404 with an underscore.
405 Example:
407 streamlink --record-and-pipe "~/recordings/{author}/{category}/{id}-{time:%Y%m%d%H%M%S}.ts" <URL> [STREAM]
409 --fs-safe-rules
411 The rules used to make formatting variables filesystem-safe are
412 chosen automatically according to the type of system in use.
413 This overrides the automatic detection.
414 Intended for use when Streamlink is running on a UNIX-like OS
416 but writing to Windows filesystems such as NTFS; USB devices us‐
417 ing VFAT or exFAT; CIFS shares that are enforcing Windows file‐
418 name limitations, etc.
419 These characters are replaced with an underscore for the rules
421 in use:
422 • POSIX: \x00-\x1F /
424 • Windows: \x00-\x1F \x7F " * / : < > ? \ |
426 Stream options
428 --url URL
429 A URL to attempt to extract streams from.
430 Usually, the protocol of http(s) URLs can be omitted (https://),
432 depending on the implementation of the plugin being used.
433 This is an alternative to setting the URL using a positional ar‐
435 gument and can be useful if set in a config file.
436 --default-stream STREAM
438 Stream to play.
439 Use best or worst for selecting the highest or lowest available
441 quality.
442 Fallback streams can be specified by using a comma-separated
444 list:
445 "720p,480p,best"
447 This is an alternative to setting the stream using a positional
449 argument and can be useful if set in a config file.
450 --stream-url
452 If possible, translate the resolved stream to a URL and print
453 it.
454 --retry-streams DELAY
456 Retry fetching the list of available streams until streams are
457 found while waiting DELAY second(s) between each attempt. If un‐
458 set, only one attempt will be made to fetch the list of streams
459 available.
460 The number of fetch retry attempts can be capped with
462 --retry-max.
463 --retry-max COUNT
465 When using --retry-streams, stop retrying the fetch after COUNT
466 retry attempt(s). Fetch will retry infinitely if COUNT is zero
467 or unset.
468 If --retry-max is set without setting --retry-streams, the delay
470 between retries will default to 1 second.
471 --retry-open ATTEMPTS
473 After a successful fetch, try ATTEMPTS time(s) to open the
474 stream until giving up.
475 Default is: 1.
477 --stream-types TYPES
479 --stream-priority TYPES
481 A comma-delimited list of stream types to allow.
482 The order will be used to separate streams when there are multi‐
484 ple streams with the same name but different stream types. Any
485 stream type not listed will be omitted from the available
486 streams list. An * (asterisk) can be used as a wildcard to
487 match any other type of stream, eg. muxed-stream.
488 Default is: "hls,http,*".
490 --stream-sorting-excludes STREAMS
492 Fine tune the best and worst stream name synonyms by excluding
493 unwanted streams.
494 If all of the available streams get excluded, best and worst
496 will become inaccessible and new special stream synonyms
497 best-unfiltered and worst-unfiltered can be used as a fallback
498 selection method.
499 Uses a filter expression in the format:
501 [operator]<value>
503 Valid operators are >, >=, < and <=. If no operator is specified
505 then equality is tested.
506 For example this will exclude streams ranked higher than "480p":
508 --stream-sorting-excludes ">480p"
510 Multiple filters can be used by separating each expression with
512 a comma.
513 For example this will exclude streams from two quality types:
515 --stream-sorting-excludes ">480p,>medium"
517 Stream transport options
519 --ringbuffer-size SIZE
520 The maximum size of the ringbuffer. Mega- or kilobytes can be
521 specified via the M or K suffix respectively.
522 The ringbuffer is used as a temporary storage between the stream
524 and the player. This allows Streamlink to download the stream
525 faster than the player which reads the data from the ringbuffer.
526 The smaller the size of the ringbuffer, the higher the chance of
528 the player buffering if the download speed decreases, and the
529 higher the size, the more data can be use as a storage to re‐
530 cover from volatile download speeds.
531 Most players have their own additional cache and will read the
533 ringbuffer's content as soon as data is available. If the
534 player stops reading data while playback is paused, Streamlink
535 will continue to download the stream in the background as long
536 as the ringbuffer doesn't get full.
537 Default is: "16M".
539 NOTE:
541 A smaller size is recommended on lower end systems (such as
542 Raspberry Pi) when playing stream types that require some ex‐
543 tra processing to avoid unnecessary background processing.
544 --stream-segment-attempts ATTEMPTS
546 How many attempts should be done to download each segment before
547 giving up.
548 This applies to all different kinds of segmented stream types,
550 such as DASH, HLS, etc.
551 Default is: 3.
553 --stream-segment-threads THREADS
555 The size of the thread pool used to download segments. Minimum
556 value is 1 and maximum is 10.
557 This applies to all different kinds of segmented stream types,
559 such as DASH, HLS, etc.
560 Default is: 1.
562 --stream-segment-timeout TIMEOUT
564 Segment connect and read timeout.
565 This applies to all different kinds of segmented stream types,
567 such as DASH, HLS, etc.
568 Default is: 10.0.
570 --stream-timeout TIMEOUT
572 Timeout for reading data from streams.
573 This applies to all different kinds of stream types, such as
575 DASH, HLS, HTTP, etc.
576 Default is: 60.0.
578 --mux-subtitles
580 Automatically mux available subtitles into the output stream.
581 Needs to be supported by the used plugin.
583 Supported plugins: funimationnow, rtve, svtplay, vimeo
585 HLS options
587 --hls-live-edge SEGMENTS
588 Number of segments from the live stream's current live position
589 to begin streaming. The size or length of each segment is de‐
590 termined by the streaming provider.
591 Lower values will decrease the latency, but will also increase
593 the chance of buffering, as there is less time for Streamlink to
594 download segments and write their data to the output buffer. The
595 number of parallel segment downloads can be set with
596 --stream-segment-threads and the HLS playlist reload time to
597 fetch and queue new segments can be overridden with
598 --hls-playlist-reload-time.
599 Default is: 3.
601 NOTE:
603 During live playback, the caching/buffering settings of the
604 used player will add additional latency. To adjust this,
605 please refer to the player's own documentation for the re‐
606 quired configuration. Player parameters can be set via
607 --player-args.
608 --hls-segment-stream-data
610 Immediately write segment data into output buffer while down‐
611 loading.
612 --hls-playlist-reload-attempts ATTEMPTS
614 How many attempts should be done to reload the HLS playlist be‐
615 fore giving up.
616 Default is: 3.
618 --hls-playlist-reload-time TIME
620 Set a custom HLS playlist reload time value, either in seconds
621 or by using one of the following keywords:
622 • segment: The duration of the last segment in the current
624 playlist
625 • live-edge: The sum of segment durations of the live edge value
627 minus one
628 • default: The playlist's target duration metadata
630 Default is: default.
632 --hls-segment-ignore-names NAMES
634 A comma-delimited list of segment names that will get filtered
635 out.
636 Example: --hls-segment-ignore-names 000,001,002
638 This will ignore every segment that ends with 000.ts, 001.ts and
640 002.ts
641 Default is: None.
643 --hls-segment-key-uri URI
645 Override the segment encryption key URIs for encrypted streams.
646 The value can be templated using the following variables, which
648 will be replaced with their respective part from the source seg‐
649 ment URI:
650 {url} {scheme} {netloc} {path} {query}
652 Examples:
654 --hls-segment-key-uri "https://example.com/hls/encryption_key"
656 --hls-segment-key-uri "{scheme}://1.2.3.4{path}{query}"
657 --hls-segment-key-uri "{scheme}://{netloc}/custom/path/to/key"
658 Default is: None.
660 --hls-audio-select CODE
662 Selects a specific audio source or sources, by language code or
663 name, when multiple audio sources are available. Can be * (as‐
664 terisk) to download all audio sources.
665 Examples:
667 --hls-audio-select "English,German"
669 --hls-audio-select "en,de"
670 --hls-audio-select "*"
671 NOTE:
673 This is only useful in special circumstances where the regu‐
674 lar locale option fails, such as when multiple sources of the
675 same language exists.
676 --hls-start-offset [HH:]MM:SS
678 Amount of time to skip from the beginning of the stream. For
679 live streams, this is a negative offset from the end of the
680 stream (rewind).
681 Default is: 00:00:00.
683 --hls-duration [HH:]MM:SS
685 Limit the playback duration, useful for watching segments of a
686 stream. The actual duration may be slightly longer, as it is
687 rounded to the nearest HLS segment.
688 Default is: unlimited.
690 --hls-live-restart
692 Skip to the beginning of a live stream, or as far back as possi‐
693 ble.
694 FFmpeg options
696 --ffmpeg-ffmpeg FILENAME
697 FFMPEG is used to access or mux separate video and audio
698 streams. You can specify the location of the ffmpeg executable
699 if it is not in your PATH.
700 Example: --ffmpeg-ffmpeg "/usr/local/bin/ffmpeg"
702 --ffmpeg-no-validation
704 Disable FFmpeg validation and version logging.
705 --ffmpeg-verbose
707 Write the console output from ffmpeg to the console.
708 --ffmpeg-verbose-path PATH
710 Path to write the output from the ffmpeg console.
711 --ffmpeg-fout OUTFORMAT
713 When muxing streams, set the output format to OUTFORMAT.
714 Default is: "matroska".
716 Example: --ffmpeg-fout "mpegts"
718 --ffmpeg-video-transcode CODEC
720 When muxing streams, transcode the video to CODEC.
721 Default is: "copy".
723 Example: --ffmpeg-video-transcode "h264"
725 --ffmpeg-audio-transcode CODEC
727 When muxing streams, transcode the audio to CODEC.
728 Default is: "copy".
730 Example: --ffmpeg-audio-transcode "aac"
732 --ffmpeg-copyts
734 Forces the -copyts ffmpeg option and does not remove the initial
735 start time offset value.
736 --ffmpeg-start-at-zero
738 Enable the -start_at_zero ffmpeg option when using
739 --ffmpeg-copyts.
740 HTTP options
742 --http-proxy HTTP_PROXY
743 A HTTP proxy to use for all HTTP and HTTPS requests, including
744 WebSocket connections.
745 Example: --http-proxy "http://hostname:port/"
747 --http-cookie KEY=VALUE
749 A cookie to add to each HTTP request.
750 Can be repeated to add multiple cookies.
752 --http-header KEY=VALUE
754 A header to add to each HTTP request.
755 Can be repeated to add multiple headers.
757 --http-query-param KEY=VALUE
759 A query parameter to add to each HTTP request.
760 Can be repeated to add multiple query parameters.
762 --http-ignore-env
764 Ignore HTTP settings set in the environment such as environment
765 variables (HTTP_PROXY, etc) or ~/.netrc authentication.
766 --http-no-ssl-verify
768 Don't attempt to verify SSL certificates.
769 Usually a bad idea, only use this if you know what you're doing.
771 --http-disable-dh
773 Disable Diffie Hellman key exchange
774 Usually a bad idea, only use this if you know what you're doing.
776 --http-ssl-cert FILENAME
778 SSL certificate to use.
779 Expects a .pem file.
781 --http-ssl-cert-crt-key CRT_FILENAME KEY_FILENAME
783 SSL certificate to use.
784 Expects a .crt and a .key file.
786 --http-timeout TIMEOUT
788 General timeout used by all HTTP requests except the ones cov‐
789 ered by other options.
790 Default is: 20.0.
792 Plugin options
794 Afreeca
795 --afreeca-username USERNAME
796 The username used to register with afreecatv.com.
797 --afreeca-password PASSWORD
799 A afreecatv.com account password to use with --afreeca-username.
800 --afreeca-purge-credentials
802 Purge cached AfreecaTV credentials to initiate a new session and
803 reauthenticate.
804 Bbciplayer
806 --bbciplayer-username USERNAME
807 The username used to register with bbc.co.uk.
808 --bbciplayer-password PASSWORD
810 A bbc.co.uk account password to use with --bbciplayer-username.
811 --bbciplayer-hd
813 Prefer HD streams over local SD streams, some live programmes
814 may not be broadcast in HD.
815 Clubbingtv
817 --clubbingtv-username
818 The username used to register with Clubbing TV.
819 --clubbingtv-password
821 A Clubbing TV account password to use with
822 --clubbingtv-username.
823 Crunchyroll
825 --crunchyroll-username USERNAME
826 A Crunchyroll username to allow access to restricted streams.
827 --crunchyroll-password [PASSWORD]
829 A Crunchyroll password for use with --crunchyroll-username.
830 If left blank you will be prompted.
832 --crunchyroll-purge-credentials
834 Purge cached Crunchyroll credentials to initiate a new session
835 and reauthenticate.
836 --crunchyroll-session-id SESSION_ID
838 Set a specific session ID for crunchyroll, can be used to bypass
839 region restrictions. If using an authenticated session ID, it is
840 recommended that the authentication parameters be omitted as the
841 session ID is account specific.
842 NOTE:
844 The session ID will be overwritten if authentication is used
845 and the session ID does not match the account.
846 Funimationnow
848 --funimation-email
849 Email address for your Funimation account.
850 --funimation-password
852 Password for your Funimation account.
853 --funimation-language
855 The audio language to use for the stream; japanese or english.
856 Default is: "english".
858 Nicolive
860 --niconico-email EMAIL
861 The email or phone number associated with your Niconico account
862 --niconico-password PASSWORD
864 The password of your Niconico account
865 --niconico-user-session VALUE
867 Value of the user-session token.
868 Can be used as an alternative to providing a password.
870 --niconico-purge-credentials
872 Purge cached Niconico credentials to initiate a new session and
873 reauthenticate.
874 --niconico-timeshift-offset [HH:]MM:SS
876 Amount of time to skip from the beginning of a stream.
877 Default is: 00:00:00.
879 Openrectv
881 --openrectv-email EMAIL
882 The email associated with your openrectv account, required to
883 access any openrectv stream.
884 --openrectv-password PASSWORD
886 An openrectv account password to use with --openrectv-email.
887 Pixiv
889 --pixiv-sessionid SESSIONID
890 The pixiv.net sessionid that's used in pixiv's PHPSESSID cookie.
891 --pixiv-devicetoken DEVICETOKEN
893 The pixiv.net device token that's used in pixiv's device_token
894 cookie.
895 --pixiv-purge-credentials
897 Purge cached Pixiv credentials to initiate a new session and
898 reauthenticate.
899 --pixiv-performer USER
901 Select a co-host stream instead of the owner stream.
902 Sbscokr
904 Schoolism
905 --schoolism-email EMAIL
906 The email associated with your Schoolism account, required to
907 access any Schoolism stream.
908 --schoolism-password PASSWORD
910 A Schoolism account password to use with --schoolism-email.
911 --schoolism-part PART
913 Play part number PART of the lesson, or assignment feedback
914 video.
915 Default is: 1.
917 Steam
919 --steam-email EMAIL
920 A Steam account email address to access friends/private streams
921 --steam-password PASSWORD
923 A Steam account password to use with --steam-email.
924 Streann
926 --streann-url URL
927 Source URL where the iframe is located, only required for direct
928 URLs of ott.streann.com
929 Twitcasting
931 --twitcasting-password PASSWORD
932 Password for private Twitcasting streams.
933 Twitch
935 --twitch-disable-ads
936 Skip embedded advertisement segments at the beginning or during
937 a stream. Will cause these segments to be missing from the out‐
938 put.
939 --twitch-disable-reruns
941 Do not open the stream if the target channel is currently broad‐
942 casting a rerun.
943 --twitch-low-latency
945 Enables low latency streaming by prefetching HLS segments. Sets
946 --hls-segment-stream-data to true and --hls-live-edge to 2, if
947 it is higher. Reducing --hls-live-edge to 1 will result in the
948 lowest latency possible, but will most likely cause buffering.
949 In order to achieve true low latency streaming during playback,
951 the player's caching/buffering settings will need to be adjusted
952 and reduced to a value as low as possible, but still high enough
953 to not cause any buffering. This depends on the stream's bi‐
954 trate and the quality of the connection to Twitch's servers.
955 Please refer to the player's own documentation for the required
956 configuration. Player parameters can be set via --player-args.
957 NOTE:
959 Low latency streams have to be enabled by the broadcasters on
960 Twitch themselves. Regular streams can cause buffering is‐
961 sues with this option enabled due to the reduced
962 --hls-live-edge value.
963 --twitch-api-header KEY=VALUE
965 A header to add to each Twitch API HTTP request.
966 Can be repeated to add multiple headers.
968 Useful for adding authentication data that can prevent ads. See
970 the plugin-specific documentation for more information.
971 --twitch-access-token-param KEY=VALUE
973 A parameter to add to the API request for acquiring the stream‐
974 ing access token.
975 Can be repeated to add multiple parameters.
977 Ustreamtv
979 --ustream-password PASSWORD
980 A password to access password protected UStream.tv channels.
981 Ustvnow
983 --ustvnow-username USERNAME
984 Your USTV Now account username
985 --ustvnow-password PASSWORD
987 Your USTV Now account password
988 Wwenetwork
990 --wwenetwork-email EMAIL
991 The email associated with your WWE Network account, required to
992 access any WWE Network stream.
993 --wwenetwork-password PASSWORD
995 A WWE Network account password to use with --wwenetwork-email.
996 Yupptv
998 --yupptv-boxid BOXID
999 The yupptv.com boxid that's used in the BoxId cookie.
1000 --yupptv-yuppflixtoken YUPPFLIXTOKEN
1002 The yupptv.com yuppflixtoken that's used in the YuppflixToken
1003 cookie.
1004 --yupptv-purge-credentials
1006 Purge cached YuppTV credentials to initiate a new session and
1007 reauthenticate.
1008 Zattoo
1010 --zattoo-email EMAIL
1011 The email associated with your zattoo account, required to ac‐
1012 cess any zattoo stream.
1013 --zattoo-password PASSWORD
1015 A zattoo account password to use with --zattoo-email.
1016 --zattoo-purge-credentials
1018 Purge cached zattoo credentials to initiate a new session and
1019 reauthenticate.
1020 --zattoo-stream-types TYPES
1022 A comma-delimited list of stream types which should be used.
1023 The following types are allowed: dash,hls7
1025 Default is: "dash".
1027
1029 Please open a new issue on Streamlink's issue tracker on GitHub and use
1030 the appropriate issue forms:
1031 https://github.com/streamlink/streamlink/issues
1033
1035 For more detailed information about config files, plugin sideloading,
1036 streaming protocols, proxy support, metadata, or plugin specific stuff,
1037 please see Streamlink's online CLI documentation here:
1038 https://streamlink.github.io/cli.html
1040 The list of available plugins and their descriptions can be found here:
1042 https://streamlink.github.io/plugins.html
1044
1046 Streamlink Contributors
1047
1049 2023, Streamlink
10505.1.2 Jan 07, 2023 STREAMLINK(1)