MAN page from Mandriva 2009 libxv1-devel-1.0.4-2mdv2009.1.i586.rpm

XvGrabPort

Section: C Library Functions (3)
Updated: libXv 1.0.4
Index

Name

XvGrabPort - lock port for exclusive use by client

Syntax

#include <X11/extensions/Xvlib.h>

XvGrabPort(Display *dpy, XvPortID port, Time time);

Arguments

dpy: Specifies the connection to the X server.
port: Defines the port to be grabbed.
time: Specifies the request timestamp.

Description

XvGrabPort(3) grabs a port. Once a client grabs a port, only that client can make video requeststo that port.

If the time is before the current port time, the XvGrabPort request isignored and XvInvalidTime is returned. If the port is already grabbed byanother client, XvAlreadyGrabbed is returned. Otherwise it returns astatus of Success. The port time is updated when the followingrequests are processed: XvGrabPort(3), XvUngrabPort(3),XvPutVideo(3), XvPutStill(3), XvGetVideo(3), XvGetStill(3).

If the port is actively processing video for another client, thevideo is preempted, and an XvVideoNotify event with detail XvPreemptedis generated for its drawable.

Returned Values

[Success]: Returned if XvGrabPort(3) completed successfully.
[XvInvalidTime]: Returned if requested time is older than the current port time.
[XvAlreadyGrabbed]: Returned if the port is already grabbed by another client.
[XvBadExtension]: Returned if the Xv extension is unavailable.
[XvBadAlloc]: Returned if XvGrabPort(3) failed to allocate memory to processthe request.

Diagnostics

[XvBadPort]: Generated if the requested port does not exist.

This document was created byman2html,using the manual pages.