ao/doc/ao_info.html

   1 <html>
   2
   3 <head>
   4 <title>libao - datatype - ao_info</title>
   5 <link rel=stylesheet href="style.css" type="text/css">
   6 </head>
   7
   8 <body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
   9 <table border=0 width=100%>
  10 <tr>
  11 <td><p class=tiny>libao documentation</p></td>
  12 <td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
  13 </tr>
  14 </table>
  15
  16 <h1>ao_info</h1>
  17
  18 <p><i>declared in "ao/ao.h";</i></p>
  19
  20 <p>This structure describes the attributes of an output driver.
  21
  22 <br><br>
  23 <table border=0 width=100% color=black cellspacing=0 cellpadding=7>
  24 <tr bgcolor=#cccccc>
  25         <td>
  26 <pre><b>typedef struct {
  27   int  type; /* live output or file output? */
  28   char *name; /* full name of driver */
  29   char *short_name; /* short name of driver */
  30   char *comment; /* driver comment */
  31   int  preferred_byte_format;
  32   int  priority;
  33   char **options;
  34   int  option_count;
  35 } ao_info;</b></pre>
  36         </td>
  37 </tr>
  38 </table>
  39
  40 <h3>Relevant Struct Members</h3>
  41 <dl>
  42 <dt><i>type</i></dt>
  43 <dd>The output type of the driver:
  44 <ul>
  45 <li>AO_TYPE_LIVE - Live output.</li>
  46 <li>AO_TYPE_FILE - File output.</li>
  47 </ul>
  48 </dd>
  49 <dt><i>name</i></dt>
  50 <dd>A longer name for the driver which may contain whitespace, but no
  51 newlines.  It is useful for telling users what output driver is in use.</dd>
  52 <dt><i>short_name</i></dt>
  53 <dd>A short identifier for the driver.  The short name contains only
  54 alphanumeric characters, and no whitespace.  It is used to look up the driver
  55 ID number using <a href="ao_driver_id.html">ao_driver_id()</a>.</dd>
  56 <dt><i>preferred_byte_format</i></dt>
  57 <dd>Specifies the preferred ordering of the sample bytes.  Using the driver
  58 with this byte format usually results in slightly less memory usage and
  59 slightly less CPU usage because a swap buffer will not be needed.
  60 See
  61 <a href="ao_sample_format.html">ao_sample_format</a> for a list of
  62 allowed values.
  63 </dd>
  64 <dt><i>priority</i></dt>
  65 <dd>A positive integer ranking how likely it is for this driver to be
  66 the default.  The default driver will be a functioning driver with
  67 highest priority.  See the <a href="drivers.html">drivers document</a>
  68 for more explanation.</dd>
  69 <dt><i>comment</i></dt>
  70 <dd>Pointer to a driver comment string (possibly <tt>NULL</tt>).  It may
  71 contain newlines.</dd>
  72 <dt><i>options</i></dt>
  73 <dd>An array of strings which list the option keys accepted by this
  74 driver.</dd>
  75 <dt><i>option_count</i></dt>
  76 <dd>Number of strings in <tt>options</tt> array.</dd>
  77 </dl>
  78
  79 <br><br>
  80 <hr noshade>
  81 <table border=0 width=100%>
  82 <tr valign=top>
  83 <td><p class=tiny>copyright &copy; 2001-2003 Stan Seibert</p></td>
  84 <td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:volsung@xiph.org">volsung@xiph.org</a></p></td>
  85 </tr><tr>
  86 <td><p class=tiny>libao documentation</p></td>
  87 <td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
  88 </tr>
  89 </table>
  90
  91 </body>
  92
  93 </html>