/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
- <?xml version="1.0" encoding="ascii"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <title>pyechonest.track</title>
- <link rel="stylesheet" href="epydoc.css" type="text/css" />
- <script type="text/javascript" src="epydoc.js"></script>
- </head>
- <body bgcolor="white" text="black" link="blue" vlink="#204080"
- alink="#204080">
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table width="100%" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="100%">
- <span class="breadcrumbs">
- <a href="pyechonest-module.html">Package pyechonest</a> ::
- Module track
- </span>
- </td>
- <td>
- <table cellpadding="0" cellspacing="0">
- <!-- hide/show private -->
- <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
- onclick="toggle_private();">hide private</a>]</span></td></tr>
- <tr><td align="right"><span class="options"
- >[<a href="frames.html" target="_top">frames</a
- >] | <a href="pyechonest.track-module.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== MODULE DESCRIPTION ==================== -->
- <h1 class="epydoc">Module track</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.track-pysrc.html">source code</a></span></p>
- <!-- ==================== CLASSES ==================== -->
- <a name="section-Classes"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Classes</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Classes"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="pyechonest.track.Track-class.html" class="summary-name">Track</a><br />
- Represents an audio analysis from The Echo Nest.
- </td>
- </tr>
- </table>
- <!-- ==================== FUNCTIONS ==================== -->
- <a name="section-Functions"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Functions</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Functions"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr class="private">
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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 />
- This is the function that actually creates the track object</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#_track_from_response">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr class="private">
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>,
- <span class="summary-sig-arg">data</span>=<span class="summary-sig-default">None</span>)</span><br />
- Calls upload either with a local audio file,
- or a url.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#_upload">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr class="private">
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#_profile">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr class="private">
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#_analyze">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr class="private">
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>,
- <span class="summary-sig-arg">filetype</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#_track_from_string">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>,
- <span class="summary-sig-arg">filetype</span>)</span><br />
- Convenience function for creating a track object from a file-like object</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_file">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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>,
- <span class="summary-sig-arg">filetype</span>=<span class="summary-sig-default">None</span>)</span><br />
- Convenience function for creating a track object from a file path
- if the filetype is none, we will get it from the extension</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_filename">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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 />
- Convenience function for creating a track object from a public http url</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_url">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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 />
- Convenience function for creating a track object from an id, like TRXXHTJ1294CD8F3B3</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_id">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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 />
- Convenience function for creating a track object from an md5</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_md5">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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 />
- Convenience function for reanalzying an already uploaded track</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_reanalyzing_id">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <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 />
- Convenience function for reanalzying an already uploaded track</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_reanalyzing_md5">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- </table>
- <!-- ==================== VARIABLES ==================== -->
- <a name="section-Variables"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Variables</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Variables"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <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>
- </td>
- </tr>
- </table>
- <!-- ==================== FUNCTION DETAILS ==================== -->
- <a name="section-FunctionDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Function Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-FunctionDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="_upload"></a>
- <div class="private">
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">_upload</span>(<span class="sig-arg">param_dict</span>,
- <span class="sig-arg">data</span>=<span class="sig-default">None</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="pyechonest.track-pysrc.html#_upload">source code</a></span>
- </td>
- </tr></table>
-
- Calls upload either with a local audio file,
- or a url. Returns a track object.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table border="0" cellpadding="0" cellspacing="0" width="100%%">
- <tr>
- <td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:57 2010
- </td>
- <td align="right" class="footer">
- <a target="mainFrame" href="http://epydoc.sourceforge.net"
- >http://epydoc.sourceforge.net</a>
- </td>
- </tr>
- </table>
- <script type="text/javascript">
- <!--
- // Private objects are initially displayed (because if
- // javascript is turned off then we want them to be
- // visible); but by default, we want to hide them. So hide
- // them unless we have a cookie that says to show them.
- checkCookie();
- // -->
- </script>
- </body>
- </html>