-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathcaps.html
More file actions
1154 lines (1113 loc) · 52.9 KB
/
caps.html
File metadata and controls
1154 lines (1113 loc) · 52.9 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
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>FFmpeg Capabilities References — python-ffmpegio 0.11.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="_static/css/custom.css?v=048f17f8" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=f3b36f1a"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
python-ffmpegio
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<!-- Local TOC -->
<div class="local-toc"><ul>
<li><a class="reference internal" href="#">FFmpeg Capabilities References</a><ul>
<li><a class="reference internal" href="#list-of-functions">List of Functions</a></li>
<li><a class="reference internal" href="#list-of-constants">List of Constants</a></li>
<li><a class="reference internal" href="#function-references">Function References</a><ul>
<li><a class="reference internal" href="#ffmpegio.caps.options"><code class="docutils literal notranslate"><span class="pre">options()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.pix_fmts"><code class="docutils literal notranslate"><span class="pre">pix_fmts()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.sample_fmts"><code class="docutils literal notranslate"><span class="pre">sample_fmts()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.layouts"><code class="docutils literal notranslate"><span class="pre">layouts()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.colors"><code class="docutils literal notranslate"><span class="pre">colors()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.filters"><code class="docutils literal notranslate"><span class="pre">filters()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.filter_info"><code class="docutils literal notranslate"><span class="pre">filter_info()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.codecs"><code class="docutils literal notranslate"><span class="pre">codecs()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.encoders"><code class="docutils literal notranslate"><span class="pre">encoders()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.encoder_info"><code class="docutils literal notranslate"><span class="pre">encoder_info()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.decoders"><code class="docutils literal notranslate"><span class="pre">decoders()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.decoder_info"><code class="docutils literal notranslate"><span class="pre">decoder_info()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.formats"><code class="docutils literal notranslate"><span class="pre">formats()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.muxers"><code class="docutils literal notranslate"><span class="pre">muxers()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.muxer_info"><code class="docutils literal notranslate"><span class="pre">muxer_info()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.demuxers"><code class="docutils literal notranslate"><span class="pre">demuxers()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.demuxer_info"><code class="docutils literal notranslate"><span class="pre">demuxer_info()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.bsfilters"><code class="docutils literal notranslate"><span class="pre">bsfilters()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.bsfilter_info"><code class="docutils literal notranslate"><span class="pre">bsfilter_info()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.devices"><code class="docutils literal notranslate"><span class="pre">devices()</span></code></a></li>
<li><a class="reference internal" href="#ffmpegio.caps.protocols"><code class="docutils literal notranslate"><span class="pre">protocols()</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">python-ffmpegio</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">FFmpeg Capabilities References</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/caps.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="ffmpeg-capabilities-references">
<span id="caps"></span><h1>FFmpeg Capabilities References<a class="headerlink" href="#ffmpeg-capabilities-references" title="Link to this heading"></a></h1>
<p><code class="xref py py-mod docutils literal notranslate"><span class="pre">ffmpegio.caps</span></code> module contains a set of functions to wrap ffmpeg’s
help/show commands to check the capabilities of the ffmpeg executable that
the <code class="xref py py-mod docutils literal notranslate"><span class="pre">ffmpegio</span></code> is employing.</p>
<div class="admonition-todo admonition" id="id1">
<p class="admonition-title">Todo</p>
<p>Parsing the additional command options that are specific to the containers,
codecs, and filters. The <code class="code docutils literal notranslate"><span class="pre">options</span></code> fields are currently returned as
unparsed <code class="code docutils literal notranslate"><span class="pre">str</span></code></p>
</div>
<section id="list-of-functions">
<h2>List of Functions<a class="headerlink" href="#list-of-functions" title="Link to this heading"></a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.options" title="ffmpegio.caps.options"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.options</span></code></a></p></td>
<td><p>get FFmpeg command options</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.pix_fmts" title="ffmpegio.caps.pix_fmts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.pix_fmts</span></code></a></p></td>
<td><p>get supported pixel formats</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.sample_fmts" title="ffmpegio.caps.sample_fmts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.sample_fmts</span></code></a></p></td>
<td><p>get supported audio sample formats</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.layouts" title="ffmpegio.caps.layouts"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.layouts</span></code></a></p></td>
<td><p>get supported audio channel layouts</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.colors" title="ffmpegio.caps.colors"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.colors</span></code></a></p></td>
<td><p>get recognized color names</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.filters" title="ffmpegio.caps.filters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.filters</span></code></a></p></td>
<td><p>get FFmpeg filters</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.filter_info" title="ffmpegio.caps.filter_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.filter_info</span></code></a></p></td>
<td><p>get detailed info of a filter</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.codecs" title="ffmpegio.caps.codecs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.codecs</span></code></a></p></td>
<td><p>get FFmpeg codecs</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.encoders" title="ffmpegio.caps.encoders"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.encoders</span></code></a></p></td>
<td><p>get summary of FFmpeg encoders</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.encoder_info" title="ffmpegio.caps.encoder_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.encoder_info</span></code></a></p></td>
<td><p>get detailed info of an encoder</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.decoders" title="ffmpegio.caps.decoders"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.decoders</span></code></a></p></td>
<td><p>get summary of FFmpeg decoders</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.decoder_info" title="ffmpegio.caps.decoder_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.decoder_info</span></code></a></p></td>
<td><p>get detailed info of a decoder</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.formats" title="ffmpegio.caps.formats"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.formats</span></code></a></p></td>
<td><p>get FFmpeg formats</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.muxers" title="ffmpegio.caps.muxers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.muxers</span></code></a></p></td>
<td><p>get FFmpeg muxers</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.muxer_info" title="ffmpegio.caps.muxer_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.muxer_info</span></code></a></p></td>
<td><p>get detailed info of a media muxer</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.demuxers" title="ffmpegio.caps.demuxers"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.demuxers</span></code></a></p></td>
<td><p>get FFmpeg demuxers</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.demuxer_info" title="ffmpegio.caps.demuxer_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.demuxer_info</span></code></a></p></td>
<td><p>get detailed info of a media demuxer</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.bsfilters" title="ffmpegio.caps.bsfilters"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.bsfilters</span></code></a></p></td>
<td><p>get list of FFmpeg bitstream filters</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.bsfilter_info" title="ffmpegio.caps.bsfilter_info"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.bsfilter_info</span></code></a></p></td>
<td><p>get detailed info of a bitstream filter</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#ffmpegio.caps.devices" title="ffmpegio.caps.devices"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.devices</span></code></a></p></td>
<td><p>get FFmpeg devices</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#ffmpegio.caps.protocols" title="ffmpegio.caps.protocols"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.protocols</span></code></a></p></td>
<td><p>get list of supported protocols</p></td>
</tr>
</tbody>
</table>
<div class="admonition-todo admonition" id="id2">
<p class="admonition-title">Todo</p>
<p>Remaining commands to be wrapped: sources, sinks, h protocol, dispositions</p>
</div>
</section>
<section id="list-of-constants">
<h2>List of Constants<a class="headerlink" href="#list-of-constants" title="Link to this heading"></a></h2>
<table class="autosummary longtable docutils align-default">
<tbody>
<tr class="row-odd"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.video_size_presets</span></code></p></td>
<td><p>list of video size presets with their sizes</p></td>
</tr>
<tr class="row-even"><td><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">ffmpegio.caps.frame_rate_presets</span></code></p></td>
<td><p>list of video frame rate presets with their rates</p></td>
</tr>
</tbody>
</table>
</section>
<section id="function-references">
<h2>Function References<a class="headerlink" href="#function-references" title="Link to this heading"></a></h2>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.options">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">return_desc</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.options" title="Link to this definition"></a></dt>
<dd><p>get FFmpeg command options</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<em>"per-file"</em><em>|</em><em>"video"</em><em>|</em><em>"audio"</em><em>|</em><em>"subtitle"</em><em>|</em><em>"general"</em><em>|</em><em>"global"</em><em>|</em><em>None</em><em>, </em><em>optional</em>) – specify option type to return, defaults to None</p></li>
<li><p><strong>name_only</strong> (<em>bool</em><em>, </em><em>optional</em>) – True to only return option names, defaults to False</p></li>
<li><p><strong>return_desc</strong> (<em>bool</em><em>, </em><em>optional</em>) – True to also return option description, defaults to False</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>dict of types of options</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict(dict or tuple) if type not specified</p>
</dd>
</dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.pix_fmts">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">pix_fmts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.pix_fmts" title="Link to this definition"></a></dt>
<dd><p>get supported pixel formats</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of supported pixel formats</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a pix_fmt and its value is a dict
with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>nb_components</p></td>
<td><p>int</p></td>
<td><p>Number of color components</p></td>
</tr>
<tr class="row-odd"><td><p>bits_per_pixel</p></td>
<td><p>int</p></td>
<td><p>Number of bits per pixel</p></td>
</tr>
<tr class="row-even"><td><p>input</p></td>
<td><p>bool</p></td>
<td><p>True if can be used as an input option</p></td>
</tr>
<tr class="row-odd"><td><p>output</p></td>
<td><p>bool</p></td>
<td><p>True if can be used as an output option</p></td>
</tr>
<tr class="row-even"><td><p>hw_accel</p></td>
<td><p>bool</p></td>
<td><p>True if supported by hardware accelerators</p></td>
</tr>
<tr class="row-odd"><td><p>paletted</p></td>
<td><p>bool</p></td>
<td><p>True if uses paletted colors</p></td>
</tr>
<tr class="row-even"><td><p>bitstream</p></td>
<td><p>bool</p></td>
<td><p>True if can be used with bistreams</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.sample_fmts">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">sample_fmts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.sample_fmts" title="Link to this definition"></a></dt>
<dd><p>get supported audio sample formats</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of supported audio sample formats</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a sample_fmt and its value
is the number of bits per sample.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.layouts">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">layouts</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.layouts" title="Link to this definition"></a></dt>
<dd><p>get supported audio channel layouts</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of supported audio channel layouts</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>Returned dict has two keys “channels” and “layouts”. The value of “channels”
is a dict of possible channel names as keys and their descriptions as values.
The value of “layouts” is also a dict, which keys specifies the names and
their value strs indicate the combinations of channels (their names are
“+”ed).</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.colors">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">colors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.colors" title="Link to this definition"></a></dt>
<dd><p>get recognized color names</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of color names</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>The keys of the returned dict are the name of the colors and their values
are the RGB hex strs.</p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.filters">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">filters</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.filters" title="Link to this definition"></a></dt>
<dd><p>get FFmpeg filters</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>type</strong> (<em>'audio'</em><em>|</em><em>'video'</em><em>|</em><em>'dynamic'</em><em>, </em><em>optional</em>) – specify input or output stream type, defaults to None</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>dict of summary of the filters</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict(key,FilterSummary)</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a filter and its value is a
FilterSummary namedtuple with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Short description of the filter</p></td>
</tr>
<tr class="row-odd"><td><p>input</p></td>
<td><p>str</p></td>
<td><p>Input stream type: ‘audio’|’video’|’dynamic’</p></td>
</tr>
<tr class="row-even"><td><p>num_inputs</p></td>
<td><p>int|None</p></td>
<td><p>Number of inputs or None if ‘dynamic’</p></td>
</tr>
<tr class="row-odd"><td><p>output</p></td>
<td><p>str</p></td>
<td><p>Output stream type: ‘audio’|’video’|’dynamic’</p></td>
</tr>
<tr class="row-even"><td><p>num_outputs</p></td>
<td><p>int|None</p></td>
<td><p>Number of outputs or None if ‘dynamic’</p></td>
</tr>
<tr class="row-odd"><td><p>timeline_support</p></td>
<td><p>bool</p></td>
<td><p>True if supports timeline editing</p></td>
</tr>
<tr class="row-even"><td><p>slice_threading</p></td>
<td><p>bool</p></td>
<td><p>True if supports threading</p></td>
</tr>
<tr class="row-odd"><td><p>command_support</p></td>
<td><p>bool</p></td>
<td><p>True if supports command input from stdin</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.filter_info">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">filter_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.filter_info" title="Link to this definition"></a></dt>
<dd><p>get detailed info of a filter</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of features</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>FilterInfo (namedtuple)</p>
</dd>
</dl>
<p>The returned FilterInfo named tuple has following entries:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>name</p></td>
<td><p>str</p></td>
<td><p>Name</p></td>
</tr>
<tr class="row-odd"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Description</p></td>
</tr>
<tr class="row-even"><td><p>threading</p></td>
<td><p>list(str)</p></td>
<td><p>List of threading capabilities</p></td>
</tr>
<tr class="row-odd"><td><p>inputs</p></td>
<td><p>list(dict)|str</p></td>
<td><p>List of input pads or ‘dynamic’ if variable</p></td>
</tr>
<tr class="row-even"><td><p>outputs</p></td>
<td><p>list(dict)|str</p></td>
<td><p>List of output pads or ‘dynamic’ if variable</p></td>
</tr>
<tr class="row-odd"><td><p>options</p></td>
<td><p>list(FilterOption)</p></td>
<td><p>List of filter options</p></td>
</tr>
<tr class="row-even"><td><p>extra_options</p></td>
<td><p>dict(str,list(FilterOption))</p></td>
<td><p>Extra options co-listed</p></td>
</tr>
<tr class="row-odd"><td><p>timeline_support</p></td>
<td><p>bool</p></td>
<td><p>True if <cite>enable</cite> timeline option is supported</p></td>
</tr>
</tbody>
</table>
<p>‘inputs’ and ‘outputs’ entries has two keys: ‘name’ and ‘type’
defining the pad name and pad stream type (‘audio’ or ‘video’)</p>
<p>FilterOption is a namedtuple with the following entries:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>name</p></td>
<td><p>str</p></td>
<td><p>Name</p></td>
</tr>
<tr class="row-odd"><td><p>alias</p></td>
<td><p>str</p></td>
<td><p>Alias name</p></td>
</tr>
<tr class="row-even"><td><p>type</p></td>
<td><p>str</p></td>
<td><p>Data type</p></td>
</tr>
<tr class="row-odd"><td><p>help</p></td>
<td><p>str</p></td>
<td><p>Help text</p></td>
</tr>
<tr class="row-even"><td><p>ranges</p></td>
<td><p>list(tuple(any,any))|None</p></td>
<td><p>List of ranges of values</p></td>
</tr>
<tr class="row-odd"><td><p>constants</p></td>
<td><p>dict(str:any)</p></td>
<td><p>List of defined constant/enum values</p></td>
</tr>
<tr class="row-even"><td><p>default</p></td>
<td><p>any</p></td>
<td><p>Default value</p></td>
</tr>
<tr class="row-odd"><td><p>video</p></td>
<td><p>bool</p></td>
<td><p>True if option for video stream</p></td>
</tr>
<tr class="row-even"><td><p>audio</p></td>
<td><p>bool</p></td>
<td><p>True if option for audio stream</p></td>
</tr>
<tr class="row-odd"><td><p>runtime</p></td>
<td><p>bool</p></td>
<td><p>True if modifiable during runtime</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.codecs">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">codecs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">stream_type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.codecs" title="Link to this definition"></a></dt>
<dd><p>get FFmpeg codecs</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>type</strong> (<em>'decoder'</em><em>|</em><em>'encoder'</em><em>, </em><em>optional</em>) – Specify to list only decoder or encoder, defaults to None</p></li>
<li><p><strong>stream_type</strong> (<em>'audio'</em><em>|</em><em>'video'</em><em>|</em><em>'subtitle'</em><em>, </em><em>optional</em>) – Specify to stream type, defaults to None</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>summary of FFmpeg codecs</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a codec and its value is a dict
with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>type</p></td>
<td><p>str</p></td>
<td><p>Stream type: ‘audio’|’video’|’subtitle’</p></td>
</tr>
<tr class="row-odd"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Short description of the codec</p></td>
</tr>
<tr class="row-even"><td><p>can_decode</p></td>
<td><p>bool</p></td>
<td><p>True if FFmpeg can decode</p></td>
</tr>
<tr class="row-odd"><td><p>decoders</p></td>
<td><p>list(str)</p></td>
<td><p>List of compatible decoders</p></td>
</tr>
<tr class="row-even"><td><p>can_encode</p></td>
<td><p>bool</p></td>
<td><p>True if FFmpeg can encode</p></td>
</tr>
<tr class="row-odd"><td><p>encoders</p></td>
<td><p>list(str)</p></td>
<td><p>List of compatible encoders</p></td>
</tr>
<tr class="row-even"><td><p>intra_frame_only</p></td>
<td><p>bool</p></td>
<td><p>True if codec only uses intra-frame coding</p></td>
</tr>
<tr class="row-odd"><td><p>is_lossy</p></td>
<td><p>bool</p></td>
<td><p>True if codec can do lossy compression</p></td>
</tr>
<tr class="row-even"><td><p>is_lossless</p></td>
<td><p>bool</p></td>
<td><p>True if codec can do lossless compression</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.encoders">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">encoders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.encoders" title="Link to this definition"></a></dt>
<dd><p>get summary of FFmpeg encoders</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>type</strong> (<em>'audio'</em><em>|</em><em>'video'</em><em>|</em><em>'subtitle'</em><em>, </em><em>optional</em>) – specify stream type, defaults to None</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of encoders</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a decoder or encoder and its
value is a dict with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>type</p></td>
<td><p>str</p></td>
<td><p>Stream type: ‘audio’|’video’|’subtitle’</p></td>
</tr>
<tr class="row-odd"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Short description of the coder</p></td>
</tr>
<tr class="row-even"><td><p>frame_mt</p></td>
<td><p>bool</p></td>
<td><p>True if employs frame-level multithreading</p></td>
</tr>
<tr class="row-odd"><td><p>slice_mt</p></td>
<td><p>bool</p></td>
<td><p>True if employs slice-level multithreading</p></td>
</tr>
<tr class="row-even"><td><p>experimental</p></td>
<td><p>bool</p></td>
<td><p>True if experimental encoder</p></td>
</tr>
<tr class="row-odd"><td><p>draw_horiz_band</p></td>
<td><p>bool</p></td>
<td><p>True if supports draw_horiz_band</p></td>
</tr>
<tr class="row-even"><td><p>directRendering</p></td>
<td><p>bool</p></td>
<td><p>True if supports direct encoding method 1</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.encoder_info">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">encoder_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.encoder_info" title="Link to this definition"></a></dt>
<dd><p>get detailed info of an encoder</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of features</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>The returned dict has following entries:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>name</p></td>
<td><p>list(str)</p></td>
<td><p>Short names</p></td>
</tr>
<tr class="row-odd"><td><p>long_name</p></td>
<td><p>str</p></td>
<td><p>Long name</p></td>
</tr>
<tr class="row-even"><td><p>capabilities</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported capabilities</p></td>
</tr>
<tr class="row-odd"><td><p>threading</p></td>
<td><p>list(str)</p></td>
<td><p>List of threading capabilities</p></td>
</tr>
<tr class="row-even"><td><p>supported_hwdevices</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported hardware accelerators</p></td>
</tr>
<tr class="row-odd"><td><p>supported_framerates</p></td>
<td><p>list(Fraction)</p></td>
<td><p>List of supported video frame rates</p></td>
</tr>
<tr class="row-even"><td><p>supported_pix_fmts</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported video pixel formats</p></td>
</tr>
<tr class="row-odd"><td><p>supported_sample_rates</p></td>
<td><p>list(int)</p></td>
<td><p>List of supported audio sample rates</p></td>
</tr>
<tr class="row-even"><td><p>supported_sample_fmts</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported audio sample formats</p></td>
</tr>
<tr class="row-odd"><td><p>supported_layouts</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported audio channel layouts</p></td>
</tr>
<tr class="row-even"><td><p>options</p></td>
<td><p>str</p></td>
<td><p>Unparsed string, listing supported options</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.decoders">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">decoders</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.decoders" title="Link to this definition"></a></dt>
<dd><p>get summary of FFmpeg decoders</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>stream_type</strong> (<em>'audio'</em><em>|</em><em>'video'</em><em>|</em><em>'subtitle'</em><em>, </em><em>optional</em>) – specify stream type, defaults to None</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>list of decoders or encoders</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a decoder and its
value is a dict with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>type</p></td>
<td><p>str</p></td>
<td><p>Stream type: ‘audio’|’video’|’subtitle’</p></td>
</tr>
<tr class="row-odd"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Short description of the coder</p></td>
</tr>
<tr class="row-even"><td><p>frame_mt</p></td>
<td><p>bool</p></td>
<td><p>True if employs frame-level multithreading</p></td>
</tr>
<tr class="row-odd"><td><p>slice_mt</p></td>
<td><p>bool</p></td>
<td><p>True if employs slice-level multithreading</p></td>
</tr>
<tr class="row-even"><td><p>experimental</p></td>
<td><p>bool</p></td>
<td><p>True if experimental encoder</p></td>
</tr>
<tr class="row-odd"><td><p>draw_horiz_band</p></td>
<td><p>bool</p></td>
<td><p>True if supports draw_horiz_band</p></td>
</tr>
<tr class="row-even"><td><p>directRendering</p></td>
<td><p>bool</p></td>
<td><p>True if supports direct encoding method 1</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.decoder_info">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">decoder_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.decoder_info" title="Link to this definition"></a></dt>
<dd><p>get detailed info of a decoder</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of features</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>The returned dict has following entries:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>name</p></td>
<td><p>list(str)</p></td>
<td><p>Short names</p></td>
</tr>
<tr class="row-odd"><td><p>long_name</p></td>
<td><p>str</p></td>
<td><p>Long name</p></td>
</tr>
<tr class="row-even"><td><p>capabilities</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported capabilities</p></td>
</tr>
<tr class="row-odd"><td><p>threading</p></td>
<td><p>list(str)</p></td>
<td><p>List of threading capabilities</p></td>
</tr>
<tr class="row-even"><td><p>supported_hwdevices</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported hardware accelerators</p></td>
</tr>
<tr class="row-odd"><td><p>supported_framerates</p></td>
<td><p>list(Fraction)</p></td>
<td><p>List of supported video frame rates</p></td>
</tr>
<tr class="row-even"><td><p>supported_pix_fmts</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported video pixel formats</p></td>
</tr>
<tr class="row-odd"><td><p>supported_sample_rates</p></td>
<td><p>list(int)</p></td>
<td><p>List of supported audio sample rates</p></td>
</tr>
<tr class="row-even"><td><p>supported_sample_fmts</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported audio sample formats</p></td>
</tr>
<tr class="row-odd"><td><p>supported_layouts</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported audio channel layouts</p></td>
</tr>
<tr class="row-even"><td><p>options</p></td>
<td><p>str</p></td>
<td><p>Unparsed string, listing supported options</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.formats">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">formats</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.formats" title="Link to this definition"></a></dt>
<dd><p>get FFmpeg formats</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of formats</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a format and its value is a dict
with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Short description of the format</p></td>
</tr>
<tr class="row-odd"><td><p>can_demux</p></td>
<td><p>bool</p></td>
<td><p>True if supports inputs of this format</p></td>
</tr>
<tr class="row-even"><td><p>can_mux</p></td>
<td><p>bool</p></td>
<td><p>True if support outputs of this format</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.muxers">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">muxers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.muxers" title="Link to this definition"></a></dt>
<dd><p>get FFmpeg muxers</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of muxers</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a muxer and its value is a dict
with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Short description of the muxer</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.muxer_info">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">muxer_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.muxer_info" title="Link to this definition"></a></dt>
<dd><p>get detailed info of a media muxer</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of features</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>The returned dict has following entries:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>names</p></td>
<td><p>list(str)</p></td>
<td><p>List of compatible short names</p></td>
</tr>
<tr class="row-odd"><td><p>long_name</p></td>
<td><p>str</p></td>
<td><p>Common long name</p></td>
</tr>
<tr class="row-even"><td><p>extensions</p></td>
<td><p>list(str)</p></td>
<td><p>List of associated common extensions (w/out ‘.’)</p></td>
</tr>
<tr class="row-odd"><td><p>mime_types</p></td>
<td><p>list(str)</p></td>
<td><p>List of associated MIME types</p></td>
</tr>
<tr class="row-even"><td><p>video_codecs</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported video codecs</p></td>
</tr>
<tr class="row-odd"><td><p>audio_codecs</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported audio codecs</p></td>
</tr>
<tr class="row-even"><td><p>subtitle_codecs</p></td>
<td><p>list(str)</p></td>
<td><p>List of supported subtitle codecs</p></td>
</tr>
<tr class="row-odd"><td><p>options</p></td>
<td><p>str</p></td>
<td><p>Unparsed string, listing supported options</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.demuxers">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">demuxers</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.demuxers" title="Link to this definition"></a></dt>
<dd><p>get FFmpeg demuxers</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of demuxers</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>Each key of the returned dict is a name of a demuxer and its value is a dict
with the following items:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>description</p></td>
<td><p>str</p></td>
<td><p>Short description of the demuxer</p></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="ffmpegio.caps.demuxer_info">
<span class="sig-prename descclassname"><span class="pre">ffmpegio.caps.</span></span><span class="sig-name descname"><span class="pre">demuxer_info</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpegio.caps.demuxer_info" title="Link to this definition"></a></dt>
<dd><p>get detailed info of a media demuxer</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>list of features</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>dict</p>
</dd>
</dl>
<p>The returned dict has following entries:</p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>type</p></th>
<th class="head"><p>description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>names</p></td>
<td><p>list(str)</p></td>
<td><p>List of compatible short names</p></td>
</tr>
<tr class="row-odd"><td><p>long_name</p></td>
<td><p>str</p></td>