Audio plugin host https://kx.studio/carla
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

52 lines
2.6KB

  1. /*! \mainpage The RtAudio Home Page
  2. 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:
  3. <UL>
  4. <LI>object-oriented C++ design</LI>
  5. <LI>simple, common API across all supported platforms</LI>
  6. <LI>only one source and two header files for easy inclusion in programming projects</LI>
  7. <LI>allow simultaneous multi-api support</LI>
  8. <LI>support dynamic connection of devices</LI>
  9. <LI>provide extensive audio device parameter control</LI>
  10. <LI>allow audio device capability probing</LI>
  11. <LI>automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping</LI>
  12. </UL>
  13. 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.
  14. \section whatsnew Latest Updates (Version 4.0.12)
  15. - new functionality to allow error reporting via a client-supplied function (thanks to Pavel Mogilevskiy)
  16. - new function to return the version number
  17. - updated RtAudio.cpp and ASIO files for UNICODE support (thanks to Renaud Schoonbroodt)
  18. - updates to PulseAudio API support (thanks to Peter Meerwald and Tristan Matthews)
  19. - updates for pkg-config support in configure script
  20. - 24-bit format changed to true 24-bit format, not sub-bytes of 32-bits (thanks to Marc Britton)
  21. - bug fixes to make sure stream status is closed if error during probeDeviceOpen
  22. - updates / fixes to SCHED_RR code in ALSA (thanks to Marc Lindahl)
  23. - various changes to avoid global variables (thanks to Martin Koegler)
  24. \section download Download
  25. 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>
  26. \section documentation Documentation Links
  27. -# \ref errors
  28. -# \ref probe
  29. -# \ref settings
  30. -# \ref playback
  31. -# \ref recording
  32. -# \ref duplex
  33. -# \ref multi
  34. -# \ref compiling
  35. -# \ref apinotes
  36. -# \ref acknowledge
  37. -# \ref license
  38. -# <A href="bugs.html">Bug Tracker</A>
  39. -# <A href="updates.html">Possible Updates</A>
  40. -# <A href="http://sourceforge.net/projects/rtaudio">RtAudio at SourceForge</A>
  41. */