XvQueryEncodings __libmansuffix__ __vendorversion__ "libXv Functions"
NAME
XvQueryEncodings - return list of encodings for an adaptor
SYNOPSIS
#include <X11/extensions/Xvlib.h> "int XvQueryEncodings(Display *" dpy ", XvPortID " port "," " unsigned int *" p_num_encodings "," " XvEncodingInfo **" pp_encoding_info ");"
ARGUMENTS
dpy 8
Specifies the connection to the X server.
port 8
Specifies the port whose adaptor is to be queried for its list of encodings.
p_num_encodings 8
A pointer to where the number of encodings supported
by the adaptor is written.
pp_encoding_info 8
A pointer to where the list of returned encoding information is returned.
XvEncodingInfo has the following structure:
.EX
typedef struct {
XvEncodingID encoding_id;
char *name;
unsigned long width;
unsigned long height;
XvRational rate;
unsigned long num_encodings;
} XvEncodingInfo;
encoding_id 8
Specifies the encoding-id of the encoding. The encoding-id is used to
identify an encoding when a port's encoding attribute is changed.
name 8
A pointer to a formatted string that identifies the encoding. The string
has the format "timing-signaltype". For example "ntsc-composite".
width,height 8
The width and height, in pixels, of the decoded video image.
rate 8
The field rate of the decoded video.
The XvRational structure is used to specify a fractional number.
It has the following structure:
.EX
typedef struct {
int numerator;
int denominator;
} XvRational;
The numerator and denominator fields specify the
appropriate parts of a fractional number.
DESCRIPTION
XvQueryEncodings (__libmansuffix__) returns encoding information about an adaptor. Each
encoding is described by the XvEncodingInfo structure described above. The
encodings are identified by an encoding-id, which can be used to set or get
the encoding attribute of a port.
RETURN VALUES
[Success] 8
Returned if
XvQueryEncodings (__libmansuffix__) completed successfully.
[XvBadExtension] 8
Returned if the Xv extension is unavailable.
[XvBadAlloc] 8
Returned if
XvQueryEncodings (__libmansuffix__) failed to allocate memory to process the request.
DIAGNOSTICS
[XvBadPort] 8
Generated if the requested port does not exist.
SEE ALSO
XvFreeEncodingInfo (__libmansuffix__)