1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
|
<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
<HR>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Effect.html">Effect</a>
</div>
<div class="contents">
<h1>stk::Effect Class Reference</h1><!-- doxytag: class="stk::Effect" --><!-- doxytag: inherits="stk::Stk" -->
<p>STK abstract effects parent class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Effect_8h_source.html">Effect.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for stk::Effect:</div>
<div class="dynsection">
<div class="center">
<img src="classstk_1_1Effect.png" usemap="#stk::Effect_map" alt=""/>
<map id="stk::Effect_map" name="stk::Effect_map">
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,96,24"/>
<area href="classstk_1_1Chorus.html" alt="stk::Chorus" shape="rect" coords="106,112,202,136"/>
<area href="classstk_1_1Echo.html" alt="stk::Echo" shape="rect" coords="106,168,202,192"/>
<area href="classstk_1_1FreeVerb.html" alt="stk::FreeVerb" shape="rect" coords="106,224,202,248"/>
<area href="classstk_1_1JCRev.html" alt="stk::JCRev" shape="rect" coords="106,280,202,304"/>
<area href="classstk_1_1LentPitShift.html" alt="stk::LentPitShift" shape="rect" coords="106,336,202,360"/>
<area href="classstk_1_1NRev.html" alt="stk::NRev" shape="rect" coords="106,392,202,416"/>
<area href="classstk_1_1PitShift.html" alt="stk::PitShift" shape="rect" coords="106,448,202,472"/>
<area href="classstk_1_1PRCRev.html" alt="stk::PRCRev" shape="rect" coords="106,504,202,528"/>
</map>
</div>
</div>
<p><a href="classstk_1_1Effect-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af6eb27819aed132dd1edf2ce9640893e"></a><!-- doxytag: member="stk::Effect::Effect" ref="af6eb27819aed132dd1edf2ce9640893e" args="(void)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#af6eb27819aed132dd1edf2ce9640893e">Effect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abfdef9ce644c251607acfd183e3d7f7b"></a><!-- doxytag: member="stk::Effect::channelsOut" ref="abfdef9ce644c251607acfd183e3d7f7b" args="(void) const " -->
unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#abfdef9ce644c251607acfd183e3d7f7b">channelsOut</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of output channels for the class. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3d7e2b8942bf7adcc71dfc6dccbb7aa0"></a><!-- doxytag: member="stk::Effect::lastFrame" ref="a3d7e2b8942bf7adcc71dfc6dccbb7aa0" args="(void) const " -->
const <a class="el" href="classstk_1_1StkFrames.html">StkFrames</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#a3d7e2b8942bf7adcc71dfc6dccbb7aa0">lastFrame</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an <a class="el" href="classstk_1_1StkFrames.html" title="An STK class to handle vectorized audio data.">StkFrames</a> reference to the last output sample frame. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0598128d1edc97729951310cc5df5171"></a><!-- doxytag: member="stk::Effect::clear" ref="a0598128d1edc97729951310cc5df5171" args="()=0" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#a0598128d1edc97729951310cc5df5171">clear</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset and clear all internal state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4facbc9b317f18c139577e52fd69c3d"></a><!-- doxytag: member="stk::Effect::setEffectMix" ref="ab4facbc9b317f18c139577e52fd69c3d" args="(StkFloat mix)" -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Effect.html#ab4facbc9b317f18c139577e52fd69c3d">setEffectMix</a> (StkFloat mix)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the mixture of input and "effected" levels in the output (0.0 = input only, 1.0 = effect only). <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>STK abstract effects parent class. </p>
<p>This class provides common functionality for STK effects subclasses. It is general enough to support both monophonic and polyphonic input/output classes.</p>
<p>by Perry R. Cook and Gary P. Scavone, 1995-2012. </p>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Effect_8h_source.html">Effect.h</a></li>
</ul>
</div>
<HR>
<table>
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
<tr><td>©1995-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
