You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

235 lines
8.2KB

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