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