8000 Update docs · lguowang/ffmpeg-python@9043bde · GitHub
[go: up one dir, main page]
Skip to content

Commit 9043bde

Browse files
kkroeningkkroening
committed
Update docs
1 parent dbcf259 commit 9043bde

File tree

4 files changed

+101
-6
lines changed

4 files changed

+101
-6
lines changed

‎genindex.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,14 @@ <h1 id="index">Index</h1>
5050
<div class="genindex-jumpbox">
5151
<a href="#C"><strong>C</strong></a>
5252
| <a href="#D"><strong>D</strong></a>
53+
| <a href="#E"><strong>E</strong></a>
5354
| <a href="#F"><strong>F</strong></a>
5455
| <a href="#G"><strong>G</strong></a>
5556
| <a href="#H"><strong>H</strong></a>
5657
| <a href="#I"><strong>I</strong></a>
5758
| <a href="#M"><strong>M</strong></a>
5859
| <a href="#O"><strong>O</strong></a>
60+
| <a href="#P"><strong>P</strong></a>
5961
| <a href="#R"><strong>R</strong></a>
6062
| <a href="#S"><strong>S</strong></a>
6163
| <a href="#T"><strong>T</strong></a>
@@ -67,6 +69,8 @@ <h2 id="C">C</h2>
6769
<table style="width: 100%" class="indextable genindextable"><tr>
6870
<td style="width: 33%; vertical-align: top;"><ul>
6971
<li><a href="index.html#ffmpeg.colorchannelmixer">colorchannelmixer() (in module ffmpeg)</a>
72+
</li>
73+
<li><a href="index.html#ffmpeg.compile">compile() (in module ffmpeg)</a>
7074
</li>
7175
</ul></td>
7276
<td style="width: 33%; vertical-align: top;"><ul>
@@ -89,6 +93,14 @@ <h2 id="D">D</h2>
8993
</ul></td>
9094
</tr></table>
9195

96+
<h2 id="E">E</h2>
97+
<table style="width: 100%" class="indextable genindextable"><tr>
98+
<td style="width: 33%; vertical-align: top;"><ul>
99+
<li><a href="index.html#ffmpeg.Error">Error</a>
100+
</li>
101+
</ul></td>
102+
</tr></table>
103+
92104
<h2 id="F">F</h2>
93105
<table style="width: 100%" class="indextable genindextable"><tr>
94106
<td style="width: 33%; vertical-align: top;"><ul>
@@ -97,6 +109,8 @@ <h2 id="F">F</h2>
97109
</ul></td>
98110
<td style="width: 33%; vertical-align: top;"><ul>
99111
<li><a href="index.html#ffmpeg.filter_">filter_() (in module ffmpeg)</a>
112+
</li>
113+
<li><a href="index.html#ffmpeg.filter_multi_output">filter_multi_output() (in module ffmpeg)</a>
100114
</li>
101115
</ul></td>
102116
</tr></table>
@@ -151,6 +165,14 @@ <h2 id="O">O</h2>
151165
</ul></td>
152166
</tr></table>
153167

168+
<h2 id="P">P</h2>
169+
<table style="width: 100%" class="indextable genindextable"><tr>
170+
<td style="width: 33%; vertical-align: top;"><ul>
171+
<li><a href="index.html#ffmpeg.probe">probe() (in module ffmpeg)</a>
172+
</li>
173+
</ul></td>
174+
</tr></table>
175+
154176
<h2 id="R">R</h2>
155177
<table style="width: 100%" class="indextable genindextable"><tr>
156178
<td style="width: 33%; vertical-align: top;"><ul>

‎index.html

Lines changed: 78 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,21 @@ <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg
313313
<p><code class="docutils literal"><span class="pre">ffmpeg.input('in.mp4').filter_('hflip').output('out.mp4').run()</span></code></p>
314314
</dd></dl>
315315

316+
<dl class="function">
317+
<dt id="ffmpeg.filter_multi_output">
318+
<code class="descclassname">ffmpeg.</code><code class="descname">filter_multi_output</code><span class="sig-paren">(</span><em>stream_spec</em>, <em>filter_name</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.filter_multi_output" title="Permalink to this definition"></a></dt>
319+
<dd><p>Apply custom filter with one or more outputs.</p>
320+
<p>This is the same as <code class="docutils literal"><span class="pre">filter_</span></code> except that the filter can produce more than one output.</p>
321+
<p>To reference an output stream, use either the <code class="docutils literal"><span class="pre">.stream</span></code> operator or bracket shorthand:</p>
322+
<p class="rubric">Example</p>
323+
<p><code class="docutils literal"><span class="pre">`</span>
324+
<span class="pre">split</span> <span class="pre">=</span> <span class="pre">ffmpeg.input('in.mp4').filter_multi_output('split')</span>
325+
<span class="pre">split0</span> <span class="pre">=</span> <span class="pre">split.stream(0)</span>
326+
<span class="pre">split1</span> <span class="pre">=</span> <span class="pre">split[1]</span>
327+
<span class="pre">ffmpeg.concat(split0,</span> <span class="pre">split1).output('out.mp4').run()</span>
328+
<span class="pre">`</span></code></p>
329+
</dd></dl>
330+
316331
<dl class="function">
317332
<dt id="ffmpeg.hflip">
318333
<code class="descclassname">ffmpeg.</code><code class="descname">hflip</code><span class="sig-paren">(</span><em>stream</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.hflip" title="Permalink to this definition"></a></dt>
@@ -479,6 +494,9 @@ <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg
479494
<dt id="ffmpeg.input">
480495
<code class="descclassname">ffmpeg.</code><code class="descname">input</code><span class="sig-paren">(</span><em>filename</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.input" title="Permalink to this definition"></a></dt>
481496
<dd><p>Input file URL (ffmpeg <code class="docutils literal"><span class="pre">-i</span></code> option)</p>
497+
<p>Any supplied kwargs are passed to ffmpeg verbatim (e.g. <code class="docutils literal"><span class="pre">t=20</span></code>,
498+
<code class="docutils literal"><span class="pre">f='mp4'</span></code>, <code class="docutils literal"><span class="pre">acodec='pcm'</span></code>, etc.).</p>
499+
<p>To tell ffmpeg to read from stdin, use <code class="docutils literal"><span class="pre">pipe:</span></code> as the filename.</p>
482500
<p>Official documentation: <a class="reference external" href="https://ffmpeg.org/ffmpeg.html#Main-options">Main options</a></p>
483501
</dd></dl>
484502

@@ -490,8 +508,17 @@ <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg
490508

491509
<dl class="function">
492510
<dt id="ffmpeg.output">
493-
<code class="descclassname">ffmpeg.</code><code class="descname">output</code><span class="sig-paren">(</span><em>stream</em>, <em>filename</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.output" title="Permalink to this definition"></a></dt>
511+
<code class="descclassname">ffmpeg.</code><code class="descname">output</code><span class="sig-paren">(</span><em>*streams_and_filename</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.output" title="Permalink to this definition"></a></dt>
494512
<dd><p>Output file URL</p>
513+
<dl class="docutils">
514+
<dt>Syntax:</dt>
515+
<dd><cite>ffmpeg.output(stream1[, stream2, stream3…], filename, **ffmpeg_args)</cite></dd>
516+
</dl>
517+
<p>If multiple streams are provided, they are mapped to the same
518+
output.</p>
519+
<p>Any supplied kwargs are passed to ffmpeg verbatim (e.g. <code class="docutils literal"><span class="pre">t=20</span></code>,
520+
<code class="docutils literal"><span class="pre">f='mp4'</span></code>, <code class="docutils literal"><span class="pre">acodec='pcm'</span></code>, etc.).</p>
521+
<p>To tell ffmpeg to write to stdout, use <code class="docutils literal"><span class="pre">pipe:</span></code> as the filename.</p>
495522
<p>Official documentation: <a class="reference external" href="https://ffmpeg.org/ffmpeg.html#Synopsis">Synopsis</a></p>
496523
</dd></dl>
497524

@@ -502,31 +529,77 @@ <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg
502529
<p>Official documentation: <a class="reference external" href="https://ffmpeg.org/ffmpeg.html#Main-options">Main options</a></p>
503530
</dd></dl>
504531

532+
<dl class="function">
533+
<dt id="ffmpeg.compile">
534+
<code class="descclassname">ffmpeg.</code><code class="descname">compile</code><span class="sig-paren">(</span><em>stream_spec</em>, <em>cmd=u'ffmpeg'</em>, <em>overwrite_output=False</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.compile" title="Permalink to this definition"></a></dt>
535+
<dd><p>Build command-line for invoking ffmpeg.</p>
536+
<p>The <a class="reference internal" href="#ffmpeg.run" title="ffmpeg.run"><code class="xref py py-meth docutils literal"><span class="pre">run()</span></code></a> function uses this to build the commnad line
537+
arguments and should work in most cases, but calling this function
538+
directly is useful for debugging or if you need to invoke ffmpeg
539+
manually for whatever reason.</p>
540+
<p>This is the same as calling <a class="reference internal" href="#ffmpeg.get_args" title="ffmpeg.get_args"><code class="xref py py-meth docutils literal"><span class="pre">get_args()</span></code></a> except that it also
541+
includes the <code class="docutils literal"><span class="pre">ffmpeg</span></code> command as the first argument.</p>
542+
</dd></dl>
543+
544+
<dl class="exception">
545+
<dt id="ffmpeg.Error">
546+
<em class="property">exception </em><code class="descclassname">ffmpeg.</code><code class="descname">Error</code><span class="sig-paren">(</span><em>cmd</em>, <em>stdout</em>, <em>stderr</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.Error" title="Permalink to this definition"></a></dt>
547+
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">exceptions.Exception</span></code></p>
548+
</dd></dl>
549+
505550
<dl class="function">
506551
<dt id="ffmpeg.get_args">
507552
<code class="descclassname">ffmpeg.</code><code class="descname">get_args</code><span class="sig-paren">(</span><em>stream_spec</em>, <em>overwrite_output=False</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.get_args" title="Permalink to this definition"></a></dt>
508-
<dd><p>Get command-line arguments for ffmpeg.</p>
553+
<dd><p>Build command-line arguments to be passed to ffmpeg.</p>
509554
</dd></dl>
510555

511556
<dl class="function">
512557
<dt id="ffmpeg.run">
513-
<code class="descclassname">ffmpeg.</code><code class="descname">run</code><span class="sig-paren">(</span><em>stream_spec</em>, <em>cmd=u'ffmpeg'</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.run" title="Permalink to this definition"></a></dt>
514-
<dd><p>Run ffmpeg on node graph B41A .</p>
558+
<code class="descclassname">ffmpeg.</code><code class="descname">run</code><span class="sig-paren">(</span><em>stream_spec</em>, <em>cmd=u'ffmpeg'</em>, <em>capture_stdout=False</em>, <em>capture_stderr=False</em>, <em>input=None</em>, <em>quiet=False</em>, <em>overwrite_output=False</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.run" title="Permalink to this definition"></a></dt>
559+
<dd><p>Ivoke ffmpeg for the supplied node graph.</p>
515560
<table class="docutils field-list" frame="void" rules="none">
516561
<col class="field-name" />
517562
<col class="field-body" />
518563
<tbody valign="top">
519-
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>**kwargs</strong> – keyword-arguments passed to <code class="docutils literal"><span class="pre">get_args()</span></code> (e.g. <code class="docutils literal"><span class="pre">overwrite_output=True</span></code>).</td>
564+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
565+
<li><strong>capture_stdout</strong> – if True, capture stdout (to be used with
566+
<code class="docutils literal"><span class="pre">pipe:</span></code> ffmpeg outputs).</li>
567+
<li><strong>capture_stderr</strong> – if True, capture stderr.</li>
568+
<li><strong>quiet</strong> – shorthand for setting <code class="docutils literal"><span class="pre">capture_stdout</span></code> and <code class="docutils literal"><span class="pre">capture_stderr</span></code>.</li>
569+
<li><strong>input</strong> – text to be sent to stdin (to be used with <code class="docutils literal"><span class="pre">pipe:</span></code>
570+
ffmpeg inputs)</li>
571+
<li><strong>**kwargs</strong> – keyword-arguments passed to <code class="docutils literal"><span class="pre">get_args()</span></code> (e.g.
572+
<code class="docutils literal"><span class="pre">overwrite_output=True</span></code>).</li>
573+
</ul>
574+
</td>
520575
</tr>
521576
</tbody>
522577
</table>
578+
<p>Returns: (out, err) tuple containing captured stdout and stderr data.</p>
523579
</dd></dl>
524580

525581
<dl class="function">
526582
<dt id="ffmpeg.view">
527583
<code class="descclassname">ffmpeg.</code><code class="descname">view</code><span class="sig-paren">(</span><em>stream_spec</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.view" title="Permalink to this definition"></a></dt>
528584
<dd></dd></dl>
529585

586+
<dl class="function">
587+
<dt id="ffmpeg.probe">
588+
<code class="descclassname">ffmpeg.</code><code class="descname">probe</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.probe" title="Permalink to this definition"></a></dt>
589+
<dd><p>Run ffprobe on the specified file and return a JSON representation of the output.</p>
590+
<table class="docutils field-list" frame="void" rules="none">
591+
<col class="field-name" />
592+
<col class="field-body" />
593+
<tbody valign="top">
594+
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="#ffmpeg.Error" title="ffmpeg.Error"><code class="xref py py-class docutils literal"><span class="pre">ffmpeg.Error</span></code></a> – if ffprobe returns a non-zero exit code,
595+
an <a class="reference internal" href="#ffmpeg.Error" title="ffmpeg.Error"><code class="xref py py-class docutils literal"><span class="pre">Error</span></code></a> is returned with a generic error message.
596+
The stderr output can be retrieved by accessing the
597+
<code class="docutils literal"><span class="pre">stderr</span></code> property of the exception.</td>
598+
</tr>
599+
</tbody>
600+
</table>
601+
</dd></dl>
602+
530603
</div>
531604
<div class="section" id="indices-and-tables">
532605
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>

‎objects.inv

29 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)
0