MirOS Manual: XvGrabPort(3)


XvGrabPort(3X)      UNIX Programmer's Manual       XvGrabPort(3X)

Name

     XvGrabPort - 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 environment vari-
             able.  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.

Description

     XvGrabPort(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 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 Success.  The
     port time is updated when the following requests are pro-
     cessed: XvGrabPort(3X), XvUngrabPort(3X), XvPutVideo(3X),
     XvPutStill(3X), XvGetVideo(3X), XvGetStill(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 current
             port time.

     [XvAlreadyGrabbed]
             Returned if the port is already grabbed by another

XFree86                   Version 4.5.0                         1

XvGrabPort(3X)      UNIX Programmer's Manual       XvGrabPort(3X)

             client.

     [XvBadExtension]
             Returned if the Xv extension is unavailable.

     [XvBadAlloc]
             Returned if XvGrabPort(3X) failed to allocate memory
             to process the request.

Diagnostics

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

See Also

     XvUngrabPort(3X) XvVideoNotify(3X)

XFree86                   Version 4.5.0                         2

Generated on 2017-04-03 16:26:17 by $MirOS: src/scripts/roff2htm,v 1.88 2017/01/29 00:51:06 tg Exp $

These manual pages and other documentation are copyrighted by their respective writers; their source is available at our CVSweb, AnonCVS, and other mirrors. The rest is Copyright © 2002–2017 The MirOS Project, Germany.
This product includes material provided by mirabilos.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.