/apidocs/echonest.audio.AudioAnalysis-class.html
http://echo-nest-remix.googlecode.com/ · HTML · 423 lines · 376 code · 24 blank · 23 comment · 0 complexity · 86d90f8bd38b6832b1dee833c69df7c0 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>echonest.audio.AudioAnalysis</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="echonest-module.html">Package echonest</a> ::
- <a href="echonest.audio-module.html">Module audio</a> ::
- Class AudioAnalysis
- </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="echonest.audio.AudioAnalysis-class.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== CLASS DESCRIPTION ==================== -->
- <h1 class="epydoc">Class AudioAnalysis</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis">source code</a></span></p>
- <center>
- </center>
- <hr />
- <p>This class wraps <code class="link">echonest.web</code> to allow transparent caching of the
- audio analysis of an audio file.</p>
- <p>For example, the following script will display the bars of a track
- twice:</p>
- <pre class="rst-literal-block">
- from echonest import *
- a = audio.AudioAnalysis('YOUR_TRACK_ID_HERE')
- a.bars
- a.bars
- </pre>
- <p>The first time <code class="link">a.bars</code> is called, a network request is made of the
- <a class="rst-reference external" href="http://the.echonest.com/" target="_top">Echo Nest</a> <a class="rst-reference external" href="http://developer.echonest.com/pages/overview?version=2" target="_top">Analyze API</a>. The second time time <code class="link">a.bars</code> is called, the
- cached value is returned immediately.</p>
- <p>An <a href="echonest.audio.AudioAnalysis-class.html" class="link">AudioAnalysis</a> object can be created using an existing ID, as in
- the example above, or by specifying the audio file to upload in
- order to create the ID, as in:</p>
- <pre class="rst-literal-block">
- a = audio.AudioAnalysis('FULL_PATH_TO_AUDIO_FILE')
- </pre>
- <!-- ==================== INSTANCE METHODS ==================== -->
- <a name="section-InstanceMethods"></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">Instance Methods</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-InstanceMethods"
- 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">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioAnalysis-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">path_or_identifier</span>)</span><br />
- Constructor.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__init__">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="__getstate__"></a><span class="summary-sig-name">__getstate__</span>(<span class="summary-sig-arg">self</span>)</span><br />
- Eliminates the circular reference for pickling.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__getstate__">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="__setstate__"></a><span class="summary-sig-name">__setstate__</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">state</span>)</span><br />
- Recreates circular references after unpickling.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__setstate__">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
- <code>__delattr__</code>,
- <code>__format__</code>,
- <code>__getattribute__</code>,
- <code>__hash__</code>,
- <code>__new__</code>,
- <code>__reduce__</code>,
- <code>__reduce_ex__</code>,
- <code>__repr__</code>,
- <code>__setattr__</code>,
- <code>__sizeof__</code>,
- <code>__str__</code>,
- <code>__subclasshook__</code>
- </p>
- </td>
- </tr>
- </table>
- <!-- ==================== PROPERTIES ==================== -->
- <a name="section-Properties"></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">Properties</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Properties"
- 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="echonest.audio.AudioAnalysis-class.html#bars" class="summary-name">bars</a>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="echonest.audio.AudioAnalysis-class.html#beats" class="summary-name">beats</a>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="echonest.audio.AudioAnalysis-class.html#tatums" class="summary-name">tatums</a>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="echonest.audio.AudioAnalysis-class.html#sections" class="summary-name">sections</a>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="echonest.audio.AudioAnalysis-class.html#segments" class="summary-name">segments</a>
- </td>
- </tr>
- <tr>
- <td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
- <code>__class__</code>
- </p>
- </td>
- </tr>
- </table>
- <!-- ==================== METHOD DETAILS ==================== -->
- <a name="section-MethodDetails"></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">Method Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-MethodDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="__init__"></a>
- <div>
- <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">__init__</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">path_or_identifier</span>)</span>
- <br /><em class="fname">(Constructor)</em>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__init__">source code</a></span>
- </td>
- </tr></table>
-
- <p>Constructor. If the argument is a valid local path or a URL,
- the track ID is generated by uploading the file to the <a class="rst-reference external" href="http://the.echonest.com/" target="_top">Echo Nest</a>
- <a class="rst-reference external" href="http://developer.echonest.com/track.html#upload" target="_top">Analyze API</a>. Otherwise, the argument is assumed to be
- the track ID.</p>
- <dl class="fields">
- <dt>Parameters:</dt>
- <dd><ul class="nomargin-top">
- <li><strong class="pname"><code>path_or_identifier</code></strong> - A string representing either a path to a local
- file, or the ID of a file that has already
- been uploaded for analysis.</li>
- </ul></dd>
- <dt>Overrides:
- object.__init__
- </dt>
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== PROPERTY DETAILS ==================== -->
- <a name="section-PropertyDetails"></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">Property Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-PropertyDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="bars"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">bars</h3>
-
- <dl class="fields">
- <dt>Get Method:</dt>
- <dd class="value"><span class="summary-sig"><i>unreachable</i>.bars(<span class="summary-sig-arg">self</span>)</span>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <a name="beats"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">beats</h3>
-
- <dl class="fields">
- <dt>Get Method:</dt>
- <dd class="value"><span class="summary-sig"><i>unreachable</i>.beats(<span class="summary-sig-arg">self</span>)</span>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <a name="tatums"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">tatums</h3>
-
- <dl class="fields">
- <dt>Get Method:</dt>
- <dd class="value"><span class="summary-sig"><i>unreachable</i>.tatums(<span class="summary-sig-arg">self</span>)</span>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <a name="sections"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">sections</h3>
-
- <dl class="fields">
- <dt>Get Method:</dt>
- <dd class="value"><span class="summary-sig"><i>unreachable</i>.sections(<span class="summary-sig-arg">self</span>)</span>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <a name="segments"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">segments</h3>
-
- <dl class="fields">
- <dt>Get Method:</dt>
- <dd class="value"><span class="summary-sig"><i>unreachable</i>.segments(<span class="summary-sig-arg">self</span>)</span>
- </dd>
- </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:58 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>