doc/html/structRtAudioDeviceInfo.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>The RtAudio Tutorial</TITLE>
   4 <LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
   5 </HEAD>
   6 <BODY BGCOLOR="#FFFFFF">
   7 <CENTER>
   8 <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>
   9 <HR>
  10 <!-- Generated by Doxygen 1.4.4 -->
  11 <h1>RtAudioDeviceInfo Struct Reference</h1><!-- doxytag: class="RtAudioDeviceInfo" -->The public device information structure for returning queried values.
  12 <a href="#_details">More...</a>
  13 <p>
  14 <code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
  15 <p>
  16 <a href="structRtAudioDeviceInfo-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
  17 <tr><td></td></tr>
  18 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
  19 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o0">name</a></td></tr>
  20
  21 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o1">probed</a></td></tr>
  22
  23 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o2">outputChannels</a></td></tr>
  24
  25 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o3">inputChannels</a></td></tr>
  26
  27 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o4">duplexChannels</a></td></tr>
  28
  29 <tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o5">isDefault</a></td></tr>
  30
  31 <tr><td class="memItemLeft" nowrap align="right" valign="top">std::vector&lt; int &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o6">sampleRates</a></td></tr>
  32
  33 <tr><td class="memItemLeft" nowrap align="right" valign="top">RtAudioFormat&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioDeviceInfo.html#o7">nativeFormats</a></td></tr>
  34
  35 </table>
  36 <hr><a name="_details"></a><h2>Detailed Description</h2>
  37 The public device information structure for returning queried values.
  38 <p>
  39 <hr><h2>Member Data Documentation</h2>
  40 <a class="anchor" name="o0"></a><!-- doxytag: member="RtAudioDeviceInfo::name" ref="o0" args="" --><p>
  41 <table class="mdTable" cellpadding="2" cellspacing="0">
  42   <tr>
  43     <td class="mdRow">
  44       <table cellpadding="0" cellspacing="0" border="0">
  45         <tr>
  46           <td class="md" nowrap valign="top">std::string <a class="el" href="structRtAudioDeviceInfo.html#o0">RtAudioDeviceInfo::name</a>          </td>
  47         </tr>
  48       </table>
  49     </td>
  50   </tr>
  51 </table>
  52 <table cellspacing="5" cellpadding="0" border="0">
  53   <tr>
  54     <td>
  55       &nbsp;
  56     </td>
  57     <td>
  58
  59 <p>
  60 Character string device identifier.     </td>
  61   </tr>
  62 </table>
  63 <a class="anchor" name="o1"></a><!-- doxytag: member="RtAudioDeviceInfo::probed" ref="o1" args="" --><p>
  64 <table class="mdTable" cellpadding="2" cellspacing="0">
  65   <tr>
  66     <td class="mdRow">
  67       <table cellpadding="0" cellspacing="0" border="0">
  68         <tr>
  69           <td class="md" nowrap valign="top">bool <a class="el" href="structRtAudioDeviceInfo.html#o1">RtAudioDeviceInfo::probed</a>          </td>
  70         </tr>
  71       </table>
  72     </td>
  73   </tr>
  74 </table>
  75 <table cellspacing="5" cellpadding="0" border="0">
  76   <tr>
  77     <td>
  78       &nbsp;
  79     </td>
  80     <td>
  81
  82 <p>
  83 true if the device capabilities were successfully probed.     </td>
  84   </tr>
  85 </table>
  86 <a class="anchor" name="o2"></a><!-- doxytag: member="RtAudioDeviceInfo::outputChannels" ref="o2" args="" --><p>
  87 <table class="mdTable" cellpadding="2" cellspacing="0">
  88   <tr>
  89     <td class="mdRow">
  90       <table cellpadding="0" cellspacing="0" border="0">
  91         <tr>
  92           <td class="md" nowrap valign="top">int <a class="el" href="structRtAudioDeviceInfo.html#o2">RtAudioDeviceInfo::outputChannels</a>          </td>
  93         </tr>
  94       </table>
  95     </td>
  96   </tr>
  97 </table>
  98 <table cellspacing="5" cellpadding="0" border="0">
  99   <tr>
 100     <td>
 101       &nbsp;
 102     </td>
 103     <td>
 104
 105 <p>
 106 Maximum output channels supported by device.     </td>
 107   </tr>
 108 </table>
 109 <a class="anchor" name="o3"></a><!-- doxytag: member="RtAudioDeviceInfo::inputChannels" ref="o3" args="" --><p>
 110 <table class="mdTable" cellpadding="2" cellspacing="0">
 111   <tr>
 112     <td class="mdRow">
 113       <table cellpadding="0" cellspacing="0" border="0">
 114         <tr>
 115           <td class="md" nowrap valign="top">int <a class="el" href="structRtAudioDeviceInfo.html#o3">RtAudioDeviceInfo::inputChannels</a>          </td>
 116         </tr>
 117       </table>
 118     </td>
 119   </tr>
 120 </table>
 121 <table cellspacing="5" cellpadding="0" border="0">
 122   <tr>
 123     <td>
 124       &nbsp;
 125     </td>
 126     <td>
 127
 128 <p>
 129 Maximum input channels supported by device.     </td>
 130   </tr>
 131 </table>
 132 <a class="anchor" name="o4"></a><!-- doxytag: member="RtAudioDeviceInfo::duplexChannels" ref="o4" args="" --><p>
 133 <table class="mdTable" cellpadding="2" cellspacing="0">
 134   <tr>
 135     <td class="mdRow">
 136       <table cellpadding="0" cellspacing="0" border="0">
 137         <tr>
 138           <td class="md" nowrap valign="top">int <a class="el" href="structRtAudioDeviceInfo.html#o4">RtAudioDeviceInfo::duplexChannels</a>          </td>
 139         </tr>
 140       </table>
 141     </td>
 142   </tr>
 143 </table>
 144 <table cellspacing="5" cellpadding="0" border="0">
 145   <tr>
 146     <td>
 147       &nbsp;
 148     </td>
 149     <td>
 150
 151 <p>
 152 Maximum simultaneous input/output channels supported by device.     </td>
 153   </tr>
 154 </table>
 155 <a class="anchor" name="o5"></a><!-- doxytag: member="RtAudioDeviceInfo::isDefault" ref="o5" args="" --><p>
 156 <table class="mdTable" cellpadding="2" cellspacing="0">
 157   <tr>
 158     <td class="mdRow">
 159       <table cellpadding="0" cellspacing="0" border="0">
 160         <tr>
 161           <td class="md" nowrap valign="top">bool <a class="el" href="structRtAudioDeviceInfo.html#o5">RtAudioDeviceInfo::isDefault</a>          </td>
 162         </tr>
 163       </table>
 164     </td>
 165   </tr>
 166 </table>
 167 <table cellspacing="5" cellpadding="0" border="0">
 168   <tr>
 169     <td>
 170       &nbsp;
 171     </td>
 172     <td>
 173
 174 <p>
 175 true if this is the default output or input device.     </td>
 176   </tr>
 177 </table>
 178 <a class="anchor" name="o6"></a><!-- doxytag: member="RtAudioDeviceInfo::sampleRates" ref="o6" args="" --><p>
 179 <table class="mdTable" cellpadding="2" cellspacing="0">
 180   <tr>
 181     <td class="mdRow">
 182       <table cellpadding="0" cellspacing="0" border="0">
 183         <tr>
 184           <td class="md" nowrap valign="top">std::vector&lt;int&gt; <a class="el" href="structRtAudioDeviceInfo.html#o6">RtAudioDeviceInfo::sampleRates</a>          </td>
 185         </tr>
 186       </table>
 187     </td>
 188   </tr>
 189 </table>
 190 <table cellspacing="5" cellpadding="0" border="0">
 191   <tr>
 192     <td>
 193       &nbsp;
 194     </td>
 195     <td>
 196
 197 <p>
 198 Supported sample rates (queried from list of standard rates).     </td>
 199   </tr>
 200 </table>
 201 <a class="anchor" name="o7"></a><!-- doxytag: member="RtAudioDeviceInfo::nativeFormats" ref="o7" args="" --><p>
 202 <table class="mdTable" cellpadding="2" cellspacing="0">
 203   <tr>
 204     <td class="mdRow">
 205       <table cellpadding="0" cellspacing="0" border="0">
 206         <tr>
 207           <td class="md" nowrap valign="top">RtAudioFormat <a class="el" href="structRtAudioDeviceInfo.html#o7">RtAudioDeviceInfo::nativeFormats</a>          </td>
 208         </tr>
 209       </table>
 210     </td>
 211   </tr>
 212 </table>
 213 <table cellspacing="5" cellpadding="0" border="0">
 214   <tr>
 215     <td>
 216       &nbsp;
 217     </td>
 218     <td>
 219
 220 <p>
 221 Bit mask of supported data formats.     </td>
 222   </tr>
 223 </table>
 224 <hr>The documentation for this struct was generated from the following file:<ul>
 225 <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
 226 <HR>
 227
 228 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
 229   <td>&copy;2001-2005 Gary P. Scavone, McGill University. All Rights Reserved.<br>
 230   Maintained by Gary P. Scavone, <a href="mailto:gary@music.mcgill.ca">gary@music.mcgill.ca</a></td></tr>
 231 </table>
 232
 233 </BODY>
 234 </HTML>