[FFmpeg-devel] [PATCH 2/3] doc: add capture protocol documentation

Timothy Lee timothy.ty.lee at gmail.com
Mon Apr 3 02:09:31 EEST 2017


Document the capture protocol, with description for the accepted option, and
an example of it being used under ffplay.
---
 doc/protocols.texi | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/doc/protocols.texi b/doc/protocols.texi
index a7968ff56e..89a1f2afa8 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -103,6 +103,29 @@ Cache the input stream to temporary file. It brings seeking capability to live s
 cache:@var{URL}
 @end example
 
+ at section capture
+
+Input stream capturing protocol.
+
+A capture URL has the form:
+ at example
+capture:@var{URL}
+ at end example
+
+This protocol accepts the following option:
+ at table @option
+
+ at item capture_file
+Name of the capture file.
+If not specified, the input stream will be written into @file{capture.dat}.
+
+ at end table
+
+For example, to capture the input stream as @file{stream.sav} during playback:
+ at example
+ffplay -capture_file stream.sav capture:@var{URL}
+ at end example
+
 @section concat
 
 Physical concatenation protocol.
-- 
2.12.1



More information about the ffmpeg-devel mailing list