summaryrefslogtreecommitdiff
path: root/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html')
-rw-r--r--doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html112
1 files changed, 59 insertions, 53 deletions
diff --git a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
index 63a4ef3..837c218 100644
--- a/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
+++ b/doc/html/structRtAudio_1_1RTAUDIO__DEVICE.html
@@ -1,19 +1,21 @@
-<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> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </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> &nbsp; <a class="qindex" href="annotated.html">Class/Enum List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; </CENTER>
<HR>
<!-- Generated by Doxygen 1.2.8.1 -->
-<h1>RtAudio::RTAUDIO_DEVICE Struct Reference</h1><code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
+<h1>RtAudio::RTAUDIO_DEVICE Struct Reference</h1>The public device information structure for passing queried values.
+<a href="#_details">More...</a>
+<p>
+<code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
<p>
<a href="structRtAudio_1_1RTAUDIO__DEVICE-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>char&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m0">name</a> [128]</td></tr>
-<tr><td nowrap align=right valign=top>DEVICE_ID&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m1">id</a> [2]</td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m2">probed</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m3">maxOutputChannels</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m4">maxInputChannels</a></td></tr>
@@ -22,10 +24,14 @@
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m7">minInputChannels</a></td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m8">minDuplexChannels</a></td></tr>
<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m9">hasDuplexSupport</a></td></tr>
-<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">nSampleRates</a></td></tr>
-<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">sampleRates</a> [MAX_SAMPLE_RATES]</td></tr>
-<tr><td nowrap align=right valign=top><a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a>&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">nativeFormats</a></td></tr>
+<tr><td nowrap align=right valign=top>bool&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m10">isDefault</a></td></tr>
+<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m11">nSampleRates</a></td></tr>
+<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m12">sampleRates</a> [MAX_SAMPLE_RATES]</td></tr>
+<tr><td nowrap align=right valign=top>RTAUDIO_FORMAT&nbsp;</td><td valign=bottom><a class="el" href="structRtAudio_1_1RTAUDIO__DEVICE.html#m13">nativeFormats</a></td></tr>
</table>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+The public device information structure for passing queried values.
+<p>
<hr><h2>Member Data Documentation</h2>
<a name="m0" doxytag="RtAudio::RTAUDIO_DEVICE::name"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
@@ -50,17 +56,17 @@ char RtAudio::RTAUDIO_DEVICE::name
<td>
<p>
- </td>
+Character string device identifier. </td>
</tr>
</table>
-<a name="m1" doxytag="RtAudio::RTAUDIO_DEVICE::id"></a><p>
+<a name="m2" doxytag="RtAudio::RTAUDIO_DEVICE::probed"></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>
-DEVICE_ID RtAudio::RTAUDIO_DEVICE::id
+bool RtAudio::RTAUDIO_DEVICE::probed
</b></td>
</tr>
@@ -76,17 +82,17 @@ DEVICE_ID RtAudio::RTAUDIO_DEVICE::id
<td>
<p>
-No value reported by <a class="el" href="classRtAudio.html#a7">getDeviceInfo</a>(). </td>
+true if the device capabilities were successfully probed. </td>
</tr>
</table>
-<a name="m2" doxytag="RtAudio::RTAUDIO_DEVICE::probed"></a><p>
+<a name="m3" doxytag="RtAudio::RTAUDIO_DEVICE::maxOutputChannels"></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>
-bool RtAudio::RTAUDIO_DEVICE::probed
+int RtAudio::RTAUDIO_DEVICE::maxOutputChannels
</b></td>
</tr>
@@ -102,17 +108,17 @@ bool RtAudio::RTAUDIO_DEVICE::probed
<td>
<p>
-true if the device capabilities were successfully probed. </td>
+Maximum output channels supported by device. </td>
</tr>
</table>
-<a name="m3" doxytag="RtAudio::RTAUDIO_DEVICE::maxOutputChannels"></a><p>
+<a name="m4" doxytag="RtAudio::RTAUDIO_DEVICE::maxInputChannels"></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::RTAUDIO_DEVICE::maxOutputChannels
+int RtAudio::RTAUDIO_DEVICE::maxInputChannels
</b></td>
</tr>
@@ -128,17 +134,17 @@ int RtAudio::RTAUDIO_DEVICE::maxOutputChannels
<td>
<p>
- </td>
+Maximum input channels supported by device. </td>
</tr>
</table>
-<a name="m4" doxytag="RtAudio::RTAUDIO_DEVICE::maxInputChannels"></a><p>
+<a name="m5" doxytag="RtAudio::RTAUDIO_DEVICE::maxDuplexChannels"></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::RTAUDIO_DEVICE::maxInputChannels
+int RtAudio::RTAUDIO_DEVICE::maxDuplexChannels
</b></td>
</tr>
@@ -154,17 +160,17 @@ int RtAudio::RTAUDIO_DEVICE::maxInputChannels
<td>
<p>
- </td>
+Maximum simultaneous input/output channels supported by device. </td>
</tr>
</table>
-<a name="m5" doxytag="RtAudio::RTAUDIO_DEVICE::maxDuplexChannels"></a><p>
+<a name="m6" doxytag="RtAudio::RTAUDIO_DEVICE::minOutputChannels"></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::RTAUDIO_DEVICE::maxDuplexChannels
+int RtAudio::RTAUDIO_DEVICE::minOutputChannels
</b></td>
</tr>
@@ -180,17 +186,17 @@ int RtAudio::RTAUDIO_DEVICE::maxDuplexChannels
<td>
<p>
- </td>
+Minimum output channels supported by device. </td>
</tr>
</table>
-<a name="m6" doxytag="RtAudio::RTAUDIO_DEVICE::minOutputChannels"></a><p>
+<a name="m7" doxytag="RtAudio::RTAUDIO_DEVICE::minInputChannels"></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::RTAUDIO_DEVICE::minOutputChannels
+int RtAudio::RTAUDIO_DEVICE::minInputChannels
</b></td>
</tr>
@@ -206,17 +212,17 @@ int RtAudio::RTAUDIO_DEVICE::minOutputChannels
<td>
<p>
- </td>
+Minimum input channels supported by device. </td>
</tr>
</table>
-<a name="m7" doxytag="RtAudio::RTAUDIO_DEVICE::minInputChannels"></a><p>
+<a name="m8" doxytag="RtAudio::RTAUDIO_DEVICE::minDuplexChannels"></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::RTAUDIO_DEVICE::minInputChannels
+int RtAudio::RTAUDIO_DEVICE::minDuplexChannels
</b></td>
</tr>
@@ -232,17 +238,17 @@ int RtAudio::RTAUDIO_DEVICE::minInputChannels
<td>
<p>
- </td>
+Minimum simultaneous input/output channels supported by device. </td>
</tr>
</table>
-<a name="m8" doxytag="RtAudio::RTAUDIO_DEVICE::minDuplexChannels"></a><p>
+<a name="m9" doxytag="RtAudio::RTAUDIO_DEVICE::hasDuplexSupport"></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::RTAUDIO_DEVICE::minDuplexChannels
+bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport
</b></td>
</tr>
@@ -258,17 +264,17 @@ int RtAudio::RTAUDIO_DEVICE::minDuplexChannels
<td>
<p>
- </td>
+true if device supports duplex mode. </td>
</tr>
</table>
-<a name="m9" doxytag="RtAudio::RTAUDIO_DEVICE::hasDuplexSupport"></a><p>
+<a name="m10" doxytag="RtAudio::RTAUDIO_DEVICE::isDefault"></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>
-bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport
+bool RtAudio::RTAUDIO_DEVICE::isDefault
</b></td>
</tr>
@@ -284,10 +290,10 @@ bool RtAudio::RTAUDIO_DEVICE::hasDuplexSupport
<td>
<p>
-true if device supports duplex mode. </td>
+true if this is the default output or input device. </td>
</tr>
</table>
-<a name="m10" doxytag="RtAudio::RTAUDIO_DEVICE::nSampleRates"></a><p>
+<a name="m11" doxytag="RtAudio::RTAUDIO_DEVICE::nSampleRates"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
@@ -313,7 +319,7 @@ int RtAudio::RTAUDIO_DEVICE::nSampleRates
Number of discrete rates or -1 if range supported. </td>
</tr>
</table>
-<a name="m11" doxytag="RtAudio::RTAUDIO_DEVICE::sampleRates"></a><p>
+<a name="m12" doxytag="RtAudio::RTAUDIO_DEVICE::sampleRates"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
@@ -339,14 +345,14 @@ int RtAudio::RTAUDIO_DEVICE::sampleRates
Supported rates or (min, max) if range. </td>
</tr>
</table>
-<a name="m12" doxytag="RtAudio::RTAUDIO_DEVICE::nativeFormats"></a><p>
+<a name="m13" doxytag="RtAudio::RTAUDIO_DEVICE::nativeFormats"></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>
-<a class="el" href="classRtAudio.html#s0">RTAUDIO_FORMAT</a> RtAudio::RTAUDIO_DEVICE::nativeFormats
+RTAUDIO_FORMAT RtAudio::RTAUDIO_DEVICE::nativeFormats
</b></td>
</tr>
@@ -367,12 +373,12 @@ Bit mask of supported data formats. </td>
</table>
<hr>The documentation for this struct 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>&copy;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>&copy;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>