diff options
Diffstat (limited to 'doc/html/classRtAudio.html')
| -rw-r--r-- | doc/html/classRtAudio.html | 227 |
1 files changed, 62 insertions, 165 deletions
diff --git a/doc/html/classRtAudio.html b/doc/html/classRtAudio.html index cb4eff4..157d97a 100644 --- a/doc/html/classRtAudio.html +++ b/doc/html/classRtAudio.html @@ -1,38 +1,37 @@ -<HTML>
-<HEAD>
-<TITLE>The RtAudio Tutorial</TITLE>
-<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
-</HEAD>
-<BODY BGCOLOR="#FFFFFF">
-<CENTER>
-<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER>
+<HTML> +<HEAD> +<TITLE>The RtAudio Tutorial</TITLE> +<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css"> +</HEAD> +<BODY BGCOLOR="#FFFFFF"> +<CENTER> +<a class="qindex" href="index.html">Tutorial</a> <a class="qindex" href="annotated.html">Class/Enum List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> </CENTER> <HR> <!-- Generated by Doxygen 1.2.8.1 --> -<h1>RtAudio Class Reference</h1><code>#include <<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>></code> +<h1>RtAudio Class Reference</h1>Realtime audio i/o C++ class. +<a href="#_details">More...</a> +<p> +<code>#include <<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>></code> <p> <a href="classRtAudio-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> -<tr><td colspan=2><br><h2>Public Types</h2></td></tr> -<tr><td nowrap align=right valign=top>typedef unsigned long </td><td valign=bottom><a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a></td></tr> -<tr><td nowrap align=right valign=top>typedef int (* </td><td valign=bottom><a class="el" href="classRtAudio.html#s1">RTAUDIO_CALLBACK</a> )(char *buffer, int bufferSize, void *userData)</td></tr> -<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <a class="el" href="classRtAudio.html#s3s2">MAX_SAMPLE_RATES</a> = 14 - }</td></tr> <tr><td colspan=2><br><h2>Public Methods</h2></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtAudio.html#a0">RtAudio</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>The default constructor.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtAudio.html#a1">RtAudio</a> (int *streamId, int outputDevice, int outputChannels, int inputDevice, int inputChannels, <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> format, int sampleRate, int *bufferSize, int numberOfBuffers)</td></tr> +<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtAudio.html#a1">RtAudio</a> (int *streamId, int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)</td></tr> <tr><td> </td><td><font size=-1><em>A constructor which can be used to open a stream during instantiation.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classRtAudio.html#a2">~RtAudio</a> ()</td></tr> <tr><td> </td><td><font size=-1><em>The destructor.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classRtAudio.html#a3">openStream</a> (int outputDevice, int outputChannels, int inputDevice, int inputChannels, <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> format, int sampleRate, int *bufferSize, int numberOfBuffers)</td></tr> +<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classRtAudio.html#a3">openStream</a> (int outputDevice, int outputChannels, int inputDevice, int inputChannels, RTAUDIO_FORMAT format, int sampleRate, int *bufferSize, int numberOfBuffers)</td></tr> <tr><td> </td><td><font size=-1><em>A public method for opening a stream with the specified parameters.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a4">setStreamCallback</a> (int streamId, <a class="el" href="classRtAudio.html#s1">RTAUDIO_CALLBACK</a> callback, void *userData)</td></tr> +<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a4">setStreamCallback</a> (int streamId, RTAUDIO_CALLBACK callback, void *userData)</td></tr> <tr><td> </td><td><font size=-1><em>A public method which sets a user-defined callback function for a given stream.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a5">cancelStreamCallback</a> (int streamId)</td></tr> <tr><td> </td><td><font size=-1><em>A public method which cancels a callback process and function for a given stream.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr> -<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classRtAudio.html#a6">getDeviceCount</a> (void)</td></tr> -<tr><td> </td><td><font size=-1><em>A public method which returns the number of audio devices found.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr> +<tr><td nowrap align=right valign=top><a name="a6" doxytag="RtAudio::getDeviceCount"></a> +int </td><td valign=bottom><a class="el" href="classRtAudio.html#a6">getDeviceCount</a> (void)</td></tr> +<tr><td> </td><td><font size=-1><em>A public method which returns the number of audio devices found.</em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a7">getDeviceInfo</a> (int device, <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> *info)</td></tr> -<tr><td> </td><td><font size=-1><em>Fill a user-supplied <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> structure for a specified device.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> +<tr><td> </td><td><font size=-1><em>Fill a user-supplied <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> structure for a specified device number.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>char* const </td><td valign=bottom><a class="el" href="classRtAudio.html#a8">getStreamBuffer</a> (int streamId)</td></tr> <tr><td> </td><td><font size=-1><em>A public method which returns a pointer to the buffer for an open stream.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classRtAudio.html#a9">tickStream</a> (int streamId)</td></tr> @@ -48,101 +47,30 @@ <tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classRtAudio.html#a14">streamWillBlock</a> (int streamId)</td></tr> <tr><td> </td><td><font size=-1><em>Queries a stream to determine whether a call to the <a class="el" href="classRtAudio.html#a9">tickStream</a>() method will block.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr> <tr><td colspan=2><br><h2>Static Public Attributes</h2></td></tr> -<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> </td><td valign=bottom><a class="el" href="classRtAudio.html#p0">RTAUDIO_SINT8</a></td></tr> -<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> </td><td valign=bottom><a class="el" href="classRtAudio.html#p1">RTAUDIO_SINT16</a></td></tr> -<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> </td><td valign=bottom><a class="el" href="classRtAudio.html#p2">RTAUDIO_SINT24</a></td></tr> -<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> </td><td valign=bottom><a class="el" href="classRtAudio.html#p3">RTAUDIO_SINT32</a></td></tr> -<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> </td><td valign=bottom><a class="el" href="classRtAudio.html#p4">RTAUDIO_FLOAT32</a></td></tr> -<tr><td nowrap align=right valign=top>const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> </td><td valign=bottom><a class="el" href="classRtAudio.html#p5">RTAUDIO_FLOAT64</a></td></tr> -</table> -<hr><h2>Member Typedef Documentation</h2> -<a name="s0" doxytag="RtAudio::RTAUDIO_FORMAT"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -typedef unsigned long RtAudio::RTAUDIO_FORMAT - </b></td> - </tr> - - </table> - </td> - </tr> +<tr><td nowrap align=right valign=top>const RTAUDIO_FORMAT </td><td valign=bottom><a class="el" href="classRtAudio.html#p0">RTAUDIO_SINT8</a></td></tr> +<tr><td nowrap align=right valign=top>const RTAUDIO_FORMAT </td><td valign=bottom><a class="el" href="classRtAudio.html#p1">RTAUDIO_SINT16</a></td></tr> +<tr><td nowrap align=right valign=top>const RTAUDIO_FORMAT </td><td valign=bottom><a class="el" href="classRtAudio.html#p2">RTAUDIO_SINT24</a></td></tr> +<tr><td nowrap align=right valign=top>const RTAUDIO_FORMAT </td><td valign=bottom><a class="el" href="classRtAudio.html#p3">RTAUDIO_SINT32</a></td></tr> +<tr><td nowrap align=right valign=top>const RTAUDIO_FORMAT </td><td valign=bottom><a class="el" href="classRtAudio.html#p4">RTAUDIO_FLOAT32</a></td></tr> +<tr><td nowrap align=right valign=top>const RTAUDIO_FORMAT </td><td valign=bottom><a class="el" href="classRtAudio.html#p5">RTAUDIO_FLOAT64</a></td></tr> </table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - +<hr><a name="_details"></a><h2>Detailed Description</h2> +Realtime audio i/o C++ class. <p> - </td> - </tr> -</table> -<a name="s1" doxytag="RtAudio::RTAUDIO_CALLBACK"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -typedef int(* RtAudio::RTAUDIO_CALLBACK)(char *buffer, int bufferSize, void *userData) - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - +RtAudio provides a common API (Application Programming Interface) for realtime audio input/output across Linux (native ALSA and OSS), SGI, Macintosh OS X (CoreAudio), and Windows (DirectSound and ASIO) operating systems. <p> - </td> - </tr> -</table> -<hr><h2>Member Enumeration Documentation</h2> -<a name="s3" doxytag="RtAudio::@0"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -anonymous enum - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - +RtAudio WWW site: <a href="http://www-ccrma.stanford.edu/~gary/rtaudio/">http://www-ccrma.stanford.edu/~gary/rtaudio/</a> +<p> +RtAudio: a realtime audio i/o C++ class Copyright (c) 2001-2002 Gary P. Scavone +<p> +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: +<p> +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. +<p> +Any person wishing to distribute modifications to the Software is requested to send the modifications to the original developer so that they can be incorporated into the canonical version. +<p> +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. <p> -<dl compact><dt> -<b>Enumeration values:</b><dd> -<table border=0 cellspacing=2 cellpadding=0> -<tr><td valign=top><a name="s3s2" doxytag="MAX_SAMPLE_RATES"></a><em>MAX_SAMPLE_RATES</em> - </td><td> -</td></tr> -</table> -</dl> - </td> - </tr> -</table> <hr><h2>Constructor & Destructor Documentation</h2> <a name="a0" doxytag="RtAudio::RtAudio"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> @@ -215,7 +143,7 @@ int <em>inputChannels</em>, <tr> <td></td> <td><b> -<a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> <em>format</em>, +RTAUDIO_FORMAT <em>format</em>, </b></td> </tr> <tr> @@ -322,7 +250,7 @@ int <em>inputChannels</em>, <tr> <td></td> <td><b> -<a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> <em>format</em>, +RTAUDIO_FORMAT <em>format</em>, </b></td> </tr> <tr> @@ -405,7 +333,7 @@ int <em>streamId</em>, <tr> <td></td> <td><b> -<a class="el" href="classRtAudio.html#s1">RTAUDIO_CALLBACK</a> <em>callback</em>, +RTAUDIO_CALLBACK <em>callback</em>, </b></td> </tr> <tr> @@ -463,37 +391,6 @@ A public method which cancels a callback process and function for a given stream This method shuts down a callback process and de-references the user function for a specific stream. Callback functionality can subsequently be restarted on the stream via the <a class="el" href="classRtAudio.html#a4">setStreamCallback</a>() method. An <a class="el" href="classRtError.html">RtError</a> will be thrown for an invalid device argument. </td> </tr> </table> -<a name="a6" doxytag="RtAudio::getDeviceCount"></a><p> -<table width="100%" cellpadding="2" cellspacing="0" border="0"> - <tr> - <td class="md"> - <table cellpadding="0" cellspacing="0" border="0"> - <tr> - <td nowrap valign="top"><b> -int RtAudio::getDeviceCount ( - </b></td> - <td valign="bottom"><b> -void ) - </b></td> - </tr> - - </table> - </td> - </tr> -</table> -<table cellspacing=5 cellpadding=0 border=0> - <tr> - <td> - - </td> - <td> - -<p> -A public method which returns the number of audio devices found. -<p> - </td> - </tr> -</table> <a name="a7" doxytag="RtAudio::getDeviceInfo"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> @@ -526,9 +423,9 @@ int <em>device</em>, <td> <p> -Fill a user-supplied <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> structure for a specified device. +Fill a user-supplied <a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html">RTAUDIO_DEVICE</a> structure for a specified device number. <p> -Any device between 0 and <a class="el" href="classRtAudio.html#a6">getDeviceCount</a>()-1 is valid. If a device is busy or otherwise unavailable, the structure member "probed" has a value of "false". The system default input and output devices are referenced by device identifier = 0. On systems which allow dynamic default device settings, the default devices are not identified by name (specific device enumerations are assigned device identifiers > 0). An <a class="el" href="classRtError.html">RtError</a> will be thrown for an invalid device argument. </td> +Any device integer between 1 and <a class="el" href="classRtAudio.html#a6">getDeviceCount</a>() is valid. If a device is busy or otherwise unavailable, the structure member "probed" will have a value of "false" and all other members are undefined. If the specified device is the current default input or output device, the "isDefault" member will have a value of "true". An <a class="el" href="classRtError.html">RtError</a> will be thrown for an invalid device argument. </td> </tr> </table> <a name="a8" doxytag="RtAudio::getStreamBuffer"></a><p> @@ -756,7 +653,7 @@ A return value of 0 indicates that the stream will NOT block. A positive return <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> -const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT8<code> [static]</code> +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT8<code> [static]</code> </b></td> </tr> @@ -772,7 +669,7 @@ const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAU <td> <p> - </td> +8-bit signed integer. </td> </tr> </table> <a name="p1" doxytag="RtAudio::RTAUDIO_SINT16"></a><p> @@ -782,7 +679,7 @@ const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAU <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> -const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT16<code> [static]</code> +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT16<code> [static]</code> </b></td> </tr> @@ -798,7 +695,7 @@ const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAU <td> <p> - </td> +16-bit signed integer. </td> </tr> </table> <a name="p2" doxytag="RtAudio::RTAUDIO_SINT24"></a><p> @@ -808,7 +705,7 @@ const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAU <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> -const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT24<code> [static]</code> +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT24<code> [static]</code> </b></td> </tr> @@ -824,7 +721,7 @@ const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAU <td> <p> -Upper 3 bytes of 32-bit integer. </td> +Upper 3 bytes of 32-bit signed integer. </td> </tr> </table> <a name="p3" doxytag="RtAudio::RTAUDIO_SINT32"></a><p> @@ -834,7 +731,7 @@ Upper 3 bytes of 32-bit integer. </td> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> -const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_SINT32<code> [static]</code> +const RTAUDIO_FORMAT RtAudio::RTAUDIO_SINT32<code> [static]</code> </b></td> </tr> @@ -850,7 +747,7 @@ const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAU <td> <p> - </td> +32-bit signed integer. </td> </tr> </table> <a name="p4" doxytag="RtAudio::RTAUDIO_FLOAT32"></a><p> @@ -860,7 +757,7 @@ const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAU <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> -const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_FLOAT32<code> [static]</code> +const RTAUDIO_FORMAT RtAudio::RTAUDIO_FLOAT32<code> [static]</code> </b></td> </tr> @@ -886,7 +783,7 @@ Normalized between plus/minus 1.0. </td> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> -const <a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_FLOAT64<code> [static]</code> +const RTAUDIO_FORMAT RtAudio::RTAUDIO_FLOAT64<code> [static]</code> </b></td> </tr> @@ -907,12 +804,12 @@ Normalized between plus/minus 1.0. </td> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul> -<HR>
-
-<table><tr><td><img src="../images/ccrma.gif">
- <td>©2001-2002 CCRMA, Stanford University. All Rights Reserved.<br>
- Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P>
-</table>
-
-</BODY>
+<HR> + +<table><tr><td><img src="../images/ccrma.gif"> + <td>©2001-2002 Gary P. Scavone, CCRMA, Stanford University. All Rights Reserved.<br> + Maintained by Gary P. Scavone, <a href="mailto:gary@ccrma.stanford.edu">gary@ccrma.stanford.edu</a><P> +</table> + +</BODY> </HTML> |