-
Notifications
You must be signed in to change notification settings - Fork 8
/
deprecations.html
799 lines (757 loc) · 58.1 KB
/
deprecations.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
<!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="Migrations" href="migrations.html" /><link rel="prev" title="Players" href="players.html" />
<!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 -->
<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="Deprecations - Streamlink 7.0.0 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>Deprecations - Streamlink 7.0.0 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=354aac6f" />
<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=302659d7" />
<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" 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">
<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 7.0.0 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-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">
<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">7.0.0</pre>
<dl class="sidebar-versions-others">
<dd><a href="/deprecations.html" class="version-current">Stable</a></dd>
<dd><a href="/latest/deprecations.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 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>
<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 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/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 current current-page"><a class="current reference internal" href="#">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="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/deprecations.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/deprecations.rst" 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">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<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">
<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="deprecations">
<h1>Deprecations<a class="headerlink" href="#deprecations" title="Link to this heading">¶</a></h1>
<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="verbose-player">
<h3>--verbose-player<a class="headerlink" href="#verbose-player" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">--verbose-player</span></code> CLI argument has been deprecated in favor of <a class="reference internal" href="cli.html#cmdoption-player-verbose"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-verbose</span></code></a>.</p>
</section>
<section id="fifo">
<h3>--fifo<a class="headerlink" href="#fifo" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">--fifo</span></code> CLI argument has been deprecated in favor of <a class="reference internal" href="cli.html#cmdoption-player-fifo"><code class="xref std std-option docutils literal notranslate"><span class="pre">--player-fifo</span></code></a>.</p>
</section>
</section>
<section id="streamlink-6-11-0">
<h2>streamlink 6.11.0<a class="headerlink" href="#streamlink-6-11-0" title="Link to this heading">¶</a></h2>
<section id="r-record-and-pipe">
<h3>-R/--record-and-pipe<a class="headerlink" href="#r-record-and-pipe" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">-R</span></code>/<code class="docutils literal notranslate"><span class="pre">--record-and-pipe</span></code> CLI argument has been deprecated in favor of using both
<a class="reference internal" href="cli.html#cmdoption-stdout"><code class="xref std std-option docutils literal notranslate"><span class="pre">--stdout</span></code></a> and <a class="reference internal" href="cli.html#cmdoption-record"><code class="xref std std-option docutils literal notranslate"><span class="pre">--record</span></code></a> arguments at the same time.</p>
</section>
</section>
<section id="streamlink-6-8-0">
<h2>streamlink 6.8.0<a class="headerlink" href="#streamlink-6-8-0" title="Link to this heading">¶</a></h2>
<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><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#streamlink-plugins-re-exports"><span class="std std-ref">Removed in 7.0.0</span></a></p>
<p>Importing <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>,
or <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> from <code class="docutils literal notranslate"><span class="pre">streamlink.plugins</span></code> now emits
a <code class="xref py py-exc docutils literal notranslate"><span class="pre">StreamlinkDeprecationWarning</span></code>. These re-exports have already been deprecated for more than ten years
and will finally be removed in the next major version. Import from the correct paths instead.</p>
</section>
</section>
<section id="streamlink-6-7-0">
<h2>streamlink 6.7.0<a class="headerlink" href="#streamlink-6-7-0" title="Link to this heading">¶</a></h2>
<section id="plugin-dirs">
<h3>--plugin-dirs<a class="headerlink" href="#plugin-dirs" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">--plugin-dirs</span></code> CLI argument for sideloading plugins from one or more custom directories, separated by commas,
has been deprecated in favor of the newly added <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, which only takes a single path,
but can be set multiple times for loading plugins from more than one path.</p>
</section>
</section>
<section id="streamlink-6-6-0">
<h2>streamlink 6.6.0<a class="headerlink" href="#streamlink-6-6-0" title="Link to this heading">¶</a></h2>
<section id="httpsession-and-httpadapters">
<h3>HTTPSession and HTTPAdapters<a class="headerlink" href="#httpsession-and-httpadapters" title="Link to this heading">¶</a></h3>
<p><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#httpsession-and-httpadapters"><span class="std std-ref">Removed in 7.0.0</span></a></p>
<p>The module structure of 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 implementation and related classes
like the <code class="docutils literal notranslate"><span class="pre">HTTPSession</span></code> has been re-organized.</p>
<p>Importing <code class="docutils literal notranslate"><span class="pre">HTTPSession</span></code> from either <code class="docutils literal notranslate"><span class="pre">streamlink.plugin.api</span></code> or <code class="docutils literal notranslate"><span class="pre">streamlink.plugin.api.http_session</span></code> is now deprecated.
It was never intended to import this class directly. Plugin implementors should always reference the session's <code class="docutils literal notranslate"><span class="pre">HTTPSession</span></code>
instance via 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">Streamlink.http</span></code></a> attribute.</p>
<p>In addition, importing <code class="docutils literal notranslate"><span class="pre">TLSNoDHAdapter</span></code> or <code class="docutils literal notranslate"><span class="pre">TLSSecLevel1Adapter</span></code> from <code class="docutils literal notranslate"><span class="pre">streamlink.plugin.api.http_session</span></code> is now also
deprecated. Import from the <code class="docutils literal notranslate"><span class="pre">streamlink.session.http</span></code> module instead, if actually necessary.</p>
</section>
<section id="streamlink-get-load-plugins">
<h3>Streamlink.{get,load}_plugins()<a class="headerlink" href="#streamlink-get-load-plugins" title="Link to this heading">¶</a></h3>
<p>As a result of the code refactoring mentioned above, the following plugins-related methods
on 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 class have been deprecated:</p>
<p><code class="docutils literal notranslate"><span class="pre">Streamlink.get_plugins()</span></code> has been deprecated in favor of
<a class="reference internal" href="api/session.html#streamlink.session.plugins.StreamlinkPlugins.get_loaded" title="streamlink.session.plugins.StreamlinkPlugins.get_loaded"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.plugins.get_loaded()</span></code></a>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Streamlink.load_plugins(path)</span></code> has been deprecated in favor of
<a class="reference internal" href="api/session.html#streamlink.session.plugins.StreamlinkPlugins.load_path" title="streamlink.session.plugins.StreamlinkPlugins.load_path"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Streamlink.plugins.load_path(path)</span></code></a>.</p>
<p><code class="docutils literal notranslate"><span class="pre">Streamlink.load_builtin_plugins()</span></code> has been deprecated in favor of using
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">plugins_builtin</span></code></a> Streamlink session keyword argument.
The old method was never publicly documented and was only used internally upon initialization.</p>
</section>
</section>
<section id="streamlink-5-4-0">
<h2>streamlink 5.4.0<a class="headerlink" href="#streamlink-5-4-0" title="Link to this heading">¶</a></h2>
<section id="force-progress">
<h3>--force-progress<a class="headerlink" href="#force-progress" title="Link to this heading">¶</a></h3>
<p><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#force-progress"><span class="std std-ref">Removed in 7.0.0</span></a></p>
<p>The <code class="docutils literal notranslate"><span class="pre">--force-progress</span></code> CLI argument has been deprecated in favor of <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>.</p>
</section>
</section>
<section id="streamlink-5-3-0">
<h2>streamlink 5.3.0<a class="headerlink" href="#streamlink-5-3-0" title="Link to this heading">¶</a></h2>
<section id="global-plugin-arguments">
<h3>Global plugin arguments<a class="headerlink" href="#global-plugin-arguments" title="Link to this heading">¶</a></h3>
<p><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#global-plugin-arguments"><span class="std std-ref">Removed in 6.0.0</span></a></p>
<p>The <code class="docutils literal notranslate"><span class="pre">is_global=True</span></code> <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">plugin</span> <span class="pre">argument</span></code></a> parameter has been deprecated.
Instead of defining a global plugin argument to set a key-value pair on the plugin's options, use the respective option on
the plugin's Streamlink session instance instead.</p>
</section>
</section>
<section id="streamlink-5-2-0">
<h2>streamlink 5.2.0<a class="headerlink" href="#streamlink-5-2-0" title="Link to this heading">¶</a></h2>
<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><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#plugin-api-validate-text"><span class="std std-ref">Removed in 6.0.0</span></a></p>
<p>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> has been marked as deprecated, as it is a remnant of the py2 implementation.
Simply replace <code class="docutils literal notranslate"><span class="pre">validate.text</span></code> with <code class="docutils literal notranslate"><span class="pre">str</span></code> in each validation schema.</p>
</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="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><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#plugin-init-self-url-compatibility-wrapper"><span class="std std-ref">Removed in 6.0.0</span></a></p>
<p>With the removal of the <code class="docutils literal notranslate"><span class="pre">Plugin.bind()</span></code> class method which was used for setting up 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 and module name in each plugin class,
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's signature was changed and it now requires
the <code class="docutils literal notranslate"><span class="pre">session</span></code> and <code class="docutils literal notranslate"><span class="pre">url</span></code> arguments. Implementors of custom plugins should define variable positional arguments and keyword
arguments when subclassing and adding a custom constructor (<code class="docutils literal notranslate"><span class="pre">*args,</span> <span class="pre">**kwargs</span></code>), and the <code class="docutils literal notranslate"><span class="pre">url</span></code> should be accessed via
<code class="docutils literal notranslate"><span class="pre">self.url</span></code> after calling the constructor of the super class.</p>
<p>Compatibility wrappers were added for old custom plugin implementations, and a deprecation message will be shown until
the compatibility wrappers will get removed in a future release.</p>
</section>
</section>
<section id="streamlink-4-2-0">
<h2>streamlink 4.2.0<a class="headerlink" href="#streamlink-4-2-0" title="Link to this heading">¶</a></h2>
<section id="url-master-in-hlsstream">
<h3>url_master in HLSStream<a class="headerlink" href="#url-master-in-hlsstream" title="Link to this heading">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">url_master</span></code> parameter and attribute of the <a class="reference internal" href="api/stream.html#streamlink.stream.HLSStream" title="streamlink.stream.HLSStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">HLSStream</span></code></a>
and <a class="reference internal" href="api/stream.html#streamlink.stream.MuxedHLSStream" title="streamlink.stream.MuxedHLSStream"><code class="xref py py-class docutils literal notranslate"><span class="pre">MuxedHLSStream</span></code></a> classes have been deprecated in favor of
the <code class="docutils literal notranslate"><span class="pre">multivariant</span></code> parameter and attribute. <code class="docutils literal notranslate"><span class="pre">multivariant</span></code> is an <code class="xref py py-class docutils literal notranslate"><span class="pre">M3U8</span></code> reference of the parsed
HLS multivariant playlist.</p>
</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="https-proxy-option">
<h3>https-proxy option<a class="headerlink" href="#https-proxy-option" title="Link to this heading">¶</a></h3>
<p><a class="reference internal" href="cli.html#http-options"><span class="std std-ref">HTTPS proxy CLI option</span></a> and the respective <a class="reference internal" href="api/session.html#session"><span class="std std-ref">Session options</span></a>
have been deprecated in favor of a single <a class="reference internal" href="cli.html#cmdoption-http-proxy"><code class="xref std std-option docutils literal notranslate"><span class="pre">--http-proxy</span></code></a> that sets the proxy for all HTTP and
HTTPS requests, including WebSocket connections.</p>
</section>
</section>
<section id="streamlink-2-4-0">
<h2>streamlink 2.4.0<a class="headerlink" href="#streamlink-2-4-0" title="Link to this heading">¶</a></h2>
<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><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#stream-type-related-cli-arguments"><span class="std std-ref">Removed in 7.0.0</span></a></p>
<p><a class="reference internal" href="cli.html#stream-transport-options"><span class="std std-ref">Stream-type related CLI arguments</span></a> and the respective
<a class="reference internal" href="api/session.html#session"><span class="std std-ref">Session options</span></a> have been deprecated in favor of existing generic arguments/options,
to avoid redundancy and potential confusion.</p>
<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">--{dash,hds,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">--{dash,hds,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">--{dash,hds,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">--{dash,hds,hls,rtmp,http-stream}-timeout</span></code></p></li>
</ul>
</section>
</section>
<section id="streamlink-2-3-0">
<h2>streamlink 2.3.0<a class="headerlink" href="#streamlink-2-3-0" title="Link to this heading">¶</a></h2>
<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><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#plugin-can-handle-url-and-plugin-priority"><span class="std std-ref">Removed in 6.0.0</span></a></p>
<p>A new plugin URL matching API was introduced in 2.3.0 which will help Streamlink with static code analysis and an improved
plugin loading mechanism in the future. Plugins now define their matching URLs and priorities declaratively.</p>
<p>The old <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 have therefore been deprecated and will be removed in the future.
When side-loading plugins which don't implement the new <code class="docutils literal notranslate"><span class="pre">@pluginmatcher</span></code> but implement the old classmethods, a deprecation
message will be written to the info log output for the first plugin that gets resolved this way.</p>
<p><strong>Deprecated plugin URL matching</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">streamlink.plugin</span> <span class="kn">import</span> <span class="n">Plugin</span>
<span class="kn">from</span> <span class="nn">streamlink.plugin.plugin</span> <span class="kn">import</span> <span class="n">HIGH_PRIORITY</span><span class="p">,</span> <span class="n">NORMAL_PRIORITY</span>
<span class="k">class</span> <span class="nc">MyPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
<span class="n">_re_url_one</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span>
<span class="sa">r</span><span class="s2">"https?://pattern-(?P<param>one)"</span>
<span class="p">)</span>
<span class="n">_re_url_two</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">"""</span>
<span class="s2"> https?://pattern-(?P<param>two)</span>
<span class="s2"> """</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">VERBOSE</span><span class="p">)</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">can_handle_url</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">url</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_re_url_one</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">url</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> \
<span class="ow">or</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_re_url_two</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">url</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
<span class="nd">@classmethod</span>
<span class="k">def</span> <span class="nf">priority</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">url</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">cls</span><span class="o">.</span><span class="n">_re_url_two</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">url</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="n">HIGH_PRIORITY</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="n">NORMAL_PRIORITY</span>
<span class="k">def</span> <span class="nf">_get_streams</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">match_one</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_re_url_one</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">)</span>
<span class="n">match_two</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_re_url_two</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">url</span><span class="p">)</span>
<span class="n">match</span> <span class="o">=</span> <span class="n">match_one</span> <span class="ow">or</span> <span class="n">match_two</span>
<span class="n">param</span> <span class="o">=</span> <span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s2">"param"</span><span class="p">)</span>
<span class="k">if</span> <span class="n">match_one</span><span class="p">:</span>
<span class="k">yield</span> <span class="o">...</span>
<span class="k">elif</span> <span class="n">match_two</span><span class="p">:</span>
<span class="k">yield</span> <span class="o">...</span>
<span class="n">__plugin__</span> <span class="o">=</span> <span class="n">MyPlugin</span>
</pre></div>
</div>
<p><strong>Migration</strong></p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">re</span>
<span class="kn">from</span> <span class="nn">streamlink.plugin</span> <span class="kn">import</span> <span class="n">HIGH_PRIORITY</span><span class="p">,</span> <span class="n">Plugin</span><span class="p">,</span> <span class="n">pluginmatcher</span>
<span class="nd">@pluginmatcher</span><span class="p">(</span><span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span>
<span class="sa">r</span><span class="s2">"https?://pattern-(?P<param>one)"</span>
<span class="p">))</span>
<span class="nd">@pluginmatcher</span><span class="p">(</span><span class="n">priority</span><span class="o">=</span><span class="n">HIGH_PRIORITY</span><span class="p">,</span> <span class="n">pattern</span><span class="o">=</span><span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">"""</span>
<span class="s2"> https?://pattern-(?P<param>two)</span>
<span class="s2">"""</span><span class="p">,</span> <span class="n">re</span><span class="o">.</span><span class="n">VERBOSE</span><span class="p">))</span>
<span class="k">class</span> <span class="nc">MyPlugin</span><span class="p">(</span><span class="n">Plugin</span><span class="p">):</span>
<span class="k">def</span> <span class="nf">_get_streams</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="n">param</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s2">"param"</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">matches</span><span class="p">[</span><span class="mi">0</span><span class="p">]:</span>
<span class="k">yield</span> <span class="o">...</span>
<span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">matches</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">yield</span> <span class="o">...</span>
<span class="n">__plugin__</span> <span class="o">=</span> <span class="n">MyPlugin</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Plugins which have more sophisticated logic in their <code class="docutils literal notranslate"><span class="pre">can_handle_url()</span></code> classmethod need to be rewritten with
multiple <code class="docutils literal notranslate"><span class="pre">@pluginmatcher</span></code> decorators and/or an improved <code class="docutils literal notranslate"><span class="pre">_get_streams()</span></code> method which returns <code class="docutils literal notranslate"><span class="pre">None</span></code> or raises a
<code class="docutils literal notranslate"><span class="pre">NoStreamsError</span></code> when there are no streams to be found on that particular URL.</p>
</div>
</section>
</section>
<section id="streamlink-2-2-0">
<h2>streamlink 2.2.0<a class="headerlink" href="#streamlink-2-2-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><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#config-file-paths"><span class="std std-ref">Removed in 7.0.0</span></a></p>
<p>Streamlink's default config file paths got updated and corrected on Linux/BSD, macOS and Windows.
Old and deprecated paths will be dropped in the future.</p>
<p>Only the first existing config file will be loaded. If a config file gets loaded from a deprecated path,
a deprecation message will be written to the info log output.</p>
<p>To resolve this, move the config file(s) to the correct location or copy the contents of the old file(s) to the new one(s).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Please note that this also affects all plugin config files, as they use the same path as the primary config file but with
<code class="docutils literal notranslate"><span class="pre">.pluginname</span></code> appended to the file name, eg. <code class="docutils literal notranslate"><span class="pre">config.twitch</span></code>.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><strong>On Windows</strong>, when installing Streamlink via the Windows installer, a default config file gets created automatically due
to technical reasons (bundled ffmpeg and rtmpdump dependencies). This means that the Windows installer will create a
config file with the new name when upgrading from an earlier version to Streamlink 2.2.0+, and the old config file won't be
loaded as a result of this.</p>
<p>This is unfortunately a soft breaking change, as the Windows installer is not supposed to touch user config data and the
users are required to update this by themselves.</p>
</div>
<p><strong>Deprecated paths</strong></p>
<div class="table-wrapper table-custom-layout table-custom-layout-platform-locations docutils container">
<table class="table-custom-layout table-custom-layout-platform-locations docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Platform</p></th>
<th class="head"><p>Location</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Linux/BSD</p></td>
<td><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">${HOME}/.streamlinkrc</span></code></p></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><p>macOS</p></td>
<td><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">${HOME}/.streamlinkrc</span></code></p></li>
</ul>
</td>
</tr>
<tr class="row-even"><td><p>Windows</p></td>
<td><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\streamlink\streamlinkrc</span></code></p></li>
</ul>
</td>
</tr>
</tbody>
</table>
</div>
<p><strong>Migration</strong></p>
<div class="table-wrapper table-custom-layout table-custom-layout-platform-locations docutils container">
<table class="table-custom-layout table-custom-layout-platform-locations docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Platform</p></th>
<th class="head"><p>Location</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Linux/BSD</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/config</span></code></p></td>
</tr>
<tr class="row-odd"><td><p>macOS</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">${HOME}/Library/Application Support/streamlink/config</span></code></p></td>
</tr>
<tr class="row-even"><td><p>Windows</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">%APPDATA%\streamlink\config</span></code></p></td>
</tr>
</tbody>
</table>
</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><a class="sd-sphinx-override sd-badge sd-bg-danger sd-bg-text-danger reference internal" href="migrations.html#custom-plugins-sideloading-paths"><span class="std std-ref">Removed in 7.0.0</span></a></p>
<p>Streamlink's default custom plugins directory path got updated and corrected on Linux/BSD and macOS.
Old and deprecated paths will be dropped in the future.</p>
<p><strong>Deprecated paths</strong></p>
<div class="table-wrapper table-custom-layout table-custom-layout-platform-locations docutils container">
<table class="table-custom-layout table-custom-layout-platform-locations docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Platform</p></th>
<th class="head"><p>Location</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Linux/BSD</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins</span></code></p></td>
</tr>
<tr class="row-odd"><td><p>macOS</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">${XDG_CONFIG_HOME:-${HOME}/.config}/streamlink/plugins</span></code></p></td>
</tr>
</tbody>
</table>
</div>
<p><strong>Migration</strong></p>
<div class="table-wrapper table-custom-layout table-custom-layout-platform-locations docutils container">
<table class="table-custom-layout table-custom-layout-platform-locations docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Platform</p></th>
<th class="head"><p>Location</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>Linux/BSD</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">${XDG_DATA_HOME:-${HOME}/.local/share}/streamlink/plugins</span></code></p></td>
</tr>
<tr class="row-odd"><td><p>macOS</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">${HOME}/Library/Application Support/streamlink/plugins</span></code></p></td>
</tr>
</tbody>
</table>
</div>
</section>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="migrations.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Migrations</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="players.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">Players</div>
</div>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © 2024, 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="#">Deprecations</a><ul>
<li><a class="reference internal" href="#streamlink-7-0-0">streamlink 7.0.0</a><ul>
<li><a class="reference internal" href="#verbose-player">--verbose-player</a></li>
<li><a class="reference internal" href="#fifo">--fifo</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-6-11-0">streamlink 6.11.0</a><ul>
<li><a class="reference internal" href="#r-record-and-pipe">-R/--record-and-pipe</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-6-8-0">streamlink 6.8.0</a><ul>
<li><a class="reference internal" href="#streamlink-plugins-re-exports">streamlink.plugins re-exports</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-6-7-0">streamlink 6.7.0</a><ul>
<li><a class="reference internal" href="#plugin-dirs">--plugin-dirs</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-6-6-0">streamlink 6.6.0</a><ul>
<li><a class="reference internal" href="#httpsession-and-httpadapters">HTTPSession and HTTPAdapters</a></li>
<li><a class="reference internal" href="#streamlink-get-load-plugins">Streamlink.{get,load}_plugins()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-5-4-0">streamlink 5.4.0</a><ul>
<li><a class="reference internal" href="#force-progress">--force-progress</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-5-3-0">streamlink 5.3.0</a><ul>
<li><a class="reference internal" href="#global-plugin-arguments">Global plugin arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-5-2-0">streamlink 5.2.0</a><ul>
<li><a class="reference internal" href="#plugin-api-validate-text">plugin.api.validate.text</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="#plugin-init-self-url-compatibility-wrapper">Plugin.__init__(self, url) compatibility wrapper</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-4-2-0">streamlink 4.2.0</a><ul>
<li><a class="reference internal" href="#url-master-in-hlsstream">url_master in HLSStream</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="#https-proxy-option">https-proxy option</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-2-4-0">streamlink 2.4.0</a><ul>
<li><a class="reference internal" href="#stream-type-related-cli-arguments">Stream-type related CLI arguments</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-2-3-0">streamlink 2.3.0</a><ul>
<li><a class="reference internal" href="#plugin-can-handle-url-and-plugin-priority">Plugin.can_handle_url() and Plugin.priority()</a></li>
</ul>
</li>
<li><a class="reference internal" href="#streamlink-2-2-0">streamlink 2.2.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>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=efe5be6f"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=5fa4622c"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
</body>
</html>