MAN page from Mandriva 2008 libxv1-devel-1.0.3-1mdv2008.0.i586.rpm

XvGetVideo

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

Name

XvGetVideo - capture video from a drawable

Syntax

include Xvlib.h

XvGetVideo(dpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh)

register Display *dpy;
XvPortID port;
Drawable d;
GC gc;
int vx, vy, dx, dy;
unsigned int vw, vh;
unsigned int dw, dh;

Arguments

dpy: Specifies the connection to the X server.
port: Defines the port to which video output is sent.
d: Defines the drawable (window) from which video output is to be obtained.
gc: Defines the graphical context. GC components are: subwindow-mode, clip-x-origin, clip-y-origin,and clip-mask.
vx,vy,vw,vh: Define the location and size of the video region is to be written. vx and vy define the x andycoordinates of the upper-left corner of the video region; vw andvhdefine the width and height, in pixels, of the video region.
dx,dy,dw,dh: Define the location of the source drawable from which thevideo image is to be taken. dx anddy define the x andy coordinates of the upper-left corner of the drawable region; dw and dh define the width and height, in pixels, of the drawable region.

Description

outputs video from a drawable. The positionand size of the destination rectangle is specified by vx,vy, vw, and vh. The position and size of the source rectangle is specified by dx, dy, dw, and dh.

Drawable data is clipped to the bounds of the drawable, scaled to therequested video region size (or the closest size supported) andclipped to the bounds of the video encoding. The contents of any regionnot updated with drawable data is undefined.

If video is successfully initiated, an XvVideoNotify event withdetail XvStarted is generated for the drawable. If the port isalready in use, its video is preempted, and if the new drawable isdifferent than the old, an XvVideoNotify event with detail XvPreemptedis generated for the old drawable. If the port is grabbed by anotherclient, this request is ignored, and an XvVideoNotify event with detailXvBusy is generated for the drawable.

Returned Values

[Success]: Returned if XvGetVideo(3) completed successfully.
[XvBadExtension]: Returned if the Xv extension is unavailable.
[XvBadAlloc]: Returned if XvGetVideo(3) failed to allocate memory to processthe request.

Diagnostics

[XvBadPort]: Generated if the requested port does not exist.
[BadGC]: Generated if the requested graphics context does not exist.
[BadDrawable]: Generated if the requested drawable does not exist.
[BadAlloc]: Generated if there were insufficient resources to process the request.

This document was created byman2html,using the manual pages.