Manual Pages for UNIX Operating System command usage for man XvQueryEncodings

libXv Functions                             XvQueryEncodings(3xv)



NAME
     XvQueryEncodings - return list of encodings for an adaptor

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

     int XvQueryEncodings(Display *dpy, XvPortID port,
                          unsigned int *p_num_encodings,
                          XvEncodingInfo **pp_encoding_info);

ARGUMENTS
     dpy     Specifies the connection to the X server.

     port    Specifies the port whose adaptor is  to  be  queried
             for its list of encodings.

     p_num_encodings
             A pointer to where the number of encodings supported
             by the adaptor is written.

     pp_encoding_info
             A pointer to where the  list  of  returned  encoding
             information  is  returned.   XvEncodingInfo  has the
             following structure:

                 typedef struct {
                   XvEncodingID encoding_id;
                   char *name;
                   unsigned long width;
                   unsigned long height;
                   XvRational rate;
                   unsigned long num_encodings;
                 } XvEncodingInfo;


     encoding_id
             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    A pointer to a formatted string that identifies  the
             encoding.    The  string  has  the  format  "timing-
             signaltype".  For example "ntsc-composite".

     width,height
             The width and height,  in  pixels,  of  the  decoded
             video image.

     rate    The field rate of the decoded video.





X Version 11        Last change: libXv 1.0.5                    1






libXv Functions                             XvQueryEncodings(3xv)



     The XvRational structure is used  to  specify  a  fractional
     number.  It has the following structure:

         typedef struct {
           int numerator;
           int denominator;
         } XvRational;

     The numerator and denominator fields specify the appropriate
     parts of a fractional number.

DESCRIPTION
     XvQueryEncodings(3xv) 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]
             Returned if XvQueryEncodings(3xv) completed success-
             fully.

     [XvBadExtension]
             Returned if the Xv extension is unavailable.

     [XvBadAlloc]
             Returned if XvQueryEncodings(3xv) failed to allocate
             memory to process the request.

DIAGNOSTICS
     [XvBadPort]
             Generated if the requested port does not exist.

SEE ALSO
     XvFreeEncodingInfo(3xv)



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













X Version 11        Last change: libXv 1.0.5                    2






libXv Functions                             XvQueryEncodings(3xv)



     ____________________________________________________________
    |       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                    3