PageRenderTime 860ms CodeModel.GetById 179ms app.highlight 378ms RepoModel.GetById 206ms app.codeStats 0ms

/apidocs/echonest.modify.Modify-class.html

http://echo-nest-remix.googlecode.com/
HTML | 424 lines | 370 code | 32 blank | 22 comment | 0 complexity | 770f0f438258bf226cd1a4c90cefb174 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.modify.Modify</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.modify-module.html">Module&nbsp;modify</a> ::
 44        Class&nbsp;Modify
 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.modify.Modify-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 Modify</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.modify-pysrc.html#Modify">source&nbsp;code</a></span></p>
 62<center>
 63
 64</center>
 65<hr />
 66<!-- ==================== INSTANCE METHODS ==================== -->
 67<a name="section-InstanceMethods"></a>
 68<table class="summary" border="1" cellpadding="3"
 69       cellspacing="0" width="100%" bgcolor="white">
 70<tr bgcolor="#70b0f0" class="table-header">
 71  <td colspan="2" class="table-header">
 72    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 73      <tr valign="top">
 74        <td align="left"><span class="table-header">Instance Methods</span></td>
 75        <td align="right" valign="top"
 76         ><span class="options">[<a href="#section-InstanceMethods"
 77         class="privatelink" onclick="toggle_private();"
 78         >hide private</a>]</span></td>
 79      </tr>
 80    </table>
 81  </td>
 82</tr>
 83<tr>
 84    <td width="15%" align="right" valign="top" class="summary">
 85      <span class="summary-type">&nbsp;</span>
 86    </td><td class="summary">
 87      <table width="100%" cellpadding="0" cellspacing="0" border="0">
 88        <tr>
 89          <td><span class="summary-sig"><a href="echonest.modify.Modify-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
 90        <span class="summary-sig-arg">sampleRate</span>=<span class="summary-sig-default">44100</span>,
 91        <span class="summary-sig-arg">numChannels</span>=<span class="summary-sig-default">1</span>,
 92        <span class="summary-sig-arg">blockSize</span>=<span class="summary-sig-default">10000</span>)</span><br />
 93      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
 94          <td align="right" valign="top">
 95            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.__init__">source&nbsp;code</a></span>
 96            
 97          </td>
 98        </tr>
 99      </table>
100      
101    </td>
102  </tr>
103<tr>
104    <td width="15%" align="right" valign="top" class="summary">
105      <span class="summary-type">&nbsp;</span>
106    </td><td class="summary">
107      <table width="100%" cellpadding="0" cellspacing="0" border="0">
108        <tr>
109          <td><span class="summary-sig"><a name="doInBlocks"></a><span class="summary-sig-name">doInBlocks</span>(<span class="summary-sig-arg">self</span>,
110        <span class="summary-sig-arg">f</span>,
111        <span class="summary-sig-arg">in_data</span>,
112        <span class="summary-sig-arg">arg</span>)</span></td>
113          <td align="right" valign="top">
114            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.doInBlocks">source&nbsp;code</a></span>
115            
116          </td>
117        </tr>
118      </table>
119      
120    </td>
121  </tr>
122<tr>
123    <td width="15%" align="right" valign="top" class="summary">
124      <span class="summary-type">&nbsp;</span>
125    </td><td class="summary">
126      <table width="100%" cellpadding="0" cellspacing="0" border="0">
127        <tr>
128          <td><span class="summary-sig"><a name="processAudio"></a><span class="summary-sig-name">processAudio</span>(<span class="summary-sig-arg">self</span>,
129        <span class="summary-sig-arg">f</span>,
130        <span class="summary-sig-arg">data</span>,
131        <span class="summary-sig-arg">arg</span>)</span></td>
132          <td align="right" valign="top">
133            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.processAudio">source&nbsp;code</a></span>
134            
135          </td>
136        </tr>
137      </table>
138      
139    </td>
140  </tr>
141<tr>
142    <td width="15%" align="right" valign="top" class="summary">
143      <span class="summary-type">&nbsp;</span>
144    </td><td class="summary">
145      <table width="100%" cellpadding="0" cellspacing="0" border="0">
146        <tr>
147          <td><span class="summary-sig"><a name="shiftRate"></a><span class="summary-sig-name">shiftRate</span>(<span class="summary-sig-arg">self</span>,
148        <span class="summary-sig-arg">audio_data</span>,
149        <span class="summary-sig-arg">ratio</span>=<span class="summary-sig-default">1</span>)</span></td>
150          <td align="right" valign="top">
151            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftRate">source&nbsp;code</a></span>
152            
153          </td>
154        </tr>
155      </table>
156      
157    </td>
158  </tr>
159<tr>
160    <td width="15%" align="right" valign="top" class="summary">
161      <span class="summary-type">&nbsp;</span>
162    </td><td class="summary">
163      <table width="100%" cellpadding="0" cellspacing="0" border="0">
164        <tr>
165          <td><span class="summary-sig"><a name="shiftTempo"></a><span class="summary-sig-name">shiftTempo</span>(<span class="summary-sig-arg">self</span>,
166        <span class="summary-sig-arg">audio_data</span>,
167        <span class="summary-sig-arg">ratio</span>)</span></td>
168          <td align="right" valign="top">
169            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftTempo">source&nbsp;code</a></span>
170            
171          </td>
172        </tr>
173      </table>
174      
175    </td>
176  </tr>
177<tr>
178    <td width="15%" align="right" valign="top" class="summary">
179      <span class="summary-type">&nbsp;</span>
180    </td><td class="summary">
181      <table width="100%" cellpadding="0" cellspacing="0" border="0">
182        <tr>
183          <td><span class="summary-sig"><a name="shiftRateChange"></a><span class="summary-sig-name">shiftRateChange</span>(<span class="summary-sig-arg">self</span>,
184        <span class="summary-sig-arg">audio_data</span>,
185        <span class="summary-sig-arg">percent</span>)</span></td>
186          <td align="right" valign="top">
187            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftRateChange">source&nbsp;code</a></span>
188            
189          </td>
190        </tr>
191      </table>
192      
193    </td>
194  </tr>
195<tr>
196    <td width="15%" align="right" valign="top" class="summary">
197      <span class="summary-type">&nbsp;</span>
198    </td><td class="summary">
199      <table width="100%" cellpadding="0" cellspacing="0" border="0">
200        <tr>
201          <td><span class="summary-sig"><a name="shiftTempoChange"></a><span class="summary-sig-name">shiftTempoChange</span>(<span class="summary-sig-arg">self</span>,
202        <span class="summary-sig-arg">audio_data</span>,
203        <span class="summary-sig-arg">percent</span>)</span></td>
204          <td align="right" valign="top">
205            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftTempoChange">source&nbsp;code</a></span>
206            
207          </td>
208        </tr>
209      </table>
210      
211    </td>
212  </tr>
213<tr>
214    <td width="15%" align="right" valign="top" class="summary">
215      <span class="summary-type">&nbsp;</span>
216    </td><td class="summary">
217      <table width="100%" cellpadding="0" cellspacing="0" border="0">
218        <tr>
219          <td><span class="summary-sig"><a name="shiftPitchSemiTones"></a><span class="summary-sig-name">shiftPitchSemiTones</span>(<span class="summary-sig-arg">self</span>,
220        <span class="summary-sig-arg">audio_data</span>,
221        <span class="summary-sig-arg">semitones</span>=<span class="summary-sig-default">0</span>)</span></td>
222          <td align="right" valign="top">
223            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftPitchSemiTones">source&nbsp;code</a></span>
224            
225          </td>
226        </tr>
227      </table>
228      
229    </td>
230  </tr>
231<tr>
232    <td width="15%" align="right" valign="top" class="summary">
233      <span class="summary-type">&nbsp;</span>
234    </td><td class="summary">
235      <table width="100%" cellpadding="0" cellspacing="0" border="0">
236        <tr>
237          <td><span class="summary-sig"><a name="shiftPitchOctaves"></a><span class="summary-sig-name">shiftPitchOctaves</span>(<span class="summary-sig-arg">self</span>,
238        <span class="summary-sig-arg">audio_data</span>,
239        <span class="summary-sig-arg">octaves</span>=<span class="summary-sig-default">0</span>)</span></td>
240          <td align="right" valign="top">
241            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftPitchOctaves">source&nbsp;code</a></span>
242            
243          </td>
244        </tr>
245      </table>
246      
247    </td>
248  </tr>
249<tr>
250    <td width="15%" align="right" valign="top" class="summary">
251      <span class="summary-type">&nbsp;</span>
252    </td><td class="summary">
253      <table width="100%" cellpadding="0" cellspacing="0" border="0">
254        <tr>
255          <td><span class="summary-sig"><a name="shiftPitch"></a><span class="summary-sig-name">shiftPitch</span>(<span class="summary-sig-arg">self</span>,
256        <span class="summary-sig-arg">audio_data</span>,
257        <span class="summary-sig-arg">ratio</span>=<span class="summary-sig-default">1</span>)</span></td>
258          <td align="right" valign="top">
259            <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftPitch">source&nbsp;code</a></span>
260            
261          </td>
262        </tr>
263      </table>
264      
265    </td>
266  </tr>
267  <tr>
268    <td colspan="2" class="summary">
269    <p class="indent-wrapped-lines"><b>Inherited from <code>soundtouch.SoundTouch</code></b>:
270      <code>__new__</code>,
271      <code>clear</code>,
272      <code>flush</code>,
273      <code>getSetting</code>,
274      <code>isEmpty</code>,
275      <code>numSamples</code>,
276      <code>numUnprocessedSamples</code>,
277      <code>putSamples</code>,
278      <code>receiveSamples</code>,
279      <code>setChannels</code>,
280      <code>setPitch</code>,
281      <code>setPitchOctaves</code>,
282      <code>setPitchSemiTones</code>,
283      <code>setRate</code>,
284      <code>setRateChange</code>,
285      <code>setSampleRate</code>,
286      <code>setSetting</code>,
287      <code>setTempo</code>,
288      <code>setTempoChange</code>
289      </p>
290    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
291      <code>__delattr__</code>,
292      <code>__format__</code>,
293      <code>__getattribute__</code>,
294      <code>__hash__</code>,
295      <code>__reduce__</code>,
296      <code>__reduce_ex__</code>,
297      <code>__repr__</code>,
298      <code>__setattr__</code>,
299      <code>__sizeof__</code>,
300      <code>__str__</code>,
301      <code>__subclasshook__</code>
302      </p>
303    </td>
304  </tr>
305</table>
306<!-- ==================== PROPERTIES ==================== -->
307<a name="section-Properties"></a>
308<table class="summary" border="1" cellpadding="3"
309       cellspacing="0" width="100%" bgcolor="white">
310<tr bgcolor="#70b0f0" class="table-header">
311  <td colspan="2" class="table-header">
312    <table border="0" cellpadding="0" cellspacing="0" width="100%">
313      <tr valign="top">
314        <td align="left"><span class="table-header">Properties</span></td>
315        <td align="right" valign="top"
316         ><span class="options">[<a href="#section-Properties"
317         class="privatelink" onclick="toggle_private();"
318         >hide private</a>]</span></td>
319      </tr>
320    </table>
321  </td>
322</tr>
323  <tr>
324    <td colspan="2" class="summary">
325    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
326      <code>__class__</code>
327      </p>
328    </td>
329  </tr>
330</table>
331<!-- ==================== METHOD DETAILS ==================== -->
332<a name="section-MethodDetails"></a>
333<table class="details" border="1" cellpadding="3"
334       cellspacing="0" width="100%" bgcolor="white">
335<tr bgcolor="#70b0f0" class="table-header">
336  <td colspan="2" class="table-header">
337    <table border="0" cellpadding="0" cellspacing="0" width="100%">
338      <tr valign="top">
339        <td align="left"><span class="table-header">Method Details</span></td>
340        <td align="right" valign="top"
341         ><span class="options">[<a href="#section-MethodDetails"
342         class="privatelink" onclick="toggle_private();"
343         >hide private</a>]</span></td>
344      </tr>
345    </table>
346  </td>
347</tr>
348</table>
349<a name="__init__"></a>
350<div>
351<table class="details" border="1" cellpadding="3"
352       cellspacing="0" width="100%" bgcolor="white">
353<tr><td>
354  <table width="100%" cellpadding="0" cellspacing="0" border="0">
355  <tr valign="top"><td>
356  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
357        <span class="sig-arg">sampleRate</span>=<span class="sig-default">44100</span>,
358        <span class="sig-arg">numChannels</span>=<span class="sig-default">1</span>,
359        <span class="sig-arg">blockSize</span>=<span class="sig-default">10000</span>)</span>
360    <br /><em class="fname">(Constructor)</em>
361  </h3>
362  </td><td align="right" valign="top"
363    ><span class="codelink"><a href="echonest.modify-pysrc.html#Modify.__init__">source&nbsp;code</a></span>&nbsp;
364    </td>
365  </tr></table>
366  
367  x.__init__(...) initializes x; see x.__class__.__doc__ for signature
368  <dl class="fields">
369    <dt>Overrides:
370        object.__init__
371        <dd><em class="note">(inherited documentation)</em></dd>
372    </dt>
373  </dl>
374</td></tr></table>
375</div>
376<br />
377<!-- ==================== NAVIGATION BAR ==================== -->
378<table class="navbar" border="0" width="100%" cellpadding="0"
379       bgcolor="#a0c0ff" cellspacing="0">
380  <tr valign="middle">
381
382  <!-- Tree link -->
383      <th>&nbsp;&nbsp;&nbsp;<a
384        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
385
386  <!-- Index link -->
387      <th>&nbsp;&nbsp;&nbsp;<a
388        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
389
390  <!-- Help link -->
391      <th>&nbsp;&nbsp;&nbsp;<a
392        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
393
394  <!-- Project homepage -->
395      <th class="navbar" align="right" width="100%">
396        <table border="0" cellpadding="0" cellspacing="0">
397          <tr><th class="navbar" align="center"
398            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
399          </tr></table></th>
400  </tr>
401</table>
402<table border="0" cellpadding="0" cellspacing="0" width="100%%">
403  <tr>
404    <td align="left" class="footer">
405    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
406    </td>
407    <td align="right" class="footer">
408      <a target="mainFrame" href="http://epydoc.sourceforge.net"
409        >http://epydoc.sourceforge.net</a>
410    </td>
411  </tr>
412</table>
413
414<script type="text/javascript">
415  <!--
416  // Private objects are initially displayed (because if
417  // javascript is turned off then we want them to be
418  // visible); but by default, we want to hide them.  So hide
419  // them unless we have a cookie that says to show them.
420  checkCookie();
421  // -->
422</script>
423</body>
424</html>