RTMPGW(8)

💖 rtmpgw — the RTMP streaming media gateway 💖

okay bestie, gather round, because this is rtmpgw(8) from the System Manager's Manual, and she is serving 💅

---

✨ NAME ✨

rtmpgw — RTMP streaming media gateway. yes queen, that's the whole vibe 🦋

---

🌸 SYNOPSIS 🌸

rtmpgw [-r url] [-n hostname] [-c port] [-l protocol] [-S host:port]
[-a app] [-t tcUrl] [-p pageUrl] [-s swfUrl] [-f flashVer] [-u auth]
[-C conndata] [-y playpath] [-v] [-d subscription] [-e] [-k skip]
[-A start] [-B stop] [-b buffer] [-m timeout] [-T key] [-j JSON]
[-w swfHash] [-x swfSize] [-W swfUrl] [-X swfAge] [-D address] [-g port]
[-q] [-V] [-z]
rtmpgw -h

---

👑 DESCRIPTION 👑

So like. rtmpgw is a server. She takes media content coming at her in RTMP and streams it out as HTTP. it's giving gateway energy, it's giving middle-man-but-make-it-fashion 🎀

Here's the tea: rtmpgw sits there listening for HTTP requests that specify RTMP stream parameters, and then she hands you back the RTMP data inside the HTTP response. literally just passing the aux cord 🫶

The only valid HTTP request is "GET /" — that's it, that's the one — but you can sneak extra options in, URL-encoded style. Options you put on the command line act as defaults, and anything in the HTTP request can override them. so the CLI is like the baseline fit and the request is the accessories ✨

---

💅 OPTIONS 💅

🌈 Network Parameters

These ones define how to connect to the media server. the "who are you texting and how" section 📱

• --rtmp, -r url — URL of the server and media content. the main character of the URL world.
• --host, -n hostname — overrides the hostname in the RTMP URL. not me just swapping the host like it's nothing 💀
• --port, -c port — overrides the port number in the RTMP URL.
• --protocol, -l number — overrides the protocol in the RTMP URL. pick your fighter:
  • 0 = rtmp
  • 1 = rtmpt
  • 2 = rtmpe
  • 3 = rtmpte
  • 4 = rtmps
  • 5 = rtmpts
• --socks, -S host:port — use the specified SOCKS4 proxy. going through a friend of a friend, lowkey 🕶️

---

💜 Connection Parameters

These define what goes inside the RTMP Connect request packet. and fr fr, if you don't give correct values here, the media server will reject the connection attempt. no cap. she's picky and honestly? valid.

• --app, -a app — name of the application to connect to on the RTMP server. Overrides the app in the RTMP URL. Sometimes the rtmpdump URL parser can't figure out the app name on its own, so you have to hand it over explicitly with this option. the parser is doing her best okay 😭
• --tcUrl, -t url — URL of the target stream. Defaults to rtmp[e]://host[:port]/app/playpath.
• --pageUrl, -p url — URL of the web page in which the media was embedded. By default, no value will be sent. she's shy like that 🙈
• --swfUrl, -s url — URL of the SWF player for the media. By default, no value will be sent.
• --flashVer, -f version — version of the Flash plugin used to run the SWF player. The default is "LNX 10,0,32,18". vintage, iconic, no notes ✨
• --auth, -u string — 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 --conn option should be used instead. yeah bestie, it's old, use --conn 💀
• --conn, -C type:data — 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.

-C B:1 -C S:authMe -C O:1 -C NN:code:1.23 -C NS:flag:ok -C O:0

---

🦋 Session Parameters

These ones kick in after the Connect request has succeeded. the post-connection glow-up 🌸

• --playpath, -y path — overrides the playpath parsed from the RTMP URL. Sometimes the rtmpdump URL parser can't determine the correct playpath automatically, so it must be given explicitly using this option.
• --live, -v — specify that the media is a live stream. No resuming or seeking in live streams is possible. you get what you get, live is live, periodt 💅
• --subscribe, -d stream — name of live stream to subscribe to. Defaults to playpath.
• --start, -A num — start at num seconds into the stream. Not valid for live streams. don't try it bestie.
• --stop, -B num — stop at num seconds into the stream.
• --buffer, -b num — set buffer time to num milliseconds. The default is 20000.
• --timeout, -m num — timeout the session after num seconds without receiving any data from the server. The default is 120. if she ghosts you for two minutes, you're out ✌️

---

🔐 Security Parameters

These handle the extra authentication requests the server throws at you. the "prove it" era 🕵️

• --token, -T key — key for SecureToken response, used if the server requires SecureToken authentication.
• --jtv, -j JSON — JSON token used by legacy Justin.tv servers. Invokes NetStream.Authenticate.UsherToken. old-school but make it work 🕰️
• --swfhash, -w hexstring — SHA256 hash of the decompressed SWF file. This option may be needed if the server uses SWF Verification, but see the --swfVfy option below. The hash is 32 bytes, and must be given in hexadecimal. The --swfsize option must always be used with this option. they're a package deal, they come as a set 💞
• --swfsize, -x num — size of the decompressed SWF file. This option may be needed if the server uses SWF Verification, but see the --swfVfy option below. The --swfhash option must always be used with this option. see? told you. matching set 🔗
• --swfVfy, -W url — URL of the SWF player for this media. This option replaces all three of the --swfUrl, --swfhash, and --swfsize 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 .swfinfo 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. she remembers so you don't have to 🧠✨
• --swfAge, -X days — 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. no double-dipping on downloads, we're efficient here 🍓

---

🎀 Miscellaneous

• --device, -D address — listener IP address. The default is 0.0.0.0, i.e., any IP address. she's open to everyone, main character energy 👑
• --sport, -g port — listener port. The default is 80.
• --quiet, -q — suppress all command output. silent but deadly 🤫
• --verbose, -V — verbose command output. tell me EVERYTHING.
• --debug, -z — debug level output. Extremely verbose, including hex dumps of all packet data. like, hex dumps of everything. it's giving unhinged and we love her for it 💀
• --help, -h — print a summary of command options.

---

🌟 EXAMPLES 🌟

okay so the HTTP request:

GET /?r=rtmp:%2f%2fserver%2fmyapp&y=somefile HTTP/1.0

is equivalent to the rtrmpdump(1) invocation:

rtmpdump -r rtmp://server/myapp -y somefile

Note: only the shortform (single letter) options are supported. long options, bestie? not here. short and sweet only 💅

---

🧚 ENVIRONMENT 🧚

• HOME — the value of $HOME is used as the location for the .swfinfo file. she knows where you live 🏠💖

---

🍓 FILES 🍓

• $HOME/.swfinfo — cache of SWF Verification information.

---

🌈 SEE ALSO 🌈

• rtmpdump(1)

---

💖 AUTHORS 💖

Andrej Stepanchuk, Howard Chu, The Flvstreamer Team <http://rtmpdump.mplayerhq.hu>

---

and that's the whole page bestie, you ate, no crumbs left 💅✨

This was RTMPDump v2.4, dated 2011-07-20, and she's the RTMPGW(8) page from the System Manager's Manual — stan forever, drink water, and don't forget your --swfsize when you use --swfhash 🫶💜