MAN page from Mandriva 2008 libxv1-devel-1.0.3-1mdv2008.0.i586.rpm
Section: C Library Functions (3)
Updated: libXv 1.0.3Index
Xv - X Window System video extension
The Xv extension provides support for video adaptors attached to an Xdisplay. It takes the approach that a display may have one or morevideo adaptors, each of which has one or more ports through whichindependent video streams pass.
An adaptor may be able to display video in a drawable, capture videofrom a drawable, or both. It translates between video encoding (NTSC,PAL, SECAM, etc...) and drawable format (depth and visual-id pair). Anadaptor may support multiple video encodings and/or multiple drawableformats.
Clients use Xv(3) to gain access and manage sharing of a display'svideo resources. Typically, a client will use XvQueryExtension(3) todetermine the status of the extension, XvQueryAdaptors(3) to get adescription of what video adaptors exist, and XvQueryEncodings(3) toget a description of what video encodings an adaptor supports.
Once a client has determined what video resources are available, it isfree to put video into a drawable or get video from a drawable,according the capabilities supported. Clients can select to receiveevents when video activity changes in a drawable and when portattributes have changed.
Summary of Library Functions
The following is a summary of Xv library functions:
XvGetPortAttribute(3) - return current port attribute value
XvGetStill(3) - capture a single frame of video from a drawable
XvGetVideo(3) - capture video from a drawable
XvGrabPort(3) - lock port for exclusive use by client
XvPortNotify(3) - event generated when port attributes change
XvPutStill(3) - write a single frame of video to a drawable
XvPutVideo(3) - write video into a drawable
XvQueryAdaptors(3) - return adaptor information for a screen
XvQueryBestSize(3) - determine the optimum drawable region size
XvQueryEncodings(3) - return list of encodings for an adaptor
XvQueryExtension(3) - return version and revision of extension
XvSelectPortNotify(3) - enable or disable XvPortNotify events
XvSelectVideoNotify(3) - enable or disable XvVideoNotify events
XvSetPortAttribute(3) - set an attribute for a port
XvStopVideo(3) - stop active video
XvUngrabPort(3) - release a grabbed port
XvVideoNotify(3) - event generated for video processing
Each of these functions is described in its own Xv man page.
- Summary of Library Functions
This document was created byman2html,using the manual pages.