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.

227 lines
7.7KB

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