8000 Update docs · Powercoder64/ffmpeg-python@0625e38 · GitHub
[go: up one dir, main page]
Skip to content

Commit 0625e38

Browse files
kkroeningkkroening
committed
Update docs
1 parent 6523c46 commit 0625e38

File tree

4 files changed

+13
-4
lines changed

4 files changed

+13
-4
lines changed

‎doc/html/genindex.html

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,8 @@ <h2 id="F">F</h2>
9696
<table style="width: 100%" class="indextable genindextable"><tr>
9797
<td style="width: 33%; vertical-align: top;"><ul>
9898
<li><a href="index.html#module-ffmpeg">ffmpeg (module)</a>
99+
</li>
100+
<li><a href="index.html#ffmpeg.filter">filter() (in module ffmpeg)</a>
99101
</li>
100102
</ul></td>
101103
<td style="width: 33%; vertical-align: top;"><ul>

‎doc/html/index.html

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg
279279
</dd></dl>
280280

281281
<dl class="function">
282-
<dt id="ffmpeg.filter_">
283-
<code class="descclassname">ffmpeg.</code><code class="descname">filter_</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_" title="Permalink to this definition"></a></dt>
282+
<dt id="ffmpeg.filter">
283+
<code class="descclassname">ffmpeg.</code><code class="descname">filter</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" title="Permalink to this definition"></a></dt>
284284
<dd><p>Apply custom filter.</p>
285285
<p><code class="docutils literal notranslate"><span class="pre">filter_</span></code> is normally used by higher-level filter functions such as <code class="docutils literal notranslate"><span class="pre">hflip</span></code>, but if a filter implementation
286286
is missing from <code class="docutils literal notranslate"><span class="pre">fmpeg-python</span></code>, you can call <code class="docutils literal notranslate"><span class="pre">filter_</span></code> directly to have <code class="docutils literal notranslate"><span class="pre">fmpeg-python</span></code> pass the filter name
@@ -301,7 +301,14 @@ <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg
301301
</table>
302302
<p>The function name is suffixed with <code class="docutils literal notranslate"><span class="pre">_</span></code> in order avoid confusion with the standard python <code class="docutils literal notranslate"><span class="pre">filter</span></code> function.</p>
303303
<p class="rubric">Example</p>
304-
<p><code class="docutils literal notranslate"><span class="pre">ffmpeg.input('in.mp4').filter_('hflip').output('out.mp4').run()</span></code></p>
304+
<p><code class="docutils literal notranslate"><span class="pre">ffmpeg.input('in.mp4').filter('hflip').output('out.mp4').run()</span></code></p>
305+
</dd></dl>
306+
307+
<dl class="function">
308+
<dt id="ffmpeg.filter_">
309+
<code class="descclassname">ffmpeg.</code> 880D <code class="descname">filter_</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_" title="Permalink to this definition"></a></dt>
310+
<dd><p>Alternate name for <code class="docutils literal notranslate"><span class="pre">filter</span></code>, so as to not collide with the
311+
built-in python <code class="docutils literal notranslate"><span class="pre">filter</span></code> operator.</p>
305312
</dd></dl>
306313

307314
<dl class="function">

‎doc/html/objects.inv

2 Bytes
Binary file not shown.

‎doc/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
0