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 - object-oriented C++ design
   6 - simple, common API across all supported platforms
   7 - only one source and one header file for easy inclusion in programming projects
   8 - allow simultaneous multi-api support
   9 - support dynamic connection of devices
  10 - provide extensive audio device parameter control
  11 - allow audio device capability probing
  12 - automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping
  13
  14 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.
  15
  16 \section whatsnew Latest Updates (Version 4.1.2)
  17
  18 Changes in this release include:
  19
  20 - miscellaneous small fixes for the various systems (more details in  <A href="http://github.com/thestk/rtaudio">GitHub</A>)
  21
  22 Changes in the 4.1.0 release included:
  23
  24 - RtError class renamed RtAudioError and embedded in RtAudio.h (RtError.h deleted)
  25 - new support for the Windows WASAPI API (thanks to Marcus Tomlinson)
  26 - CMake support (thanks to Berkus Decker)
  27 - pulse audio update to support bufferFrames argument with audio input (thanks to Jonatan Wallmander)
  28 - fixes for ALSA API to avoid high CPU usage during stops and to clear stale data before input (thanks to Pluto Hades)
  29 - miscellaneous efficiency updates suggested by Martin Koegler
  30 - bug fix for OS-X xrun reporting problem
  31 - bug fix if error when opening a stream after closing a previously open stream
  32
  33 \section download Download
  34
  35 Latest Release (22 February 2016): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.1.2.tar.gz">Version 4.1.2</A>
  36
  37 \section documentation Documentation Links
  38
  39 -# \ref errors
  40 -# \ref probe
  41 -# \ref settings
  42 -# \ref playback
  43 -# \ref recording
  44 -# \ref duplex
  45 -# \ref multi
  46 -# \ref compiling
  47 -# \ref apinotes
  48 -# \ref acknowledge
  49 -# \ref license
  50 -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
  51
  52 */
  53
  54 -# <A href="bugs.html">Bug Tracker (out of date)</A>
  55 -# <A href="updates.html">Possible Updates (out of date)</A>