doc/html/structRtAudio_1_1DeviceInfo.html

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