XvStopVideo(3)

📦
version 1.0.13 · 3 versions
, in alpine 3.22, alpine 3.23, alpine 3.24, arch rolling, fedora 43, fedora 44, ubuntu resolute, ubuntu stonking

💅 XvStopVideo(3) — the libXv girlies' guide to ✨stopping video✨

okay so bestie, welcome to XvStopVideo, a lil function from the libXv crew (that's the X Version 11 manual, section 3, iykyk). if you've got video playing on an X port and you need it to stop like right now, this is literally your girl. let's get into it 🎀

🌸 NAME 🌸

XvStopVideo — stop active video. that's it, that's the whole vibe. short, iconic, does exactly what it says on the tin 🫶

✨ SYNOPSIS ✨

#include <X11/extensions/Xvlib.h>

int XvStopVideo(Display *dpy, XvPortID port, Drawable draw);

three args, one int coming back at you. no cap. 💖

🦋 ARGUMENTS 🦋

  • dpy — the connection to the X server. your whole line to the mothership, basically. 📡
  • port — the port whose video is getting stopped. this is the one we're shutting down, bestie. 🛑
  • draw — the drawable that's associated with the named port. they come as a pair, like us. 👯‍♀️

💜 DESCRIPTION 💜

so XvStopVideo(3) stops the active video for the port and drawable you specified. simple, clean, slay.

but here's the tea ☕ — it's kinda picky, and honestly? respect. if the port isn't processing video at all, or if it is processing video but in a different drawable, the request just gets ignored. not an error, not a crash, just... silence. ghosted. 💀

when video actually does stop, an XvVideoNotify(3) event gets generated for the associated drawable, with detail XvStopped. so your event loop gets the little notification and it's like "oh periodt, we're done here." 🔔

👑 RETURN VALUES 👑

  • [Success] — returned if XvStopVideo(3) completed successfully. the good ending. the main character moment. ✨
  • [XvBadExtension] — returned if the Xv extension is unavailable. like showing up to the party and the party isn't there. 😭
  • [XvBadAlloc] — returned if XvStopVideo(3) failed to allocate memory to process the request. the memory said no and honestly, mood. 🙈

🔥 DIAGNOSTICS 🔥

these are the dramatic ones, bestie. they don't come back to you, they get generated.

  • [XvBadPort] — generated if the requested port does not exist. that port is not real, girl. it never was. 💀
  • [BadDrawable] — generated if the requested drawable does not exist. same energy, different name. ghost drawable, no notes. 👻
fr fr, if you're hitting these, check your port and drawable values before you blame the library. it's giving "user error" and we've all been there 🫶

🌈 SEE ALSO 🌈

the whole squad, go read them too, they're all bangers. 💖

okay that's the page!! this was libXv 1.0.13 from the X Version 11 distribution, so if you see those numbers floating around in your man output, that's me, that's my signature 💅✨ bye bestie, go stop some video, you're gonna ate it up 🎀🦋

📦 where this page comes from