Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XvGetVideo(3)			libXv Functions			 XvGetVideo(3)

NAME
       XvGetVideo - capture video from a drawable

SYNOPSIS
       #include	<X11/extensions/Xvlib.h>

       int XvGetVideo(Display *dpy, XvPortID port, Drawable d, GC gc,
		      int vx, int vy, unsigned int vw, unsigned	int vh,
		      int dx, int dy, unsigned int dw, unsigned	int 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: sub-
		      window-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	xand y coordinates  of
		      the  upper-left corner of	the video region; vwand	vh de-
		      fine the width and height, in pixels, of the  video  re-
		      gion.

       dx,dy,dw,dh    Define  the  location  of	the source drawable from which
		      the video	image is to be taken.	dxand  dy  define  the
		      xand y coordinates of the	upper-left corner of the draw-
		      able  region;  dwand  dh define the width	and height, in
		      pixels, of the drawable region.

DESCRIPTION
       outputs video from a drawable.  The position and	size of	 the  destina-
       tion  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  the
       requested video region size (or the closest size	supported) and clipped
       to  the	bounds	of the video encoding.	The contents of	any region not
       updated with drawable data is undefined.

       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 drawable.  If the port is grabbed by	another	 client,  this
       request	is  ignored,  and an XvVideoNotify event with detail XvBusy is
       generated for the drawable.

RETURN 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  process
	       the 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.

SEE ALSO
       XvGetStill(3), XvPutVideo(3), XvVideoNotify(3)

X Version 11			 libXv 1.0.12			 XvGetVideo(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=XvGetVideo&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help