← Back to branch summary

~oif-team/ubuntu/natty/qt4-x11/xi2.1

« back to all changes in this revision

Viewing changes to doc/html/phonon-effect.html

  • Committer: Bazaar Package Importer
  • Author(s): Alessandro Ghersi
  • Date: 2009-11-02 18:30:08 UTC
  • mfrom: (1.2.2 upstream)
  • mto: (15.2.5 experimental)
  • mto: This revision was merged to the branch mainline in revision 88.
  • Revision ID: james.westby@ubuntu.com-20091102183008-b6a4gcs128mvfb3m
Tags: upstream-4.6.0~beta1
Import upstream version 4.6.0~beta1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html/phonon-effect.html
2
2
<!DOCTYPE html
3
3
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
 
<!-- /fasttmp/mkdist-qt-4.5.2-1245473805/qt-x11-opensource-src-4.5.2/doc/src/phonon-api.qdoc -->
 
5
<!-- phonon-api.qdoc -->
6
6
<head>
7
 
  <title>Qt 4.5: Effect Class Reference</title>
 
7
  <title>Qt 4.6: Effect Class Reference</title>
8
8
  <link href="classic.css" rel="stylesheet" type="text/css" />
9
9
</head>
10
10
<body>
 
11
<a name="//apple_ref/cpp/cl/Phonon/Effect" />
11
12
<table border="0" cellpadding="0" cellspacing="0" width="100%">
12
13
<tr>
13
 
<td align="left" valign="top" width="32"><a href="http://qtsoftware.com/products/qt"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
14
 
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="namespaces.html"><font color="#004faf">All&nbsp;Namespaces</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
15
 
<td align="right" valign="top" width="230"></td></tr></table><h1 class="title">Effect Class Reference<br /><span class="small-subtitle">(Phonon::Effect)<br />[<a href="phonon.html">Phonon</a> module]</span>
 
14
<td align="left" valign="top" width="32"><a href="http://qt.nokia.com/"><img src="images/qt-logo.png" align="left" border="0" /></a></td>
 
15
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">All&nbsp;Functions</font></a>&nbsp;&middot; <a href="overviews.html"><font color="#004faf">Overviews</font></a></td><td class="searchBar" align="right" valign="center"><form action="http://www.google.com/cse" id="cse-search-box"><div><input type="hidden" name="cx" value="000136343326384750312:dhbxnqlakyu" /><input type="hidden" name="ie" value="UTF-8" /><input type="text" name="q" size="31" /><input type="submit" name="sa" value="Search" /></div></form></td>
 
16
</tr></table><h1 class="title">Effect Class Reference<br /><span class="small-subtitle">(Phonon::Effect)<br />[<a href="phonon.html">Phonon</a> module]</span>
16
17
</h1>
17
18
<p>The Effect class is used to transform audio streams. <a href="#details">More...</a></p>
18
 
<pre> #include &lt;Phonon/Effect&gt;</pre><p>Inherits <a href="qobject.html">QObject</a> and <a href="phonon-medianode.html">MediaNode</a>.</p>
 
19
<pre> #include &lt;Phonon/Effect&gt;</pre><p><b>This class is not part of the Qt GUI Framework Edition.</b></p>
 
20
<p>Inherits <a href="qobject.html">QObject</a> and <a href="phonon-medianode.html">MediaNode</a>.</p>
19
21
<p>This class was introduced in Qt 4.4.</p>
20
22
<ul>
21
23
<li><a href="phonon-effect-members.html">List of all members, including inherited members</a></li>
22
24
</ul>
 
25
<hr />
23
26
<a name="public-functions"></a>
24
 
<h3>Public Functions</h3>
25
 
<ul>
26
 
<li><div class="fn"></div><b><a href="phonon-effect.html#Effect">Effect</a></b> ( const EffectDescription &amp; <i>description</i>, QObject * <i>parent</i> = 0 )</li>
27
 
<li><div class="fn"></div>EffectDescription <b><a href="phonon-effect.html#description">description</a></b> () const</li>
28
 
<li><div class="fn"></div>QVariant <b><a href="phonon-effect.html#parameterValue">parameterValue</a></b> ( const EffectParameter &amp; <i>parameter</i> ) const</li>
29
 
<li><div class="fn"></div>QList&lt;EffectParameter&gt; <b><a href="phonon-effect.html#parameters">parameters</a></b> () const</li>
30
 
<li><div class="fn"></div>void <b><a href="phonon-effect.html#setParameterValue">setParameterValue</a></b> ( const EffectParameter &amp; <i>parameter</i>, const QVariant &amp; <i>value</i> )</li>
31
 
</ul>
32
 
<ul>
33
 
<li><div class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
34
 
<li><div class="fn"></div>3 public functions inherited from <a href="phonon-medianode.html#public-functions">Phonon::MediaNode</a></li>
 
27
<h2>Public Functions</h2>
 
28
<table class="alignedsummary" border="0" cellpadding="0" cellspacing="0" width="100%">
 
29
<tr><td class="memItemLeft" align="right" valign="top"></td><td class="memItemRight" valign="bottom"><b><a href="phonon-effect.html#Effect">Effect</a></b> ( const EffectDescription &amp; <i>description</i>, QObject * <i>parent</i> = 0 )</td></tr>
 
30
<tr><td class="memItemLeft" align="right" valign="top">EffectDescription </td><td class="memItemRight" valign="bottom"><b><a href="phonon-effect.html#description">description</a></b> () const</td></tr>
 
31
<tr><td class="memItemLeft" align="right" valign="top">QVariant </td><td class="memItemRight" valign="bottom"><b><a href="phonon-effect.html#parameterValue">parameterValue</a></b> ( const EffectParameter &amp; <i>parameter</i> ) const</td></tr>
 
32
<tr><td class="memItemLeft" align="right" valign="top">QList&lt;EffectParameter&gt; </td><td class="memItemRight" valign="bottom"><b><a href="phonon-effect.html#parameters">parameters</a></b> () const</td></tr>
 
33
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><b><a href="phonon-effect.html#setParameterValue">setParameterValue</a></b> ( const EffectParameter &amp; <i>parameter</i>, const QVariant &amp; <i>value</i> )</td></tr>
 
34
</table>
 
35
<ul>
 
36
<li><div bar="2" class="fn"></div>29 public functions inherited from <a href="qobject.html#public-functions">QObject</a></li>
 
37
<li><div bar="2" class="fn"></div>3 public functions inherited from <a href="phonon-medianode.html#public-functions">Phonon::MediaNode</a></li>
35
38
</ul>
36
39
<h3>Additional Inherited Members</h3>
37
40
<ul>
66
69
<p>See also <a href="phonon-module.html">Phonon Module</a> and <a href="phonon-effectwidget.html">EffectWidget</a>.</p>
67
70
<hr />
68
71
<h2>Member Function Documentation</h2>
 
72
<a name="//apple_ref/cpp/instm/Phonon::Effect/Effect" />
69
73
<h3 class="fn"><a name="Effect"></a>Effect::Effect ( const <a href="phonon-objectdescription.html#EffectDescription-typedef">EffectDescription</a> &amp; <i>description</i>, <a href="qobject.html">QObject</a> * <i>parent</i> = 0 )</h3>
70
74
<p>Constructs a new effect object with the given <i>description</i> and <i>parent</i> object.</p>
71
75
<p>The <a href="phonon-objectdescription.html#EffectDescription-typedef">EffectDescription</a> object determines the type of the effect.</p>
72
76
<p>See also <a href="phonon-backendcapabilities.html#availableAudioEffects">Phonon::BackendCapabilities::availableAudioEffects</a>().</p>
 
77
<a name="//apple_ref/cpp/instm/Phonon::Effect/description" />
73
78
<h3 class="fn"><a name="description"></a><a href="phonon-objectdescription.html#EffectDescription-typedef">EffectDescription</a> Effect::description () const</h3>
74
79
<p>Returns the description of this effect. This is the same description that was passed to the constructor.</p>
 
80
<a name="//apple_ref/cpp/instm/Phonon::Effect/parameterValue" />
75
81
<h3 class="fn"><a name="parameterValue"></a><a href="qvariant.html">QVariant</a> Effect::parameterValue ( const <a href="phonon-effectparameter.html">EffectParameter</a> &amp; <i>parameter</i> ) const</h3>
76
82
<p>Returns the value of the given effect <i>parameter</i>. You can fetch the available parameters for an effect with <a href="phonon-effect.html#parameters">parameters</a>().</p>
77
83
<p>See also <a href="phonon-effect.html#setParameterValue">setParameterValue</a>() and <a href="phonon-effectparameter.html">EffectParameter</a>.</p>
 
84
<a name="//apple_ref/cpp/instm/Phonon::Effect/parameters" />
78
85
<h3 class="fn"><a name="parameters"></a><a href="qlist.html">QList</a>&lt;<a href="phonon-effectparameter.html">EffectParameter</a>&gt; Effect::parameters () const</h3>
79
86
<p>Returns a list of parameters that this effect provides to control its behavior.</p>
80
87
<p>See also <a href="phonon-effectparameter.html">EffectParameter</a> and <a href="phonon-effectwidget.html">EffectWidget</a>.</p>
 
88
<a name="//apple_ref/cpp/instm/Phonon::Effect/setParameterValue" />
81
89
<h3 class="fn"><a name="setParameterValue"></a>void Effect::setParameterValue ( const <a href="phonon-effectparameter.html">EffectParameter</a> &amp; <i>parameter</i>, const <a href="qvariant.html">QVariant</a> &amp; <i>value</i> )</h3>
82
90
<p>Sets the given effect <i>parameter</i> to the specified <i>value</i>.</p>
83
91
<p>Parameters for an effect are returned by <a href="phonon-effect.html#parameters">parameters</a>(). You can check which <a href="qvariant.html#Type-enum">QVariant::Type</a> an <a href="phonon-effectparameter.html">EffectParameter</a> takes with the <a href="phonon-effectparameter.html#type">EffectParameter::type</a>() function.</p>
84
92
<p>See also <a href="phonon-effect.html#parameterValue">parameterValue</a>() and <a href="phonon-effectparameter.html">EffectParameter</a>.</p>
85
93
<p /><address><hr /><div align="center">
86
94
<table width="100%" cellspacing="0" border="0"><tr class="address">
87
 
<td width="30%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
88
 
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
89
 
<td width="30%" align="right"><div align="right">Qt 4.5.2</div></td>
90
 
</tr></table></div></address></body>
 
95
<td width="40%" align="left">Copyright &copy; 2009 Nokia Corporation and/or its subsidiary(-ies)</td>
 
96
<td width="20%" align="center"><a href="trademarks.html">Trademarks</a></td>
 
97
<td width="40%" align="right"><div align="right">Qt 4.6.0</div></td>
 
98
<script type="text/javascript" src="http://www.google.com/jsapi"></script><script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script><script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script><script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script></tr></table></div></address></body>
91
99
</html>