Manual Pages for UNIX Operating System command usage for man XvPutVideo

libXv Functions                                   XvPutVideo(3xv)



NAME
     XvPutVideo - write video into a drawable

SYNOPSIS
     cc [ flag... ] file... -lXv [ library... ]
     #include 

     int XvPutVideo(Display *dpy, XvPortID port, Drawable d
                    int vx, int vy, unsigned int vw
                    int dx, int dy, unsigned int dw

ARGUMENTS
     dpy            Specifies the connection to the X server.

     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,
     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



X Version 11        Last change: libXv 1.0.5                    1






libXv Functions                                   XvPutVideo(3xv)



     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.

RETURN VALUES
     [Success]
             Returned if XvPutVideo(3xv) 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(3xv), XvGetVideo(3xv), XvVideoNotify(3xv)


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:

     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Availability                | x11/library/libxv           |
    |_____________________________|_____________________________|
    | Interface Stability         | Volatile                    |
    |_____________________________|_____________________________|
    | MT-Level                    | See XInitThreads(3X11)      |
    |_____________________________|_____________________________|







X Version 11        Last change: libXv 1.0.5                    2