1Xv(3)                      Library Functions Manual                      Xv(3)
2
3
4

Name

6       Xv - X Window System video extension
7

Description

9       The  Xv  extension provides support for video adaptors attached to an X
10       display.  It takes the approach that a display may  have  one  or  more
11       video adaptors, each of which has one or more ports through which inde‐
12       pendent video streams pass.
13
14       An adaptor may be able to display video in a  drawable,  capture  video
15       from  a drawable, or both.  It translates between video encoding (NTSC,
16       PAL, SECAM, etc...) and drawable format (depth and visual-id pair).  An
17       adaptor  may  support multiple video encodings and/or multiple drawable
18       formats.
19
20       Clients use Xv(3) to gain access and  manage  sharing  of  a  display's
21       video  resources.   Typically, a client will use XvQueryExtension(3) to
22       determine the status of the  extension,  XvQueryAdaptors(3)  to  get  a
23       description  of  what  video adaptors exist, and XvQueryEncodings(3) to
24       get a description of what video encodings an adaptor supports.
25
26       Once a client has determined what video resources are available, it  is
27       free to put video into a drawable or get video from a drawable, accord‐
28       ing the capabilities supported.  Clients can select to  receive  events
29       when video activity changes in a drawable and when port attributes have
30       changed.
31

Summary of Library Functions

33       The following is a summary of Xv library functions:
34
35       XvGetPortAttribute(3) - return current port attribute value
36
37       XvGetStill(3) - capture a single frame of video from a drawable
38
39       XvGetVideo(3) - capture video from a drawable
40
41       XvGrabPort(3) - lock port for exclusive use by client
42
43       XvPortNotify(3) - event generated when port attributes change
44
45       XvPutStill(3) - write a single frame of video to a drawable
46
47       XvPutVideo(3) - write video into a drawable
48
49       XvQueryAdaptors(3) - return adaptor information for a screen
50
51       XvQueryBestSize(3) - determine the optimum drawable region size
52
53       XvQueryEncodings(3) - return list of encodings for an adaptor
54
55       XvQueryExtension(3) - return version and revision of extension
56
57       XvSelectPortNotify(3) - enable or disable XvPortNotify events
58
59       XvSelectVideoNotify(3) - enable or disable XvVideoNotify events
60
61       XvSetPortAttribute(3) - set an attribute for a port
62
63       XvStopVideo(3) - stop active video
64
65       XvUngrabPort(3) - release a grabbed port
66
67       XvVideoNotify(3) - event generated for video processing
68
69
70       Each of these functions is described in its own Xv man page.
71
72
73
74
75X Version 11                      libXv 1.0.3                            Xv(3)
Impressum