1STREAMLINK(1)                     Streamlink                     STREAMLINK(1)
2
3
4

NAME

6       streamlink - extracts streams from various services and pipes them into
7       a video player of choice
8

SYNOPSIS

10          streamlink [OPTIONS] <URL> [STREAM]
11

EXAMPLES

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

OPTIONS

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

BUGS

1005       Please open a new issue on Streamlink's issue tracker on GitHub and use
1006       the appropriate issue forms:
1007
1008       https://github.com/streamlink/streamlink/issues
1009

SEE ALSO

1011       For more detailed information about config files,  plugin  sideloading,
1012       streaming protocols, proxy support, metadata, or plugin specific stuff,
1013       please see Streamlink's online CLI documentation here:
1014
1015       https://streamlink.github.io/cli.html
1016
1017       The list of available plugins and their descriptions can be found here:
1018
1019       https://streamlink.github.io/plugins.html
1020

AUTHOR

1022       Streamlink Contributors
1023
1025       2023, Streamlink
1026
1027
1028
1029
10305.3.1                            Mar 26, 2023                    STREAMLINK(1)
Impressum