XvPutVideo(3X) UNIX Programmer's Manual XvPutVideo(3X)
Name
XvPutVideo - write video into a drawable
Syntax
#include <X11/extensions/Xvlib.h>
XvPutVideo(dpy, port, d, gc, vx, vy, vw, vh, dx, dy, dw, dh)
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 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 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 from which to get video.
d Defines the drawable (window) into which
video is to be written.
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 size and location of the source
(video) region to be written. vx and vy
define the upper-left pixel of the region. vw
and vh define the width and height, in pix-
els, of the region.
dx,dy,dw,dh Define the location and size of the destina-
tion (drawable) region into which the video
image is written. dx and dy define the
upper-left pixel of the region. dw and dh
define the width and height, in pixels, of
the region.
Description
XvPutVideo writes video into a drawable. The position and
size of the source (video) rectangle is specified by vx, vy,
XFree86 Version 4.5.0 1
XvPutVideo(3X) UNIX Programmer's Manual XvPutVideo(3X)
vw, and vh. The position and size of the destination (draw-
able) rectangle is specified by dx, dy, dw, and dh.
Video data is clipped to the bounds of the video encoding,
scaled to the requested drawable region size (or the closest
size supported) and clipped to the bounds of the drawable.
If video is successfully initiated, an XvVideoNotify event
with detail XvStarted is generated for the drawable. If the
port is already in use, its video is preempted, and if the
new drawable is different than the old, an XvVideoNotify
event with detail XvPreempted is generated for the old draw-
able. If the port is grabbed by another client, this
request is ignored, and an XvVideoNotify event with detail
XvBusy is generated for the drawable. If the port is not
receiving a valid video signal or if the video signal is
interrupted while video is active a VideoNotify event with
detail XvHardError is generated for the drawable.
Returned Values
[Success]
Returned if XvPutVideo(3X) completed successfully.
[XvBadExtension]
Returned if the Xv extension is unavailable.
[XvBadAlloc]
Returned if there were insufficient resources to
process the request.
Diagnostics
[XvBadPort]
Generated if the requested port does not exist.
[BadDrawable]
Generated if the requested drawable does not exist.
[BadGC] Generated if the requested graphics context does not
exist.
[BadAlloc]
Generated if there were insufficient resources to
process the request.
See Also
XvPutStill(3X), XvGetVideo(3X), XvVideoNotify(3X)
XFree86 Version 4.5.0 2