-
Notifications
You must be signed in to change notification settings - Fork 8
/
cli.html
1799 lines (1618 loc) · 134 KB
/
cli.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Tutorial" href="cli/tutorial.html" /><link rel="prev" title="Installation" href="install.html" />
<!-- Generated with Sphinx 7.3.7 and Furo 2024.04.27 -->
<link rel="apple-touch-icon" sizes="180x180" href="/_static/apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="/_static/favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="/_static/favicon-16x16.png">
<link rel="shortcut icon" href="/_static/favicon.ico">
<link rel="manifest" href="/_static/site.webmanifest">
<meta property="og:title" content="Command-Line Interface - Streamlink 6.8.1 documentation">
<meta property="og:description" content="A command-line utility that extracts streams from various services and pipes them into a video player of choice.">
<meta property="og:image" content="/_static/opengraph-image.png">
<meta property="og:image:width" content="1200">
<meta property="og:image:height" content="630">
<title>Command-Line Interface - Streamlink 6.8.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=437aa6ec" />
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="_static/styles/custom.css?v=4504cacd" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/fontawesome.min.css" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/solid.min.css" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.3.0/css/brands.min.css" />
<style>
body {
--color-code-background: #f8f8f8;
--color-code-foreground: black;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #202020;
--color-code-foreground: #d0d0d0;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">Streamlink 6.8.1 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><div class="sidebar-scroll"><a class="sidebar-brand centered" href="index.html">
<div class="sidebar-logo-container">
<img class="sidebar-logo only-light" src="_static/icon.svg" alt="Streamlink"/>
<img class="sidebar-logo only-dark" src="_static/icon.svg" alt="Streamlink"/>
</div>
<p class="sidebar-brand-text">Streamlink</p>
<p class="sidebar-brand-oneliner">A command-line utility that extracts streams from various services and pipes them into a video player of choice.</p>
</a>
<div class="sidebar-versions centered" role="note" aria-label="versions">
<pre class="sidebar-versions-current">6.8.1</pre>
<dl class="sidebar-versions-others">
<dd><a href="/cli.html" class="version-current">Stable</a></dd>
<dd><a href="/latest/cli.html" class="">Latest</a></dd>
</dl>
</div><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-tree">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1 current has-children"><a class="current reference internal" href="#">Command-Line Interface</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Command-Line Interface</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Command-line usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/tutorial.html">Tutorial</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/config.html">Configuration file</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/plugin-sideloading.html">Plugin sideloading</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/protocols.html">Streaming protocols</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/proxy.html">Proxy support</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/metadata.html">Metadata</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="cli/plugins.html">Plugin specific usage</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Plugin specific usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/crunchyroll.html">Crunchyroll</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/twitch.html">Twitch</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="players.html">Players</a></li>
<li class="toctree-l1"><a class="reference internal" href="deprecations.html">Deprecations</a></li>
<li class="toctree-l1"><a class="reference internal" href="migrations.html">Migrations</a></li>
<li class="toctree-l1"><a class="reference internal" href="developing.html">Developing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="api_guide.html">API Guide</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of API Guide</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api_guide/quickstart.html">Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="api_guide/validate.html">Validation schemas</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="api.html">API Reference</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of API Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="api/streamlink.html">Streamlink</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/session.html">Session</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/plugin.html">Plugin</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/options.html">Options</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/cache.html">Cache</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/validate.html">Validation schemas</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/stream.html">Stream</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/webbrowser.html">Webbrowser</a></li>
<li class="toctree-l2"><a class="reference internal" href="api/exceptions.html">Exceptions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="donate.html">Donating</a></li>
<li class="toctree-l1"><a class="reference internal" href="applications.html">Streamlink Applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="thirdparty.html">Third Party Applications</a></li>
</ul>
</div><div class="github-buttons centered">
<a href="https://github.com/streamlink/streamlink"
class="github-button"
data-icon="octicon-mark-github"
data-count-href="/streamlink/streamlink/stargazers"
data-count-api="/repos/streamlink/streamlink#stargazers_count">Github</a>
<a href="https://github.com/streamlink/streamlink/issues"
class="github-button"
data-icon="octicon-issue-opened">Issues</a>
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
</div></div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="edit-this-page">
<a class="muted-link" href="https://github.com/streamlink/streamlink/edit/master/docs/cli.rst" title="Edit this page">
<svg aria-hidden="true" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<path d="M4 20h4l10.5 -10.5a1.5 1.5 0 0 0 -4 -4l-10.5 10.5v4" />
<line x1="13.5" y1="6.5" x2="17.5" y2="10.5" />
</svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="command-line-interface">
<h1>Command-Line Interface<a class="headerlink" href="#command-line-interface" title="Link to this heading">¶</a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Table of Contents</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Command-line usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli/tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli/tutorial.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/tutorial.html#getting-started">Getting started</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/tutorial.html#shell-syntax">Shell syntax</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli/config.html">Configuration file</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli/config.html#location">Location</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/config.html#syntax">Syntax</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli/config.html#example">Example</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli/config.html#plugin-specific-configuration-file">Plugin specific configuration file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli/plugin-sideloading.html">Plugin sideloading</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli/protocols.html">Streaming protocols</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli/protocols.html#playing-built-in-streaming-protocols-directly">Playing built-in streaming protocols directly</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/protocols.html#supported-streaming-protocols">Supported streaming protocols</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/protocols.html#protocol-parameters">Protocol parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/protocols.html#available-parameters">Available parameters</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli/proxy.html">Proxy support</a></li>
<li class="toctree-l1"><a class="reference internal" href="cli/metadata.html">Metadata</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli/metadata.html#variables">Variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="cli/metadata.html#examples">Examples</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="cli/plugins.html">Plugin specific usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="cli/plugins/crunchyroll.html">Crunchyroll</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/crunchyroll.html#authentication">Authentication</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/crunchyroll.html#http-proxy">HTTP proxy</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="cli/plugins/twitch.html">Twitch</a><ul>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/twitch.html#authentication">Authentication</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/twitch.html#embedded-ads">Embedded ads</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/twitch.html#client-integrity-token">Client-integrity token</a></li>
<li class="toctree-l3"><a class="reference internal" href="cli/plugins/twitch.html#low-latency-streaming">Low latency streaming</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<section id="command-line-usage">
<h2>Command-line usage<a class="headerlink" href="#command-line-usage" title="Link to this heading">¶</a></h2>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="gp">$ </span>streamlink<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><URL><span class="w"> </span><span class="o">[</span>STREAM<span class="o">]</span>
</pre></div>
</div>
<section id="positional-arguments">
<h3>Positional arguments<a class="headerlink" href="#positional-arguments" title="Link to this heading">¶</a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-URL">
<span class="sig-name descname"><span class="pre">URL</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-URL" title="Link to this definition">¶</a></dt>
<dd><p>A URL to attempt to extract streams from.</p>
<p>Usually, the protocol of http(s) URLs can be omitted (<code class="code docutils literal notranslate"><span class="pre">https://</span></code>),
depending on the implementation of the plugin being used.</p>
<p>Alternatively, the URL can also be specified by using the <a class="reference internal" href="#cmdoption-url"><code class="xref std std-option docutils literal notranslate"><span class="pre">--url</span></code></a> option.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-arg-STREAM">
<span class="sig-name descname"><span class="pre">STREAM</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-arg-STREAM" title="Link to this definition">¶</a></dt>
<dd><p>Stream to play.</p>
<p>Use <code class="code docutils literal notranslate"><span class="pre">best</span></code> or <code class="code docutils literal notranslate"><span class="pre">worst</span></code> for selecting the highest or lowest available
quality.</p>
<p>Fallback streams can be specified by using a comma-separated list:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"720p,480p,best"</span>
</pre></div>
</div>
<p>If no stream is specified and <a class="reference internal" href="#cmdoption-default-stream"><code class="xref std std-option docutils literal notranslate"><span class="pre">--default-stream</span></code></a> is not used, then a list
of available streams will be printed.</p>
</dd></dl>
</section>
<section id="general-options">
<h3>General options<a class="headerlink" href="#general-options" title="Link to this heading">¶</a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-h">
<span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-h" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-help">
<span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-help" title="Link to this definition">¶</a></dt>
<dd><p>Show this help message and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-V">
<span class="sig-name descname"><span class="pre">-V</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-V" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-version">
<span class="sig-name descname"><span class="pre">--version</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-version" title="Link to this definition">¶</a></dt>
<dd><p>Show version number and exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-plugins">
<span class="sig-name descname"><span class="pre">--plugins</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-plugins" title="Link to this definition">¶</a></dt>
<dd><p>Print a list of all currently installed plugins.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-plugin-dir">
<span class="sig-name descname"><span class="pre">--plugin-dir</span></span><span class="sig-prename descclassname"> <span class="pre">DIRECTORY</span></span><a class="headerlink" href="#cmdoption-plugin-dir" title="Link to this definition">¶</a></dt>
<dd><p>Load plugins from this directory.</p>
<p>Can be set multiple times to load plugins from multiple directories.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-plugin-dirs">
<span class="sig-name descname"><span class="pre">--plugin-dirs</span></span><span class="sig-prename descclassname"> <span class="pre">DIRECTORY</span></span><a class="headerlink" href="#cmdoption-plugin-dirs" title="Link to this definition">¶</a></dt>
<dd><p>Load plugins from a list of comma-separated directories. (deprecated)</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-can-handle-url">
<span class="sig-name descname"><span class="pre">--can-handle-url</span></span><span class="sig-prename descclassname"> <span class="pre">URL</span></span><a class="headerlink" href="#cmdoption-can-handle-url" title="Link to this definition">¶</a></dt>
<dd><p>Check if Streamlink has a plugin that can handle the specified URL.</p>
<p>Returns status code <code class="code docutils literal notranslate"><span class="pre">1</span></code> for false and <code class="code docutils literal notranslate"><span class="pre">0</span></code> for true.</p>
<p>Useful for external scripting.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-can-handle-url-no-redirect">
<span class="sig-name descname"><span class="pre">--can-handle-url-no-redirect</span></span><span class="sig-prename descclassname"> <span class="pre">URL</span></span><a class="headerlink" href="#cmdoption-can-handle-url-no-redirect" title="Link to this definition">¶</a></dt>
<dd><p>Same as <a class="reference internal" href="#cmdoption-can-handle-url"><code class="xref std std-option docutils literal notranslate"><span class="pre">--can-handle-url</span></code></a> but without following redirects when looking up
the URL.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-config">
<span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-config" title="Link to this definition">¶</a></dt>
<dd><p>Load options from this config file.</p>
<p>Can be repeated to load multiple files, in which case the options are
merged on top of each other where the last config has highest priority.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-no-config">
<span class="sig-name descname"><span class="pre">--no-config</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-no-config" title="Link to this definition">¶</a></dt>
<dd><p>Disable loading any default or custom config files.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-l">
<span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"> <span class="pre">LEVEL</span></span><a class="headerlink" href="#cmdoption-l" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-loglevel">
<span class="sig-name descname"><span class="pre">--loglevel</span></span><span class="sig-prename descclassname"> <span class="pre">LEVEL</span></span><a class="headerlink" href="#cmdoption-loglevel" title="Link to this definition">¶</a></dt>
<dd><p>Set the log message threshold.</p>
<p>Valid levels are, in order of increasing verbosity:</p>
<p><code class="code docutils literal notranslate"><span class="pre">none</span></code>, <code class="code docutils literal notranslate"><span class="pre">critical</span></code>, <code class="code docutils literal notranslate"><span class="pre">error</span></code>, <code class="code docutils literal notranslate"><span class="pre">warning</span></code>, <code class="code docutils literal notranslate"><span class="pre">info</span></code>, <code class="code docutils literal notranslate"><span class="pre">debug</span></code>, <code class="code docutils literal notranslate"><span class="pre">trace</span></code>, <code class="code docutils literal notranslate"><span class="pre">all</span></code></p>
<p>Default is: <strong>"info"</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-logfile">
<span class="sig-name descname"><span class="pre">--logfile</span></span><span class="sig-prename descclassname"> <span class="pre">FILE</span></span><a class="headerlink" href="#cmdoption-logfile" title="Link to this definition">¶</a></dt>
<dd><p>Append log output to <code class="code docutils literal notranslate"><span class="pre">FILE</span></code> instead of writing to stdout/stderr.</p>
<p>User prompts and download progress won't be written to <code class="code docutils literal notranslate"><span class="pre">FILE</span></code>.</p>
<p>A value of <code class="code docutils literal notranslate"><span class="pre">-</span></code> (dash) will set the file name to an ISO8601-like string
and will choose the following default log directories.</p>
<p>Windows:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">TEMP</span><span class="o">%</span>\<span class="n">streamlink</span>\<span class="n">logs</span>
</pre></div>
</div>
<p>macOS:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>${HOME}/Library/Logs/streamlink
</pre></div>
</div>
<p>Linux/BSD:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>${XDG_STATE_HOME:-${HOME}/.local/state}/streamlink/logs
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-Q">
<span class="sig-name descname"><span class="pre">-Q</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-Q" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-quiet">
<span class="sig-name descname"><span class="pre">--quiet</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-quiet" title="Link to this definition">¶</a></dt>
<dd><p>Hide all log output.</p>
<p>Alias for <code class="code docutils literal notranslate"><span class="pre">--loglevel</span> <span class="pre">none</span></code>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-j">
<span class="sig-name descname"><span class="pre">-j</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-j" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-json">
<span class="sig-name descname"><span class="pre">--json</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-json" title="Link to this definition">¶</a></dt>
<dd><p>Output JSON representations instead of the normal text output.</p>
<p>Useful for external scripting.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-auto-version-check">
<span class="sig-name descname"><span class="pre">--auto-version-check</span></span><span class="sig-prename descclassname"> <span class="pre">{yes,true,1,on,no,false,0,off}</span></span><a class="headerlink" href="#cmdoption-auto-version-check" title="Link to this definition">¶</a></dt>
<dd><p>Enable or disable the automatic check for a new version of Streamlink.</p>
<p>Default is: <strong>"no"</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-version-check">
<span class="sig-name descname"><span class="pre">--version-check</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-version-check" title="Link to this definition">¶</a></dt>
<dd><p>Runs a version check and exits.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-locale">
<span class="sig-name descname"><span class="pre">--locale</span></span><span class="sig-prename descclassname"> <span class="pre">LOCALE</span></span><a class="headerlink" href="#cmdoption-locale" title="Link to this definition">¶</a></dt>
<dd><p>The preferred locale setting, for selecting the preferred subtitle and
audio language.</p>
<p>The locale is formatted as <code class="code docutils literal notranslate"><span class="pre">[language_code]_[country_code]</span></code>, eg. <code class="code docutils literal notranslate"><span class="pre">en_US</span></code> or
<code class="code docutils literal notranslate"><span class="pre">es_ES</span></code>.</p>
<p>Default is: <strong>system locale</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-interface">
<span class="sig-name descname"><span class="pre">--interface</span></span><span class="sig-prename descclassname"> <span class="pre">INTERFACE</span></span><a class="headerlink" href="#cmdoption-interface" title="Link to this definition">¶</a></dt>
<dd><p>Set the network interface.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-4">
<span class="sig-name descname"><span class="pre">-4</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-4" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-ipv4">
<span class="sig-name descname"><span class="pre">--ipv4</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ipv4" title="Link to this definition">¶</a></dt>
<dd><p>Resolve address names to IPv4 only. This option overrides <a class="reference internal" href="#cmdoption-ipv6"><code class="xref std std-option docutils literal notranslate"><span class="pre">--ipv6</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-6">
<span class="sig-name descname"><span class="pre">-6</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-6" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-ipv6">
<span class="sig-name descname"><span class="pre">--ipv6</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-ipv6" title="Link to this definition">¶</a></dt>
<dd><p>Resolve address names to IPv6 only. This option overrides <a class="reference internal" href="#cmdoption-ipv4"><code class="xref std std-option docutils literal notranslate"><span class="pre">--ipv4</span></code></a>.</p>
</dd></dl>
</section>
<section id="player-options">
<h3>Player options<a class="headerlink" href="#player-options" title="Link to this heading">¶</a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-p">
<span class="sig-name descname"><span class="pre">-p</span></span><span class="sig-prename descclassname"> <span class="pre">PATH</span></span><a class="headerlink" href="#cmdoption-p" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-player">
<span class="sig-name descname"><span class="pre">--player</span></span><span class="sig-prename descclassname"> <span class="pre">PATH</span></span><a class="headerlink" href="#cmdoption-player" title="Link to this definition">¶</a></dt>
<dd><p>The player executable that will be launched (unless a different output method was chosen).</p>
<p>Either set an absolute or relative path to the player executable, or just set the executable's name
if it can be resolved from the paths of the system's <code class="code docutils literal notranslate"><span class="pre">PATH</span></code> environment variable.</p>
<p>In addition to setting the player executable path, custom player arguments can be set via <a class="reference internal" href="#cmdoption-player-args"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-args</span></code></a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>In the past, <a class="reference internal" href="#cmdoption-player"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player</span></code></a> allowed defining additional player arguments, which as a consequence required wrapping
player paths that contained spaces in quotation marks. This is unsupported since release <code class="code docutils literal notranslate"><span class="pre">6.0.0</span></code>.</p>
</div>
<p>Default is: <strong>VLC player, if available</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-a">
<span class="sig-name descname"><span class="pre">-a</span></span><span class="sig-prename descclassname"> <span class="pre">ARGUMENTS</span></span><a class="headerlink" href="#cmdoption-a" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-player-args">
<span class="sig-name descname"><span class="pre">--player-args</span></span><span class="sig-prename descclassname"> <span class="pre">ARGUMENTS</span></span><a class="headerlink" href="#cmdoption-player-args" title="Link to this definition">¶</a></dt>
<dd><p>This option allows the arguments which are used to launch the player process to be customized.</p>
<p>The value can contain formatting variables surrounded by curly braces, <code class="code docutils literal notranslate"><span class="pre">{</span></code> and <code class="code docutils literal notranslate"><span class="pre">}</span></code>.
Curly brace characters can be escaped by doubling, e.g. <code class="code docutils literal notranslate"><span class="pre">{{</span></code> and <code class="code docutils literal notranslate"><span class="pre">}}</span></code>.</p>
<p>Available formatting variables:</p>
<dl class="simple">
<dt><code class="code docutils literal notranslate"><span class="pre">{playerinput}</span></code></dt><dd><p>This is the input argument that the player will receive. For standard input (stdin),
it is <code class="code docutils literal notranslate"><span class="pre">-</span></code> (dash), but it can also be a file path or URL, depending on the options used.
If unset, then the player input argument will be appended to the parsed player arguments list.</p>
</dd>
<dt><code class="code docutils literal notranslate"><span class="pre">{playertitleargs}</span></code></dt><dd><p>The automatically generated player title arguments, if a supported player was found. See <a class="reference internal" href="#cmdoption-title"><code class="xref std std-option docutils literal notranslate"><span class="pre">--title</span></code></a> for more.
If unset, automatically generated player title arguments will be prepended to the parsed player arguments list.</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">streamlink</span> <span class="o">-</span><span class="n">p</span> <span class="n">vlc</span> <span class="o">-</span><span class="n">a</span> <span class="s2">"--play-and-exit --no-one-instance"</span> <span class="o"><</span><span class="n">url</span><span class="o">></span> <span class="p">[</span><span class="n">stream</span><span class="p">]</span>
</pre></div>
</div>
<p>Default is: <strong>""</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-env">
<span class="sig-name descname"><span class="pre">--player-env</span></span><span class="sig-prename descclassname"> <span class="pre">KEY=VALUE</span></span><a class="headerlink" href="#cmdoption-player-env" title="Link to this definition">¶</a></dt>
<dd><p>Add an additional environment variable to the spawned player process, in addition to the ones inherited from
the Streamlink/Python parent process. This allows setting player environment variables in config files.</p>
<p>Can be repeated to add multiple environment variables.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-v">
<span class="sig-name descname"><span class="pre">-v</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-v" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-verbose-player">
<span class="sig-name descname"><span class="pre">--verbose-player</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-verbose-player" title="Link to this definition">¶</a></dt>
<dd><p>Allow the player to display its console output.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-n">
<span class="sig-name descname"><span class="pre">-n</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-n" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-player-fifo">
<span class="sig-name descname"><span class="pre">--player-fifo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-player-fifo" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-fifo">
<span class="sig-name descname"><span class="pre">--fifo</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fifo" title="Link to this definition">¶</a></dt>
<dd><p>Make the player read the stream through a named pipe instead of the
stdin pipe.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-http">
<span class="sig-name descname"><span class="pre">--player-http</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-player-http" title="Link to this definition">¶</a></dt>
<dd><p>Make the player read the stream through HTTP instead of the stdin pipe.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-continuous-http">
<span class="sig-name descname"><span class="pre">--player-continuous-http</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-player-continuous-http" title="Link to this definition">¶</a></dt>
<dd><p>Make the player read the stream through HTTP, but unlike <a class="reference internal" href="#cmdoption-player-http"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-http</span></code></a>
it will continuously try to open the stream if the player requests it.</p>
<p>This makes it possible to handle stream disconnects if your player is
capable of reconnecting to a HTTP stream. This is usually done by
setting your player to a "repeat mode".</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-external-http">
<span class="sig-name descname"><span class="pre">--player-external-http</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-player-external-http" title="Link to this definition">¶</a></dt>
<dd><p>Serve stream data through HTTP without running any player. This is
useful to allow external devices like smartphones or streaming boxes to
watch streams they wouldn't be able to otherwise.</p>
<p>The default behavior is similar to the <a class="reference internal" href="#cmdoption-player-continuous-http"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-continuous-http</span></code></a> option,
but no player program will be started, and the server will listen on all available
connections instead of just in the local (loopback) interface.</p>
<p>See <a class="reference internal" href="#cmdoption-player-external-http-interface"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-external-http-interface</span></code></a> for choosing a specific network interface, and
see <a class="reference internal" href="#cmdoption-player-external-http-port"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-external-http-port</span></code></a> for choosing a non-randomized port.</p>
<p>Optionally, the <a class="reference internal" href="#cmdoption-player-external-http-continuous"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-external-http-continuous</span></code></a> option allows for disabling
the continuous run-mode, so that Streamlink will stop when the stream ends.</p>
<p>The URLs that can be used to access the stream will be printed to the
console, and the server can be interrupted using CTRL-C.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-external-http-continuous">
<span class="sig-name descname"><span class="pre">--player-external-http-continuous</span></span><span class="sig-prename descclassname"> <span class="pre">{yes,true,1,on,no,false,0,off}</span></span><a class="headerlink" href="#cmdoption-player-external-http-continuous" title="Link to this definition">¶</a></dt>
<dd><p>Set the run-mode of <a class="reference internal" href="#cmdoption-player-external-http"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-external-http</span></code></a> to continuous or non-continuous.</p>
<p>In the continuous run-mode, Streamlink will keep running after the stream has ended
and will wait for the next HTTP request being made unless it gets shut down via CTRL-C.</p>
<p>If set to non-continuous, Streamlink will stop once the stream has ended.</p>
<p>Default is: <strong>true</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-external-http-interface">
<span class="sig-name descname"><span class="pre">--player-external-http-interface</span></span><span class="sig-prename descclassname"> <span class="pre">INTERFACE</span></span><a class="headerlink" href="#cmdoption-player-external-http-interface" title="Link to this definition">¶</a></dt>
<dd><p>The network interface on which the HTTP server will be listening on.
If unset or set to <code class="code docutils literal notranslate"><span class="pre">0.0.0.0</span></code>, all available interfaces will be bound.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-external-http-port">
<span class="sig-name descname"><span class="pre">--player-external-http-port</span></span><span class="sig-prename descclassname"> <span class="pre">PORT</span></span><a class="headerlink" href="#cmdoption-player-external-http-port" title="Link to this definition">¶</a></dt>
<dd><p>A fixed port to use for the external HTTP server if that mode is
enabled. Omit or set to <code class="code docutils literal notranslate"><span class="pre">0</span></code> to use a random high ( >1024) port.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-passthrough">
<span class="sig-name descname"><span class="pre">--player-passthrough</span></span><span class="sig-prename descclassname"> <span class="pre">TYPES</span></span><a class="headerlink" href="#cmdoption-player-passthrough" title="Link to this definition">¶</a></dt>
<dd><p>A comma-delimited list of stream types to pass to the player as a URL to
let it handle the transport of the stream instead.</p>
<p>Stream types that can be converted into a playable URL are:</p>
<ul class="simple">
<li><p>hls</p></li>
<li><p>http</p></li>
</ul>
<p>Make sure your player can handle the stream type when using this.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-player-no-close">
<span class="sig-name descname"><span class="pre">--player-no-close</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-player-no-close" title="Link to this definition">¶</a></dt>
<dd><p>By default Streamlink will close the player when the stream
ends. This is to avoid "dead" GUI players lingering after a
stream ends.</p>
<p>It does however have the side-effect of sometimes closing a
player before it has played back all of its cached data.</p>
<p>This option will instead let the player decide when to exit.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-t">
<span class="sig-name descname"><span class="pre">-t</span></span><span class="sig-prename descclassname"> <span class="pre">TITLE</span></span><a class="headerlink" href="#cmdoption-t" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-title">
<span class="sig-name descname"><span class="pre">--title</span></span><span class="sig-prename descclassname"> <span class="pre">TITLE</span></span><a class="headerlink" href="#cmdoption-title" title="Link to this definition">¶</a></dt>
<dd><p>Change the title of the video player's window.</p>
<p>Please see the "<a class="reference internal" href="cli/metadata.html#variables"><span class="std std-ref">Metadata variables</span></a>" section of Streamlink's CLI documentation for all available metadata variables,
as well as the "<a class="reference internal" href="plugins.html#plugins"><span class="std std-ref">Plugins</span></a>" section for the list of metadata variables defined in each plugin.</p>
<p>This option is only supported for the following players: mpv, potplayer, vlc</p>
<dl>
<dt>VLC specific information:</dt><dd><p>VLC does support special formatting variables on its own:
<a class="reference external" href="https://wiki.videolan.org/Documentation:Format_String/">https://wiki.videolan.org/Documentation:Format_String/</a></p>
<p>These variables are accessible in the <a class="reference internal" href="#cmdoption-title"><code class="xref std std-option docutils literal notranslate"><span class="pre">--title</span></code></a> option by adding a backslash
in front of the dollar sign which VLC uses as its formatting character.</p>
<p>For example, to put the current date in your VLC window title,
the string <code class="code docutils literal notranslate"><span class="pre">\$A</span></code> could be inserted inside the <a class="reference internal" href="#cmdoption-title"><code class="xref std std-option docutils literal notranslate"><span class="pre">--title</span></code></a> string.</p>
</dd>
</dl>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">streamlink</span> <span class="o">-</span><span class="n">p</span> <span class="n">mpv</span> <span class="o">--</span><span class="n">title</span> <span class="s2">"</span><span class="si">{author}</span><span class="s2"> - </span><span class="si">{category}</span><span class="s2"> - </span><span class="si">{title}</span><span class="s2">"</span> <span class="o"><</span><span class="n">URL</span><span class="o">></span> <span class="p">[</span><span class="n">STREAM</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
</section>
<section id="file-output-options">
<h3>File output options<a class="headerlink" href="#file-output-options" title="Link to this heading">¶</a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-o">
<span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-o" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-output">
<span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-output" title="Link to this definition">¶</a></dt>
<dd><p>Write stream data to <code class="code docutils literal notranslate"><span class="pre">FILENAME</span></code> instead of playing it. If <code class="code docutils literal notranslate"><span class="pre">FILENAME</span></code> is set to <code class="code docutils literal notranslate"><span class="pre">-</span></code> (dash), then the stream data will be
written to stdout, similar to the <a class="reference internal" href="#cmdoption-stdout"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stdout</span></code></a> argument.</p>
<p>Non-existent directories and subdirectories will be created if they do not exist, if filesystem permissions allow.</p>
<p>You will be prompted if the file already exists.</p>
<p>Please see the "<a class="reference internal" href="cli/metadata.html#variables"><span class="std std-ref">Metadata variables</span></a>" section of Streamlink's CLI documentation for all available metadata variables,
as well as the "<a class="reference internal" href="plugins.html#plugins"><span class="std std-ref">Plugins</span></a>" section for the list of metadata variables defined in each plugin.</p>
<p>Unsupported characters in substituted variables will be replaced with an underscore.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">streamlink</span> <span class="o">--</span><span class="n">output</span> <span class="s2">"~/recordings/</span><span class="si">{author}</span><span class="s2">/</span><span class="si">{category}</span><span class="s2">/</span><span class="si">{id}</span><span class="s2">-{time:%Y%m</span><span class="si">%d</span><span class="s2">%H%M%S}.ts"</span> <span class="o"><</span><span class="n">URL</span><span class="o">></span> <span class="p">[</span><span class="n">STREAM</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-O">
<span class="sig-name descname"><span class="pre">-O</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-O" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-stdout">
<span class="sig-name descname"><span class="pre">--stdout</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-stdout" title="Link to this definition">¶</a></dt>
<dd><p>Write stream data to stdout instead of playing it.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-r">
<span class="sig-name descname"><span class="pre">-r</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-r" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-record">
<span class="sig-name descname"><span class="pre">--record</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-record" title="Link to this definition">¶</a></dt>
<dd><p>Open the stream in the player, while at the same time writing it to <code class="code docutils literal notranslate"><span class="pre">FILENAME</span></code>. If <code class="code docutils literal notranslate"><span class="pre">FILENAME</span></code> is set to <code class="code docutils literal notranslate"><span class="pre">-</span></code> (dash),
then the stream data will be written to stdout, similar to the <a class="reference internal" href="#cmdoption-stdout"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stdout</span></code></a> argument, while still opening the player.</p>
<p>Non-existent directories and subdirectories will be created if they do not exist, if filesystem permissions allow.</p>
<p>You will be prompted if the file already exists.</p>
<p>Please see the "<a class="reference internal" href="cli/metadata.html#variables"><span class="std std-ref">Metadata variables</span></a>" section of Streamlink's CLI documentation for all available metadata variables,
as well as the "<a class="reference internal" href="plugins.html#plugins"><span class="std std-ref">Plugins</span></a>" section for the list of metadata variables defined in each plugin.</p>
<p>Unsupported characters in substituted variables will be replaced with an underscore.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">streamlink</span> <span class="o">--</span><span class="n">record</span> <span class="s2">"~/recordings/</span><span class="si">{author}</span><span class="s2">/</span><span class="si">{category}</span><span class="s2">/</span><span class="si">{id}</span><span class="s2">-{time:%Y%m</span><span class="si">%d</span><span class="s2">%H%M%S}.ts"</span> <span class="o"><</span><span class="n">URL</span><span class="o">></span> <span class="p">[</span><span class="n">STREAM</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-R">
<span class="sig-name descname"><span class="pre">-R</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-R" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-record-and-pipe">
<span class="sig-name descname"><span class="pre">--record-and-pipe</span></span><span class="sig-prename descclassname"> <span class="pre">FILENAME</span></span><a class="headerlink" href="#cmdoption-record-and-pipe" title="Link to this definition">¶</a></dt>
<dd><p>Write stream data to stdout, while at the same time writing it to <code class="code docutils literal notranslate"><span class="pre">FILENAME</span></code>.</p>
<p>Non-existent directories and subdirectories will be created if they do not exist, if filesystem permissions allow.</p>
<p>You will be prompted if the file already exists.</p>
<p>Please see the "<a class="reference internal" href="cli/metadata.html#variables"><span class="std std-ref">Metadata variables</span></a>" section of Streamlink's CLI documentation for all available metadata variables,
as well as the "<a class="reference internal" href="plugins.html#plugins"><span class="std std-ref">Plugins</span></a>" section for the list of metadata variables defined in each plugin.</p>
<p>Unsupported characters in substituted variables will be replaced with an underscore.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">streamlink</span> <span class="o">--</span><span class="n">record</span><span class="o">-</span><span class="ow">and</span><span class="o">-</span><span class="n">pipe</span> <span class="s2">"~/recordings/</span><span class="si">{author}</span><span class="s2">/</span><span class="si">{category}</span><span class="s2">/</span><span class="si">{id}</span><span class="s2">-{time:%Y%m</span><span class="si">%d</span><span class="s2">%H%M%S}.ts"</span> <span class="o"><</span><span class="n">URL</span><span class="o">></span> <span class="p">[</span><span class="n">STREAM</span><span class="p">]</span>
</pre></div>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-fs-safe-rules">
<span class="sig-name descname"><span class="pre">--fs-safe-rules</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-fs-safe-rules" title="Link to this definition">¶</a></dt>
<dd><p>The rules used to make formatting variables filesystem-safe are chosen
automatically according to the type of system in use. This overrides
the automatic detection.</p>
<p>Intended for use when Streamlink is running on a UNIX-like OS but writing
to Windows filesystems such as NTFS; USB devices using VFAT or exFAT; CIFS
shares that are enforcing Windows filename limitations, etc.</p>
<p>These characters are replaced with an underscore for the rules in use:</p>
<ul class="simple">
<li><p>POSIX: <code class="code docutils literal notranslate"><span class="pre">\x00-\x1F</span> <span class="pre">/</span></code></p></li>
<li><p>Windows: <code class="code docutils literal notranslate"><span class="pre">\x00-\x1F</span> <span class="pre">\x7F</span> <span class="pre">"</span> <span class="pre">*</span> <span class="pre">/</span> <span class="pre">:</span> <span class="pre"><</span> <span class="pre">></span> <span class="pre">?</span> <span class="pre">\</span> <span class="pre">|</span></code></p></li>
</ul>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-f">
<span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-f" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-force">
<span class="sig-name descname"><span class="pre">--force</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-force" title="Link to this definition">¶</a></dt>
<dd><p>When using <a class="reference internal" href="#cmdoption-output"><code class="xref std std-option docutils literal notranslate"><span class="pre">--output</span></code></a> or <a class="reference internal" href="#cmdoption-record"><code class="xref std std-option docutils literal notranslate"><span class="pre">--record</span></code></a>, always write to file even if it already exists (overwrite).</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-progress">
<span class="sig-name descname"><span class="pre">--progress</span></span><span class="sig-prename descclassname"> <span class="pre">{yes,force,no}</span></span><a class="headerlink" href="#cmdoption-progress" title="Link to this definition">¶</a></dt>
<dd><p>When using <a class="reference internal" href="#cmdoption-output"><code class="xref std std-option docutils literal notranslate"><span class="pre">--output</span></code></a> or <a class="reference internal" href="#cmdoption-record"><code class="xref std std-option docutils literal notranslate"><span class="pre">--record</span></code></a>, show or hide the download progress bar, or force it if there's no terminal.</p>
<p>Default is: <strong>yes</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-force-progress">
<span class="sig-name descname"><span class="pre">--force-progress</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-force-progress" title="Link to this definition">¶</a></dt>
<dd><p>Deprecated in favor of <a class="reference internal" href="#cmdoption-progress"><code class="xref std std-option docutils literal notranslate"><span class="pre">--progress=force</span></code></a>.</p>
</dd></dl>
</section>
<section id="stream-options">
<h3>Stream options<a class="headerlink" href="#stream-options" title="Link to this heading">¶</a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-url">
<span class="sig-name descname"><span class="pre">--url</span></span><span class="sig-prename descclassname"> <span class="pre">URL</span></span><a class="headerlink" href="#cmdoption-url" title="Link to this definition">¶</a></dt>
<dd><p>A URL to attempt to extract streams from.</p>
<p>Usually, the protocol of http(s) URLs can be omitted (<code class="code docutils literal notranslate"><span class="pre">https://</span></code>),
depending on the implementation of the plugin being used.</p>
<p>This is an alternative to setting the URL using a positional argument
and can be useful if set in a config file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-default-stream">
<span class="sig-name descname"><span class="pre">--default-stream</span></span><span class="sig-prename descclassname"> <span class="pre">STREAM</span></span><a class="headerlink" href="#cmdoption-default-stream" title="Link to this definition">¶</a></dt>
<dd><p>Stream to play.</p>
<p>Use <code class="code docutils literal notranslate"><span class="pre">best</span></code> or <code class="code docutils literal notranslate"><span class="pre">worst</span></code> for selecting the highest or lowest available
quality.</p>
<p>Fallback streams can be specified by using a comma-separated list:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"720p,480p,best"</span>
</pre></div>
</div>
<p>This is an alternative to setting the stream using a positional argument
and can be useful if set in a config file.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream-url">
<span class="sig-name descname"><span class="pre">--stream-url</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-stream-url" title="Link to this definition">¶</a></dt>
<dd><p>If possible, translate the resolved stream to a URL and print it.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-retry-streams">
<span class="sig-name descname"><span class="pre">--retry-streams</span></span><span class="sig-prename descclassname"> <span class="pre">DELAY</span></span><a class="headerlink" href="#cmdoption-retry-streams" title="Link to this definition">¶</a></dt>
<dd><p>Retry fetching the list of available streams until streams are found
while waiting <code class="code docutils literal notranslate"><span class="pre">DELAY</span></code> second(s) between each attempt. If unset, only one
attempt will be made to fetch the list of streams available.</p>
<p>The number of fetch retry attempts can be capped with <a class="reference internal" href="#cmdoption-retry-max"><code class="xref std std-option docutils literal notranslate"><span class="pre">--retry-max</span></code></a>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-retry-max">
<span class="sig-name descname"><span class="pre">--retry-max</span></span><span class="sig-prename descclassname"> <span class="pre">COUNT</span></span><a class="headerlink" href="#cmdoption-retry-max" title="Link to this definition">¶</a></dt>
<dd><p>When using <a class="reference internal" href="#cmdoption-retry-streams"><code class="xref std std-option docutils literal notranslate"><span class="pre">--retry-streams</span></code></a>, stop retrying the fetch after <code class="code docutils literal notranslate"><span class="pre">COUNT</span></code> retry
attempt(s). Fetch will retry infinitely if <code class="code docutils literal notranslate"><span class="pre">COUNT</span></code> is zero or unset.</p>
<p>If <a class="reference internal" href="#cmdoption-retry-max"><code class="xref std std-option docutils literal notranslate"><span class="pre">--retry-max</span></code></a> is set without setting <a class="reference internal" href="#cmdoption-retry-streams"><code class="xref std std-option docutils literal notranslate"><span class="pre">--retry-streams</span></code></a>, the delay between
retries will default to 1 second.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-retry-open">
<span class="sig-name descname"><span class="pre">--retry-open</span></span><span class="sig-prename descclassname"> <span class="pre">ATTEMPTS</span></span><a class="headerlink" href="#cmdoption-retry-open" title="Link to this definition">¶</a></dt>
<dd><p>After a successful fetch, try <code class="code docutils literal notranslate"><span class="pre">ATTEMPTS</span></code> time(s) to open the stream until
giving up.</p>
<p>Default is: <strong>1</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream-types">
<span class="sig-name descname"><span class="pre">--stream-types</span></span><span class="sig-prename descclassname"> <span class="pre">TYPES</span></span><a class="headerlink" href="#cmdoption-stream-types" title="Link to this definition">¶</a></dt>
<dt class="sig sig-object std" id="cmdoption-stream-priority">
<span class="sig-name descname"><span class="pre">--stream-priority</span></span><span class="sig-prename descclassname"> <span class="pre">TYPES</span></span><a class="headerlink" href="#cmdoption-stream-priority" title="Link to this definition">¶</a></dt>
<dd><p>A comma-delimited list of stream types to allow.</p>
<p>The order will be used to separate streams when there are multiple
streams with the same name but different stream types. Any stream type
not listed will be omitted from the available streams list. An <code class="code docutils literal notranslate"><span class="pre">*</span></code> (asterisk) can
be used as a wildcard to match any other type of stream, eg. muxed-stream.</p>
<p>Default is: <strong>"hls,http,*"</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream-sorting-excludes">
<span class="sig-name descname"><span class="pre">--stream-sorting-excludes</span></span><span class="sig-prename descclassname"> <span class="pre">STREAMS</span></span><a class="headerlink" href="#cmdoption-stream-sorting-excludes" title="Link to this definition">¶</a></dt>
<dd><p>Fine tune the <code class="code docutils literal notranslate"><span class="pre">best</span></code> and <code class="code docutils literal notranslate"><span class="pre">worst</span></code> stream name synonyms by excluding unwanted streams.</p>
<p>If all of the available streams get excluded, <code class="code docutils literal notranslate"><span class="pre">best</span></code> and <code class="code docutils literal notranslate"><span class="pre">worst</span></code> will become
inaccessible and new special stream synonyms <code class="code docutils literal notranslate"><span class="pre">best-unfiltered</span></code> and <code class="code docutils literal notranslate"><span class="pre">worst-unfiltered</span></code>
can be used as a fallback selection method.</p>
<p>Uses a filter expression in the format:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">operator</span><span class="p">]</span><span class="o"><</span><span class="n">value</span><span class="o">></span>
</pre></div>
</div>
<p>Valid operators are <code class="code docutils literal notranslate"><span class="pre">></span></code>, <code class="code docutils literal notranslate"><span class="pre">>=</span></code>, <code class="code docutils literal notranslate"><span class="pre"><</span></code> and <code class="code docutils literal notranslate"><span class="pre"><=</span></code>. If no operator is specified then
equality is tested.</p>
<p>For example this will exclude streams ranked higher than "480p":</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">--</span><span class="n">stream</span><span class="o">-</span><span class="n">sorting</span><span class="o">-</span><span class="n">excludes</span> <span class="s2">">480p"</span>
</pre></div>
</div>
<p>Multiple filters can be used by separating each expression with a comma.</p>
<p>For example this will exclude streams from two quality types:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">--</span><span class="n">stream</span><span class="o">-</span><span class="n">sorting</span><span class="o">-</span><span class="n">excludes</span> <span class="s2">">480p,>medium"</span>
</pre></div>
</div>
</dd></dl>
</section>
<section id="stream-transport-options">
<h3>Stream transport options<a class="headerlink" href="#stream-transport-options" title="Link to this heading">¶</a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ringbuffer-size">
<span class="sig-name descname"><span class="pre">--ringbuffer-size</span></span><span class="sig-prename descclassname"> <span class="pre">SIZE</span></span><a class="headerlink" href="#cmdoption-ringbuffer-size" title="Link to this definition">¶</a></dt>
<dd><p>The maximum size of the ringbuffer.</p>
<p>Mebibytes or kibibytes (base 2) can be specified via the M or K suffix respectively.</p>
<p>The ringbuffer is used as a temporary storage between the stream and the player.
This allows Streamlink to download the stream faster than the player which reads the data from the ringbuffer.</p>
<p>The smaller the size of the ringbuffer, the higher the chance of the player buffering if the download speed decreases,
and the higher the size, the more data can be use as a storage to recover from volatile download speeds.</p>
<p>Most players have their own additional cache and will read the ringbuffer's content as soon as data is available.
If the player stops reading data while playback is paused, Streamlink will continue to download the stream in the
background as long as the ringbuffer doesn't get full.</p>
<p>Default is: <strong>"16M"</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream-segment-attempts">
<span class="sig-name descname"><span class="pre">--stream-segment-attempts</span></span><span class="sig-prename descclassname"> <span class="pre">ATTEMPTS</span></span><a class="headerlink" href="#cmdoption-stream-segment-attempts" title="Link to this definition">¶</a></dt>
<dd><p>How many attempts should be done to download each segment before giving up.</p>
<p>This applies to all different kinds of segmented stream types, such as DASH, HLS, etc.</p>
<p>Default is: <strong>3</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream-segment-threads">
<span class="sig-name descname"><span class="pre">--stream-segment-threads</span></span><span class="sig-prename descclassname"> <span class="pre">THREADS</span></span><a class="headerlink" href="#cmdoption-stream-segment-threads" title="Link to this definition">¶</a></dt>
<dd><p>The size of the thread pool used to download segments. Minimum value is <code class="code docutils literal notranslate"><span class="pre">1</span></code> and maximum is <code class="code docutils literal notranslate"><span class="pre">10</span></code>.</p>
<p>This applies to all different kinds of segmented stream types, such as DASH, HLS, etc.</p>
<p>Default is: <strong>1</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream-segment-timeout">
<span class="sig-name descname"><span class="pre">--stream-segment-timeout</span></span><span class="sig-prename descclassname"> <span class="pre">TIMEOUT</span></span><a class="headerlink" href="#cmdoption-stream-segment-timeout" title="Link to this definition">¶</a></dt>
<dd><p>Segment connect and read timeout.</p>
<p>This applies to all different kinds of segmented stream types, such as DASH, HLS, etc.</p>
<p>Default is: <strong>10.0</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-stream-timeout">
<span class="sig-name descname"><span class="pre">--stream-timeout</span></span><span class="sig-prename descclassname"> <span class="pre">TIMEOUT</span></span><a class="headerlink" href="#cmdoption-stream-timeout" title="Link to this definition">¶</a></dt>
<dd><p>Timeout for reading data from streams.</p>
<p>This applies to all different kinds of stream types, such as DASH, HLS, HTTP, etc.</p>
<p>Default is: <strong>60.0</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-mux-subtitles">
<span class="sig-name descname"><span class="pre">--mux-subtitles</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-mux-subtitles" title="Link to this definition">¶</a></dt>
<dd><p>Automatically mux available subtitles into the output stream.</p>
<p>Needs to be supported by the used plugin.</p>
</dd></dl>
<section id="hls-options">
<h4>HLS options<a class="headerlink" href="#hls-options" title="Link to this heading">¶</a></h4>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-hls-live-edge">
<span class="sig-name descname"><span class="pre">--hls-live-edge</span></span><span class="sig-prename descclassname"> <span class="pre">SEGMENTS</span></span><a class="headerlink" href="#cmdoption-hls-live-edge" title="Link to this definition">¶</a></dt>
<dd><p>Number of segments from the live stream's current live position to begin streaming.
The size or length of each segment is determined by the streaming provider.</p>
<p>Lower values will decrease the latency, but will also increase the chance of buffering, as there is less time for
Streamlink to download segments and write their data to the output buffer. The number of parallel segment downloads
can be set with <a class="reference internal" href="#cmdoption-stream-segment-threads"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stream-segment-threads</span></code></a> and the HLS playlist reload time to fetch and queue new segments can be
overridden with <a class="reference internal" href="#cmdoption-hls-playlist-reload-time"><code class="xref std std-option docutils literal notranslate"><span class="pre">--hls-playlist-reload-time</span></code></a>.</p>
<p>Default is: <strong>3</strong>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>During live playback, the caching/buffering settings of the used player will add additional latency. To adjust
this, please refer to the player's own documentation for the required configuration. Player parameters can be set via
<a class="reference internal" href="#cmdoption-player-args"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-args</span></code></a>.</p>
</div>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-hls-segment-stream-data">
<span class="sig-name descname"><span class="pre">--hls-segment-stream-data</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-hls-segment-stream-data" title="Link to this definition">¶</a></dt>
<dd><p>Immediately write segment data into output buffer while downloading.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-hls-playlist-reload-attempts">
<span class="sig-name descname"><span class="pre">--hls-playlist-reload-attempts</span></span><span class="sig-prename descclassname"> <span class="pre">ATTEMPTS</span></span><a class="headerlink" href="#cmdoption-hls-playlist-reload-attempts" title="Link to this definition">¶</a></dt>
<dd><p>Max number of attempts when reloading the HLS playlist before giving up.</p>
<p>Default is: <strong>3</strong>.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-hls-playlist-reload-time">
<span class="sig-name descname"><span class="pre">--hls-playlist-reload-time</span></span><span class="sig-prename descclassname"> <span class="pre">TIME</span></span><a class="headerlink" href="#cmdoption-hls-playlist-reload-time" title="Link to this definition">¶</a></dt>
<dd><p>Set a custom HLS playlist reload time value, either in seconds
or by using one of the following keywords:</p>
<ul class="simple">
<li><p>segment: The duration of the last segment in the current playlist</p></li>
<li><p>live-edge: The sum of segment durations of the live edge value minus one</p></li>
<li><p>default: The playlist's target duration metadata</p></li>
</ul>
<p>Default is: <strong>default</strong>.</p>
</dd></dl>
<dl class="std option">