PageRenderTime 308ms CodeModel.GetById 141ms app.highlight 40ms RepoModel.GetById 121ms app.codeStats 0ms

/apidocs/echonest.audio.ModifiedRenderable-class.html

http://echo-nest-remix.googlecode.com/
HTML | 389 lines | 343 code | 22 blank | 24 comment | 0 complexity | c2b48e4aed560bb3ed38066e53cf7068 MD5 | raw file
  1<?xml version="1.0" encoding="ascii"?>
  2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3          "DTD/xhtml1-transitional.dtd">
  4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5<head>
  6  <title>echonest.audio.ModifiedRenderable</title>
  7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8  <script type="text/javascript" src="epydoc.js"></script>
  9</head>
 10
 11<body bgcolor="white" text="black" link="blue" vlink="#204080"
 12      alink="#204080">
 13<!-- ==================== NAVIGATION BAR ==================== -->
 14<table class="navbar" border="0" width="100%" cellpadding="0"
 15       bgcolor="#a0c0ff" cellspacing="0">
 16  <tr valign="middle">
 17
 18  <!-- Tree link -->
 19      <th>&nbsp;&nbsp;&nbsp;<a
 20        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 21
 22  <!-- Index link -->
 23      <th>&nbsp;&nbsp;&nbsp;<a
 24        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 25
 26  <!-- Help link -->
 27      <th>&nbsp;&nbsp;&nbsp;<a
 28        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 29
 30  <!-- Project homepage -->
 31      <th class="navbar" align="right" width="100%">
 32        <table border="0" cellpadding="0" cellspacing="0">
 33          <tr><th class="navbar" align="center"
 34            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
 35          </tr></table></th>
 36  </tr>
 37</table>
 38<table width="100%" cellpadding="0" cellspacing="0">
 39  <tr valign="top">
 40    <td width="100%">
 41      <span class="breadcrumbs">
 42        <a href="echonest-module.html">Package&nbsp;echonest</a> ::
 43        <a href="echonest.audio-module.html">Module&nbsp;audio</a> ::
 44        Class&nbsp;ModifiedRenderable
 45      </span>
 46    </td>
 47    <td>
 48      <table cellpadding="0" cellspacing="0">
 49        <!-- hide/show private -->
 50        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 51    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 52        <tr><td align="right"><span class="options"
 53            >[<a href="frames.html" target="_top">frames</a
 54            >]&nbsp;|&nbsp;<a href="echonest.audio.ModifiedRenderable-class.html"
 55            target="_top">no&nbsp;frames</a>]</span></td></tr>
 56      </table>
 57    </td>
 58  </tr>
 59</table>
 60<!-- ==================== CLASS DESCRIPTION ==================== -->
 61<h1 class="epydoc">Class ModifiedRenderable</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable">source&nbsp;code</a></span></p>
 62<center>
 63
 64</center>
 65<hr />
 66Class that contains any AudioRenderable, but overrides the
 67render() method with nested effects, called sequentially on the
 68result of the preceeding effect.
 69
 70<!-- ==================== INSTANCE METHODS ==================== -->
 71<a name="section-InstanceMethods"></a>
 72<table class="summary" border="1" cellpadding="3"
 73       cellspacing="0" width="100%" bgcolor="white">
 74<tr bgcolor="#70b0f0" class="table-header">
 75  <td colspan="2" class="table-header">
 76    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 77      <tr valign="top">
 78        <td align="left"><span class="table-header">Instance Methods</span></td>
 79        <td align="right" valign="top"
 80         ><span class="options">[<a href="#section-InstanceMethods"
 81         class="privatelink" onclick="toggle_private();"
 82         >hide private</a>]</span></td>
 83      </tr>
 84    </table>
 85  </td>
 86</tr>
 87<tr>
 88    <td width="15%" align="right" valign="top" class="summary">
 89      <span class="summary-type">&nbsp;</span>
 90    </td><td class="summary">
 91      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 92        <tr>
 93          <td><span class="summary-sig"><a href="echonest.audio.ModifiedRenderable-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 94        <span class="summary-sig-arg">original</span>,
 95        <span class="summary-sig-arg">effects</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span><br />
 96      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
 97          <td align="right" valign="top">
 98            <span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.__init__">source&nbsp;code</a></span>
 99            
100          </td>
101        </tr>
102      </table>
103      
104    </td>
105  </tr>
106<tr>
107    <td width="15%" align="right" valign="top" class="summary">
108      <span class="summary-type">&nbsp;</span>
109    </td><td class="summary">
110      <table width="100%" cellpadding="0" cellspacing="0" border="0">
111        <tr>
112          <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">self</span>,
113        <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0.0</span>,
114        <span class="summary-sig-arg">to_audio</span>=<span class="summary-sig-default">None</span>,
115        <span class="summary-sig-arg">with_source</span>=<span class="summary-sig-default">None</span>)</span></td>
116          <td align="right" valign="top">
117            <span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.render">source&nbsp;code</a></span>
118            
119          </td>
120        </tr>
121      </table>
122      
123    </td>
124  </tr>
125<tr>
126    <td width="15%" align="right" valign="top" class="summary">
127      <span class="summary-type">&nbsp;</span>
128    </td><td class="summary">
129      <table width="100%" cellpadding="0" cellspacing="0" border="0">
130        <tr>
131          <td><span class="summary-sig"><a name="toxml"></a><span class="summary-sig-name">toxml</span>(<span class="summary-sig-arg">self</span>,
132        <span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>)</span></td>
133          <td align="right" valign="top">
134            <span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.toxml">source&nbsp;code</a></span>
135            
136          </td>
137        </tr>
138      </table>
139      
140    </td>
141  </tr>
142  <tr>
143    <td colspan="2" class="summary">
144    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
145      <code><a href="echonest.audio.AudioRenderable-class.html#encode">encode</a></code>,
146      <code><a href="echonest.audio.AudioRenderable-class.html#resolve_source">resolve_source</a></code>
147      </p>
148    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
149      <code>__delattr__</code>,
150      <code>__format__</code>,
151      <code>__getattribute__</code>,
152      <code>__hash__</code>,
153      <code>__new__</code>,
154      <code>__reduce__</code>,
155      <code>__reduce_ex__</code>,
156      <code>__repr__</code>,
157      <code>__setattr__</code>,
158      <code>__sizeof__</code>,
159      <code>__str__</code>,
160      <code>__subclasshook__</code>
161      </p>
162    </td>
163  </tr>
164</table>
165<!-- ==================== STATIC METHODS ==================== -->
166<a name="section-StaticMethods"></a>
167<table class="summary" border="1" cellpadding="3"
168       cellspacing="0" width="100%" bgcolor="white">
169<tr bgcolor="#70b0f0" class="table-header">
170  <td colspan="2" class="table-header">
171    <table border="0" cellpadding="0" cellspacing="0" width="100%">
172      <tr valign="top">
173        <td align="left"><span class="table-header">Static Methods</span></td>
174        <td align="right" valign="top"
175         ><span class="options">[<a href="#section-StaticMethods"
176         class="privatelink" onclick="toggle_private();"
177         >hide private</a>]</span></td>
178      </tr>
179    </table>
180  </td>
181</tr>
182  <tr>
183    <td colspan="2" class="summary">
184    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
185      <code><a href="echonest.audio.AudioRenderable-class.html#init_audio_data">init_audio_data</a></code>
186      </p>
187    </td>
188  </tr>
189</table>
190<!-- ==================== PROPERTIES ==================== -->
191<a name="section-Properties"></a>
192<table class="summary" border="1" cellpadding="3"
193       cellspacing="0" width="100%" bgcolor="white">
194<tr bgcolor="#70b0f0" class="table-header">
195  <td colspan="2" class="table-header">
196    <table border="0" cellpadding="0" cellspacing="0" width="100%">
197      <tr valign="top">
198        <td align="left"><span class="table-header">Properties</span></td>
199        <td align="right" valign="top"
200         ><span class="options">[<a href="#section-Properties"
201         class="privatelink" onclick="toggle_private();"
202         >hide private</a>]</span></td>
203      </tr>
204    </table>
205  </td>
206</tr>
207<tr>
208    <td width="15%" align="right" valign="top" class="summary">
209      <span class="summary-type">&nbsp;</span>
210    </td><td class="summary">
211        <a href="echonest.audio.ModifiedRenderable-class.html#duration" class="summary-name">duration</a>
212    </td>
213  </tr>
214<tr>
215    <td width="15%" align="right" valign="top" class="summary">
216      <span class="summary-type">&nbsp;</span>
217    </td><td class="summary">
218        <a href="echonest.audio.ModifiedRenderable-class.html#source" class="summary-name">source</a>
219    </td>
220  </tr>
221<tr>
222    <td width="15%" align="right" valign="top" class="summary">
223      <span class="summary-type">&nbsp;</span>
224    </td><td class="summary">
225        <a href="echonest.audio.ModifiedRenderable-class.html#sources" class="summary-name">sources</a>
226    </td>
227  </tr>
228  <tr>
229    <td colspan="2" class="summary">
230    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
231      <code>__class__</code>
232      </p>
233    </td>
234  </tr>
235</table>
236<!-- ==================== METHOD DETAILS ==================== -->
237<a name="section-MethodDetails"></a>
238<table class="details" border="1" cellpadding="3"
239       cellspacing="0" width="100%" bgcolor="white">
240<tr bgcolor="#70b0f0" class="table-header">
241  <td colspan="2" class="table-header">
242    <table border="0" cellpadding="0" cellspacing="0" width="100%">
243      <tr valign="top">
244        <td align="left"><span class="table-header">Method Details</span></td>
245        <td align="right" valign="top"
246         ><span class="options">[<a href="#section-MethodDetails"
247         class="privatelink" onclick="toggle_private();"
248         >hide private</a>]</span></td>
249      </tr>
250    </table>
251  </td>
252</tr>
253</table>
254<a name="__init__"></a>
255<div>
256<table class="details" border="1" cellpadding="3"
257       cellspacing="0" width="100%" bgcolor="white">
258<tr><td>
259  <table width="100%" cellpadding="0" cellspacing="0" border="0">
260  <tr valign="top"><td>
261  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
262        <span class="sig-arg">original</span>,
263        <span class="sig-arg">effects</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span>
264    <br /><em class="fname">(Constructor)</em>
265  </h3>
266  </td><td align="right" valign="top"
267    ><span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.__init__">source&nbsp;code</a></span>&nbsp;
268    </td>
269  </tr></table>
270  
271  x.__init__(...) initializes x; see x.__class__.__doc__ for signature
272  <dl class="fields">
273    <dt>Overrides:
274        object.__init__
275        <dd><em class="note">(inherited documentation)</em></dd>
276    </dt>
277  </dl>
278</td></tr></table>
279</div>
280<br />
281<!-- ==================== PROPERTY DETAILS ==================== -->
282<a name="section-PropertyDetails"></a>
283<table class="details" border="1" cellpadding="3"
284       cellspacing="0" width="100%" bgcolor="white">
285<tr bgcolor="#70b0f0" class="table-header">
286  <td colspan="2" class="table-header">
287    <table border="0" cellpadding="0" cellspacing="0" width="100%">
288      <tr valign="top">
289        <td align="left"><span class="table-header">Property Details</span></td>
290        <td align="right" valign="top"
291         ><span class="options">[<a href="#section-PropertyDetails"
292         class="privatelink" onclick="toggle_private();"
293         >hide private</a>]</span></td>
294      </tr>
295    </table>
296  </td>
297</tr>
298</table>
299<a name="duration"></a>
300<div>
301<table class="details" border="1" cellpadding="3"
302       cellspacing="0" width="100%" bgcolor="white">
303<tr><td>
304  <h3 class="epydoc">duration</h3>
305  
306  <dl class="fields">
307    <dt>Get Method:</dt>
308    <dd class="value"><span class="summary-sig"><i>unreachable</i>.duration(<span class="summary-sig-arg">self</span>)</span>
309    </dd>
310  </dl>
311</td></tr></table>
312</div>
313<a name="source"></a>
314<div>
315<table class="details" border="1" cellpadding="3"
316       cellspacing="0" width="100%" bgcolor="white">
317<tr><td>
318  <h3 class="epydoc">source</h3>
319  
320  <dl class="fields">
321    <dt>Get Method:</dt>
322    <dd class="value"><span class="summary-sig"><i>unreachable</i>.source(<span class="summary-sig-arg">self</span>)</span>
323    </dd>
324  </dl>
325</td></tr></table>
326</div>
327<a name="sources"></a>
328<div>
329<table class="details" border="1" cellpadding="3"
330       cellspacing="0" width="100%" bgcolor="white">
331<tr><td>
332  <h3 class="epydoc">sources</h3>
333  
334  <dl class="fields">
335    <dt>Get Method:</dt>
336    <dd class="value"><span class="summary-sig"><i>unreachable</i>.sources(<span class="summary-sig-arg">self</span>)</span>
337    </dd>
338  </dl>
339</td></tr></table>
340</div>
341<br />
342<!-- ==================== NAVIGATION BAR ==================== -->
343<table class="navbar" border="0" width="100%" cellpadding="0"
344       bgcolor="#a0c0ff" cellspacing="0">
345  <tr valign="middle">
346
347  <!-- Tree link -->
348      <th>&nbsp;&nbsp;&nbsp;<a
349        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
350
351  <!-- Index link -->
352      <th>&nbsp;&nbsp;&nbsp;<a
353        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
354
355  <!-- Help link -->
356      <th>&nbsp;&nbsp;&nbsp;<a
357        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
358
359  <!-- Project homepage -->
360      <th class="navbar" align="right" width="100%">
361        <table border="0" cellpadding="0" cellspacing="0">
362          <tr><th class="navbar" align="center"
363            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
364          </tr></table></th>
365  </tr>
366</table>
367<table border="0" cellpadding="0" cellspacing="0" width="100%%">
368  <tr>
369    <td align="left" class="footer">
370    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
371    </td>
372    <td align="right" class="footer">
373      <a target="mainFrame" href="http://epydoc.sourceforge.net"
374        >http://epydoc.sourceforge.net</a>
375    </td>
376  </tr>
377</table>
378
379<script type="text/javascript">
380  <!--
381  // Private objects are initially displayed (because if
382  // javascript is turned off then we want them to be
383  // visible); but by default, we want to hide them.  So hide
384  // them unless we have a cookie that says to show them.
385  checkCookie();
386  // -->
387</script>
388</body>
389</html>