doc/doxygen/tutorial.txt

   1 /*! \mainpage The RtAudio Home Page
   2
   3 RtAudio 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.  RtAudio significantly simplifies the process of interacting with computer audio hardware.  It was designed with the following objectives:
   4
   5 <UL>
   6   <LI>object-oriented C++ design</LI>
   7   <LI>simple, common API across all supported platforms</LI>
   8   <LI>only one source and one header file for easy inclusion in programming projects</LI>
   9   <LI>allow simultaneous multi-api support</LI>
  10   <LI>support dynamic connection of devices</LI>
  11   <LI>provide extensive audio device parameter control</LI>
  12   <LI>allow audio device capability probing</LI>
  13   <LI>automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping</LI>
  14 </UL>
  15
  16 RtAudio 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 RtAudio instance.  See the \ref apinotes section for information specific to each of the supported audio APIs.
  17
  18 \section whatsnew Latest Updates (Version 4.1.1)
  19
  20 Changes in this release include:
  21
  22 - updates to WASAPI API for MinGW compiling
  23 - WASAPI bug fixes for audio INPUT mode (thanks to Marcus Tomlinson)
  24 - DirectSound bug fix for INPUT mode
  25 - Bug fixes in Core, Jack, ASIO and DS for internal draining in INPUT mode
  26 - updates to test programs for default device specifiers
  27 - CMake buildfile update for WASAPI
  28 - new setStreamTime function
  29
  30 Changes in the previous 4.1.0 release included:
  31
  32 - RtError class renamed RtAudioError and embedded in RtAudio.h (RtError.h deleted)
  33 - new support for the Windows WASAPI API (thanks to Marcus Tomlinson)
  34 - CMake support (thanks to Berkus Decker)
  35 - pulse audio update to support bufferFrames argument with audio input (thanks to Jonatan Wallmander)
  36 - fixes for ALSA API to avoid high CPU usage during stops and to clear stale data before input (thanks to Pluto Hades)
  37 - miscellaneous efficiency updates suggested by Martin Koegler
  38 - bug fix for OS-X xrun reporting problem
  39 - bug fix if error when opening a stream after closing a previously open stream
  40
  41 \section download Download
  42
  43 Latest Release (26 April 2014): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.1.1.tar.gz">Version 4.1.1</A>
  44
  45 \section documentation Documentation Links
  46
  47 -# \ref errors
  48 -# \ref probe
  49 -# \ref settings
  50 -# \ref playback
  51 -# \ref recording
  52 -# \ref duplex
  53 -# \ref multi
  54 -# \ref compiling
  55 -# \ref apinotes
  56 -# \ref acknowledge
  57 -# \ref license
  58 -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
  59
  60 */
  61
  62 -# <A href="bugs.html">Bug Tracker (out of date)</A>
  63 -# <A href="updates.html">Possible Updates (out of date)</A>