diff options
Diffstat (limited to 'doc/doxygen')
| -rw-r--r-- | doc/doxygen/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/doxygen/compiling.txt | 10 | ||||
| -rw-r--r-- | doc/doxygen/tutorial.txt | 22 |
3 files changed, 22 insertions, 12 deletions
diff --git a/doc/doxygen/Doxyfile b/doc/doxygen/Doxyfile index d7081b8..46d07db 100644 --- a/doc/doxygen/Doxyfile +++ b/doc/doxygen/Doxyfile @@ -32,7 +32,7 @@ PROJECT_NAME = RtAudio # This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = 4.1.0 +PROJECT_NUMBER = 4.1.1 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer diff --git a/doc/doxygen/compiling.txt b/doc/doxygen/compiling.txt index 3fa52cc..53a06f7 100644 --- a/doc/doxygen/compiling.txt +++ b/doc/doxygen/compiling.txt @@ -65,7 +65,7 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to <TD>RtApiDs</TD> <TD>__WINDOWS_DS__</TD> <TD><TT>dsound.lib (ver. 5.0 or higher), multithreaded</TT></TD> - <TD><I>compiler specific</I></TD> + <TD>MinGW: <TT>g++ -Wall -D__WINDOWS_DS__ -o audioprobe audioprobe.cpp RtAudio.cpp -lole32 -lwinmm -ldsound</TT></TD> </TR> <TR> <TD>Windows</TD> @@ -73,20 +73,20 @@ In order to compile RtAudio for a specific OS and audio API, it is necessary to <TD>RtApiAsio</TD> <TD>__WINDOWS_ASIO__</TD> <TD><I>various ASIO header and source files</I></TD> - <TD><I>compiler specific</I></TD> + <TD>MinGW: <TT>g++ -Wall -D__WINDOWS_ASIO__ -Iinclude -o audioprobe audioprobe.cpp RtAudio.cpp asio.cpp asiolist.cpp asiodrivers.cpp iasiothiscallresolver.cpp -lole32</TT></TD> </TR> <TR> <TD>Windows</TD> <TD>WASAPI</TD> <TD>RtApiWasapi</TD> <TD>__WINDOWS_WASAPI__</TD> - <TD><I>various ASIO header and source files</I></TD> - <TD><I>compiler specific ... not currently working with MingW compiler</I></TD> + <TD>MinGW: <TT>FunctionDiscoveryKeys_devpkey.h, lksuser, luuid, lwinmm, lole32</TT></TD> + <TD>MinGW: <TT>g++ -Wall -D__WINDOWS_WASAPI__ -Iinclude -o audioprobe audioprobe.cpp RtAudio.cpp -lole32 -lwinmm -lksuser -luuid</TT></TD> </TR> </TABLE> <P> -The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT> and <TT>RtAudio.cpp</TT> all exist in the same directory. +The example compiler statements above could be used to compile the <TT>audioprobe.cpp</TT> example file, assuming that <TT>audioprobe.cpp</TT>, <TT>RtAudio.h</TT>, <TT>RtAudio.cpp</TT> and any other necessary files all exist in the same directory or the include directory. */ diff --git a/doc/doxygen/tutorial.txt b/doc/doxygen/tutorial.txt index fc1a226..04b77d9 100644 --- a/doc/doxygen/tutorial.txt +++ b/doc/doxygen/tutorial.txt @@ -15,12 +15,21 @@ RtAudio is a set of C++ classes that provide a common API (Application Programmi 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.0) +\section whatsnew Latest Updates (Version 4.1.1) -A minor API change was made. The RtError class was renamed RtAudioError and embedded directly in RtAudio.h. Thus, all references to RtError should be renamed to RtAudioError and the RtError.h file should be deleted. +Changes in this release include: -Other 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 +Changes in the previous 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) - CMake support (thanks to Berkus Decker) - pulse audio update to support bufferFrames argument with audio input (thanks to Jonatan Wallmander) @@ -31,7 +40,7 @@ Other changes in this release include: \section download Download -Latest Release (10 April 2014): <A href="http://www.music.mcgill.ca/~gary/rtaudio/release/rtaudio-4.1.0.tar.gz">Version 4.1.0</A> +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> \section documentation Documentation Links @@ -46,8 +55,9 @@ Latest Release (10 April 2014): <A href="http://www.music.mcgill.ca/~gary/rtaudi -# \ref apinotes -# \ref acknowledge -# \ref license --# <A href="bugs.html">Bug Tracker (out of date)</A> --# <A href="updates.html">Possible Updates (out of date)</A> -# <A href="http://github.com/thestk/rtaudio">RtAudio on GitHub</A> */ + +-# <A href="bugs.html">Bug Tracker (out of date)</A> +-# <A href="updates.html">Possible Updates (out of date)</A> |