Release 4.0.4 tarball
[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.4.4 -->
12 <div class="nav">
13 <a class="el" href="classRtAudio.html">RtAudio</a>::<a class="el" href="structRtAudio_1_1StreamParameters.html">StreamParameters</a></div>
14 <h1>RtAudio::StreamParameters Struct Reference</h1><!-- doxytag: class="RtAudio::StreamParameters" -->The structure for specifying input or ouput stream parameters.  
15 <a href="#_details">More...</a>
16 <p>
17 <code>#include &lt;<a class="el" href="RtAudio_8h-source.html">RtAudio.h</a>&gt;</code>
18 <p>
19 <a href="structRtAudio_1_1StreamParameters-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
20 <tr><td></td></tr>
21 <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
22 <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#o0">deviceId</a></td></tr>
23
24 <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#o1">nChannels</a></td></tr>
25
26 <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#o2">firstChannel</a></td></tr>
27
28 </table>
29 <hr><a name="_details"></a><h2>Detailed Description</h2>
30 The structure for specifying input or ouput stream parameters. 
31 <p>
32 <hr><h2>Member Data Documentation</h2>
33 <a class="anchor" name="o0"></a><!-- doxytag: member="RtAudio::StreamParameters::deviceId" ref="o0" args="" --><p>
34 <table class="mdTable" cellpadding="2" cellspacing="0">
35   <tr>
36     <td class="mdRow">
37       <table cellpadding="0" cellspacing="0" border="0">
38         <tr>
39           <td class="md" nowrap valign="top">unsigned int <a class="el" href="structRtAudio_1_1StreamParameters.html#o0">RtAudio::StreamParameters::deviceId</a>          </td>
40         </tr>
41       </table>
42     </td>
43   </tr>
44 </table>
45 <table cellspacing="5" cellpadding="0" border="0">
46   <tr>
47     <td>
48       &nbsp;
49     </td>
50     <td>
51
52 <p>
53 Device index (0 to <a class="el" href="classRtAudio.html#a3">getDeviceCount()</a> - 1).     </td>
54   </tr>
55 </table>
56 <a class="anchor" name="o1"></a><!-- doxytag: member="RtAudio::StreamParameters::nChannels" 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">unsigned int <a class="el" href="structRtAudio_1_1StreamParameters.html#o1">RtAudio::StreamParameters::nChannels</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
75 <p>
76 Number of channels.     </td>
77   </tr>
78 </table>
79 <a class="anchor" name="o2"></a><!-- doxytag: member="RtAudio::StreamParameters::firstChannel" ref="o2" args="" --><p>
80 <table class="mdTable" cellpadding="2" cellspacing="0">
81   <tr>
82     <td class="mdRow">
83       <table cellpadding="0" cellspacing="0" border="0">
84         <tr>
85           <td class="md" nowrap valign="top">unsigned int <a class="el" href="structRtAudio_1_1StreamParameters.html#o2">RtAudio::StreamParameters::firstChannel</a>          </td>
86         </tr>
87       </table>
88     </td>
89   </tr>
90 </table>
91 <table cellspacing="5" cellpadding="0" border="0">
92   <tr>
93     <td>
94       &nbsp;
95     </td>
96     <td>
97
98 <p>
99 First channel index on device (default = 0).     </td>
100   </tr>
101 </table>
102 <hr>The documentation for this struct was generated from the following file:<ul>
103 <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
104 <HR>
105
106 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
107   <td>&copy;2001-2008 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>
108 </table>
109
110 </BODY>
111 </HTML>