Audio plugin host https://kx.studio/carla
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.

260 lines
9.2KB

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