USTREAMER-DUMP(1)

💖 USTREAMER-DUMP(1) — the manual page, but make it make sense 💖

okay bestie, gather round, because we're talking about ustreamer-dump, a lil general commands manual page and honestly? she's serving utility. 🎀

✨ NAME ✨

ustreamer-dump — dump uStreamer's memory sink to a file, no cap

---

🦋 SYNOPSIS 🦋

ustreamer-dump [OPTIONS]

---

🌸 DESCRIPTION 🌸

µStreamer-dump (aka ustreamer-dump) takes a local stream from ustreamer and writes it to a file, OR redirects it off to other utilities (like ffmpeg, our beloved). it's giving pipeline princess. 💅

---

👑 USAGE 👑

ustreamer needs at least the --sink option to operate, periodt. that's the bare minimum, she can't function without it.

so say you wanna output ustreamer's sink test to ffmpeg, and also into a file called test.mp4. here's the moment:

ustreamer-dump \
       --sink=test \ # Use ustreamer sink "test"
       --output - \ # Output to stdout
       | ffmpeg -use_wallclock_as_timestamps 1 -i pipe: -c:v libx264 test.mp4

see how it just pipes straight through? iconic. 🔥

---

⭐ OPTIONS ⭐

🧚 Sink options

• -s, --sink name — the Memory sink ID. no default, so you gotta provide it. no default bestie, i said what i said.
• -t, --sink-timeout sec — how long to wait for the upcoming frame. Default: 1.
• -o, --output filename — the filename to dump output to. Use '-' for stdout. Default: it just consumes the sink (no output file, just vibes).
• -j, --output-json — format the output as JSON. this one requires the --output option, don't forget. Default: disabled.
• -c, --count N — limit the number of frames. Default: 0 (which means infinite, we go forever).
• -i, --interval sec — delay between reading frames, and yes it's a float. Default: 0.
• -k, --key-required — request a keyframe from the sink. Default: disabled.

🌈 Logging options

• --log-level N — verbosity level of messages, from 0 (info) to 3 (debug). heads up: enabling debugging messages can slow down the program. available levels: 0 (info), 1 (performance), 2 (verbose), 3 (debug). Default: 0.
• --perf — enable performance messages (same as --log-level=1). Default: disabled.
• --verbose — enable verbose messages and lower (same as --log-level=2). Default: disabled.
• --debug — enable debug messages and lower (same as --log-level=3). Default: disabled.
• --force-log-colors — force color logging. Default: colored if stderr is a TTY.
• --no-log-colors — disable color logging. Default: ditto (same as above, bestie).

🫶 Help options

• -h, --help — print this text and exit. the classic.
• -v, --version — print version and exit.

---

💜 SEE ALSO 💜

ustreamer(1) — go read that one too, iykyk

---

💀 BUGS 💀

found a bug? an issue? something acting up? please file any bugs and issues at https://github.com/pikvm/ustreamer/issues — the devs will love you for it. 🫶

---

🎀 AUTHOR 🎀

Maxim Devaev <mdevaev@gmail.com> — the mastermind, the main character. 👑

---

🌟 HOMEPAGE 🌟

https://pikvm.org/

---

💖 COPYRIGHT 💖

GNU General Public License v3.0

---

and that's the whole page, bestie. no detail left behind, every flag accounted for, we ate and left no crumbs. 🍓

okay so this manual page is dated January 2021 and it's version 6.12 — signing off, mwah 💅✨