This repository was archived by the owner on Aug 8, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
Expand file tree
/
Copy pathrtmpdump.1.html
More file actions
439 lines (425 loc) · 10.9 KB
/
rtmpdump.1.html
File metadata and controls
439 lines (425 loc) · 10.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
<HTML>
<HEAD>
<title>RTMPDUMP(1): </title></head>
<table>
<thead>
<tr><td>RTMPDUMP(1)<td align="center"><td align="right">RTMPDUMP(1)
</thead>
<tfoot>
<tr><td>RTMPDump v2.4<td align="center">2012-07-24<td align="right">RTMPDUMP(1)
</tfoot>
<tbody><tr><td colspan="3"><br><br><ul>
<!-- Copyright 2011 Howard Chu.
Copying permitted according to the GNU General Public License V2.-->
</ul>
<h3>NAME</h3><ul>
rtmpdump − RTMP streaming media client
</ul>
<h3>SYNOPSIS</h3><ul>
<b>rtmpdump</b>
<b>−r</b><i> url</i>
[<b>−n</b><i> hostname</i>]
[<b>−c</b><i> port</i>]
[<b>−l</b><i> protocol</i>]
[<b>−S</b><i> host:port</i>]
[<b>−a</b><i> app</i>]
[<b>−t</b><i> tcUrl</i>]
[<b>−p</b><i> pageUrl</i>]
[<b>−s</b><i> swfUrl</i>]
[<b>−f</b><i> flashVer</i>]
[<b>−u</b><i> auth</i>]
[<b>−C</b><i> conndata</i>]
[<b>−y</b><i> playpath</i>]
[<b>−Y</b>]
[<b>−v</b>]
[<b>−R</b>]
[<b>−d</b><i> subscription</i>]
[<b>−e</b>]
[<b>−k</b><i> skip</i>]
[<b>−A</b><i> start</i>]
[<b>−B</b><i> stop</i>]
[<b>−b</b><i> buffer</i>]
[<b>−m</b><i> timeout</i>]
[<b>−T</b><i> key</i>]
[<b>−j</b><i> JSON</i>]
[<b>−w</b><i> swfHash</i>]
[<b>−x</b><i> swfSize</i>]
[<b>−W</b><i> swfUrl</i>]
[<b>−X</b><i> swfAge</i>]
[<b>−o</b><i> output</i>]
[<b>−#</b>]
[<b>−q</b>]
[<b>−V</b>]
[<b>−z</b>]
<br>
<b>rtmpdump −h</b>
</ul>
<h3>DESCRIPTION</h3><ul>
<b>rtmpdump</b>
is a tool for dumping media content streamed over RTMP.
<p>
<b>rtmpdump</b>
makes a connection to the specified RTMP server and plays the media
specified by the given
<i>url</i>.
The url should be of the form
<pre>
rtmp[t][e]://hostname[:port][/app[/playpath]]
</pre>
<p>
Plain rtmp, as well as tunneled and encrypted sessions are supported.
</ul>
<h3>OPTIONS</h3><ul>
</ul>
<h4>Network Parameters</h4><ul>
These options define how to connect to the media server.
<p>
<dl compact><dt>
<b>−−rtmp −r</b> <i>url</i>
<dd>
URL of the server and media content.
</dl>
<p>
<dl compact><dt>
<b>−−host −n</b> <i>hostname</i>
<dd>
Overrides the hostname in the RTMP URL.
</dl>
<p>
<dl compact><dt>
<b>−−port −c</b> <i>port</i>
<dd>
Overrides the port number in the RTMP URL.
</dl>
<p>
<dl compact><dt>
<b>−−protocol −l</b> <i>number</i>
<dd>
Overrides the protocol in the RTMP URL.
<pre>
0 = rtmp
1 = rtmpt
2 = rtmpe
3 = rtmpte
4 = rtmps
5 = rtmpts
</pre>
</dl>
<p>
<dl compact><dt>
<b>−−socks −S</b> <i>host:port</i>
<dd>
Use the specified SOCKS4 proxy.
</dl>
</ul>
<h4>Connection Parameters</h4><ul>
These options define the content of the RTMP Connect request packet.
If correct values are not provided, the media server will reject the
connection attempt.
<p>
<dl compact><dt>
<b>−−app −a</b> <i>app</i>
<dd>
Name of application to connect to on the RTMP server. Overrides
the app in the RTMP URL. Sometimes the rtmpdump URL parser cannot
determine the app name automatically, so it must be given explicitly
using this option.
</dl>
<p>
<dl compact><dt>
<b>−−tcUrl −t</b> <i>url</i>
<dd>
URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath.
</dl>
<p>
<dl compact><dt>
<b>−−pageUrl −p</b> <i>url</i>
<dd>
URL of the web page in which the media was embedded. By default no
value will be sent.
</dl>
<p>
<dl compact><dt>
<b>−−swfUrl −s</b> <i>url</i>
<dd>
URL of the SWF player for the media. By default no value will be sent.
</dl>
<p>
<dl compact><dt>
<b>−−flashVer −f</b> <i>version</i>
<dd>
Version of the Flash plugin used to run the SWF player. The
default is "LNX 10,0,32,18".
</dl>
<p>
<dl compact><dt>
<b>−−auth −u</b> <i>string</i>
<dd>
An authentication string to be appended to the Connect message. Using
this option will append a Boolean TRUE and then the specified string.
This option is only used by some particular servers and is
deprecated. The more general
<b>−−conn</b>
option should be used instead.
</dl>
<p>
<dl compact><dt>
<b>−−conn −C</b> <i>type:data</i>
<dd>
Append arbitrary AMF data to the Connect message. The type
must be B for Boolean, N for number, S for string, O for object, or Z
for null. For Booleans the data must be either 0 or 1 for FALSE or TRUE,
respectively. Likewise for Objects the data must be 0 or 1 to end or
begin an object, respectively. Data items in subobjects may be named, by
prefixing the type with 'N' and specifying the name before the value, e.g.
NB:myFlag:1. This option may be used multiple times to construct arbitrary
AMF sequences. E.g.
<pre>
−C B:1 −C S:authMe −C O:1 −C NN:code:1.23 −C NS:flag:ok −C O:0
</pre>
</dl>
</ul>
<h4>Session Parameters</h4><ul>
These options take effect after the Connect request has succeeded.
<p>
<dl compact><dt>
<b>−−playpath −y</b> <i>path</i>
<dd>
Overrides the playpath parsed from the RTMP URL. Sometimes the
rtmpdump URL parser cannot determine the correct playpath
automatically, so it must be given explicitly using this option.
</dl>
<p>
<dl compact><dt>
<b>−−playlist −Y</b>
<dd>
Issue a set_playlist command before sending the play command. The
playlist will just contain the current playpath.
</dl>
<p>
<dl compact><dt>
<b>−−live −v</b>
<dd>
Specify that the media is a live stream. No resuming or seeking in
live streams is possible.
</dl>
<p>
<dl compact><dt>
<b>−−subscribe −d</b> <i>stream</i>
<dd>
Name of live stream to subscribe to. Defaults to
<i>playpath</i>.
</dl>
<p>
<dl compact><dt>
<b>−−realtime −R</b>
<dd>
Download approximately in realtime, without attempting to speed up via
Pause/Unpause commands ("the BUFX hack").
Useful for servers that jump backwards in time at the Unpause command.
Resuming and seeking in realtime streams is still possible.
</dl>
<p>
<dl compact><dt>
<b>−−resume −e</b>
<dd>
Resume an incomplete RTMP download.
</dl>
<p>
<dl compact><dt>
<b>−−skip −k</b> <i>num</i>
<dd>
Skip
<i>num</i>
keyframes when looking for the last keyframe from which to resume. This
may be useful if a regular attempt to resume fails. The default is 0.
</dl>
<p>
<dl compact><dt>
<b>−−start −A</b> <i>num</i>
<dd>
Start at
<i>num</i>
seconds into the stream. Not valid for live streams.
</dl>
<p>
<dl compact><dt>
<b>−−stop −B</b> <i>num</i>
<dd>
Stop at
<i>num</i>
seconds into the stream.
</dl>
<p>
<dl compact><dt>
<b>−−buffer −b</b> <i>num</i>
<dd>
Set buffer time to
<i>num</i>
milliseconds. The default is 36000000.
</dl>
<p>
<dl compact><dt>
<b>−−timeout −m</b> <i>num</i>
<dd>
Timeout the session after
<i>num</i>
seconds without receiving any data from the server. The default is 120.
</dl>
</ul>
<h4>Security Parameters</h4><ul>
These options handle additional authentication requests from the server.
<p>
<dl compact><dt>
<b>−−token −T</b> <i>key</i>
<dd>
Key for SecureToken response, used if the server requires SecureToken
authentication.
</dl>
<p>
<dl compact><dt>
<b>−−jtv −j</b> <i>JSON</i>
<dd>
JSON token used by legacy Justin.tv servers. Invokes NetStream.Authenticate.UsherToken
</dl>
<p>
<dl compact><dt>
<b>−−swfhash −w</b> <i>hexstring</i>
<dd>
SHA256 hash of the decompressed SWF file. This option may be needed if
the server uses SWF Verification, but see the
<b>−−swfVfy</b>
option below. The hash is 32 bytes, and must be
given in hexadecimal. The
<b>−−swfsize</b>
option must always be used with this option.
</dl>
<p>
<dl compact><dt>
<b>−−swfsize −x</b> <i>num</i>
<dd>
Size of the decompressed SWF file. This option may be needed if the
server uses SWF Verification, but see the
<b>−−swfVfy</b>
option below. The
<b>−−swfhash</b>
option must always be used with this option.
</dl>
<p>
<dl compact><dt>
<b>−−swfVfy −W</b> <i>url</i>
<dd>
URL of the SWF player for this media. This option replaces all three
of the
<b>−−swfUrl</b>,
<b>−−swfhash</b>,
and
<b>−−swfsize</b>
options. When this option is used, the SWF player is retrieved from the
specified URL and the hash and size are computed automatically. Also
the information is cached in a
<i>.swfinfo</i>
file in the user's home directory, so that it doesn't need to be retrieved
and recalculated every time rtmpdump is run. The .swfinfo file records
the URL, the time it was fetched, the modification timestamp of the SWF
file, its size, and its hash. By default, the cached info will be used
for 30 days before re-checking.
</dl>
<p>
<dl compact><dt>
<b>−−swfAge −X</b> <i>days</i>
<dd>
Specify how many days to use the cached SWF info before re-checking. Use
0 to always check the SWF URL. Note that if the check shows that the
SWF file has the same modification timestamp as before, it will not be
retrieved again.
</dl>
</ul>
<h4>Miscellaneous</h4><ul>
<p>
<dl compact><dt>
<b>−−flv −o</b> <i>output</i>
<dd>
Specify the output file name. If the name is − or is omitted, the
stream is written to stdout.
</dl>
<p>
<dl compact><dt>
<b>−−hashes −#</b>
<dd>
Display streaming progress with a hash mark for each 1% of progress, instead
of a byte counter.
</dl>
<p>
<dl compact><dt>
<b>−−quiet −q</b>
<dd>
Suppress all command output.
</dl>
<p>
<dl compact><dt>
<b>−−verbose −V</b>
<dd>
Verbose command output.
</dl>
<p>
<dl compact><dt>
<b>−−debug −z</b>
<dd>
Debug level output. Extremely verbose, including hex dumps of all packet data.
</dl>
<p>
<dl compact><dt>
<b>−−help −h</b>
<dd>
Print a summary of command options.
</dl>
</ul>
<h3>EXIT STATUS</h3><ul>
<p>
<dl compact><dt>
<b>0</b>
<dd>
Successful program execution.
</dl>
<p>
<dl compact><dt>
<b>1</b>
<dd>
Unrecoverable error.
</dl>
<p>
<dl compact><dt>
<b>2</b>
<dd>
Incomplete transfer, resuming may get further.
</dl>
</ul>
<h3>ENVIRONMENT</h3><ul>
<p>
<dl compact><dt>
<b>HOME</b>
<dd>
The value of
$<b>HOME</b>
is used as the location for the
<i>.swfinfo</i>
file.
</dl>
</ul>
<h3>FILES</h3><ul>
<p>
<dl compact><dt>
<i>$HOME/.swfinfo</i>
<dd>
Cache of SWF Verification information
</dl>
</ul>
<h3>SEE ALSO</h3><ul>
<a href="../man8/rtmpgw.8"><b>rtmpgw</b></a>(8)
</ul>
<h3>AUTHORS</h3><ul>
Andrej Stepanchuk, Howard Chu, The Flvstreamer Team
<br>
<<a href="http://rtmpdump.mplayerhq.hu">http://rtmpdump.mplayerhq.hu</a>>
</ul></tbody></table></html>