Merge 4.0.6 into releases
[rtaudio.git] / doc / html / structRtAudio_1_1StreamParameters.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.5.8 -->
12   <div class="navpath"><a class="el" href="classRtAudio.html">RtAudio</a>::<a class="el" href="structRtAudio_1_1StreamParameters.html">StreamParameters</a>
13   </div>
14 <div class="contents">
15 <h1>RtAudio::RtAudio::StreamParameters Struct Reference</h1><!-- doxytag: class="RtAudio::StreamParameters" -->The structure for specifying input or ouput stream parameters.  
16 <a href="#_details">More...</a>
17 <p>
18 <code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
19 <p>
20
21 <p>
22 <a href="structRtAudio_1_1StreamParameters-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
23 <tr><td></td></tr>
24 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
25 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#ffd27496c70c0986522056234c64e28e">deviceId</a></td></tr>
26
27 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#78798b65fada7941e1a7e47c11c9e627">nChannels</a></td></tr>
28
29 <tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudio_1_1StreamParameters.html#ddc8281f23a87455ec6dedbc766a74db">firstChannel</a></td></tr>
30
31 </table>
32 <hr><a name="_details"></a><h2>Detailed Description</h2>
33 The structure for specifying input or ouput stream parameters. <hr><h2>Member Data Documentation</h2>
34 <a class="anchor" name="ffd27496c70c0986522056234c64e28e"></a><!-- doxytag: member="RtAudio::StreamParameters::deviceId" ref="ffd27496c70c0986522056234c64e28e" args="" -->
35 <div class="memitem">
36 <div class="memproto">
37       <table class="memname">
38         <tr>
39           <td class="memname">unsigned int RtAudio::RtAudio::StreamParameters::deviceId          </td>
40         </tr>
41       </table>
42 </div>
43 <div class="memdoc">
44
45 <p>
46 Device index (0 to <a class="el" href="classRtAudio.html#747ce2d73803641bbb66d6e78092aa1a" title="A public function that queries for the number of audio devices available.">getDeviceCount()</a> - 1). 
47 </div>
48 </div><p>
49 <a class="anchor" name="78798b65fada7941e1a7e47c11c9e627"></a><!-- doxytag: member="RtAudio::StreamParameters::nChannels" ref="78798b65fada7941e1a7e47c11c9e627" args="" -->
50 <div class="memitem">
51 <div class="memproto">
52       <table class="memname">
53         <tr>
54           <td class="memname">unsigned int RtAudio::RtAudio::StreamParameters::nChannels          </td>
55         </tr>
56       </table>
57 </div>
58 <div class="memdoc">
59
60 <p>
61 Number of channels. 
62 </div>
63 </div><p>
64 <a class="anchor" name="ddc8281f23a87455ec6dedbc766a74db"></a><!-- doxytag: member="RtAudio::StreamParameters::firstChannel" ref="ddc8281f23a87455ec6dedbc766a74db" args="" -->
65 <div class="memitem">
66 <div class="memproto">
67       <table class="memname">
68         <tr>
69           <td class="memname">unsigned int RtAudio::RtAudio::StreamParameters::firstChannel          </td>
70         </tr>
71       </table>
72 </div>
73 <div class="memdoc">
74
75 <p>
76 First channel index on device (default = 0). 
77 </div>
78 </div><p>
79 <hr>The documentation for this struct was generated from the following file:<ul>
80 <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
81 </div>
82 <HR>
83
84 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
85   <td>&copy;2001-2009 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>
86 </table>
87
88 </BODY>
89 </HTML>