Xv(3X) UNIX Programmer's Manual Xv(3X)
Xv - X Window System video extension
The Xv extension provides support for video adaptors
attached to an X display. It takes the approach that a
display may have one or more video adaptors, each of which
has one or more ports through which independent video
streams pass.
An adaptor may be able to display video in a drawable, cap-
ture video from a drawable, or both. It translates between
video encoding (NTSC, PAL, SECAM, etc...) and drawable for-
mat (depth and visual-id pair). An adaptor may support mul-
tiple video encodings and/or multiple drawable formats.
Clients use Xv(3X) to gain access and manage sharing of a
display's video resources. Typically, a client will use
XvQueryExtension(3X) to determine the status of the exten-
sion, XvQueryAdaptors(3X) to get a description of what video
adaptors exist, and XvQueryEncodings(3X) to get a descrip-
tion of what video encodings an adaptor supports.
Once a client has determined what video resources are avail-
able, it is free to put video into a drawable or get video
from a drawable, according the capabilities supported.
Clients can select to receive events when video activity
changes in a drawable and when port attributes have changed.
The following is a summary of Xv library functions:
XvGetPortAttribute(3X) - return current port attribute value
XvGetStill(3X) - capture a single frame of video from a
drawable
XvGetVideo(3X) - capture video from a drawable
XvGrabPort(3X) - lock port for exclusive use by client
XvPortNotify(3X) - event generated when port attributes
change
XvPutStill(3X) - write a single frame of video to a drawable
XvPutVideo(3X) - write video into a drawable
XvQueryAdaptors(3X) - return adaptor information for a
screen
XvQueryBestSize(3X) - determine the optimum drawable region
XFree86 Version 4.5.0 1
Xv(3X) UNIX Programmer's Manual Xv(3X)
size
XvQueryEncodings(3X) - return list of encodings for an adap-
tor
XvQueryExtension(3X) - return version and revision of exten-
sion
XvSelectPortNotify(3X) - enable or disable XvPortNotify
events
XvSelectVideoNotify(3X) - enable or disable XvVideoNotify
events
XvSetPortAttribute(3X) - set an attribute for a port
XvStopVideo(3X) - stop active video
XvUngrabPort(3X) - release a grabbed port
XvVideoNotify(3X) - event generated for video processing
Each of these functions is described in its own Xv man page.
XFree86 Version 4.5.0 2
Generated on 2012-02-20 02:47:02 by $MirOS: src/scripts/roff2htm,v 1.70 2011/12/03 18:21:12 tg Exp $
These manual pages and other documentation are copyrighted by their respective writers;
their source is available at our CVSweb,
AnonCVS, and other mirrors. The rest is Copyright © 2002‒2011 The MirOS Project, Germany.
This product includes material
provided by Thorsten Glaser.
This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report – diffs preferred.