X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=doc%2Fdoxygen%2Ftutorial.txt;h=ec6e5ece78e49fa2365285fe2e011736062c3128;hb=d27f257b4bc827e4152cdc4d69a2e22084204afd;hp=ffbc43559c1d5f5820be3d85e2e7c15aacf3d229;hpb=8f2275b4cf067760f574e00c41697107930e1912;p=rtaudio.git diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt index ffbc435..ec6e5ec 100644 --- a/doc/doxygen/tutorial.txt +++ b/doc/doxygen/tutorial.txt @@ -1,38 +1,33 @@ /*! \mainpage The RtAudio Home Page -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 (DirectSound and ASIO) operating systems. RtAudio significantly simplifies the process of interacting with computer audio hardware. It was designed with the following objectives: - - +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: + +- object-oriented C++ design +- simple, common API across all supported platforms +- only one source and one header file for easy inclusion in programming projects +- allow simultaneous multi-api support +- support dynamic connection of devices +- provide extensive audio device parameter control +- allow audio device capability probing +- automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping 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. -\section whatsnew What's New (Version 4.0) +\section whatsnew Latest Updates (Version 5.1.0) -RtAudio V4 represents a significant rewrite of the code and includes a number of API and functionality changes form previous versions. A partial list of the changes includes: -- new support for non-interleaved user data -- additional input/output parameter specifications, including channel offset -- new support for dynamic connection of devices -- new support for stream time -- revised callback arguments, including separate input and output buffer arguments -- revised C++ exception handling -- updated support for OSS version 4.0 -- discontinued support of blocking functionality -- discontinued support of SGI +Changes in this release include: -Devices are now re-enumerated every time the RtAudio::getDeviceCount(), RtAudio::getDeviceInfo(), and RtAudio::openStream() functions are called. This allows for the proper identification of hot-pluggable (USB, Firewire, ...) devices while a given RtAudio instance exists. +- new C API wrapper +- new static functions to get API names +- many WASAPI updates (thanks to Marcus Tomlinson) +- miscellaneous build system updates +- bug fix for stream ticking in CoreAudio if using two devices for duplex +- ALSA stream handle bug fixes +- see git history for complete list of changes \section download Download -Latest Release (13 August 2007): Version 4.0.1 +Latest Release (17 April 2019): Version 5.1.0 \section documentation Documentation Links @@ -47,8 +42,9 @@ Latest Release (13 August 2007): Bug Tracker --# Possible Updates --# RtAudio at SourceForge +-# RtAudio on GitHub */ + +-# Bug Tracker (out of date) +-# Possible Updates (out of date)