| blob | 4c39b359e05048287fc3354cb25ce7520b86d180 |
1 <HTML>
2 <HEAD>
4 <table>
5 <thead>
7 </thead>
8 <tfoot>
10 </tfoot>
12 <!-- Copyright 2011 Howard Chu.
13 Copying permitted according to the GNU General Public License V2.-->
14 </ul>
17 rtmpdump − RTMP streaming media client
18 </ul>
56 <br>
58 </ul>
62 is a tool for dumping media content streamed over RTMP.
63 <p>
65 makes a connection to the specified RTMP server and plays the media
66 specified by the given
68 The url should be of the form
69 <pre>
70 rtmp[t][e]://hostname[:port][/app[/playpath]]
71 </pre>
72 <p>
73 Plain rtmp, as well as tunneled and encrypted sessions are supported.
74 </ul>
77 </ul>
80 These options define how to connect to the media server.
81 <p>
84 <dd>
85 URL of the server and media content.
86 </dl>
87 <p>
90 <dd>
91 Overrides the hostname in the RTMP URL.
92 </dl>
93 <p>
96 <dd>
97 Overrides the port number in the RTMP URL.
98 </dl>
99 <p>
102 <dd>
103 Overrides the protocol in the RTMP URL.
104 <pre>
105 0 = rtmp
106 1 = rtmpt
107 2 = rtmpe
108 3 = rtmpte
109 4 = rtmps
110 5 = rtmpts
111 </pre>
112 </dl>
113 <p>
116 <dd>
117 Use the specified SOCKS4 proxy.
118 </dl>
119 </ul>
122 These options define the content of the RTMP Connect request packet.
123 If correct values are not provided, the media server will reject the
124 connection attempt.
125 <p>
128 <dd>
129 Name of application to connect to on the RTMP server. Overrides
130 the app in the RTMP URL. Sometimes the rtmpdump URL parser cannot
131 determine the app name automatically, so it must be given explicitly
132 using this option.
133 </dl>
134 <p>
137 <dd>
138 URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath.
139 </dl>
140 <p>
143 <dd>
144 URL of the web page in which the media was embedded. By default no
145 value will be sent.
146 </dl>
147 <p>
150 <dd>
151 URL of the SWF player for the media. By default no value will be sent.
152 </dl>
153 <p>
156 <dd>
157 Version of the Flash plugin used to run the SWF player. The
158 default is "LNX 10,0,32,18".
159 </dl>
160 <p>
163 <dd>
164 An authentication string to be appended to the Connect message. Using
165 this option will append a Boolean TRUE and then the specified string.
166 This option is only used by some particular servers and is
167 deprecated. The more general
169 option should be used instead.
170 </dl>
171 <p>
174 <dd>
175 Append arbitrary AMF data to the Connect message. The type
176 must be B for Boolean, N for number, S for string, O for object, or Z
179 begin an object, respectively. Data items in subobjects may be named, by
180 prefixing the type with 'N' and specifying the name before the value, e.g.
181 NB:myFlag:1. This option may be used multiple times to construct arbitrary
182 AMF sequences. E.g.
183 <pre>
184 −C B:1 −C S:authMe −C O:1 −C NN:code:1.23 −C NS:flag:ok −C O:0
185 </pre>
186 </dl>
187 </ul>
190 These options take effect after the Connect request has succeeded.
191 <p>
194 <dd>
195 Overrides the playpath parsed from the RTMP URL. Sometimes the
196 rtmpdump URL parser cannot determine the correct playpath
197 automatically, so it must be given explicitly using this option.
198 </dl>
199 <p>
202 <dd>
203 Issue a set_playlist command before sending the play command. The
204 playlist will just contain the current playpath.
205 </dl>
206 <p>
209 <dd>
210 Specify that the media is a live stream. No resuming or seeking in
211 live streams is possible.
212 </dl>
213 <p>
216 <dd>
217 Name of live stream to subscribe to. Defaults to
219 </dl>
220 <p>
223 <dd>
224 Download approximately in realtime, without attempting to speed up via
226 Useful for servers that jump backwards in time at the Unpause command.
227 Resuming and seeking in realtime streams is still possible.
228 </dl>
229 <p>
232 <dd>
233 Resume an incomplete RTMP download.
234 </dl>
235 <p>
238 <dd>
239 Skip
241 keyframes when looking for the last keyframe from which to resume. This
242 may be useful if a regular attempt to resume fails. The default is 0.
243 </dl>
244 <p>
247 <dd>
248 Start at
250 seconds into the stream. Not valid for live streams.
251 </dl>
252 <p>
255 <dd>
256 Stop at
258 seconds into the stream.
259 </dl>
260 <p>
263 <dd>
264 Set buffer time to
266 milliseconds. The default is 36000000.
267 </dl>
268 <p>
271 <dd>
272 Timeout the session after
274 seconds without receiving any data from the server. The default is 120.
275 </dl>
276 </ul>
279 These options handle additional authentication requests from the server.
280 <p>
283 <dd>
284 Key for SecureToken response, used if the server requires SecureToken
285 authentication.
286 </dl>
287 <p>
290 <dd>
291 JSON token used by legacy Justin.tv servers. Invokes NetStream.Authenticate.UsherToken
292 </dl>
293 <p>
296 <dd>
297 SHA256 hash of the decompressed SWF file. This option may be needed if
298 the server uses SWF Verification, but see the
300 option below. The hash is 32 bytes, and must be
301 given in hexadecimal. The
303 option must always be used with this option.
304 </dl>
305 <p>
308 <dd>
309 Size of the decompressed SWF file. This option may be needed if the
310 server uses SWF Verification, but see the
312 option below. The
314 option must always be used with this option.
315 </dl>
316 <p>
319 <dd>
320 URL of the SWF player for this media. This option replaces all three
321 of the
324 and
326 options. When this option is used, the SWF player is retrieved from the
327 specified URL and the hash and size are computed automatically. Also
328 the information is cached in a
330 file in the user's home directory, so that it doesn't need to be retrieved
331 and recalculated every time rtmpdump is run. The .swfinfo file records
332 the URL, the time it was fetched, the modification timestamp of the SWF
333 file, its size, and its hash. By default, the cached info will be used
334 for 30 days before re-checking.
335 </dl>
336 <p>
339 <dd>
340 Specify how many days to use the cached SWF info before re-checking. Use
341 0 to always check the SWF URL. Note that if the check shows that the
342 SWF file has the same modification timestamp as before, it will not be
343 retrieved again.
344 </dl>
345 </ul>
348 <p>
351 <dd>
352 Specify the output file name. If the name is − or is omitted, the
353 stream is written to stdout.
354 </dl>
355 <p>
358 <dd>
359 Display streaming progress with a hash mark for each 1% of progress, instead
360 of a byte counter.
361 </dl>
362 <p>
365 <dd>
366 Suppress all command output.
367 </dl>
368 <p>
371 <dd>
372 Verbose command output.
373 </dl>
374 <p>
377 <dd>
378 Debug level output. Extremely verbose, including hex dumps of all packet data.
379 </dl>
380 <p>
383 <dd>
384 Print a summary of command options.
385 </dl>
386 </ul>
389 <p>
392 <dd>
393 Successful program execution.
394 </dl>
395 <p>
398 <dd>
399 Unrecoverable error.
400 </dl>
401 <p>
404 <dd>
405 Incomplete transfer, resuming may get further.
406 </dl>
407 </ul>
410 <p>
413 <dd>
414 The value of
416 is used as the location for the
418 file.
419 </dl>
420 </ul>
423 <p>
426 <dd>
427 Cache of SWF Verification information
428 </dl>
429 </ul>
433 </ul>
436 Andrej Stepanchuk, Howard Chu, The Flvstreamer Team
437 <br>
439 </ul></tbody></table></html>