1XvGetVideo(3)                   libXv Functions                  XvGetVideo(3)
2
3
4

NAME

6       XvGetVideo - capture video from a drawable
7

SYNOPSIS

9       #include <X11/extensions/Xvlib.h>
10
11       int XvGetVideo(Display *dpy, XvPortID port, Drawable d, GC gc,
12                      int vx, int vy, unsigned int vw, unsigned int vh,
13                      int dx, int dy, unsigned int dw, unsigned int dh);
14

ARGUMENTS

16       dpy            Specifies the connection to the X server.
17
18       port           Defines the port to which video output is sent.
19
20       d              Defines the drawable (window) from which video output is
21                      to be obtained.
22
23       gc             Defines the graphical context.  GC components are:  sub‐
24                      window-mode,  clip-x-origin,  clip-y-origin,  and  clip-
25                      mask.
26
27       vx,vy,vw,vh    Define the location and size of the video region  is  to
28                      be  written.  vx and vy define the xand y coordinates of
29                      the upper-left corner of  the  video  region;  vwand  vh
30                      define  the  width  and  height, in pixels, of the video
31                      region.
32
33       dx,dy,dw,dh    Define the location of the source  drawable  from  which
34                      the  video  image  is  to be taken.  dxand dy define the
35                      xand y coordinates of the upper-left corner of the draw‐
36                      able  region;  dwand  dh define the width and height, in
37                      pixels, of the drawable region.
38

DESCRIPTION

40       outputs video from a drawable.  The position and size of  the  destina‐
41       tion  rectangle  is  specified by vx, vy, vw, and vh.  The position and
42       size of the source rectangle is specified by dx, dy, dw, and dh.
43
44       Drawable data is clipped to the bounds of the drawable, scaled  to  the
45       requested video region size (or the closest size supported) and clipped
46       to the bounds of the video encoding.  The contents of  any  region  not
47       updated with drawable data is undefined.
48
49       If  video is successfully initiated, an XvVideoNotify event with detail
50       XvStarted is generated for the drawable.  If the  port  is  already  in
51       use,  its video is preempted, and if the new drawable is different than
52       the old, an XvVideoNotify event with detail  XvPreempted  is  generated
53       for  the  old drawable.  If the port is grabbed by another client, this
54       request is ignored, and an XvVideoNotify event with  detail  XvBusy  is
55       generated for the drawable.
56

RETURN VALUES

58       [Success]
59               Returned if XvGetVideo(3) completed successfully.
60
61       [XvBadExtension]
62               Returned if the Xv extension is unavailable.
63
64       [XvBadAlloc]
65               Returned  if XvGetVideo(3) failed to allocate memory to process
66               the request.
67

DIAGNOSTICS

69       [XvBadPort]
70               Generated if the requested port does not exist.
71
72       [BadGC] Generated if the requested graphics context does not exist.
73
74       [BadDrawable]
75               Generated if the requested drawable does not exist.
76
77       [BadAlloc]
78               Generated if there were insufficient resources to  process  the
79               request.
80

SEE ALSO

82       XvGetStill(3), XvPutVideo(3), XvVideoNotify(3)
83
84
85
86X Version 11                      libXv 1.0.5                    XvGetVideo(3)
Impressum