PageRenderTime 44ms CodeModel.GetById 19ms app.highlight 19ms RepoModel.GetById 1ms app.codeStats 0ms

/apidocs/echonest.action-module.html

http://echo-nest-remix.googlecode.com/
HTML | 376 lines | 329 code | 24 blank | 23 comment | 0 complexity | 84b8cda09e3ccbb714a4ff5b0501592f 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.action</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        Module&nbsp;action
 44      </span>
 45    </td>
 46    <td>
 47      <table cellpadding="0" cellspacing="0">
 48        <!-- hide/show private -->
 49        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 50    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 51        <tr><td align="right"><span class="options"
 52            >[<a href="frames.html" target="_top">frames</a
 53            >]&nbsp;|&nbsp;<a href="echonest.action-module.html"
 54            target="_top">no&nbsp;frames</a>]</span></td></tr>
 55      </table>
 56    </td>
 57  </tr>
 58</table>
 59<!-- ==================== MODULE DESCRIPTION ==================== -->
 60<h1 class="epydoc">Module action</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.action-pysrc.html">source&nbsp;code</a></span></p>
 61<p>action.py</p>
 62<p>Created by Tristan Jehan and Jason Sundram.</p>
 63
 64<!-- ==================== CLASSES ==================== -->
 65<a name="section-Classes"></a>
 66<table class="summary" border="1" cellpadding="3"
 67       cellspacing="0" width="100%" bgcolor="white">
 68<tr bgcolor="#70b0f0" class="table-header">
 69  <td colspan="2" class="table-header">
 70    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 71      <tr valign="top">
 72        <td align="left"><span class="table-header">Classes</span></td>
 73        <td align="right" valign="top"
 74         ><span class="options">[<a href="#section-Classes"
 75         class="privatelink" onclick="toggle_private();"
 76         >hide private</a>]</span></td>
 77      </tr>
 78    </table>
 79  </td>
 80</tr>
 81<tr>
 82    <td width="15%" align="right" valign="top" class="summary">
 83      <span class="summary-type">&nbsp;</span>
 84    </td><td class="summary">
 85        <a href="echonest.action.Playback-class.html" class="summary-name">Playback</a><br />
 86      A snippet of the given track with start and duration.
 87    </td>
 88  </tr>
 89<tr>
 90    <td width="15%" align="right" valign="top" class="summary">
 91      <span class="summary-type">&nbsp;</span>
 92    </td><td class="summary">
 93        <a href="echonest.action.Fadeout-class.html" class="summary-name">Fadeout</a><br />
 94      Fadeout
 95    </td>
 96  </tr>
 97<tr>
 98    <td width="15%" align="right" valign="top" class="summary">
 99      <span class="summary-type">&nbsp;</span>
100    </td><td class="summary">
101        <a href="echonest.action.Fadein-class.html" class="summary-name">Fadein</a><br />
102      Fadein
103    </td>
104  </tr>
105<tr>
106    <td width="15%" align="right" valign="top" class="summary">
107      <span class="summary-type">&nbsp;</span>
108    </td><td class="summary">
109        <a href="echonest.action.Edit-class.html" class="summary-name">Edit</a><br />
110      Refer to a snippet of audio
111    </td>
112  </tr>
113<tr>
114    <td width="15%" align="right" valign="top" class="summary">
115      <span class="summary-type">&nbsp;</span>
116    </td><td class="summary">
117        <a href="echonest.action.Crossfade-class.html" class="summary-name">Crossfade</a><br />
118      Crossfades between two tracks, at the start points specified, for the given duration
119    </td>
120  </tr>
121<tr>
122    <td width="15%" align="right" valign="top" class="summary">
123      <span class="summary-type">&nbsp;</span>
124    </td><td class="summary">
125        <a href="echonest.action.Jump-class.html" class="summary-name">Jump</a><br />
126      Move from one point
127    </td>
128  </tr>
129<tr>
130    <td width="15%" align="right" valign="top" class="summary">
131      <span class="summary-type">&nbsp;</span>
132    </td><td class="summary">
133        <a href="echonest.action.Blend-class.html" class="summary-name">Blend</a><br />
134      Mix together two lists of beats
135    </td>
136  </tr>
137<tr>
138    <td width="15%" align="right" valign="top" class="summary">
139      <span class="summary-type">&nbsp;</span>
140    </td><td class="summary">
141        <a href="echonest.action.Crossmatch-class.html" class="summary-name">Crossmatch</a><br />
142      Makes a beat-matched crossfade between the two input tracks.
143    </td>
144  </tr>
145</table>
146<!-- ==================== FUNCTIONS ==================== -->
147<a name="section-Functions"></a>
148<table class="summary" border="1" cellpadding="3"
149       cellspacing="0" width="100%" bgcolor="white">
150<tr bgcolor="#70b0f0" class="table-header">
151  <td colspan="2" class="table-header">
152    <table border="0" cellpadding="0" cellspacing="0" width="100%">
153      <tr valign="top">
154        <td align="left"><span class="table-header">Functions</span></td>
155        <td align="right" valign="top"
156         ><span class="options">[<a href="#section-Functions"
157         class="privatelink" onclick="toggle_private();"
158         >hide private</a>]</span></td>
159      </tr>
160    </table>
161  </td>
162</tr>
163<tr>
164    <td width="15%" align="right" valign="top" class="summary">
165      <span class="summary-type">&nbsp;</span>
166    </td><td class="summary">
167      <table width="100%" cellpadding="0" cellspacing="0" border="0">
168        <tr>
169          <td><span class="summary-sig"><a name="rows"></a><span class="summary-sig-name">rows</span>(<span class="summary-sig-arg">m</span>)</span><br />
170      returns the # of rows in a numpy matrix</td>
171          <td align="right" valign="top">
172            <span class="codelink"><a href="echonest.action-pysrc.html#rows">source&nbsp;code</a></span>
173            
174          </td>
175        </tr>
176      </table>
177      
178    </td>
179  </tr>
180<tr>
181    <td width="15%" align="right" valign="top" class="summary">
182      <span class="summary-type">&nbsp;</span>
183    </td><td class="summary">
184      <table width="100%" cellpadding="0" cellspacing="0" border="0">
185        <tr>
186          <td><span class="summary-sig"><a name="make_mono"></a><span class="summary-sig-name">make_mono</span>(<span class="summary-sig-arg">track</span>)</span><br />
187      Converts stereo tracks to mono; leaves mono tracks alone.</td>
188          <td align="right" valign="top">
189            <span class="codelink"><a href="echonest.action-pysrc.html#make_mono">source&nbsp;code</a></span>
190            
191          </td>
192        </tr>
193      </table>
194      
195    </td>
196  </tr>
197<tr>
198    <td width="15%" align="right" valign="top" class="summary">
199      <span class="summary-type">&nbsp;</span>
200    </td><td class="summary">
201      <table width="100%" cellpadding="0" cellspacing="0" border="0">
202        <tr>
203          <td><span class="summary-sig"><a href="echonest.action-module.html#make_stereo" class="summary-sig-name">make_stereo</a>(<span class="summary-sig-arg">track</span>)</span><br />
204      If the track is mono, doubles it.</td>
205          <td align="right" valign="top">
206            <span class="codelink"><a href="echonest.action-pysrc.html#make_stereo">source&nbsp;code</a></span>
207            
208          </td>
209        </tr>
210      </table>
211      
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      <table width="100%" cellpadding="0" cellspacing="0" border="0">
219        <tr>
220          <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">actions</span>,
221        <span class="summary-sig-arg">filename</span>)</span><br />
222      Calls render on each action in actions, concatenates the results, renders an audio file, and returns a path to the file</td>
223          <td align="right" valign="top">
224            <span class="codelink"><a href="echonest.action-pysrc.html#render">source&nbsp;code</a></span>
225            
226          </td>
227        </tr>
228      </table>
229      
230    </td>
231  </tr>
232<tr>
233    <td width="15%" align="right" valign="top" class="summary">
234      <span class="summary-type">&nbsp;</span>
235    </td><td class="summary">
236      <table width="100%" cellpadding="0" cellspacing="0" border="0">
237        <tr>
238          <td><span class="summary-sig"><a name="humanize_time"></a><span class="summary-sig-name">humanize_time</span>(<span class="summary-sig-arg">secs</span>)</span><br />
239      Turns seconds into a string of the form HH:MM:SS, or MM:SS if less than one hour.</td>
240          <td align="right" valign="top">
241            <span class="codelink"><a href="echonest.action-pysrc.html#humanize_time">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="display_actions"></a><span class="summary-sig-name">display_actions</span>(<span class="summary-sig-arg">actions</span>)</span></td>
256          <td align="right" valign="top">
257            <span class="codelink"><a href="echonest.action-pysrc.html#display_actions">source&nbsp;code</a></span>
258            
259          </td>
260        </tr>
261      </table>
262      
263    </td>
264  </tr>
265</table>
266<!-- ==================== VARIABLES ==================== -->
267<a name="section-Variables"></a>
268<table class="summary" border="1" cellpadding="3"
269       cellspacing="0" width="100%" bgcolor="white">
270<tr bgcolor="#70b0f0" class="table-header">
271  <td colspan="2" class="table-header">
272    <table border="0" cellpadding="0" cellspacing="0" width="100%">
273      <tr valign="top">
274        <td align="left"><span class="table-header">Variables</span></td>
275        <td align="right" valign="top"
276         ><span class="options">[<a href="#section-Variables"
277         class="privatelink" onclick="toggle_private();"
278         >hide private</a>]</span></td>
279      </tr>
280    </table>
281  </td>
282</tr>
283<tr>
284    <td width="15%" align="right" valign="top" class="summary">
285      <span class="summary-type">&nbsp;</span>
286    </td><td class="summary">
287        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'echonest'"><code class="variable-quote">'</code><code class="variable-string">echonest</code><code class="variable-quote">'</code></code>
288    </td>
289  </tr>
290</table>
291<!-- ==================== FUNCTION DETAILS ==================== -->
292<a name="section-FunctionDetails"></a>
293<table class="details" border="1" cellpadding="3"
294       cellspacing="0" width="100%" bgcolor="white">
295<tr bgcolor="#70b0f0" class="table-header">
296  <td colspan="2" class="table-header">
297    <table border="0" cellpadding="0" cellspacing="0" width="100%">
298      <tr valign="top">
299        <td align="left"><span class="table-header">Function Details</span></td>
300        <td align="right" valign="top"
301         ><span class="options">[<a href="#section-FunctionDetails"
302         class="privatelink" onclick="toggle_private();"
303         >hide private</a>]</span></td>
304      </tr>
305    </table>
306  </td>
307</tr>
308</table>
309<a name="make_stereo"></a>
310<div>
311<table class="details" border="1" cellpadding="3"
312       cellspacing="0" width="100%" bgcolor="white">
313<tr><td>
314  <table width="100%" cellpadding="0" cellspacing="0" border="0">
315  <tr valign="top"><td>
316  <h3 class="epydoc"><span class="sig"><span class="sig-name">make_stereo</span>(<span class="sig-arg">track</span>)</span>
317  </h3>
318  </td><td align="right" valign="top"
319    ><span class="codelink"><a href="echonest.action-pysrc.html#make_stereo">source&nbsp;code</a></span>&nbsp;
320    </td>
321  </tr></table>
322  
323  If the track is mono, doubles it. otherwise, does nothing.
324  <dl class="fields">
325  </dl>
326</td></tr></table>
327</div>
328<br />
329<!-- ==================== NAVIGATION BAR ==================== -->
330<table class="navbar" border="0" width="100%" cellpadding="0"
331       bgcolor="#a0c0ff" cellspacing="0">
332  <tr valign="middle">
333
334  <!-- Tree link -->
335      <th>&nbsp;&nbsp;&nbsp;<a
336        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
337
338  <!-- Index link -->
339      <th>&nbsp;&nbsp;&nbsp;<a
340        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
341
342  <!-- Help link -->
343      <th>&nbsp;&nbsp;&nbsp;<a
344        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
345
346  <!-- Project homepage -->
347      <th class="navbar" align="right" width="100%">
348        <table border="0" cellpadding="0" cellspacing="0">
349          <tr><th class="navbar" align="center"
350            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
351          </tr></table></th>
352  </tr>
353</table>
354<table border="0" cellpadding="0" cellspacing="0" width="100%%">
355  <tr>
356    <td align="left" class="footer">
357    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
358    </td>
359    <td align="right" class="footer">
360      <a target="mainFrame" href="http://epydoc.sourceforge.net"
361        >http://epydoc.sourceforge.net</a>
362    </td>
363  </tr>
364</table>
365
366<script type="text/javascript">
367  <!--
368  // Private objects are initially displayed (because if
369  // javascript is turned off then we want them to be
370  // visible); but by default, we want to hide them.  So hide
371  // them unless we have a cookie that says to show them.
372  checkCookie();
373  // -->
374</script>
375</body>
376</html>