ao/doc/ao_open_live.html

   1 <html>
   2
   3 <head>
   4 <title>libao - function - ao_open_live</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_open_live</h1>
  17
  18 <p><i>declared in "ao/ao.h";</i></p>
  19
  20 <p>Open a live playback audio device for output.
  21
  22 <br><br>
  23 <table border=0 color=black cellspacing=0 cellpadding=7>
  24 <tr bgcolor=#cccccc>
  25         <td>
  26 <pre><b>
  27 <a href="ao_device.html">ao_device</a>* ao_open_live(int driver_id, <a href="ao_sample_format.html">ao_sample_format</a> *format, <a href="ao_option.html">ao_option</a> *options);
  28 </b></pre>
  29         </td>
  30 </tr>
  31 </table>
  32
  33 <h3>Parameters</h3>
  34 <dl>
  35 <dt><i>driver_id</i></dt>
  36 <dd>The ID number of the driver as returned by either
  37 <a href="ao_driver_id.html">ao_driver_id()</a> or
  38 <a href="ao_default_driver_id.html">ao_default_driver_id()</a>.</dd>
  39 <dt><i>format</i></dt>
  40 <dd>Pointer to a struct describing the sample format.  The caller retains ownership of this structure.</dd>
  41 <dt><i>options</i></dt>
  42 <dd>A linked list of options to be passed to the driver or NULL if no options
  43 are needed.  Unsupported options are ignored.</dd>
  44 </dl>
  45
  46 <h3>Return Values</h3>
  47 <blockquote>
  48 <li>
  49 non-NULL pointer inicates success.  This pointer must be passed in subsequent
  50 calls to <a href="ao_play.html">ao_play()</a> and
  51 <a href="ao_close.html">ao_close()</a>.</li>
  52
  53 <li>NULL indicates failure.  <tt>errno</tt> will contain the specific cause of the failure:</li>
  54 <ul>
  55 <li>AO_ENODRIVER - No driver corresponds to <tt>driver_id</tt>.</li>
  56 <li>AO_ENOTLIVE - This driver is not a live output device.</li>
  57 <li>AO_EBADOPTION - A valid option key has an invalid value.</li>
  58 <li>AO_EOPENDEVICE - Cannot open the device (for example, if /dev/dsp cannot be
  59 opened for writing).</li>
  60 <li>AO_EFAIL - Any other cause of failure.</li>
  61 </ul>
  62 </blockquote>
  63 <p>
  64
  65
  66 <h3>Notes</h3>
  67
  68 <p>File output drivers cannot be used with this function.  Use <a
  69 href="ao_open_file.html">ao_open_file()</a> instead.
  70
  71 <br><br>
  72 <hr noshade>
  73 <table border=0 width=100%>
  74 <tr valign=top>
  75 <td><p class=tiny>copyright &copy; 2001-2003 Stan Seibert</p></td>
  76 <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>
  77 </tr><tr>
  78 <td><p class=tiny>libao documentation</p></td>
  79 <td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
  80 </tr>
  81 </table>
  82
  83 </body>
  84
  85 </html>