doc/html/index.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>The RtAudio Home Page</TITLE>
   4 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
   5 <LINK REL="SHORTCUT ICON" HREF="http://www.music.mcgill.ca/~gary/favicon.ico">
   6 </HEAD>
   7 <BODY BGCOLOR="#FFFFFF">
   8 <CENTER>
   9 <a class="qindex" href="index.html">Home</a> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
  10 <HR>
  11 <!-- Generated by Doxygen 1.8.2 -->
  12 </div><!-- top -->
  13 <div class="header">
  14   <div class="headertitle">
  15 <div class="title">The <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> Home Page </div>  </div>
  16 </div><!--header-->
  17 <div class="contents">
  18 <div class="textblock"><p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> is a set of C++ classes that provide a common API (Application Programming Interface) for realtime audio input/output across Linux, Macintosh OS-X and Windows operating systems. <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives:</p>
  19 <ul>
  20 <li>
  21 object-oriented C++ design </li>
  22 <li>
  23 simple, common API across all supported platforms </li>
  24 <li>
  25 only one source and two header files for easy inclusion in programming projects </li>
  26 <li>
  27 allow simultaneous multi-api support </li>
  28 <li>
  29 support dynamic connection of devices </li>
  30 <li>
  31 provide extensive audio device parameter control </li>
  32 <li>
  33 allow audio device capability probing </li>
  34 <li>
  35 automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping </li>
  36 </ul>
  37 <p><a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> incorporates the concept of audio streams, which represent audio output (playback) and/or input (recording). Available audio devices and their capabilities can be enumerated and then specified when opening a stream. Where applicable, multiple API support can be compiled and a particular API specified when creating an <a class="el" href="classRtAudio.html" title="Realtime audio i/o C++ classes.">RtAudio</a> instance. See the <a class="el" href="apinotes.html">API Notes</a> section for information specific to each of the supported audio APIs.</p>
  38 <h1><a class="anchor" id="whatsnew"></a>
  39 Latest Updates (Version 4.0.12)</h1>
  40 <ul>
  41 <li>new functionality to allow error reporting via a client-supplied function (thanks to Pavel Mogilevskiy)</li>
  42 <li>new function to return the version number</li>
  43 <li>updated RtAudio.cpp and ASIO files for UNICODE support (thanks to Renaud Schoonbroodt)</li>
  44 <li>updates to PulseAudio API support (thanks to Peter Meerwald and Tristan Matthews)</li>
  45 <li>updates for pkg-config support in configure script</li>
  46 <li>24-bit format changed to true 24-bit format, not sub-bytes of 32-bits (thanks to Marc Britton)</li>
  47 <li>bug fixes to make sure stream status is closed if error during probeDeviceOpen</li>
  48 <li>updates / fixes to SCHED_RR code in ALSA (thanks to Marc Lindahl)</li>
  49 <li>various changes to avoid global variables (thanks to Martin Koegler)</li>
  50 </ul>
  51 <h1><a class="anchor" id="download"></a>
  52 Download</h1>
  53 <p>Latest Release (16 April 2013): <a href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.0.12.tar.gz">Version 4.0.12</a></p>
  54 <h1><a class="anchor" id="documentation"></a>
  55 Documentation Links</h1>
  56 <ol type="1">
  57 <li><a class="el" href="errors.html">Error Handling</a></li>
  58 <li><a class="el" href="probe.html">Probing Device Capabilities</a></li>
  59 <li><a class="el" href="settings.html">Device Settings</a></li>
  60 <li><a class="el" href="playback.html">Playback</a></li>
  61 <li><a class="el" href="recording.html">Recording</a></li>
  62 <li><a class="el" href="duplex.html">Duplex Mode</a></li>
  63 <li><a class="el" href="multi.html">Using Simultaneous Multiple APIs</a></li>
  64 <li><a class="el" href="compiling.html">Debugging &amp; Compiling</a></li>
  65 <li><a class="el" href="apinotes.html">API Notes</a></li>
  66 <li><a class="el" href="acknowledge.html">Acknowledgements</a></li>
  67 <li><a class="el" href="license.html">License</a></li>
  68 <li><a href="bugs.html">Bug Tracker</a></li>
  69 <li><a href="updates.html">Possible Updates</a></li>
  70 <li><a href="http://sourceforge.net/projects/rtaudio">RtAudio at SourceForge</a> </li>
  71 </ol>
  72 </div></div><!-- contents -->
  73 <HR>
  74 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
  75   <td>&copy;2001-2013 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr>
  76 </table>
  77 </BODY>
  78 </HTML>