10000 Update docs · yoyonel/ffmpeg-python@e7690df · GitHub
[go: up one dir, main page]
Skip to content

Commit e7690df

Browse files
kkroeningkkroening
committed
Update docs
1 parent df1ba84 commit e7690df

File tree

4 files changed

+65
-5
lines changed

4 files changed

+65
-5
lines changed

‎genindex.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ <h2 id="F">F</h2>
9090
<table style="width: 100%" class="indextable genindextable"><tr>
9191
<td style="width: 33%; vertical-align: top;"><ul>
9292
<li><a href="index.html#module-ffmpeg">ffmpeg (module)</a>
93+
</li>
94+
</ul></td>
95+
<td style="width: 33%; vertical-align: top;"><ul>
96+
<li><a href="index.html#ffmpeg.filter_">filter_() (in module ffmpeg)</a>
97+
</li>
98+
<li><a href="index.html#ffmpeg.filter_multi">filter_multi() (in module ffmpeg)</a>
9399
</li>
94100
</ul></td>
95101
</tr></table>

‎index.html

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,62 @@ <h1>ffmpeg-python: Python bindings for FFmpeg<a class="headerlink" href="#ffmpeg
121121
<p>Official documentation: <a class="reference external" href="https://ffmpeg.org/ffmpeg-filters.html#drawbox">drawbox</a></p>
122122
</dd></dl>
123123

124+
<dl class="function">
125+
<dt id="ffmpeg.filter_">
126+
<code class="descclassname">ffmpeg.</code><code class="descname">filter_</code><span class="sig-paren">(</span><em>parent_node</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>
127+
<dd><p>Apply custom single-source filter.</p>
128+
<p><code class="docutils literal"><span class="pre">filter_</span></code> is normally used by higher-level filter functions such as <code class="docutils literal"><span class="pre">hflip</span></code>, but if a filter implementation
129+
is missing from <code class="docutils literal"><span class="pre">fmpeg-python</span></code>, you can call <code class="docutils literal"><span class="pre">filter_</span></code> directly to have <code class="docutils literal"><span class="pre">fmpeg-python</span></code> pass the filter name
130+
and arguments to ffmpeg verbatim.</p>
131+
<table class="docutils field-list" frame="void" rules="none">
132+
<col class="field-name" />
133+
<col class="field-body" />
134+
<tbody valign="top">
135+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
136+
<li><strong>parent_node</strong> – Source stream to apply filter to.</li>
137+
<li><strong>filter_name</strong> – ffmpeg filter name, e.g. <cite>colorchannelmixer</cite></li>
138+
<li><strong>*args</strong> – list of args to pass to ffmpeg verbatim</li>
139+
<li><strong>**kwargs</strong> – list of keyword-args to pass to ffmpeg verbatim</li>
140+
</ul>
141+
</td>
142+
</tr>
143+
</tbody>
144+
</table>
145+
<p>This function is used internally by all of the other single-source filters (e.g. <code class="docutils literal"><span class="pre">hflip</span></code>, <code class="docutils literal"><span class="pre">crop</span></code>, etc.).
146+
For custom multi-source filters, see <code class="docutils literal"><span class="pre">filter_multi</span></code> instead.</p>
147+
<p>The function name is suffixed with <code class="docutils literal"><span class="pre">_</span></code> in order avoid confusion with the standard python <code class="docutils literal"><span class="pre">filter</span></code> function.</p>
148+
<p class="rubric">Example</p>
149+
<p><code class="docutils literal"><span class="pre">ffmpeg.input('in.mp4').filter_('hflip').output('out.mp4').run()</span></code></p>
150+
</dd></dl>
151+
152+
<dl class="function">
153+
<dt id="ffmpeg.filter_multi">
154+
<code class="descclassname">ffmpeg.</code><code class="descname">filter_multi</code><span class="sig-paren">(</span><em>parent_nodes</em>, <em>filter_name</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.filter_multi" title="Permalink to this definition"></a></dt>
155+
<dd><p>Apply custom multi-source filter.</p>
156+
<p>This is nearly identical to the <code class="docutils literal"><span class="pre">filter</span></code> function except that it allows filters to be applied to multiple
157+
streams. It’s normally used by higher-level filter functions such as <code class="docutils literal"><span class="pre">concat</span></code>, but if a filter implementation
158+
is missing from <code class="docutils literal"><span class="pre">fmpeg-python</span></code>, you can call <code class="docutils literal"><span class="pre">filter_multi</span></code> directly.</p>
159+
<p>Note that because it applies to multiple streams, it can’t be used as an operator, unlike the <code class="docutils literal"><span class="pre">filter</span></code> function
160+
(e.g. <code class="docutils literal"><span class="pre">ffmpeg.input('in.mp4').filter_('hflip')</span></code>)</p>
161+
<table class="docutils field-list" frame="void" rules="none">
162+
<col class="field-name" />
163+
<col class="field-body" />
164+
<tbody valign="top">
165+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
166+
<li><strong>parent_nodes</strong> – List of source streams to apply filter to.</li>
167+
<li><strong>filter_name</strong> – ffmpeg filter name, e.g. <cite>concat</cite></li>
168+
<li><strong>*args</strong> – list of args to pass to ffmpeg verbatim</li>
169+
<li><strong>**kwargs</strong> – list of keyword-args to pass to ffmpeg verbatim</li>
170+
</ul>
171+
</td>
172+
</tr>
173+
</tbody>
174+
</table>
175+
<p>For custom single-source filters, see <code class="docutils literal"><span class="pre">filter_multi</span></code> instead.</p>
176+
<p class="rubric">Example</p>
177+
<p><code class="docutils literal"><span class="pre">ffmpeg.filter_multi(ffmpeg.input('in1.mp4'),</span> <span class="pre">ffmpeg.input('in2.mp4'),</span> <span class="pre">'concat',</span> <span class="pre">n=2).output('out.mp4').run()</span></code></p>
178+
</dd></dl>
179+
124180
<dl class="function">
125181
<dt id="ffmpeg.hflip">
126182
<code class="descclassname">ffmpeg.</code><code class="descname">hflip</code><span class="sig-paren">(</span><em>parent_node</em><span class="sig-paren">)</span><a class="headerlink" href="#ffmpeg.hflip" title="Permalink to this definition"></a></dt>

‎objects.inv

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,5 @@
22
# Project: ffmpeg-python
33
# Version:
44
# The remainder of this file is compressed using zlib.
5-
xڍ����0�O1�{�l�>@����>@�:��d&Ĥ�>��A����I�|�3!Fk�@��}v_`���0$�>J�����<t�8v�"B��q��L]�Lp|���SID���-O"k0]U4��� �E�RȲMy�����M[���0:5��=ڴ#
6-
�L"7b
7-
���h��ħ�`�A�3�A�*0��q�E����༾VO�s��Q:�aNS�� �",-����J����/���P>�]�^�<�Zn�{��
8-
�)�e���|O�
5+
xڕ��j�0�O1�^]�W`���B@�Nb ��8��>}� ݅B�'e���D��>���4> �!������޽�Z�
6+
u�wx� �:ogL[Tg����c�)E�b��waYmcj�c}vlE�ܪd&��Q&3����eo�c2؆�k@6m�2z���"��d�FJ�DnB���q�^o�����I�^���Ʃ�g8�������aC�7� J�:.<j�_�[���o�!�岑j=���K},�~��]:O�����(��?��U���Mp-

‎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