2009-10-31 12:54:56 -06:00
|
|
|
.TH XvGrabPort __libmansuffix__ __vendorversion__ "libXv Functions"
|
|
|
|
|
.SH NAME
|
2006-11-25 11:01:46 -07:00
|
|
|
XvGrabPort \- lock port for exclusive use by client
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH SYNOPSIS
|
2006-11-25 11:01:46 -07:00
|
|
|
.B #include <X11/extensions/Xvlib.h>
|
2008-05-24 07:46:47 -06:00
|
|
|
.sp
|
|
|
|
|
.nf
|
2009-10-31 12:54:56 -06:00
|
|
|
.BI "int XvGrabPort(Display *" dpy ", XvPortID " port ", Time " time ");"
|
2008-05-24 07:46:47 -06:00
|
|
|
.fi
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH ARGUMENTS
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2008-05-24 07:46:47 -06:00
|
|
|
.IP \fIdpy\fR 8
|
2006-11-25 11:01:46 -07:00
|
|
|
Specifies the connection to the X server.
|
|
|
|
|
.IP \fIport\fR 8
|
|
|
|
|
Defines the port to be grabbed.
|
|
|
|
|
.IP \fItime\fR 8
|
|
|
|
|
Specifies the request timestamp.
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH DESCRIPTION
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.BR XvGrabPort (__libmansuffix__)
|
|
|
|
|
grabs a port. Once a client grabs a port, only that client can make video
|
|
|
|
|
requests to that port.
|
2006-11-25 11:01:46 -07:00
|
|
|
.PP
|
|
|
|
|
If the time is before the current port time, the XvGrabPort request is
|
|
|
|
|
ignored and XvInvalidTime is returned. If the port is already grabbed by
|
|
|
|
|
another client, XvAlreadyGrabbed is returned. Otherwise it returns a
|
|
|
|
|
status of \fISuccess\fR. The port time is updated when the following
|
2009-10-31 12:54:56 -06:00
|
|
|
requests are processed:
|
|
|
|
|
.BR XvGrabPort (__libmansuffix__),
|
|
|
|
|
.BR XvUngrabPort (__libmansuffix__),
|
|
|
|
|
.BR XvPutVideo (__libmansuffix__),
|
|
|
|
|
.BR XvPutStill (__libmansuffix__),
|
|
|
|
|
.BR XvGetVideo (__libmansuffix__),
|
|
|
|
|
.BR XvGetStill (__libmansuffix__).
|
2006-11-25 11:01:46 -07:00
|
|
|
.PP
|
|
|
|
|
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.
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH RETURN VALUES
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [Success] 8
|
2009-10-31 12:54:56 -06:00
|
|
|
Returned if
|
|
|
|
|
.BR XvGrabPort (__libmansuffix__)
|
|
|
|
|
completed successfully.
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [XvInvalidTime] 8
|
|
|
|
|
Returned if requested time is older than the current port time.
|
|
|
|
|
.IP [XvAlreadyGrabbed] 8
|
|
|
|
|
Returned if the port is already grabbed by another client.
|
|
|
|
|
.IP [XvBadExtension] 8
|
|
|
|
|
Returned if the Xv extension is unavailable.
|
|
|
|
|
.IP [XvBadAlloc] 8
|
2009-10-31 12:54:56 -06:00
|
|
|
Returned if
|
|
|
|
|
.BR XvGrabPort (__libmansuffix__)
|
|
|
|
|
failed to allocate memory to process the request.
|
|
|
|
|
.SH DIAGNOSTICS
|
2006-11-25 11:01:46 -07:00
|
|
|
.IP [XvBadPort] 15
|
|
|
|
|
Generated if the requested port does not exist.
|
|
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.SH SEE ALSO
|
2006-11-25 11:01:46 -07:00
|
|
|
.\"
|
2009-10-31 12:54:56 -06:00
|
|
|
.BR XvUngrabPort (__libmansuffix__),
|
|
|
|
|
.BR XvVideoNotify (__libmansuffix__)
|
|
|
|
|
|
