diff options
| author | Gary Scavone <gary@music.mcgill.ca> | 2016-02-11 08:13:14 -0500 |
|---|---|---|
| committer | Gary Scavone <gary@music.mcgill.ca> | 2016-02-11 08:13:14 -0500 |
| commit | f92ecf14ca5522b264f720b642e3e47c99073017 (patch) | |
| tree | 9ebb7a1f84e8cca7c65c98e00adeb9e46246d010 /doc | |
| parent | 70b95123e8cf93092d23688a65fb276e98d42f5e (diff) | |
Documentation updates in advance of new release
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/doxygen/footer.html | 2 | ||||
| -rw-r--r-- | doc/doxygen/license.txt | 2 | ||||
| -rw-r--r-- | doc/doxygen/tutorial.txt | 32 | ||||
| -rw-r--r-- | doc/release.txt | 5 |
4 files changed, 18 insertions, 23 deletions
diff --git a/doc/doxygen/footer.html b/doc/doxygen/footer.html index 086b22b..4fb5c48 100644 --- a/doc/doxygen/footer.html +++ b/doc/doxygen/footer.html @@ -1,7 +1,7 @@ <HR> <table><tr><td><img src="../images/mcgill.gif" width=165></td> - <td>©2001-2014 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> + <td>©2001-2016 Gary P. Scavone, McGill University. All Rights Reserved.<br>Maintained by <a href="http://www.music.mcgill.ca/~gary/">Gary P. Scavone</a>.</td></tr> </table> </BODY> diff --git a/doc/doxygen/license.txt b/doc/doxygen/license.txt index c595b4f..1072921 100644 --- a/doc/doxygen/license.txt +++ b/doc/doxygen/license.txt @@ -1,7 +1,7 @@ /*! \page license License RtAudio: a set of realtime audio i/o C++ classes<BR> - Copyright (c) 2001-2012 Gary P. Scavone + Copyright (c) 2001-2016 Gary P. Scavone Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt index 04b77d9..f65aed1 100644 --- a/doc/doxygen/tutorial.txt +++ b/doc/doxygen/tutorial.txt @@ -2,32 +2,24 @@ 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: -<UL> - <LI>object-oriented C++ design</LI> - <LI>simple, common API across all supported platforms</LI> - <LI>only one source and one header file for easy inclusion in programming projects</LI> - <LI>allow simultaneous multi-api support</LI> - <LI>support dynamic connection of devices</LI> - <LI>provide extensive audio device parameter control</LI> - <LI>allow audio device capability probing</LI> - <LI>automatic internal conversion for data format, channel number compensation, (de)interleaving, and byte-swapping</LI> -</UL> +- 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 Latest Updates (Version 4.1.1) +\section whatsnew Latest Updates (Version 4.1.2) Changes in this release include: -- updates to WASAPI API for MinGW compiling -- WASAPI bug fixes for audio INPUT mode (thanks to Marcus Tomlinson) -- DirectSound bug fix for INPUT mode -- Bug fixes in Core, Jack, ASIO and DS for internal draining in INPUT mode -- updates to test programs for default device specifiers -- CMake buildfile update for WASAPI -- new setStreamTime function +- miscellaneous small fixes for the various systems (more details in <A href="http://github.com/thestk/rtaudio">GitHub</A>) -Changes in the previous 4.1.0 release included: +Changes in the 4.1.0 release included: - RtError class renamed RtAudioError and embedded in RtAudio.h (RtError.h deleted) - new support for the Windows WASAPI API (thanks to Marcus Tomlinson) @@ -40,7 +32,7 @@ Changes in the previous 4.1.0 release included: \section download Download -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> +Latest Release (?? February 2016): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.1.2.tar.gz">Version 4.1.2</A> \section documentation Documentation Links diff --git a/doc/release.txt b/doc/release.txt index 9dc44a3..44f94b2 100644 --- a/doc/release.txt +++ b/doc/release.txt @@ -1,6 +1,9 @@ RtAudio - a set of C++ classes that provide a common API for realtime audio input/output across Linux (native ALSA, JACK, PulseAudio, and OSS), Macintosh OS X (CoreAudio and JACK), and Windows (DirectSound, ASIO and WASAPI) operating systems. -By Gary P. Scavone, 2001-2014. +By Gary P. Scavone, 2001-2016. + +v4.1.2: (?? February 2016) +- miscellaneous updates, see github repo commit history for details v4.1.1: (26 April 2014) - updates to WASAPI API for MinGW compiling |
