XvGrabPort(3X)XvGrabPort(3X)NameXvGrabPort - lock port for exclusive use by client
Syntax
#include <X11/extensions/Xvlib.h>
XvGrabPort(dpy, port, time)
Display *dpy;
XvPortID port;
Time time;
Arguments
dpy Specifies the display screen on which the Xv
Server is to accept requests from Xv clients. If
the display option is not specified, Xv uses the
display screen specified by your DISPLAY environ-
ment variable. The display option has the format
hostname:number. Using two colons (::) instead of
one (:) indicates that DECnet is to be used for
transport.
port Defines the port to be grabbed.
time Specifies the request timestamp.
DescriptionXvGrabPort(3X) grabs a port. Once a client grabs a port,
only that client can make video requests to that port.
If the time is before the current port time, the XvGrab-
Port request is ignored and XvInvalidTime is returned. If
the port is already grabbed by another client, XvAlready-
Grabbed is returned. Otherwise it returns a status of Suc-
cess. The port time is updated when the following
requests are processed: XvGrabPort(3X), XvUngrabPort(3X),
XvPutVideo(3X), XvPutStill(3X), XvGetVideo(3X), XvGet-
Still(3X).
If the port is actively processing video for another
client, the video is preempted, and an XvVideoNotify event
with detail XvPreempted is generated for its drawable.
Returned Values
[Success]
Returned if XvGrabPort(3X) completed successfully.
[XvInvalidTime]
Returned if requested time is older than the cur-
rent port time.
[XvAlreadyGrabbed]
Returned if the port is already grabbed by another
client.
1
XvGrabPort(3X)XvGrabPort(3X)
[XvBadExtension]
Returned if the Xv extension is unavailable.
[XvBadAlloc]
Returned if XvGrabPort(3X) failed to allocate mem-
ory to process the request.
Diagnostics
[XvBadPort] Generated if the requested port does not
exist.
See AlsoXvUngrabPort(3X)XvVideoNotify(3X)
2
