| blob | 68d6734a677a91fd2df8c58a8ff648ca6e4551ea |
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 rtmpgw − RTMP streaming media gateway
18 </ul>
54 <br>
56 </ul>
60 is a server for streaming media content from RTMP out to HTTP.
61 <p>
63 listens for HTTP requests that specify RTMP stream parameters and
64 then returns the RTMP data in the HTTP response. The only valid
65 HTTP request is "GET /" but additional options can be provided
66 in URL-encoded fashion. Options specified on the command line will
67 be used as defaults, which can be overridden by options in the HTTP
68 request.
69 </ul>
72 </ul>
75 These options define how to connect to the media server.
76 <p>
79 <dd>
80 URL of the server and media content.
81 </dl>
82 <p>
85 <dd>
86 Overrides the hostname in the RTMP URL.
87 </dl>
88 <p>
91 <dd>
92 Overrides the port number in the RTMP URL.
93 </dl>
94 <p>
97 <dd>
98 Overrides the protocol in the RTMP URL.
99 <pre>
100 0 = rtmp
101 1 = rtmpt
102 2 = rtmpe
103 3 = rtmpte
104 4 = rtmps
105 5 = rtmpts
106 </pre>
107 </dl>
108 <p>
111 <dd>
112 Use the specified SOCKS4 proxy.
113 </dl>
114 </ul>
117 These options define the content of the RTMP Connect request packet.
118 If correct values are not provided, the media server will reject the
119 connection attempt.
120 <p>
123 <dd>
124 Name of application to connect to on the RTMP server. Overrides
125 the app in the RTMP URL. Sometimes the rtmpdump URL parser cannot
126 determine the app name automatically, so it must be given explicitly
127 using this option.
128 </dl>
129 <p>
132 <dd>
133 URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath.
134 </dl>
135 <p>
138 <dd>
139 URL of the web page in which the media was embedded. By default no
140 value will be sent.
141 </dl>
142 <p>
145 <dd>
146 URL of the SWF player for the media. By default no value will be sent.
147 </dl>
148 <p>
151 <dd>
152 Version of the Flash plugin used to run the SWF player. The
153 default is "LNX 10,0,32,18".
154 </dl>
155 <p>
158 <dd>
159 An authentication string to be appended to the Connect message. Using
160 this option will append a Boolean TRUE and then the specified string.
161 This option is only used by some particular servers and is
162 deprecated. The more general
164 option should be used instead.
165 </dl>
166 <p>
169 <dd>
170 Append arbitrary AMF data to the Connect message. The type
171 must be B for Boolean, N for number, S for string, O for object, or Z
174 begin an object, respectively. Data items in subobjects may be named, by
175 prefixing the type with 'N' and specifying the name before the value, e.g.
176 NB:myFlag:1. This option may be used multiple times to construct arbitrary
177 AMF sequences. E.g.
178 <pre>
179 −C B:1 −C S:authMe −C O:1 −C NN:code:1.23 −C NS:flag:ok −C O:0
180 </pre>
181 </dl>
182 </ul>
185 These options take effect after the Connect request has succeeded.
186 <p>
189 <dd>
190 Overrides the playpath parsed from the RTMP URL. Sometimes the
191 rtmpdump URL parser cannot determine the correct playpath
192 automatically, so it must be given explicitly using this option.
193 </dl>
194 <p>
197 <dd>
198 Specify that the media is a live stream. No resuming or seeking in
199 live streams is possible.
200 </dl>
201 <p>
204 <dd>
205 Name of live stream to subscribe to. Defaults to
207 </dl>
208 <p>
211 <dd>
212 Start at
214 seconds into the stream. Not valid for live streams.
215 </dl>
216 <p>
219 <dd>
220 Stop at
222 seconds into the stream.
223 </dl>
224 <p>
227 <dd>
228 Set buffer time to
230 milliseconds. The default is 20000.
231 </dl>
232 <p>
235 <dd>
236 Timeout the session after
238 seconds without receiving any data from the server. The default is 120.
239 </dl>
240 </ul>
243 These options handle additional authentication requests from the server.
244 <p>
247 <dd>
248 Key for SecureToken response, used if the server requires SecureToken
249 authentication.
250 </dl>
251 <p>
254 <dd>
255 JSON token used by legacy Justin.tv servers. Invokes NetStream.Authenticate.UsherToken
256 </dl>
257 <p>
260 <dd>
261 SHA256 hash of the decompressed SWF file. This option may be needed if
262 the server uses SWF Verification, but see the
264 option below. The hash is 32 bytes, and must be
265 given in hexadecimal. The
267 option must always be used with this option.
268 </dl>
269 <p>
272 <dd>
273 Size of the decompressed SWF file. This option may be needed if the
274 server uses SWF Verification, but see the
276 option below. The
278 option must always be used with this option.
279 </dl>
280 <p>
283 <dd>
284 URL of the SWF player for this media. This option replaces all three
285 of the
288 and
290 options. When this option is used, the SWF player is retrieved from the
291 specified URL and the hash and size are computed automatically. Also
292 the information is cached in a
294 file in the user's home directory, so that it doesn't need to be retrieved
295 and recalculated every time rtmpdump is run. The .swfinfo file records
296 the URL, the time it was fetched, the modification timestamp of the SWF
297 file, its size, and its hash. By default, the cached info will be used
298 for 30 days before re-checking.
299 </dl>
300 <p>
303 <dd>
304 Specify how many days to use the cached SWF info before re-checking. Use
305 0 to always check the SWF URL. Note that if the check shows that the
306 SWF file has the same modification timestamp as before, it will not be
307 retrieved again.
308 </dl>
309 </ul>
312 <p>
315 <dd>
316 Listener IP address. The default is 0.0.0.0, i.e., any IP address.
317 </dl>
318 <p>
321 <dd>
322 Listener port. The default is 80.
323 </dl>
324 <p>
327 <dd>
328 Suppress all command output.
329 </dl>
330 <p>
333 <dd>
334 Verbose command output.
335 </dl>
336 <p>
339 <dd>
340 Debug level output. Extremely verbose, including hex dumps of all packet data.
341 </dl>
342 <p>
345 <dd>
346 Print a summary of command options.
347 </dl>
348 </ul>
351 The HTTP request
352 <pre>
354 </pre>
355 is equivalent to the
357 invocation
358 <pre>
360 </pre>
361 <p>
362 Note that only the shortform (single letter) options are supported.
363 </ul>
366 <p>
369 <dd>
370 The value of
372 is used as the location for the
374 file.
375 </dl>
376 </ul>
379 <p>
382 <dd>
383 Cache of SWF Verification information
384 </dl>
385 </ul>
389 </ul>
392 Andrej Stepanchuk, Howard Chu, The Flvstreamer Team
393 <br>
395 </ul></tbody></table></html>