From 57b8f9fa227d781034cf9baaf3a3c87cd6b878a8 Mon Sep 17 00:00:00 2001 From: Karl Kroening Date: Sun, 20 May 2018 01:14:10 -0700 Subject: [PATCH] Pull docs from #85 --- doc/html/genindex.html | 22 +++++++++++ doc/html/index.html | 83 +++++++++++++++++++++++++++++++++++++--- doc/html/objects.inv | Bin 398 -> 427 bytes doc/html/searchindex.js | 2 +- 4 files changed, 101 insertions(+), 6 deletions(-) diff --git a/doc/html/genindex.html b/doc/html/genindex.html index c39ba30..4e258ee 100644 --- a/doc/html/genindex.html +++ b/doc/html/genindex.html @@ -50,12 +50,14 @@
C | D + | E | F | G | H | I | M | O + | P | R | S | T @@ -67,6 +69,8 @@
    @@ -89,6 +93,14 @@
+

E

+ + +
+

F

    @@ -97,6 +109,8 @@
@@ -151,6 +165,14 @@ +

P

+ + +
+

R

    diff --git a/doc/html/index.html b/doc/html/index.html index c7717a6..ba91983 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -313,6 +313,21 @@ and arguments to ffmpeg verbatim.

    ffmpeg.input('in.mp4').filter_('hflip').output('out.mp4').run()

    +
    +
    +ffmpeg.filter_multi_output(stream_spec, filter_name, *args, **kwargs)
    +

    Apply custom filter with one or more outputs.

    +

    This is the same as filter_ except that the filter can produce more than one output.

    +

    To reference an output stream, use either the .stream operator or bracket shorthand:

    +

    Example

    +

    ` +split = ffmpeg.input('in.mp4').filter_multi_output('split') +split0 = split.stream(0) +split1 = split[1] +ffmpeg.concat(split0, split1).output('out.mp4').run() +`

    +
    +
    ffmpeg.hflip(stream)
    @@ -479,6 +494,9 @@ for single input image.
    ffmpeg.input(filename, **kwargs)

    Input file URL (ffmpeg -i option)

    +

    Any supplied kwargs are passed to ffmpeg verbatim (e.g. t=20, +f='mp4', acodec='pcm', etc.).

    +

    To tell ffmpeg to read from stdin, use pipe: as the filename.

    Official documentation: Main options

    @@ -490,8 +508,17 @@ for single input image.
    -ffmpeg.output(stream, filename, **kwargs)
    +ffmpeg.output(*streams_and_filename, **kwargs)

    Output file URL

    +
    +
    Syntax:
    +
    ffmpeg.output(stream1[, stream2, stream3…], filename, **ffmpeg_args)
    +
    +

    If multiple streams are provided, they are mapped to the same +output.

    +

    Any supplied kwargs are passed to ffmpeg verbatim (e.g. t=20, +f='mp4', acodec='pcm', etc.).

    +

    To tell ffmpeg to write to stdout, use pipe: as the filename.

    Official documentation: Synopsis

    @@ -502,24 +529,53 @@ for single input image.

    Official documentation: Main options

    +
    +
    +ffmpeg.compile(stream_spec, cmd=u'ffmpeg', overwrite_output=False)
    +

    Build command-line for invoking ffmpeg.

    +

    The run() function uses this to build the commnad line +arguments and should work in most cases, but calling this function +directly is useful for debugging or if you need to invoke ffmpeg +manually for whatever reason.

    +

    This is the same as calling get_args() except that it also +includes the ffmpeg command as the first argument.

    +
    + +
    +
    +exception ffmpeg.Error(stream_spec, stdout, stderr)
    +

    Bases: exceptions.Exception

    +
    +
    ffmpeg.get_args(stream_spec, overwrite_output=False)
    -

    Get command-line arguments for ffmpeg.

    +

    Build command-line arguments to be passed to ffmpeg.

    -ffmpeg.run(stream_spec, cmd=u'ffmpeg', **kwargs)
    -

    Run ffmpeg on node graph.

    +ffmpeg.run(stream_spec, cmd=u'ffmpeg', capture_stdout=False, capture_stderr=False, input=None, quiet=False, overwrite_output=False) +

    Ivoke ffmpeg for the supplied node graph.

    - +
    Parameters:**kwargs – keyword-arguments passed to get_args() (e.g. overwrite_output=True).
    Parameters:
      +
    • capture_stdout – if True, capture stdout (to be used with +pipe: ffmpeg outputs).
      • +
    • capture_stderr – if True, capture stderr.
      • +
    • quiet – shorthand for setting capture_stdout and capture_stderr.
      • +
    • input – text to be sent to stdin (to be used with pipe: +ffmpeg inputs)
      • +
    • **kwargs – keyword-arguments passed to get_args() (e.g. +overwrite_output=True).
      • +
    +
    +

    Returns: (out, err) tuple containing captured stdout and stderr data.

    @@ -527,6 +583,23 @@ for single input image. ffmpeg.view(stream_spec, **kwargs)
    +
    +
    +ffmpeg.probe(filename)
    +

    Run ffprobe on the specified file and return a JSON representation of the output.

    + +++ + + + +
    Raises:ffmpeg.Error – if ffprobe returns a non-zero exit code, +an Error is returned with a generic error message. +The stderr output can be retrieved by accessing the +stderr property of the exception.
    +
    +

    Indices and tables

    diff --git a/doc/html/objects.inv b/doc/html/objects.inv index 49e13ed09c61f4724332794f7da26e5aa7e62699..1072aecde4a2efc3029fc6e2136fd1873ccda6a9 100644 GIT binary patch delta 313 zcmV-90mlB01FHj&dw-Rb!D_=W42JJ{3d43yS+BjXu*0CR2MA6gCkERxirglB`Z@8+ zIv7+v*+`!(>9;Loe1t*8<>0YT4%C~np@(@lvUe}VR==vcG8?#iCqi0rm^+AUF{u50 z#2wn9L+VBy0yuAH*uqQ--Ge9}ZLUMchEB5#C5$4lCw*yg7Jsu0v#bJR9RoGbus%7q z4JM9BmSX^JG!2so9*wgyO~xd<4;!R~dY}P*I+IoVgbH{Da(WT77qSe`$Q%he zh?{_;PzWaLMc`R{zh?^<5qQP?JN1K>1_+x)P23-xZo#Q~uWr_jQy=TL`o((eR_Kl> z8SA+4h~c14+cK)!OxTbgxXDxKcwCVx52=6h#ihPE%7LF{zLm@q=scSKMig6tzl#5) L2dKUQZAQzNXb_U# delta 284 zcmV+%0ptFw1C9fbdw-48&1!@&5C`zPPchJ5UAk8vV4;V?LLWe)PBf4&#)%*M^i_j& z7Ydz|GWq?T3~ID?5qpSh7Snj1$30{MIIevj{#ya8dm;Qjh+q zz{p)?Rf87FE1cEC!RLNk{IV{zJ9-kiV;NT-g0J9yT%p;7@!Mys1HtXKlVbbV|L7Oj i@?6Ld{L05f?iD