~ubuntu-branches/ubuntu/quantal/qtmobility/quantal

« back to all changes in this revision

Viewing changes to doc/html/qaudio.html

  • Committer: Bazaar Package Importer
  • Author(s): Jonathan Riddell
  • Date: 2010-11-16 16:18:07 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20101116161807-k2dzt2nyse975r3l
Tags: 1.1.0-0ubuntu1
* New upstream release
* Syncronise with Debian, no remaining changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="UTF-8"?>
2
 
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
 
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
4
 
<head>
5
 
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
 
<!-- qaudio.cpp -->
7
 
  <title>Qt Mobility 1.1: QAudio Namespace</title>
8
 
  <link rel="stylesheet" type="text/css" href="style/style.css"
9
 
 />  <!--[if IE]>
10
 
<meta name="MSSmartTagsPreventParsing" content="true">
11
 
<meta http-equiv="imagetoolbar" content="no">
12
 
<![endif]-->
13
 
<!--[if lt IE 7]>
14
 
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
15
 
<![endif]-->
16
 
<!--[if IE 7]>
17
 
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
18
 
<![endif]-->
19
 
<!--[if IE 8]>
20
 
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
21
 
<![endif]-->
22
 
  <script src="scripts/jquery.js" type="text/javascript"></script>
23
 
  <script src="scripts/functions.js" type="text/javascript"></script>
24
 
 <script src="./scripts/superfish.js" type="text/javascript"></script>
25
 
 <script src="./scripts/narrow.js" type="text/javascript"></script>
26
 
  <link rel="stylesheet" type="text/css" href="style/superfish.css" />  <link rel="stylesheet" type="text/css" href="style/narrow.css" /></head>
27
 
<body class="" onload="CheckEmptyAndLoadList();">
28
 
 <div class="header" id="qtdocheader">
29
 
    <div class="content"> 
30
 
    <div id="nav-logo">
31
 
      <a href="index.html">Home</a></div>
32
 
    <a href="index.html" class="qtref"><span>Qt Mobility Reference Documentation</span></a>
33
 
                <div id="narrowsearch"><form onsubmit="return false;" action="" id="qtdocsearchTop">
34
 
                <fieldset>
35
 
                <input type="text" value="" id="pageType2" name="searchstring"/>
36
 
                 </fieldset>
37
 
                </form></div>
38
 
    <div id="nav-topright">
39
 
      <ul>
40
 
        <li class="nav-topright-home"><a href="http://qt.nokia.com/">Qt HOME</a></li>
41
 
        <li class="nav-topright-dev"><a href="http://developer.qt.nokia.com/">DEV</a></li>
42
 
        <li class="nav-topright-labs"><a href="http://labs.qt.nokia.com/blogs/">LABS</a></li>
43
 
        <li class="nav-topright-doc nav-topright-doc-active"><a href="http://doc.qt.nokia.com/">
44
 
          DOC</a></li>
45
 
        <li class="nav-topright-blog"><a href="http://blog.qt.nokia.com/">BLOG</a></li>
46
 
      </ul>
47
 
    </div>
48
 
    <div id="shortCut">
49
 
      <ul>
50
 
        <li class="shortCut-topleft-inactive"><span><a href="index.html">Mobility 1.1 BETA</a></span></li>
51
 
        <li class="shortCut-topleft-active"><a href="http://doc.qt.nokia.com">ALL VERSIONS        </a></li>
52
 
      </ul>
53
 
     </div>
54
 
 <ul class="sf-menu sf-js-enabled sf-shadow" id="narrowmenu"> 
55
 
                 <li><a href="#">API Lookup</a> 
56
 
                         <ul id="topmenuLook"> 
57
 
                           <li><a href="classes.html">Class index</a></li> 
58
 
                          <li><a href="functions.html">Function index</a></li> 
59
 
                           <li><a href="modules.html">Modules</a></li> 
60
 
                           </ul> 
61
 
                 </li> 
62
 
                 <li><a href="#">Examples</a> 
63
 
                         <ul id="topmenuexample"> 
64
 
                                 <li><a href="all-examples.html">Examples</a></li> 
65
 
                         </ul> 
66
 
                 </li> 
67
 
 </ul> 
68
 
    </div>
69
 
  </div>
70
 
  <div class="wrapper">
71
 
    <div class="hd">
72
 
      <span></span>
73
 
    </div>
74
 
    <div class="bd group">
75
 
      <div class="sidebar">
76
 
        <div class="searchlabel">
77
 
          Search index:</div>
78
 
        <div class="search">
79
 
          <form id="qtdocsearch" action="" onsubmit="return false;">
80
 
            <fieldset>
81
 
              <input type="text" name="searchstring" id="pageType" value="" />
82
 
            </fieldset>
83
 
          </form>
84
 
        </div>
85
 
        <div class="box first bottombar" id="lookup">
86
 
          <h2 title="API Lookup"><span></span>
87
 
            API Lookup</h2>
88
 
          <div  id="list001" class="list">
89
 
          <ul id="ul001" >
90
 
              <li class="defaultLink"><a href="classes.html">Class index</a></li>
91
 
              <li class="defaultLink"><a href="functions.html">Function index</a></li>
92
 
              <li class="defaultLink"><a href="modules.html">Modules</a></li>
93
 
              <li class="defaultLink"><a href="index.html#platform-compatibility">Platform Compatibility</a></li>
94
 
              <li class="defaultLink"><a href="qml-plugins.html">QML Plugins</a></li>
95
 
            </ul> 
96
 
          </div>
97
 
        </div>
98
 
        <div class="box bottombar" id="topics">
99
 
          <h2 title="Qt Topics"><span></span>
100
 
            Qt Topics</h2>
101
 
          <div id="list002" class="list">
102
 
            <ul id="ul002" >
103
 
              <li class="defaultLink"><a href="http://doc.qt.nokia.com/4.7-snapshot/">Qt 4.7</a></li>
104
 
              <li class="defaultLink"><a href="http://doc.qt.nokia.com/4.7-snapshot/qt-basic-concepts.html">Basic Qt architecture</a></li>
105
 
              <li class="defaultLink"><a href="http://doc.qt.nokia.com/4.7-snapshot/declarativeui.html">Device UI's &amp; Qt Quick</a></li>
106
 
              <li class="defaultLink"><a href="http://doc.qt.nokia.com/4.7-snapshot/qt-gui-concepts.html">Desktop UI components</a></li>
107
 
              <li class="defaultLink"><a href="http://doc.qt.nokia.com/4.7-snapshot/platform-specific.html">Platform-specific info</a></li>
108
 
            </ul>  
109
 
          </div>
110
 
        </div>
111
 
        <div class="box" id="examples">
112
 
          <h2 title="Examples"><span></span>
113
 
            Examples</h2>
114
 
          <div id="list003" class="list">
115
 
        <ul id="ul003">
116
 
              <li class="defaultLink"><a href="all-examples.html">Examples</a></li>
117
 
            </ul> 
118
 
          </div>
119
 
        </div>
120
 
      </div>
121
 
      <div class="wrap">
122
 
        <div class="toolbar">
123
 
          <div class="breadcrumb toolblock">
124
 
            <ul>
125
 
              <li class="first"><a href="index.html">Home</a></li>
126
 
              <!--  Bread crumbs goes here -->
127
 
              <li><a href="namespaces.html">Namespaces</a></li>              <li>QAudio Namespace</li>            </ul>
128
 
          </div>
129
 
          <div class="toolbuttons toolblock">
130
 
            <ul>
131
 
              <li id="smallA" class="t_button">A</li>
132
 
              <li id="medA" class="t_button active">A</li>
133
 
              <li id="bigA" class="t_button">A</li>
134
 
              <li id="print" class="t_button"><a href="javascript:this.print();">
135
 
                <span>Print</span></a></li>
136
 
            </ul>
137
 
          </div>
138
 
        </div>
139
 
        <div class="content">
140
 
<div class="toc">
141
 
<h3>Contents</h3>
142
 
<ul>
143
 
</ul>
144
 
</div>
145
 
<h1 class="title">QAudio Namespace</h1>
146
 
<p>The QAudio namespace contains enums used by the audio classes. <a href="#details">More...</a></p>
147
 
<pre class="highlightedCode brush: cpp"> #include &lt;QAudio&gt;</pre><ul>
148
 
</ul>
149
 
<hr />
150
 
<a name="types"></a>
151
 
<h2>Types</h2>
152
 
<table class="alignedsummary">
153
 
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qaudio.html#Error-enum">Error</a></b> { NoError, OpenError, IOError, UnderrunError, FatalError }</td></tr>
154
 
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qaudio.html#Mode-enum">Mode</a></b> { AudioOutput, AudioInput }</td></tr>
155
 
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qaudio.html#State-enum">State</a></b> { ActiveState, SuspendedState, StoppedState, IdleState }</td></tr>
156
 
</table>
157
 
<a name="details"></a>
158
 
<hr />
159
 
<div class="descr"/>
160
 
<h2>Detailed Description</h2>
161
 
<p>The QAudio namespace contains enums used by the audio classes.</p>
162
 
</div>
163
 
<hr />
164
 
<div class="types"/>
165
 
<h2>Type Documentation</h2>
166
 
<h3 class="fn"><a name="Error-enum"></a>enum QAudio::Error</h3>
167
 
<table class="valuelist"><tr class="odd"><tr><th>Constant</th><th>Value</th><th>Description</th></tr>
168
 
<tr><td  class="topAlign"><tt>QAudio::NoError</tt></td><td class=" topAlign"><tt>0</tt></td><td  class="topAlign">No errors have occurred</td></tr>
169
 
<tr><td  class="topAlign"><tt>QAudio::OpenError</tt></td><td class=" topAlign"><tt>1</tt></td><td  class="topAlign">An error opening the audio device</td></tr>
170
 
<tr><td  class="topAlign"><tt>QAudio::IOError</tt></td><td class=" topAlign"><tt>2</tt></td><td  class="topAlign">An error occurred during read/write of audio device</td></tr>
171
 
<tr><td  class="topAlign"><tt>QAudio::UnderrunError</tt></td><td class=" topAlign"><tt>3</tt></td><td  class="topAlign">Audio data is not being fed to the audio device at a fast enough rate</td></tr>
172
 
<tr><td  class="topAlign"><tt>QAudio::FatalError</tt></td><td class=" topAlign"><tt>4</tt></td><td  class="topAlign">A non-recoverable error has occurred, the audio device is not usable at this time.</td></tr>
173
 
</table>
174
 
<h3 class="fn"><a name="Mode-enum"></a>enum QAudio::Mode</h3>
175
 
<table class="valuelist"><tr class="odd"><tr><th>Constant</th><th>Value</th><th>Description</th></tr>
176
 
<tr><td  class="topAlign"><tt>QAudio::AudioOutput</tt></td><td class=" topAlign"><tt>1</tt></td><td  class="topAlign">audio output device</td></tr>
177
 
<tr><td  class="topAlign"><tt>QAudio::AudioInput</tt></td><td class=" topAlign"><tt>0</tt></td><td  class="topAlign">audio input device</td></tr>
178
 
</table>
179
 
<h3 class="fn"><a name="State-enum"></a>enum QAudio::State</h3>
180
 
<table class="valuelist"><tr class="odd"><tr><th>Constant</th><th>Value</th><th>Description</th></tr>
181
 
<tr><td  class="topAlign"><tt>QAudio::ActiveState</tt></td><td class=" topAlign"><tt>0</tt></td><td  class="topAlign">Audio data is being processed, this state is set after start() is called and while audio data is available to be processed.</td></tr>
182
 
<tr><td  class="topAlign"><tt>QAudio::SuspendedState</tt></td><td class=" topAlign"><tt>1</tt></td><td  class="topAlign">The audio device is in a suspended state, this state will only be entered after suspend() is called.</td></tr>
183
 
<tr><td  class="topAlign"><tt>QAudio::StoppedState</tt></td><td class=" topAlign"><tt>2</tt></td><td  class="topAlign">The audio device is closed, not processing any audio data</td></tr>
184
 
<tr><td  class="topAlign"><tt>QAudio::IdleState</tt></td><td class=" topAlign"><tt>3</tt></td><td  class="topAlign">The QIODevice passed in has no data and audio system's buffer is empty, this state is set after start() is called and while no audio data is available to be processed.</td></tr>
185
 
</table>
186
 
</div>
187
 
        <!-- /div -->
188
 
        <div class="feedback t_button">
189
 
          [+] Documentation Feedback</div>
190
 
      </div>
191
 
    </div>
192
 
    <div class="ft">
193
 
      <span></span>
194
 
    </div>
195
 
  </div> 
196
 
  </div> 
197
 
  <div class="footer">
198
 
    <p>
199
 
      <acronym title="Copyright">&copy;</acronym> 2008-2010 Nokia Corporation and/or its
200
 
      subsidiaries. Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
201
 
      in Finland and/or other countries worldwide.</p>
202
 
    <p>
203
 
      All other trademarks are property of their respective owners. <a title="Privacy Policy"
204
 
        href="http://qt.nokia.com/about/privacy-policy">Privacy Policy</a></p>
205
 
  </div>
206
 
  <div id="feedbackBox">
207
 
      <div id="feedcloseX" class="feedclose t_button">X</div>
208
 
    <form id="feedform" action="http://doc.qt.nokia.com/docFeedbck/feedback.php" method="get">
209
 
      <p id="noteHead">Thank you for giving your feedback.</p> <div class="note"><p>Make sure it is related to this specific page. For more general bugs and 
210
 
      requests, please use the <a href="http://bugreports.qt.nokia.com/secure/Dashboard.jspa">Qt Bug Tracker</a>.</p></div>
211
 
      <p><textarea id="feedbox" name="feedText" rows="5" cols="40"></textarea></p>
212
 
      <p><input id="feedsubmit" class="feedclose" type="submit" name="feedback" /></p>
213
 
    </form>
214
 
  </div>
215
 
  <div id="blurpage">
216
 
  </div>
217
 
  </div>
218
 
  <script src="scripts/functions.js" type="text/javascript"></script>
219
 
</body>
220
 
</html>