diff mbox

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

Message ID 20170402230932.10906-2-timothy.ty.lee@gmail.com
State New
Headers show

Commit Message

Timothy Lee April 2, 2017, 11:09 p.m. UTC 
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 mbox

Patch

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
 
+@section capture
+
+Input stream capturing protocol.
+
+A capture URL has the form:
+@example
+capture:@var{URL}
+@end example
+
+This protocol accepts the following option:
+@table @option
+
+@item capture_file
+Name of the capture file.
+If not specified, the input stream will be written into @file{capture.dat}.
+
+@end table
+
+For example, to capture the input stream as @file{stream.sav} during playback:
+@example
+ffplay -capture_file stream.sav capture:@var{URL}
+@end example
+
 @section concat
 
 Physical concatenation protocol.