History

Apply misc fixes spotted by Diego to protocols.texi.

Originally committed as revision 24726 to svn://svn.ffmpeg.org/ffmpeg/trunk

Stefano Sabatini committed 16 years ago

Commit 209e4511 parent 63f805f1 file · +31 −32Browse files

Unified · Split

doc/protocols.texi+31−32
@@ -4,9 +4,9 @@ · 3 unmodified lines
44 Protocols are configured elements in FFmpeg which allow to access
55 resources which require the use of a particular protocol.
66
7−When you configure your FFmpeg build, all the supported protocols
8−are enabled by default. You can list them using the configure option
9−"--list-protocols".
7+When you configure your FFmpeg build, all the supported protocols are
8+enabled by default. You can list all available ones using the
9+configure option "--list-protocols".
1010
1111 You can disable all the protocols using the configure option
1212 "--disable-protocols", and selectively enable a protocol using the
@@ -15,7 +15,7 @@ particular protocol using the option · 2 unmodified lines
1515 "--disable-protocol=@var{PROTOCOL}".
1616
1717 The option "-protocols" of the ff* tools will display the list of
18−the supported protocols.
18+supported protocols.
1919
2020 A description of the currently available protocols follows.
2121
@@ -23,10 +23,10 @@ A description of the currently available protocols follows. · 1 unmodified line
2323
2424 Physical concatenation protocol.
2525
26−Allow to read and seek from many resource in sequence as they were an
27−unique resource.
26+Allow to read and seek from many resource in sequence as if they were
27+a unique resource.
2828
29−An url accepted by this protocol has the syntax:
29+An URL accepted by this protocol has the syntax:
3030 @example
3131 concat:@var{URL1}|@var{URL2}|...|@var{URLN}
3232 @end example
@@ -57,9 +57,9 @@ use the command: · 24 unmodified lines
5757 ffmpeg -i file:input.mpeg output.mpeg
5858 @end example
5959
60−Note that if not specified otherwise, the ff* tools will use the file
61−protocol by default, that is a resource specified with the name
62−"FILE.mpeg" is interpreted as it were the url "file:FILE.mpeg".
60+The ff* tools default to the file protocol, that is a resource
61+specified with the name "FILE.mpeg" is interpreted as the URL
62+"file:FILE.mpeg".
6363
6464 @section gopher
6565
@@ -67,7 +67,7 @@ Gopher protocol. · 1 unmodified line
6767
6868 @section http
6969
70−HTTP (Hyper Text Trasfer Protocol).
70+HTTP (Hyper Text Transfer Protocol).
7171
7272 @section mmst
7373
@@ -77,20 +77,20 @@ MMS (Microsoft Media Server) protocol over TCP. · 3 unmodified lines
7777
7878 MD5 output protocol.
7979
80−Computes the MD5 hash of data written, and on close writes this to the
81−designated output or stdout if none is specified. It can be used to
82−test muxers without writing an actual file.
80+Computes the MD5 hash of the data to be written, and on close writes
81+this to the designated output or stdout if none is specified. It can
82+be used to test muxers without writing an actual file.
8383
8484 Some examples follow.
8585 @example
86−# write the MD5 hash of the encoded AVI file in the file output.avi.md5
86+# Write the MD5 hash of the encoded AVI file in the file output.avi.md5.
8787 ffmpeg -i input.flv -f avi -y md5:output.avi.md5
8888
89−# write the MD5 hash of the encoded AVI file to stdout
89+# Write the MD5 hash of the encoded AVI file to stdout.
9090 ffmpeg -i input.flv -f avi -y md5:
9191 @end example
9292
93−Note that some formats (typically mov) require the output protocol to
93+Note that some formats (typically MOV) require the output protocol to
9494 be seekable, so they will fail with the MD5 output protocol.
9595
9696 @section pipe
@@ -105,26 +105,25 @@ pipe:[@var{number}] · 8 unmodified lines
105105 @end example
106106
107107 @var{number} is the number corresponding to the file descriptor of the
108−pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr).
109−If @var{number} is not specified will use by default stdout if the
110−protocol is used for writing, stdin if the protocol is used for
111−reading.
108+pipe (e.g. 0 for stdin, 1 for stdout, 2 for stderr). If @var{number}
109+is not specified, by default the stdout file descriptor will be used
110+for writing, stdin for reading.
112111
113112 For example to read from stdin with @file{ffmpeg}:
114113 @example
115114 cat test.wav | ffmpeg -i pipe:0
116−# this is the same as
115+# ...this is the same as...
117116 cat test.wav | ffmpeg -i pipe:
118117 @end example
119118
120119 For writing to stdout with @file{ffmpeg}:
121120 @example
122121 ffmpeg -i test.wav -f avi pipe:1 | cat > test.avi
123−# this is the same as
122+# ...this is the same as...
124123 ffmpeg -i test.wav -f avi pipe: | cat > test.avi
125124 @end example
126125
127−Note that some formats (typically mov), require the output protocol to
126+Note that some formats (typically MOV), require the output protocol to
128127 be seekable, so they will fail with the pipe output protocol.
129128
130129 @section rtmp
@@ -139,18 +138,18 @@ The required syntax is: · 8 unmodified lines
139138 rtmp://@var{server}[:@var{port}][/@var{app}][/@var{playpath}]
140139 @end example
141140
142−Follows the description of the accepted parameters.
141+The accepted parameters are:
143142 @table @option
144143
145144 @item server
146−It is the address of the RTMP server.
145+The address of the RTMP server.
147146
148147 @item port
149−It is the number of the TCP port to use (by default is 1935).
148+The number of the TCP port to use (by default is 1935).
150149
151150 @item app
152−It is the name of the application to acces. It usually corresponds to
153−the the path where the application is installed on the RTMP server
151+It is the name of the application to access. It usually corresponds to
152+the path where the application is installed on the RTMP server
154153 (e.g. @file{/ondemand/}, @file{/flash/live/}, etc.).
155154
156155 @item playpath
@@ -170,7 +169,7 @@ ffplay rtmp://myserver/vod/sample · 13 unmodified lines
170169 Real-Time Messaging Protocol and its variants supported through
171170 librtmp.
172171
173−Require the presence of the headers and library of librtmp during
172+Requires the presence of the librtmp headers and library during
174173 configuration. You need to explicitely configure the build with
175174 "--enable-librtmp". If enabled this will replace the native RTMP
176175 protocol.
@@ -188,11 +187,11 @@ The required syntax is: · 11 unmodified lines
188187 where @var{rtmp_proto} is one of the strings "rtmp", "rtmpt", "rtmpe",
189188 "rtmps", "rtmpte", "rtmpts" corresponding to each RTMP variant, and
190189 @var{server}, @var{port}, @var{app} and @var{playpath} have the same
191−meaning has specified for the RTMP native protocol.
190+meaning as specified for the RTMP native protocol.
192191 @var{options} contains a list of space-separated options of the form
193192 @var{key}=@var{val}.
194193
195−See the manual page of librtmp (man 3 librtmp) for more information.
194+See the librtmp manual page (man 3 librtmp) for more information.
196195
197196 For example, to stream a file in real-time to an RTMP server using
198197 @file{ffmpeg}:

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t