ao/doc/ao_play.html

   1 <html>
   2
   3 <head>
   4 <title>libao - function - ao_play</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_play</h1>
  17
  18 <p><i>declared in "ao/ao.h";</i></p>
  19
  20 <p>Play a block of audio data to an open device.  Samples are interleaved by
  21 channels (Time 1, Channel 1; Time 1, Channel 2; Time 2, Channel 1;
  22 etc.) in the memory buffer.
  23
  24 <br><br>
  25 <table border=0 color=black cellspacing=0 cellpadding=7>
  26 <tr bgcolor=#cccccc>
  27         <td>
  28 <pre><b>
  29 int ao_play(<a href="ao_device.html">ao_device</a> *device, void *output_samples, uint_32 num_bytes);
  30 </b></pre>
  31         </td>
  32 </tr>
  33 </table>
  34
  35 <h3>Parameters</h3>
  36 <dl>
  37 <dt><i>device</i></dt>
  38 <dd>Pointer to device structure as returned by <a href="ao_open_live.html">ao_open_live()</a> or <a href="ao_open_file.html">ao_open_file()</a></dd>
  39 <dt><i>output_samples</i></dt>
  40 <dd>Memory buffer containing audio data.</dd>
  41 <dt><i>num_bytes</i></dt>
  42 <dd>Number of bytes of audio data in the memory buffer.</dd>
  43 </dl>
  44
  45 <h3>Return Values</h3>
  46 <blockquote>
  47 <li>non-zero value indicates success.</li>
  48
  49 <li>0 indicates failure.  The device should be closed.</li>
  50 </blockquote>
  51 <p>
  52
  53 <br><br>
  54 <hr noshade>
  55 <table border=0 width=100%>
  56 <tr valign=top>
  57 <td><p class=tiny>copyright &copy; 2001-2003 Stan Seibert</p></td>
  58 <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>
  59 </tr><tr>
  60 <td><p class=tiny>libao documentation</p></td>
  61 <td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
  62 </tr>
  63 </table>
  64
  65 </body>
  66
  67 </html>