PageRenderTime 38ms CodeModel.GetById 11ms app.highlight 20ms RepoModel.GetById 1ms app.codeStats 1ms

/apidocs/pyechonest.track-module.html

http://echo-nest-remix.googlecode.com/
HTML | 424 lines | 366 code | 35 blank | 23 comment | 0 complexity | b8443997795a740c21eea30fd5e61e1c 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>pyechonest.track</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="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
 43        Module&nbsp;track
 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="pyechonest.track-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 track</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.track-pysrc.html">source&nbsp;code</a></span></p>
 61<!-- ==================== CLASSES ==================== -->
 62<a name="section-Classes"></a>
 63<table class="summary" border="1" cellpadding="3"
 64       cellspacing="0" width="100%" bgcolor="white">
 65<tr bgcolor="#70b0f0" class="table-header">
 66  <td colspan="2" class="table-header">
 67    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 68      <tr valign="top">
 69        <td align="left"><span class="table-header">Classes</span></td>
 70        <td align="right" valign="top"
 71         ><span class="options">[<a href="#section-Classes"
 72         class="privatelink" onclick="toggle_private();"
 73         >hide private</a>]</span></td>
 74      </tr>
 75    </table>
 76  </td>
 77</tr>
 78<tr>
 79    <td width="15%" align="right" valign="top" class="summary">
 80      <span class="summary-type">&nbsp;</span>
 81    </td><td class="summary">
 82        <a href="pyechonest.track.Track-class.html" class="summary-name">Track</a><br />
 83      Represents an audio analysis from The Echo Nest.
 84    </td>
 85  </tr>
 86</table>
 87<!-- ==================== FUNCTIONS ==================== -->
 88<a name="section-Functions"></a>
 89<table class="summary" border="1" cellpadding="3"
 90       cellspacing="0" width="100%" bgcolor="white">
 91<tr bgcolor="#70b0f0" class="table-header">
 92  <td colspan="2" class="table-header">
 93    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 94      <tr valign="top">
 95        <td align="left"><span class="table-header">Functions</span></td>
 96        <td align="right" valign="top"
 97         ><span class="options">[<a href="#section-Functions"
 98         class="privatelink" onclick="toggle_private();"
 99         >hide private</a>]</span></td>
100      </tr>
101    </table>
102  </td>
103</tr>
104<tr class="private">
105    <td width="15%" align="right" valign="top" class="summary">
106      <span class="summary-type">&nbsp;</span>
107    </td><td class="summary">
108      <table width="100%" cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <td><span class="summary-sig"><a name="_track_from_response"></a><span class="summary-sig-name">_track_from_response</span>(<span class="summary-sig-arg">response</span>)</span><br />
111      This is the function that actually creates the track object</td>
112          <td align="right" valign="top">
113            <span class="codelink"><a href="pyechonest.track-pysrc.html#_track_from_response">source&nbsp;code</a></span>
114            
115          </td>
116        </tr>
117      </table>
118      
119    </td>
120  </tr>
121<tr class="private">
122    <td width="15%" align="right" valign="top" class="summary">
123      <span class="summary-type">&nbsp;</span>
124    </td><td class="summary">
125      <table width="100%" cellpadding="0" cellspacing="0" border="0">
126        <tr>
127          <td><span class="summary-sig"><a href="pyechonest.track-module.html#_upload" class="summary-sig-name" onclick="show_private();">_upload</a>(<span class="summary-sig-arg">param_dict</span>,
128        <span class="summary-sig-arg">data</span>=<span class="summary-sig-default">None</span>)</span><br />
129      Calls upload either with a local audio file,
130or a url.</td>
131          <td align="right" valign="top">
132            <span class="codelink"><a href="pyechonest.track-pysrc.html#_upload">source&nbsp;code</a></span>
133            
134          </td>
135        </tr>
136      </table>
137      
138    </td>
139  </tr>
140<tr class="private">
141    <td width="15%" align="right" valign="top" class="summary">
142      <span class="summary-type">&nbsp;</span>
143    </td><td class="summary">
144      <table width="100%" cellpadding="0" cellspacing="0" border="0">
145        <tr>
146          <td><span class="summary-sig"><a name="_profile"></a><span class="summary-sig-name">_profile</span>(<span class="summary-sig-arg">param_dict</span>)</span></td>
147          <td align="right" valign="top">
148            <span class="codelink"><a href="pyechonest.track-pysrc.html#_profile">source&nbsp;code</a></span>
149            
150          </td>
151        </tr>
152      </table>
153      
154    </td>
155  </tr>
156<tr class="private">
157    <td width="15%" align="right" valign="top" class="summary">
158      <span class="summary-type">&nbsp;</span>
159    </td><td class="summary">
160      <table width="100%" cellpadding="0" cellspacing="0" border="0">
161        <tr>
162          <td><span class="summary-sig"><a name="_analyze"></a><span class="summary-sig-name">_analyze</span>(<span class="summary-sig-arg">param_dict</span>)</span></td>
163          <td align="right" valign="top">
164            <span class="codelink"><a href="pyechonest.track-pysrc.html#_analyze">source&nbsp;code</a></span>
165            
166          </td>
167        </tr>
168      </table>
169      
170    </td>
171  </tr>
172<tr class="private">
173    <td width="15%" align="right" valign="top" class="summary">
174      <span class="summary-type">&nbsp;</span>
175    </td><td class="summary">
176      <table width="100%" cellpadding="0" cellspacing="0" border="0">
177        <tr>
178          <td><span class="summary-sig"><a name="_track_from_string"></a><span class="summary-sig-name">_track_from_string</span>(<span class="summary-sig-arg">audio_data</span>,
179        <span class="summary-sig-arg">filetype</span>)</span></td>
180          <td align="right" valign="top">
181            <span class="codelink"><a href="pyechonest.track-pysrc.html#_track_from_string">source&nbsp;code</a></span>
182            
183          </td>
184        </tr>
185      </table>
186      
187    </td>
188  </tr>
189<tr>
190    <td width="15%" align="right" valign="top" class="summary">
191      <span class="summary-type">&nbsp;</span>
192    </td><td class="summary">
193      <table width="100%" cellpadding="0" cellspacing="0" border="0">
194        <tr>
195          <td><span class="summary-sig"><a name="track_from_file"></a><span class="summary-sig-name">track_from_file</span>(<span class="summary-sig-arg">file_object</span>,
196        <span class="summary-sig-arg">filetype</span>)</span><br />
197      Convenience function for creating a track object from a file-like object</td>
198          <td align="right" valign="top">
199            <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_file">source&nbsp;code</a></span>
200            
201          </td>
202        </tr>
203      </table>
204      
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      <table width="100%" cellpadding="0" cellspacing="0" border="0">
212        <tr>
213          <td><span class="summary-sig"><a name="track_from_filename"></a><span class="summary-sig-name">track_from_filename</span>(<span class="summary-sig-arg">filename</span>,
214        <span class="summary-sig-arg">filetype</span>=<span class="summary-sig-default">None</span>)</span><br />
215      Convenience function for creating a track object from a file path
216if the filetype is none, we will get it from the extension</td>
217          <td align="right" valign="top">
218            <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_filename">source&nbsp;code</a></span>
219            
220          </td>
221        </tr>
222      </table>
223      
224    </td>
225  </tr>
226<tr>
227    <td width="15%" align="right" valign="top" class="summary">
228      <span class="summary-type">&nbsp;</span>
229    </td><td class="summary">
230      <table width="100%" cellpadding="0" cellspacing="0" border="0">
231        <tr>
232          <td><span class="summary-sig"><a name="track_from_url"></a><span class="summary-sig-name">track_from_url</span>(<span class="summary-sig-arg">url</span>)</span><br />
233      Convenience function for creating a track object from a public http url</td>
234          <td align="right" valign="top">
235            <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_url">source&nbsp;code</a></span>
236            
237          </td>
238        </tr>
239      </table>
240      
241    </td>
242  </tr>
243<tr>
244    <td width="15%" align="right" valign="top" class="summary">
245      <span class="summary-type">&nbsp;</span>
246    </td><td class="summary">
247      <table width="100%" cellpadding="0" cellspacing="0" border="0">
248        <tr>
249          <td><span class="summary-sig"><a name="track_from_id"></a><span class="summary-sig-name">track_from_id</span>(<span class="summary-sig-arg">identifier</span>)</span><br />
250      Convenience function for creating a track object from an id, like TRXXHTJ1294CD8F3B3</td>
251          <td align="right" valign="top">
252            <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_id">source&nbsp;code</a></span>
253            
254          </td>
255        </tr>
256      </table>
257      
258    </td>
259  </tr>
260<tr>
261    <td width="15%" align="right" valign="top" class="summary">
262      <span class="summary-type">&nbsp;</span>
263    </td><td class="summary">
264      <table width="100%" cellpadding="0" cellspacing="0" border="0">
265        <tr>
266          <td><span class="summary-sig"><a name="track_from_md5"></a><span class="summary-sig-name">track_from_md5</span>(<span class="summary-sig-arg">md5</span>)</span><br />
267      Convenience function for creating a track object from an md5</td>
268          <td align="right" valign="top">
269            <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_md5">source&nbsp;code</a></span>
270            
271          </td>
272        </tr>
273      </table>
274      
275    </td>
276  </tr>
277<tr>
278    <td width="15%" align="right" valign="top" class="summary">
279      <span class="summary-type">&nbsp;</span>
280    </td><td class="summary">
281      <table width="100%" cellpadding="0" cellspacing="0" border="0">
282        <tr>
283          <td><span class="summary-sig"><a name="track_from_reanalyzing_id"></a><span class="summary-sig-name">track_from_reanalyzing_id</span>(<span class="summary-sig-arg">identifier</span>)</span><br />
284      Convenience function for reanalzying an already uploaded track</td>
285          <td align="right" valign="top">
286            <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_reanalyzing_id">source&nbsp;code</a></span>
287            
288          </td>
289        </tr>
290      </table>
291      
292    </td>
293  </tr>
294<tr>
295    <td width="15%" align="right" valign="top" class="summary">
296      <span class="summary-type">&nbsp;</span>
297    </td><td class="summary">
298      <table width="100%" cellpadding="0" cellspacing="0" border="0">
299        <tr>
300          <td><span class="summary-sig"><a name="track_from_reanalyzing_md5"></a><span class="summary-sig-name">track_from_reanalyzing_md5</span>(<span class="summary-sig-arg">md5</span>)</span><br />
301      Convenience function for reanalzying an already uploaded track</td>
302          <td align="right" valign="top">
303            <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_reanalyzing_md5">source&nbsp;code</a></span>
304            
305          </td>
306        </tr>
307      </table>
308      
309    </td>
310  </tr>
311</table>
312<!-- ==================== VARIABLES ==================== -->
313<a name="section-Variables"></a>
314<table class="summary" border="1" cellpadding="3"
315       cellspacing="0" width="100%" bgcolor="white">
316<tr bgcolor="#70b0f0" class="table-header">
317  <td colspan="2" class="table-header">
318    <table border="0" cellpadding="0" cellspacing="0" width="100%">
319      <tr valign="top">
320        <td align="left"><span class="table-header">Variables</span></td>
321        <td align="right" valign="top"
322         ><span class="options">[<a href="#section-Variables"
323         class="privatelink" onclick="toggle_private();"
324         >hide private</a>]</span></td>
325      </tr>
326    </table>
327  </td>
328</tr>
329<tr>
330    <td width="15%" align="right" valign="top" class="summary">
331      <span class="summary-type">&nbsp;</span>
332    </td><td class="summary">
333        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'pyechonest'"><code class="variable-quote">'</code><code class="variable-string">pyechonest</code><code class="variable-quote">'</code></code>
334    </td>
335  </tr>
336</table>
337<!-- ==================== FUNCTION DETAILS ==================== -->
338<a name="section-FunctionDetails"></a>
339<table class="details" border="1" cellpadding="3"
340       cellspacing="0" width="100%" bgcolor="white">
341<tr bgcolor="#70b0f0" class="table-header">
342  <td colspan="2" class="table-header">
343    <table border="0" cellpadding="0" cellspacing="0" width="100%">
344      <tr valign="top">
345        <td align="left"><span class="table-header">Function Details</span></td>
346        <td align="right" valign="top"
347         ><span class="options">[<a href="#section-FunctionDetails"
348         class="privatelink" onclick="toggle_private();"
349         >hide private</a>]</span></td>
350      </tr>
351    </table>
352  </td>
353</tr>
354</table>
355<a name="_upload"></a>
356<div class="private">
357<table class="details" border="1" cellpadding="3"
358       cellspacing="0" width="100%" bgcolor="white">
359<tr><td>
360  <table width="100%" cellpadding="0" cellspacing="0" border="0">
361  <tr valign="top"><td>
362  <h3 class="epydoc"><span class="sig"><span class="sig-name">_upload</span>(<span class="sig-arg">param_dict</span>,
363        <span class="sig-arg">data</span>=<span class="sig-default">None</span>)</span>
364  </h3>
365  </td><td align="right" valign="top"
366    ><span class="codelink"><a href="pyechonest.track-pysrc.html#_upload">source&nbsp;code</a></span>&nbsp;
367    </td>
368  </tr></table>
369  
370  Calls upload either with a local audio file,
371or a url. Returns a track object.
372  <dl class="fields">
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:57 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>