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 5.1.0)
  17
  18 Changes in this release include:
  19
  20 - new C API wrapper
  21 - new functions to get API names
  22 - many WASAPI updates (thanks to Marcus Tomlinson)
  23 - miscellaneous build system updates
  24 - bug fix for stream ticking in CoreAudio if using two devices for duplex
  25 - ALSA stream handle bug fixes
  26 - see git history for complete list of changes
  27
  28 \section download Download
  29
  30 Latest Release (17 April 2019): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-5.1.0.tar.gz">Version 5.1.0</A>
  31
  32 \section documentation Documentation Links
  33
  34 -# \ref errors
  35 -# \ref probe
  36 -# \ref settings
  37 -# \ref playback
  38 -# \ref recording
  39 -# \ref duplex
  40 -# \ref multi
  41 -# \ref compiling
  42 -# \ref apinotes
  43 -# \ref acknowledge
  44 -# \ref license
  45 -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A>
  46
  47 */
  48
  49 -# <A href="bugs.html">Bug Tracker (out of date)</A>
  50 -# <A href="updates.html">Possible Updates (out of date)</A>