Release 4.0.12 tarball
[rtaudio.git] / 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.8.2 -->
12 <div id="nav-path" class="navpath">
13   <ul>
14 <li class="navelem"><a class="el" href="classRtAudio.html">RtAudio</a></li><li class="navelem"><a class="el" href="structRtAudio_1_1DeviceInfo.html">DeviceInfo</a></li>  </ul>
15 </div>
16 </div><!-- top -->
17 <div class="header">
18   <div class="summary">
19 <a href="#pub-attribs">Public Attributes</a> &#124;
20 <a href="structRtAudio_1_1DeviceInfo-members.html">List of all members</a>  </div>
21   <div class="headertitle">
22 <div class="title">RtAudio::DeviceInfo Struct Reference</div>  </div>
23 </div><!--header-->
24 <div class="contents">
25
26 <p>The public device information structure for returning queried values.  
27  <a href="structRtAudio_1_1DeviceInfo.html#details">More...</a></p>
28
29 <p><code>#include &lt;<a class="el" href="RtAudio_8h_source.html">RtAudio.h</a>&gt;</code></p>
30 <table class="memberdecls">
31 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
32 Public Attributes</h2></td></tr>
33 <tr class="memitem:a97573717ccb1e75a834a0a108cd6982d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a97573717ccb1e75a834a0a108cd6982d">probed</a></td></tr>
34 <tr class="separator:a97573717ccb1e75a834a0a108cd6982d"><td class="memSeparator" colspan="2">&#160;</td></tr>
35 <tr class="memitem:a24df596ab8d54f2eb540c7cf16212b3b"><td class="memItemLeft" align="right" valign="top">std::string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a24df596ab8d54f2eb540c7cf16212b3b">name</a></td></tr>
36 <tr class="separator:a24df596ab8d54f2eb540c7cf16212b3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
37 <tr class="memitem:a81aaf488f8158ef55b1bb678f66feb7d"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a81aaf488f8158ef55b1bb678f66feb7d">outputChannels</a></td></tr>
38 <tr class="separator:a81aaf488f8158ef55b1bb678f66feb7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
39 <tr class="memitem:a56247b458a937ae84d98ca9c4b243275"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a56247b458a937ae84d98ca9c4b243275">inputChannels</a></td></tr>
40 <tr class="separator:a56247b458a937ae84d98ca9c4b243275"><td class="memSeparator" colspan="2">&#160;</td></tr>
41 <tr class="memitem:a3e8ad34c2d14e24293a0beafc26186e7"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a3e8ad34c2d14e24293a0beafc26186e7">duplexChannels</a></td></tr>
42 <tr class="separator:a3e8ad34c2d14e24293a0beafc26186e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
43 <tr class="memitem:a5365245e73ffe29a05734de4474acd58"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a5365245e73ffe29a05734de4474acd58">isDefaultOutput</a></td></tr>
44 <tr class="separator:a5365245e73ffe29a05734de4474acd58"><td class="memSeparator" colspan="2">&#160;</td></tr>
45 <tr class="memitem:a7c8aca084bd908799b6be5954b80def2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a7c8aca084bd908799b6be5954b80def2">isDefaultInput</a></td></tr>
46 <tr class="separator:a7c8aca084bd908799b6be5954b80def2"><td class="memSeparator" colspan="2">&#160;</td></tr>
47 <tr class="memitem:afa65f5f92f66ce7aacd3ff35e11b230f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; unsigned int &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#afa65f5f92f66ce7aacd3ff35e11b230f">sampleRates</a></td></tr>
48 <tr class="separator:afa65f5f92f66ce7aacd3ff35e11b230f"><td class="memSeparator" colspan="2">&#160;</td></tr>
49 <tr class="memitem:a23251b549b89b2fe04a57fcd7cb76ea4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1DeviceInfo.html#a23251b549b89b2fe04a57fcd7cb76ea4">nativeFormats</a></td></tr>
50 <tr class="separator:a23251b549b89b2fe04a57fcd7cb76ea4"><td class="memSeparator" colspan="2">&#160;</td></tr>
51 </table>
52 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
53 <div class="textblock"><p>The public device information structure for returning queried values. </p>
54 </div><h2 class="groupheader">Member Data Documentation</h2>
55 <a class="anchor" id="a97573717ccb1e75a834a0a108cd6982d"></a>
56 <div class="memitem">
57 <div class="memproto">
58       <table class="memname">
59         <tr>
60           <td class="memname">bool RtAudio::DeviceInfo::probed</td>
61         </tr>
62       </table>
63 </div><div class="memdoc">
64 <p>true if the device capabilities were successfully probed. </p>
65
66 </div>
67 </div>
68 <a class="anchor" id="a24df596ab8d54f2eb540c7cf16212b3b"></a>
69 <div class="memitem">
70 <div class="memproto">
71       <table class="memname">
72         <tr>
73           <td class="memname">std::string RtAudio::DeviceInfo::name</td>
74         </tr>
75       </table>
76 </div><div class="memdoc">
77 <p>Character string device identifier. </p>
78
79 </div>
80 </div>
81 <a class="anchor" id="a81aaf488f8158ef55b1bb678f66feb7d"></a>
82 <div class="memitem">
83 <div class="memproto">
84       <table class="memname">
85         <tr>
86           <td class="memname">unsigned int RtAudio::DeviceInfo::outputChannels</td>
87         </tr>
88       </table>
89 </div><div class="memdoc">
90 <p>Maximum output channels supported by device. </p>
91
92 </div>
93 </div>
94 <a class="anchor" id="a56247b458a937ae84d98ca9c4b243275"></a>
95 <div class="memitem">
96 <div class="memproto">
97       <table class="memname">
98         <tr>
99           <td class="memname">unsigned int RtAudio::DeviceInfo::inputChannels</td>
100         </tr>
101       </table>
102 </div><div class="memdoc">
103 <p>Maximum input channels supported by device. </p>
104
105 </div>
106 </div>
107 <a class="anchor" id="a3e8ad34c2d14e24293a0beafc26186e7"></a>
108 <div class="memitem">
109 <div class="memproto">
110       <table class="memname">
111         <tr>
112           <td class="memname">unsigned int RtAudio::DeviceInfo::duplexChannels</td>
113         </tr>
114       </table>
115 </div><div class="memdoc">
116 <p>Maximum simultaneous input/output channels supported by device. </p>
117
118 </div>
119 </div>
120 <a class="anchor" id="a5365245e73ffe29a05734de4474acd58"></a>
121 <div class="memitem">
122 <div class="memproto">
123       <table class="memname">
124         <tr>
125           <td class="memname">bool RtAudio::DeviceInfo::isDefaultOutput</td>
126         </tr>
127       </table>
128 </div><div class="memdoc">
129 <p>true if this is the default output device. </p>
130
131 </div>
132 </div>
133 <a class="anchor" id="a7c8aca084bd908799b6be5954b80def2"></a>
134 <div class="memitem">
135 <div class="memproto">
136       <table class="memname">
137         <tr>
138           <td class="memname">bool RtAudio::DeviceInfo::isDefaultInput</td>
139         </tr>
140       </table>
141 </div><div class="memdoc">
142 <p>true if this is the default input device. </p>
143
144 </div>
145 </div>
146 <a class="anchor" id="afa65f5f92f66ce7aacd3ff35e11b230f"></a>
147 <div class="memitem">
148 <div class="memproto">
149       <table class="memname">
150         <tr>
151           <td class="memname">std::vector&lt;unsigned int&gt; RtAudio::DeviceInfo::sampleRates</td>
152         </tr>
153       </table>
154 </div><div class="memdoc">
155 <p>Supported sample rates (queried from list of standard rates). </p>
156
157 </div>
158 </div>
159 <a class="anchor" id="a23251b549b89b2fe04a57fcd7cb76ea4"></a>
160 <div class="memitem">
161 <div class="memproto">
162       <table class="memname">
163         <tr>
164           <td class="memname"><a class="el" href="RtAudio_8h.html#aafca92882d25915560018873221e44b8">RtAudioFormat</a> RtAudio::DeviceInfo::nativeFormats</td>
165         </tr>
166       </table>
167 </div><div class="memdoc">
168 <p>Bit mask of supported data formats. </p>
169
170 </div>
171 </div>
172 <hr/>The documentation for this struct was generated from the following file:<ul>
173 <li><a class="el" href="RtAudio_8h_source.html">RtAudio.h</a></li>
174 </ul>
175 </div><!-- contents -->
176 <HR>
177 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
178   <td>&copy;2001-2013 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>
179 </table>
180 </BODY>
181 </HTML>