WHIP-CLIENT(1)

πŸ’… NAME πŸ’…

okay so bestie, meet whip-client β€” a simple GStreamer-based WHIP client πŸ¦‹ like, it does the WHIP thing, thru GStreamer, and it's cute about it. that's the whole vibe ✨

this one lives in section 1 of the manual (User Commands, iykyk), so it's a command you actually run in your terminal, not some arcane config file situation πŸŽ€


🌸 DESCRIPTION 🌸

πŸ“Ž Usage:

whip-client [OPTION???] -- Simple WHIP client

yeah the [OPTION???] is literally how it's written, no cap, that's the synopsis, we do not question the ???, we simply vibe with it πŸ’€

🫢 Help Options:

  • -h, --help β€” shows you the help options. the classic. when in doubt, -h out 🧚

πŸ‘‘ Application Options:

  • -u, --url β€” the address of the WHIP endpoint. this one's required, bestie, like it's the main character, no url no stream, periodt. πŸ”₯
  • -t, --token β€” authentication Bearer token to use. optional! only if your server's like "who even are you" πŸ™ˆ
  • -A, --audio β€” the GStreamer pipeline to use for audio. optional… but if you're going audio-only, it's required. so like, optional-optional, know what I mean? 🌈
  • -V, --video β€” the GStreamer pipeline to use for video. also optional, and also required if you're going video-only. same energy as above, symmetric queens πŸ’–
  • -n, --no-trickle β€” don't trickle candidates; instead put them inside the SDP offer. default: false ⭐
  • -f, --follow-link β€” use the Link headers the WHIP server hands back to auto-configure the STUN/TURN servers you should use. default: false 🌸
  • -S, --stun-server β€” the STUN server to use, if any, in the form stun://hostname:port πŸ¦‹
  • -T, --turn-server β€” the TURN server to use, if any, in the form turn(s)://username:password@host:port?transport=[udp,tcp]. and bestie β€” you can call this one multiple times, so stack 'em up πŸ’…
  • -F, --force-turn β€” if TURN servers were provided, this forces using a relay. default: false ✨
  • -l, --log-level β€” the logging level. 0=disable logging, 7=maximum log level. default: 4 πŸ‘‘
  • -o, --disable-colors β€” disables colors in the logging. default: enabled (so the colors are on until you say otherwise πŸŽ€)
  • -L, --log-timestamps β€” enables logging timestamps. default: disabled ⏰
  • -H, --http-debugging β€” HTTP debugging level, and the options are none, minimal, headers, body. default: none 🫢
  • -e, --eos-sink-name β€” the GStreamer sink name for the EOS signal πŸ’€
  • -b, --jitter-buffer β€” the jitter buffer (a.k.a. latency) to use in RTP, measured in milliseconds. default: -1, which means use webrtcbin's default 🌈

lowkey a reminder that -u/--url is required, and -A/--audio is required if you're audio-only while -V/--video is required if you're video-only. not me double-checking your flags for you πŸ₯°

anyway that's the whole page bestie, no skips, every flag accounted for, we ate that πŸ’…

toodles! this was whip-client version 0.0~git20240308, dated January 2026 πŸŒΈπŸ’–βœ¨

πŸ“¦ where this page comes from