-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathmigrations.html
More file actions
829 lines (791 loc) · 85.6 KB
/
migrations.html
File metadata and controls
829 lines (791 loc) · 85.6 KB
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
<!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="Developing" href="developing.html"><link rel="prev" title="Deprecations" href="deprecations.html">
<link rel="prefetch" href="_static/icon.svg" as="image">
<link rel="prefetch" href="_static/icon.svg" as="image">
<link rel="prefetch" href="_static/icon.svg" as="image">
<!-- Generated with Sphinx 9.1.0 and Furo 2025.12.19 -->
<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="Migrations - Streamlink 8.2.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>Migrations - Streamlink 8.2.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d111a655" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=7bdb33bb" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=8dab3a3b" />
<link rel="stylesheet" type="text/css" href="_static/styles/custom.css?v=72de1884" />
<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: #f2f2f2;
--color-code-foreground: #1e1e1e;
}
@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" 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" 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-with-moon" viewBox="0 0 24 24">
<title>Auto light/dark, in light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
<line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
<line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
<line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
<line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
<line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
<line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
<line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
<line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
<circle cx="14.5" cy="9.55" r="3.6"/>
</svg>
</symbol>
<symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
<title>Auto light/dark, in dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
class="icon-custom-derived-from-feather-sun-and-tabler-moon">
<path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
<line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
<line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
<line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
<line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
<line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
<line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
<line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
<line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
<circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
</svg>
</symbol>
<symbol id="svg-pencil" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
<path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
<path d="M13.5 6.5l4 4" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
<symbol id="svg-eye" viewBox="0 0 24 24">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
<path
d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
<path d="M20 21l2 -2l-2 -2" />
<path d="M17 17l-2 2l2 2" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation" aria-label="Toggle site navigation sidebar">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc" aria-label="Toggle table of contents sidebar">
<label class="overlay sidebar-overlay" for="__navigation"></label>
<label class="overlay toc-overlay" for="__toc"></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">
<span class="icon"><svg><use href="#svg-menu"></use></svg></span>
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">Streamlink 8.2.1 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></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">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</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">8.2.1</pre>
<dl class="sidebar-versions-others">
<dd><a href="/migrations.html" class="version-current">Stable</a></dd>
<dd><a href="/latest/migrations.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 has-children"><a class="reference internal" href="cli.html">Command-Line Interface</a><input aria-label="Toggle navigation of Command-Line Interface" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<li class="toctree-l2"><a class="reference internal" href="cli.html">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 aria-label="Toggle navigation of Plugin specific usage" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></label><ul>
<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 current current-page"><a class="current reference internal" href="#">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 aria-label="Toggle navigation of API Guide" class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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 aria-label="Toggle navigation of API Reference" class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><span class="icon"><svg><use href="#svg-arrow-right"></use></svg></span></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="support.html">Support</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="view-this-page">
<a class="muted-link" href="https://github.com/streamlink/streamlink/blob/master/docs/migrations.rst?plain=true" title="View this page">
<svg><use href="#svg-eye"></use></svg>
<span class="visually-hidden">View this page</span>
</a>
</div><div class="edit-this-page">
<a class="muted-link" href="https://github.com/streamlink/streamlink/edit/master/docs/migrations.rst" rel="edit" title="Edit this page">
<svg><use href="#svg-pencil"></use></svg>
<span class="visually-hidden">Edit this page</span>
</a>
</div><div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle" aria-label="Toggle Light / Dark / Auto color theme">
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></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">
<span class="icon"><svg><use href="#svg-toc"></use></svg></span>
</label>
</div>
<article role="main" id="furo-main-content">
<section id="migrations">
<h1>Migrations<a class="headerlink" href="#migrations" title="Link to this heading">¶</a></h1>
<section id="streamlink-8-0-0">
<h2>streamlink 8.0.0<a class="headerlink" href="#streamlink-8-0-0" title="Link to this heading">¶</a></h2>
<section id="hlsstream-url-master-argument">
<h3>HLSStream url_master argument<a class="headerlink" href="#hlsstream-url-master-argument" title="Link to this heading">¶</a></h3>
<p>Support for the <a class="reference internal" href="deprecations.html#url-master-in-hlsstream"><span class="std std-ref">deprecated</span></a> <code class="docutils literal notranslate"><span class="pre">url_master</span></code> argument and respective class attribute
in <code class="xref py py-class docutils literal notranslate"><span class="pre">HLSStream</span></code> and <code class="xref py py-class docutils literal notranslate"><span class="pre">MuxedHLSStream</span></code>
has been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6688">#6688</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<p><code class="docutils literal notranslate"><span class="pre">HLSStream</span></code> and <code class="docutils literal notranslate"><span class="pre">MuxedHLSStream</span></code> objects which originate from a multivariant (master) playlist should receive a reference
to the <code class="docutils literal notranslate"><span class="pre">M3U8</span></code> instance of the parsed multivariant playlist via the <code class="docutils literal notranslate"><span class="pre">multivariant</span></code> argument. The <code class="docutils literal notranslate"><span class="pre">multivariant.uri</span></code>
attribute is a string of the multivariant playlist address.</p>
</div>
</section>
</section>
<section id="streamlink-7-0-0">
<h2>streamlink 7.0.0<a class="headerlink" href="#streamlink-7-0-0" title="Link to this heading">¶</a></h2>
<section id="config-file-paths">
<h3>Config file paths<a class="headerlink" href="#config-file-paths" title="Link to this heading">¶</a></h3>
<p>Support for the old and <a class="reference internal" href="deprecations.html#config-file-paths"><span class="std std-ref">deprecated</span></a> config file paths,
including plugin-specific config file paths, has been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/3766">#3766</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6149">#6149</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<p>Please switch to the config file paths listed in the <a class="reference internal" href="cli/config.html#configuration-file"><span class="std std-ref">Configuration file</span></a>
section of the CLI docs, or use the <a class="reference internal" href="cli.html#cmdoption-config"><code class="xref std std-option docutils literal notranslate"><span class="pre">--config</span></code></a> CLI argument to set custom config file paths.</p>
</div>
</section>
<section id="custom-plugins-sideloading-paths">
<h3>Custom plugins sideloading paths<a class="headerlink" href="#custom-plugins-sideloading-paths" title="Link to this heading">¶</a></h3>
<p>Support for the old and <a class="reference internal" href="deprecations.html#custom-plugins-sideloading-paths"><span class="std std-ref">deprecated</span></a> custom plugins sideloading paths
has been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/3766">#3766</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6150">#6150</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<p>Please see the plugins directory paths listed in the <a class="reference internal" href="cli/plugin-sideloading.html#plugin-sideloading"><span class="std std-ref">Plugin sideloading</span></a>
section of the CLI docs, or use the <a class="reference internal" href="cli.html#cmdoption-plugin-dir"><code class="xref std std-option docutils literal notranslate"><span class="pre">--plugin-dir</span></code></a> CLI argument to set the path to another location.</p>
</div>
</section>
<section id="stream-type-related-cli-arguments">
<h3>Stream-type related CLI arguments<a class="headerlink" href="#stream-type-related-cli-arguments" title="Link to this heading">¶</a></h3>
<p>The <a class="reference internal" href="deprecations.html#stream-type-related-cli-arguments"><span class="std std-ref">deprecated</span></a>
<code class="docutils literal notranslate"><span class="pre">--hls-segment-{attempts,threads,timeout}</span></code> and <code class="docutils literal notranslate"><span class="pre">--{hls,http-stream}-timeout</span></code> CLI arguments,
as well as their <a class="reference internal" href="deprecations.html#stream-type-related-cli-arguments"><span class="std std-ref">deprecated</span></a>
<code class="docutils literal notranslate"><span class="pre">{dash,hls}-segment-{attempts,threads,timeout}</span></code> and <code class="docutils literal notranslate"><span class="pre">{dash,hls,http-stream}-timeout</span></code>
session option counterparts have been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/3893">#3893</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6232">#6232</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-0" name="sd-tab-set-0" type="radio">
<label class="sd-tab-label" for="sd-tab-item-0">
CLI arguments</label><div class="sd-tab-content docutils">
<ul class="simple">
<li><p>use <a class="reference internal" href="cli.html#cmdoption-stream-segment-attempts"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stream-segment-attempts</span></code></a> instead of <code class="docutils literal notranslate"><span class="pre">--hls-segment-attempts</span></code></p></li>
<li><p>use <a class="reference internal" href="cli.html#cmdoption-stream-segment-threads"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stream-segment-threads</span></code></a> instead of <code class="docutils literal notranslate"><span class="pre">--hls-segment-threads</span></code></p></li>
<li><p>use <a class="reference internal" href="cli.html#cmdoption-stream-segment-timeout"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stream-segment-timeout</span></code></a> instead of <code class="docutils literal notranslate"><span class="pre">--hls-segment-timeout</span></code></p></li>
<li><p>use <a class="reference internal" href="cli.html#cmdoption-stream-timeout"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stream-timeout</span></code></a> instead of <code class="docutils literal notranslate"><span class="pre">--{hls,http-stream}-timeout</span></code></p></li>
</ul>
</div>
<input id="sd-tab-item-1" name="sd-tab-set-0" type="radio">
<label class="sd-tab-label" for="sd-tab-item-1">
Session options</label><div class="sd-tab-content docutils">
<ul class="simple">
<li><p>use <a class="reference internal" href="api/session.html#streamlink.session.options.StreamlinkOptions" title="streamlink.session.options.StreamlinkOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">stream-segment-attempts</span></code></a>
instead of <code class="docutils literal notranslate"><span class="pre">{dash,hls}-segment-attempts</span></code></p></li>
<li><p>use <a class="reference internal" href="api/session.html#streamlink.session.options.StreamlinkOptions" title="streamlink.session.options.StreamlinkOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">stream-segment-threads</span></code></a>
instead of <code class="docutils literal notranslate"><span class="pre">{dash,hls}-segment-threads</span></code></p></li>
<li><p>use <a class="reference internal" href="api/session.html#streamlink.session.options.StreamlinkOptions" title="streamlink.session.options.StreamlinkOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">stream-segment-timeout</span></code></a>
instead of <code class="docutils literal notranslate"><span class="pre">{dash,hls}-segment-timeout</span></code></p></li>
<li><p>use <a class="reference internal" href="api/session.html#streamlink.session.options.StreamlinkOptions" title="streamlink.session.options.StreamlinkOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">stream-timeout</span></code></a>
instead of <code class="docutils literal notranslate"><span class="pre">{dash,hls,http-stream}-timeout</span></code></p></li>
</ul>
</div>
</div>
</div>
</section>
<section id="httpsession-and-httpadapters">
<h3>HTTPSession and HTTPAdapters<a class="headerlink" href="#httpsession-and-httpadapters" title="Link to this heading">¶</a></h3>
<p>The <a class="reference internal" href="deprecations.html#httpsession-and-httpadapters"><span class="std std-ref">deprecated</span></a> import paths for the <code class="docutils literal notranslate"><span class="pre">HTTPSession</span></code> class
and custom <code class="docutils literal notranslate"><span class="pre">HTTPAdapter</span></code> classes have been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5807">#5807</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6274">#6274</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<p>Plugin implementors were never supposed to import the <code class="docutils literal notranslate"><span class="pre">HTTPSession</span></code> class directly, and instead should always reference
the <a class="reference internal" href="api/session.html#streamlink.session.Streamlink.http" title="streamlink.session.Streamlink.http"><code class="xref py py-attr docutils literal notranslate"><span class="pre">http</span></code></a> attribute of Streamlink's
<a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin.session" title="streamlink.plugin.Plugin.session"><code class="xref py py-attr docutils literal notranslate"><span class="pre">session</span></code></a> attribute in instances of <code class="docutils literal notranslate"><span class="pre">Plugin</span></code>.</p>
<p>Import Streamlink's custom <code class="docutils literal notranslate"><span class="pre">HTTPAdapter</span></code> classes from <code class="docutils literal notranslate"><span class="pre">streamlink.session.http</span></code>.</p>
</div>
</section>
<section id="streamlink-plugins-re-exports">
<h3>streamlink.plugins re-exports<a class="headerlink" href="#streamlink-plugins-re-exports" title="Link to this heading">¶</a></h3>
<p>The <a class="reference internal" href="deprecations.html#streamlink-plugins-re-exports"><span class="std std-ref">deprecated</span></a> import paths for
the <a class="reference internal" href="api/exceptions.html#streamlink.exceptions.NoPluginError" title="streamlink.exceptions.NoPluginError"><code class="xref py py-class docutils literal notranslate"><span class="pre">NoPluginError</span></code></a>,
<a class="reference internal" href="api/exceptions.html#streamlink.exceptions.NoStreamsError" title="streamlink.exceptions.NoStreamsError"><code class="xref py py-class docutils literal notranslate"><span class="pre">NoStreamsError</span></code></a>, <a class="reference internal" href="api/exceptions.html#streamlink.exceptions.PluginError" title="streamlink.exceptions.PluginError"><code class="xref py py-class docutils literal notranslate"><span class="pre">PluginError</span></code></a>,
and <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> classes have been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6005">#6005</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6274">#6274</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<p>Import error classes from <code class="docutils literal notranslate"><span class="pre">streamlink.exceptions</span></code> or <code class="docutils literal notranslate"><span class="pre">streamlink.plugin</span></code>.</p>
<p>Import the <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> class from <code class="docutils literal notranslate"><span class="pre">streamlink.plugin</span></code>.</p>
</div>
</section>
<section id="force-progress">
<h3>--force-progress<a class="headerlink" href="#force-progress" title="Link to this heading">¶</a></h3>
<p>The <a class="reference internal" href="deprecations.html#force-progress"><span class="std std-ref">deprecated</span></a> <code class="docutils literal notranslate"><span class="pre">--force-progress</span></code> CLI argument has been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5268">#5268</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/6196">#6196</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<p>Use <a class="reference internal" href="cli.html#cmdoption-progress"><code class="xref std std-option docutils literal notranslate"><span class="pre">--progress=force</span></code></a> instead of <code class="docutils literal notranslate"><span class="pre">--force-progress</span></code>.</p>
</div>
</section>
</section>
<section id="streamlink-6-0-0">
<h2>streamlink 6.0.0<a class="headerlink" href="#streamlink-6-0-0" title="Link to this heading">¶</a></h2>
<section id="player-path-only-player-cli-argument">
<h3>Player-path-only --player CLI argument<a class="headerlink" href="#player-path-only-player-cli-argument" title="Link to this heading">¶</a></h3>
<p>Despite having the dedicated CLI argument for setting custom player arguments <a class="reference internal" href="cli.html#cmdoption-player-args"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-args</span></code></a>,
Streamlink used to support setting custom player arguments using the <a class="reference internal" href="cli.html#cmdoption-player"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player</span></code></a> CLI argument.</p>
<p>This meant that the <a class="reference internal" href="cli.html#cmdoption-player"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player</span></code></a> value had to be treated as a command line string rather than a player path.
As a result of this, player paths would need to be quoted if they contained whitespace characters. While the default config
file of Streamlink's Windows installer tried to teach this, it was often used incorrectly on command-line shells, especially
on Windows where escaping the CLI argument is more difficult compared to POSIX compliant command-line shells. Not quoting
the player path on Windows still worked, but at the cost of potentially resolving an incorrect or malicious executable.</p>
<p>The support for custom player arguments in <a class="reference internal" href="cli.html#cmdoption-player"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player</span></code></a> was a relic from the Livestreamer project and has finally
been removed. <a class="reference internal" href="cli.html#cmdoption-player"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player</span></code></a> now only accepts player executable path strings and any custom player arguments need to be set
using the <a class="reference internal" href="cli.html#cmdoption-player-args"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-args</span></code></a> CLI argument where the argument value gets properly interpreted using shell-like syntax.</p>
<p>Streamlink's Windows installer has received a new default config file and users now also can choose to overwrite their existing
config file from previous installs. The default behavior remains the same with existing config files staying untouched.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5305">#5305</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5310">#5310</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Move any custom player arguments from the value of <a class="reference internal" href="cli.html#cmdoption-player"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player</span></code></a> to <a class="reference internal" href="cli.html#cmdoption-player-args"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-args</span></code></a></p></li>
<li><p>In config files, remove any quotation from the value of <a class="reference internal" href="cli.html#cmdoption-player"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player</span></code></a>
(command-line shells will of course require quotation when the player path contains whitespace characters)</p></li>
</ol>
</div>
</section>
<section id="filename-variable-in-player-args">
<h3>{filename} variable in --player-args<a class="headerlink" href="#filename-variable-in-player-args" title="Link to this heading">¶</a></h3>
<p>The <a class="reference internal" href="cli.html#cmdoption-player-args"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-args</span></code></a>'s <code class="docutils literal notranslate"><span class="pre">{filename}</span></code> variable has been removed. This was kept as a fallback when
the <code class="docutils literal notranslate"><span class="pre">{playerinput}</span></code> variable as added to prevent confusion around the player's input argument
for various different stream transport methods, like stdin, named pipes, passthrough, etc.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/3313">#3313</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5310">#5310</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Rename <code class="docutils literal notranslate"><span class="pre">{filename}</span></code> to <code class="docutils literal notranslate"><span class="pre">{playerinput}</span></code></p></li>
</ol>
</div>
</section>
<section id="plugin-can-handle-url-and-plugin-priority">
<h3>Plugin.can_handle_url() and Plugin.priority()<a class="headerlink" href="#plugin-can-handle-url-and-plugin-priority" title="Link to this heading">¶</a></h3>
<p>Streamlink 2.3.0 <a class="reference internal" href="deprecations.html#plugin-can-handle-url-and-plugin-priority"><span class="std std-ref">deprecated</span></a>
the <code class="docutils literal notranslate"><span class="pre">can_handle_url()</span></code> and <code class="docutils literal notranslate"><span class="pre">priority()</span></code> classmethods of <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> in favor of
the plugin matcher API. These deprecated classmethods have now been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/3814">#3814</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5403">#5403</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Replace custom matching logic in <code class="docutils literal notranslate"><span class="pre">Plugin.can_handle_url()</span></code> with
<a class="reference internal" href="api/plugin.html#streamlink.plugin.pluginmatcher" title="streamlink.plugin.pluginmatcher"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pluginmatcher</span></code></a> decorators</p></li>
<li><p>Replace custom plugin priority matching logic in <code class="docutils literal notranslate"><span class="pre">Plugin.priority()</span></code> with the <code class="docutils literal notranslate"><span class="pre">priority</span></code> argument
of the <a class="reference internal" href="api/plugin.html#streamlink.plugin.pluginmatcher" title="streamlink.plugin.pluginmatcher"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pluginmatcher</span></code></a> decorators</p></li>
</ol>
</div>
</section>
<section id="plugin-init-self-url-compatibility-wrapper">
<h3>Plugin.__init__(self, url) compatibility wrapper<a class="headerlink" href="#plugin-init-self-url-compatibility-wrapper" title="Link to this heading">¶</a></h3>
<p>Streamlink 5.0.0 <a class="reference internal" href="deprecations.html#plugin-init-self-url-compatibility-wrapper"><span class="std std-ref">deprecated</span></a> the usage of the old
<a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> constructor without the <a class="reference internal" href="api/session.html#streamlink.session.Streamlink" title="streamlink.session.Streamlink"><code class="xref py py-class docutils literal notranslate"><span class="pre">Streamlink</span></code></a>
<code class="docutils literal notranslate"><span class="pre">session</span></code> argument. <code class="docutils literal notranslate"><span class="pre">session</span></code> was added because the old <code class="docutils literal notranslate"><span class="pre">Plugin.bind()</span></code> classmethod got removed, which previously
bound the session instance to the entire <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> class, rather than individual <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> instances, causing Python's
garbage collector to not be able to let go of any loaded built-in plugins when initializing more than one session.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/4768">#4768</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5402">#5402</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Replace the arguments of custom constructors of each <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> subclass with
<code class="docutils literal notranslate"><span class="pre">*args,</span> <span class="pre">**kwargs</span></code> and call <code class="docutils literal notranslate"><span class="pre">super().__init__(*args,</span> <span class="pre">**kwargs)</span></code></p></li>
<li><p>If needed, access the <code class="docutils literal notranslate"><span class="pre">url</span></code> using <code class="docutils literal notranslate"><span class="pre">self.url</span></code></p></li>
</ol>
</div>
</section>
<section id="streamlink-g-s-et-plugin-option">
<h3>Streamlink.{g,s}et_plugin_option()<a class="headerlink" href="#streamlink-g-s-et-plugin-option" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">Streamlink.get_plugin_option()</span></code> and <code class="docutils literal notranslate"><span class="pre">Streamlink.set_plugin_option()</span></code> methods were removed as a result of moving
plugin options from the <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> classes to individual <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> instances.</p>
<p>Plugin options now must be get/set referencing the <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin.options" title="streamlink.plugin.Plugin.options"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Plugin.options</span></code></a> instance and its
respective <a class="reference internal" href="api/options.html#streamlink.options.Options.get" title="streamlink.options.Options.get"><code class="xref py py-meth docutils literal notranslate"><span class="pre">get()</span></code></a> and <a class="reference internal" href="api/options.html#streamlink.options.Options.set" title="streamlink.options.Options.set"><code class="xref py py-meth docutils literal notranslate"><span class="pre">set()</span></code></a> methods.</p>
<p>Alternatively, when initializing a <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> class, e.g. after calling
<a class="reference internal" href="api/session.html#streamlink.session.Streamlink.resolve_url" title="streamlink.session.Streamlink.resolve_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.resolve_url()</span></code></a>
or <a class="reference internal" href="api/session.html#streamlink.session.Streamlink.streams" title="streamlink.session.Streamlink.streams"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.streams()</span></code></a>, an optional pre-initialized instance of
<a class="reference internal" href="api/options.html#streamlink.options.Options" title="streamlink.options.Options"><code class="xref py py-class docutils literal notranslate"><span class="pre">Options</span></code></a> can be passed to the constructor of the resolved <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> class.</p>
<p>Be aware that <code class="docutils literal notranslate"><span class="pre">Streamlink.resolve_url()</span></code> will return the explicit plugin name, plugin class and the resolved URL, whereas
<code class="docutils literal notranslate"><span class="pre">Streamlink.streams()</span></code> will initialize the first matching plugin automatically, so it's possible to pass custom options
to a different plugin by accident, if the URL matches an unintended plugin.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5033">#5033</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Initialize an <a class="reference internal" href="api/options.html#streamlink.options.Options" title="streamlink.options.Options"><code class="xref py py-class docutils literal notranslate"><span class="pre">Options</span></code></a> object with the desired key-value pairs and pass it to the
<a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> constructor or the
<a class="reference internal" href="api/session.html#streamlink.session.Streamlink.streams" title="streamlink.session.Streamlink.streams"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.streams()</span></code></a> method.</p></li>
<li><p>After instantiating a <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> class, get or set its options using the <code class="docutils literal notranslate"><span class="pre">get()</span></code>/<code class="docutils literal notranslate"><span class="pre">set()</span></code> methods on the
<a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin.options" title="streamlink.plugin.Plugin.options"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Plugin.options</span></code></a> instance.</p></li>
<li><p>If plugin options need to be accessed in custom <code class="xref py py-class docutils literal notranslate"><span class="pre">Stream</span></code> implementations related to
custom <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> implementations, then those options need to be passed from the <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> to the <code class="docutils literal notranslate"><span class="pre">Stream</span></code> constructor
beforehand, since the <a class="reference internal" href="api/session.html#streamlink.session.Streamlink" title="streamlink.session.Streamlink"><code class="xref py py-class docutils literal notranslate"><span class="pre">Streamlink</span></code></a> session can't be used for that anymore.</p></li>
</ol>
<div class="sd-tab-set docutils">
<input checked="checked" id="sd-tab-item-2" name="sd-tab-set-1" type="radio">
<label class="sd-tab-label" for="sd-tab-item-2">
Before</label><div class="sd-tab-content docutils">
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">streamlink.session</span><span class="w"> </span><span class="kn">import</span> <span class="n">Streamlink</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">Streamlink</span><span class="p">()</span>
<span class="n">session</span><span class="o">.</span><span class="n">set_plugin_option</span><span class="p">(</span><span class="s2">"twitch"</span><span class="p">,</span> <span class="s2">"api-header"</span><span class="p">,</span> <span class="p">[(</span><span class="s2">"Authorization"</span><span class="p">,</span> <span class="s2">"OAuth TOKEN"</span><span class="p">)])</span>
<span class="n">streams</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">streams</span><span class="p">(</span><span class="s2">"twitch.tv/..."</span><span class="p">)</span>
</pre></div>
</div>
</div>
<input id="sd-tab-item-3" name="sd-tab-set-1" type="radio">
<label class="sd-tab-label" for="sd-tab-item-3">
After</label><div class="sd-tab-content docutils">
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">streamlink.options</span><span class="w"> </span><span class="kn">import</span> <span class="n">Options</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">streamlink.session</span><span class="w"> </span><span class="kn">import</span> <span class="n">Streamlink</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">Streamlink</span><span class="p">()</span>
<span class="n">options</span> <span class="o">=</span> <span class="n">Options</span><span class="p">()</span>
<span class="n">options</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"api-header"</span><span class="p">,</span> <span class="p">[(</span><span class="s2">"Authorization"</span><span class="p">,</span> <span class="s2">"OAuth TOKEN"</span><span class="p">)])</span>
<span class="n">streams</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">streams</span><span class="p">(</span><span class="s2">"twitch.tv/..."</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
</pre></div>
</div>
</div>
<input id="sd-tab-item-4" name="sd-tab-set-1" type="radio">
<label class="sd-tab-label" for="sd-tab-item-4">
Alternative</label><div class="sd-tab-content docutils">
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span><span class="w"> </span><span class="nn">streamlink.options</span><span class="w"> </span><span class="kn">import</span> <span class="n">Options</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">streamlink.session</span><span class="w"> </span><span class="kn">import</span> <span class="n">Streamlink</span>
<span class="n">session</span> <span class="o">=</span> <span class="n">Streamlink</span><span class="p">()</span>
<span class="n">pluginname</span><span class="p">,</span> <span class="n">Pluginclass</span><span class="p">,</span> <span class="n">resolved_url</span> <span class="o">=</span> <span class="n">session</span><span class="o">.</span><span class="n">resolve_url</span><span class="p">(</span><span class="s2">"twitch.tv/..."</span><span class="p">)</span>
<span class="n">options</span> <span class="o">=</span> <span class="n">Options</span><span class="p">()</span>
<span class="n">options</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="s2">"api-header"</span><span class="p">,</span> <span class="p">[(</span><span class="s2">"Authorization"</span><span class="p">,</span> <span class="s2">"OAuth TOKEN"</span><span class="p">)])</span>
<span class="n">plugin</span> <span class="o">=</span> <span class="n">Pluginclass</span><span class="p">(</span><span class="n">session</span><span class="p">,</span> <span class="n">resolved_url</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span>
<span class="n">streams</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">streams</span><span class="p">()</span>
</pre></div>
</div>
</div>
</div>
</div>
</section>
<section id="global-plugin-arguments">
<h3>Global plugin arguments<a class="headerlink" href="#global-plugin-arguments" title="Link to this heading">¶</a></h3>
<p>Streamlink 5.3.0 <a class="reference internal" href="deprecations.html#global-plugin-arguments"><span class="std std-ref">deprecated</span></a> the <code class="docutils literal notranslate"><span class="pre">is_global=True</span></code> argument
of the <a class="reference internal" href="api/plugin.html#streamlink.plugin.pluginargument" title="streamlink.plugin.pluginargument"><code class="xref py py-meth docutils literal notranslate"><span class="pre">pluginargument</span></code></a> decorator (as well as the
<a class="reference internal" href="api/options.html#streamlink.options.Argument" title="streamlink.options.Argument"><code class="xref py py-class docutils literal notranslate"><span class="pre">Argument</span></code></a> class), as global plugin arguments were deemed unnecessary.
The <code class="docutils literal notranslate"><span class="pre">is_global</span></code> argument has thus been removed now.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5140">#5140</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5033">#5033</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Get the value of the global argument using <a class="reference internal" href="api/session.html#streamlink.session.Streamlink.get_option" title="streamlink.session.Streamlink.get_option"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.get_option()</span></code></a>
instead of getting it from <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin.options" title="streamlink.plugin.Plugin.options"><code class="xref py py-attr docutils literal notranslate"><span class="pre">Plugin.options</span></code></a></p></li>
</ol>
</div>
</section>
<section id="plugin-api-validate-text">
<h3>plugin.api.validate.text<a class="headerlink" href="#plugin-api-validate-text" title="Link to this heading">¶</a></h3>
<p>Streamlink 5.2.0 <a class="reference internal" href="deprecations.html#plugin-api-validate-text"><span class="std std-ref">deprecated</span></a> the <code class="docutils literal notranslate"><span class="pre">plugin.api.validate.text</span></code> alias for <code class="docutils literal notranslate"><span class="pre">str</span></code>.
This was a remnant of the Python 2 era and has been removed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5090">#5090</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5404">#5404</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Replace <code class="docutils literal notranslate"><span class="pre">plugin.api.validate.text</span></code> with <code class="docutils literal notranslate"><span class="pre">str</span></code></p></li>
</ol>
</div>
</section>
<section id="httpstream-and-hlsstream-signature-changes">
<h3>HTTPStream and HLSStream signature changes<a class="headerlink" href="#httpstream-and-hlsstream-signature-changes" title="Link to this heading">¶</a></h3>
<p>The signatures of the constructors of <code class="xref py py-class docutils literal notranslate"><span class="pre">HTTPStream</span></code>
and <code class="xref py py-class docutils literal notranslate"><span class="pre">HLSStream</span></code>, as well as
the <code class="xref py py-meth docutils literal notranslate"><span class="pre">HLSStream.parse_variant_playlist()</span></code> classmethod
were changed and fixed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/5429">#5429</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Set the <a class="reference internal" href="api/session.html#streamlink.session.Streamlink" title="streamlink.session.Streamlink"><code class="xref py py-class docutils literal notranslate"><span class="pre">Streamlink</span></code></a> session instance as a positional argument,
or replace the <code class="docutils literal notranslate"><span class="pre">session_</span></code> keyword with <code class="docutils literal notranslate"><span class="pre">session</span></code></p></li>
</ol>
</div>
</section>
</section>
<section id="streamlink-5-0-0">
<h2>streamlink 5.0.0<a class="headerlink" href="#streamlink-5-0-0" title="Link to this heading">¶</a></h2>
<section id="session-resolve-url-return-type-changes">
<h3>Session.resolve_url() return type changes<a class="headerlink" href="#session-resolve-url-return-type-changes" title="Link to this heading">¶</a></h3>
<p>With the removal of the <code class="docutils literal notranslate"><span class="pre">Plugin.bind()</span></code> classmethod, the return value of
<a class="reference internal" href="api/session.html#streamlink.session.Streamlink.resolve_url" title="streamlink.session.Streamlink.resolve_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.resolve_url()</span></code></a>
and <a class="reference internal" href="api/session.html#streamlink.session.Streamlink.resolve_url_no_redirect" title="streamlink.session.Streamlink.resolve_url_no_redirect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.resolve_url_no_redirect()</span></code></a>
were changed. Both methods now return a three-element tuple of the resolved plugin name, plugin class and URL.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/4768">#4768</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Return type changed from <code class="docutils literal notranslate"><span class="pre">tuple[type[Plugin],</span> <span class="pre">str]</span></code> to <code class="docutils literal notranslate"><span class="pre">tuple[str,</span> <span class="pre">type[Plugin],</span> <span class="pre">str]</span></code></p></li>
</ol>
</div>
</section>
</section>
<section id="streamlink-4-0-0">
<h2>streamlink 4.0.0<a class="headerlink" href="#streamlink-4-0-0" title="Link to this heading">¶</a></h2>
<section id="streamlink-plugin-api-utils">
<h3>streamlink.plugin.api.utils<a class="headerlink" href="#streamlink-plugin-api-utils" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">streamlink.plugin.api.utils</span></code> module has been removed, including the <code class="docutils literal notranslate"><span class="pre">itertags</span></code> function and the export aliases
for <code class="docutils literal notranslate"><span class="pre">streamlink.utils.parse</span></code>.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-x-circle" viewBox="0 0 16 16" aria-hidden="true"><path d="M2.344 2.343h-.001a8 8 0 0 1 11.314 11.314A8.002 8.002 0 0 1 .234 10.089a8 8 0 0 1 2.11-7.746Zm1.06 10.253a6.5 6.5 0 1 0 9.108-9.275 6.5 6.5 0 0 0-9.108 9.275ZM6.03 4.97 8 6.94l1.97-1.97a.749.749 0 0 1 1.275.326.749.749 0 0 1-.215.734L9.06 8l1.97 1.97a.749.749 0 0 1-.326 1.275.749.749 0 0 1-.734-.215L8 9.06l-1.97 1.97a.749.749 0 0 1-1.275-.326.749.749 0 0 1 .215-.734L6.94 8 4.97 6.03a.751.751 0 0 1 .018-1.042.751.751 0 0 1 1.042-.018Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/4455">#4455</a></div>
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/4467">#4467</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Write validation schemas using the <code class="docutils literal notranslate"><span class="pre">parse_{html,json,xml}()</span></code> validators.
Parsed HTML/XML documents enable data extraction with XPath queries.</p></li>
<li><p>Alternatively, import the <code class="docutils literal notranslate"><span class="pre">parse_{html,json,qsd,xml}()</span></code> utility functions from the <code class="docutils literal notranslate"><span class="pre">streamlink.utils.parse</span></code> module</p></li>
</ol>
</div>
</section>
</section>
<section id="streamlink-3-0-0">
<h2>streamlink 3.0.0<a class="headerlink" href="#streamlink-3-0-0" title="Link to this heading">¶</a></h2>
<section id="plugin-class-returned-by-session-resolve-url">
<h3>Plugin class returned by Session.resolve_url()<a class="headerlink" href="#plugin-class-returned-by-session-resolve-url" title="Link to this heading">¶</a></h3>
<p>In order to enable <a class="reference internal" href="api/plugin.html#streamlink.plugin.Plugin" title="streamlink.plugin.Plugin"><code class="xref py py-class docutils literal notranslate"><span class="pre">Plugin</span></code></a> constructors to have access to plugin options derived from
the resolved plugin arguments, <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> instantiation moved from
<a class="reference internal" href="api/session.html#streamlink.session.Streamlink.resolve_url" title="streamlink.session.Streamlink.resolve_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.resolve_url()</span></code></a> to <code class="docutils literal notranslate"><span class="pre">streamlink_cli</span></code>,
and the return value of <a class="reference internal" href="api/session.html#streamlink.session.Streamlink.resolve_url" title="streamlink.session.Streamlink.resolve_url"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.resolve_url()</span></code></a>
and <a class="reference internal" href="api/session.html#streamlink.session.Streamlink.resolve_url_no_redirect" title="streamlink.session.Streamlink.resolve_url_no_redirect"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.resolve_url_no_redirect()</span></code></a> were changed.</p>
<div class="line-block">
<div class="line"><svg version="1.1" width="1.0em" height="1.0em" class="sd-octicon sd-octicon-git-pull-request" viewBox="0 0 16 16" aria-hidden="true"><path d="M1.5 3.25a2.25 2.25 0 1 1 3 2.122v5.256a2.251 2.251 0 1 1-1.5 0V5.372A2.25 2.25 0 0 1 1.5 3.25Zm5.677-.177L9.573.677A.25.25 0 0 1 10 .854V2.5h1A2.5 2.5 0 0 1 13.5 5v5.628a2.251 2.251 0 1 1-1.5 0V5a1 1 0 0 0-1-1h-1v1.646a.25.25 0 0 1-.427.177L7.177 3.427a.25.25 0 0 1 0-.354ZM3.75 2.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm0 9.5a.75.75 0 1 0 0 1.5.75.75 0 0 0 0-1.5Zm8.25.75a.75.75 0 1 0 1.5 0 .75.75 0 0 0-1.5 0Z"></path></svg> <a class="reference external" href="https://github.com/streamlink/streamlink/issues/4163">#4163</a></div>
</div>
<div class="hint admonition">
<p class="admonition-title">Migration</p>
<ol class="arabic simple">
<li><p>Return type changed from <code class="docutils literal notranslate"><span class="pre">Plugin</span></code> to <code class="docutils literal notranslate"><span class="pre">tuple[type[Plugin],</span> <span class="pre">str]</span></code></p></li>
</ol>
</div>
</section>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="developing.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Developing</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="deprecations.html">
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Deprecations</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2026, Streamlink
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Migrations</a><ul>
<li><a class="reference internal" href="#streamlink-8-0-0">streamlink 8.0.0</a><ul>
<li><a class="reference internal" href="#hlsstream-url-master-argument">HLSStream url_master argument</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-7-0-0">streamlink 7.0.0</a><ul>
<li><a class="reference internal" href="#config-file-paths">Config file paths</a></li>
<li><a class="reference internal" href="#custom-plugins-sideloading-paths">Custom plugins sideloading paths</a></li>
<li><a class="reference internal" href="#stream-type-related-cli-arguments">Stream-type related CLI arguments</a></li>
<li><a class="reference internal" href="#httpsession-and-httpadapters">HTTPSession and HTTPAdapters</a></li>
<li><a class="reference internal" href="#streamlink-plugins-re-exports">streamlink.plugins re-exports</a></li>
<li><a class="reference internal" href="#force-progress">--force-progress</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-6-0-0">streamlink 6.0.0</a><ul>
<li><a class="reference internal" href="#player-path-only-player-cli-argument">Player-path-only --player CLI argument</a></li>
<li><a class="reference internal" href="#filename-variable-in-player-args">{filename} variable in --player-args</a></li>
<li><a class="reference internal" href="#plugin-can-handle-url-and-plugin-priority">Plugin.can_handle_url() and Plugin.priority()</a></li>
<li><a class="reference internal" href="#plugin-init-self-url-compatibility-wrapper">Plugin.__init__(self, url) compatibility wrapper</a></li>
<li><a class="reference internal" href="#streamlink-g-s-et-plugin-option">Streamlink.{g,s}et_plugin_option()</a></li>
<li><a class="reference internal" href="#global-plugin-arguments">Global plugin arguments</a></li>
<li><a class="reference internal" href="#plugin-api-validate-text">plugin.api.validate.text</a></li>
<li><a class="reference internal" href="#httpstream-and-hlsstream-signature-changes">HTTPStream and HLSStream signature changes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-5-0-0">streamlink 5.0.0</a><ul>
<li><a class="reference internal" href="#session-resolve-url-return-type-changes">Session.resolve_url() return type changes</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-4-0-0">streamlink 4.0.0</a><ul>
<li><a class="reference internal" href="#streamlink-plugin-api-utils">streamlink.plugin.api.utils</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-3-0-0">streamlink 3.0.0</a><ul>
<li><a class="reference internal" href="#plugin-class-returned-by-session-resolve-url">Plugin class returned by Session.resolve_url()</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=b1b1fbe1"></script>
<script src="_static/doctools.js?v=fd6eb6e6"></script>
<script src="_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="_static/scripts/furo.js?v=46bd48cc"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
</body>
</html>