Release 4.0.0 tarball
[rtaudio.git] / doc / html / structRtAudioStreamParameters.html
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>RtAudioStreamParameters Struct Reference</h1><!-- doxytag: class="RtAudioStreamParameters" -->The structure for specifying input or ouput stream parameters.  
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="structRtAudioStreamParameters-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">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioStreamParameters.html#o0">deviceId</a></td></tr>
21
22 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioStreamParameters.html#o1">nChannels</a></td></tr>
23
24 <tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structRtAudioStreamParameters.html#o2">firstChannel</a></td></tr>
25
26 </table>
27 <hr><a name="_details"></a><h2>Detailed Description</h2>
28 The structure for specifying input or ouput stream parameters. 
29 <p>
30 <hr><h2>Member Data Documentation</h2>
31 <a class="anchor" name="o0"></a><!-- doxytag: member="RtAudioStreamParameters::deviceId" ref="o0" args="" --><p>
32 <table class="mdTable" cellpadding="2" cellspacing="0">
33   <tr>
34     <td class="mdRow">
35       <table cellpadding="0" cellspacing="0" border="0">
36         <tr>
37           <td class="md" nowrap valign="top">int <a class="el" href="structRtAudioStreamParameters.html#o0">RtAudioStreamParameters::deviceId</a>          </td>
38         </tr>
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
50 <p>
51 Device index (0 to getDeviceCount() - 1).     </td>
52   </tr>
53 </table>
54 <a class="anchor" name="o1"></a><!-- doxytag: member="RtAudioStreamParameters::nChannels" ref="o1" args="" --><p>
55 <table class="mdTable" cellpadding="2" cellspacing="0">
56   <tr>
57     <td class="mdRow">
58       <table cellpadding="0" cellspacing="0" border="0">
59         <tr>
60           <td class="md" nowrap valign="top">int <a class="el" href="structRtAudioStreamParameters.html#o1">RtAudioStreamParameters::nChannels</a>          </td>
61         </tr>
62       </table>
63     </td>
64   </tr>
65 </table>
66 <table cellspacing="5" cellpadding="0" border="0">
67   <tr>
68     <td>
69       &nbsp;
70     </td>
71     <td>
72
73 <p>
74 Number of channels.     </td>
75   </tr>
76 </table>
77 <a class="anchor" name="o2"></a><!-- doxytag: member="RtAudioStreamParameters::firstChannel" ref="o2" args="" --><p>
78 <table class="mdTable" cellpadding="2" cellspacing="0">
79   <tr>
80     <td class="mdRow">
81       <table cellpadding="0" cellspacing="0" border="0">
82         <tr>
83           <td class="md" nowrap valign="top">int <a class="el" href="structRtAudioStreamParameters.html#o2">RtAudioStreamParameters::firstChannel</a>          </td>
84         </tr>
85       </table>
86     </td>
87   </tr>
88 </table>
89 <table cellspacing="5" cellpadding="0" border="0">
90   <tr>
91     <td>
92       &nbsp;
93     </td>
94     <td>
95
96 <p>
97 First channel index on device (default = 0).     </td>
98   </tr>
99 </table>
100 <hr>The documentation for this struct was generated from the following file:<ul>
101 <li><a class="el" href="RtAudio_8h-source.html">RtAudio.h</a></ul>
102 <HR>
103
104 <table><tr><td><img src="../images/mcgill.gif" width=165></td>
105   <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>
106 </table>
107
108 </BODY>
109 </HTML>