/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

  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.audio.AudioAnalysis</title>
  7. <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8. <script type="text/javascript" src="epydoc.js"></script>
  9. </head>
  10. <body bgcolor="white" text="black" link="blue" vlink="#204080"
  11. alink="#204080">
  12. <!-- ==================== NAVIGATION BAR ==================== -->
  13. <table class="navbar" border="0" width="100%" cellpadding="0"
  14. bgcolor="#a0c0ff" cellspacing="0">
  15. <tr valign="middle">
  16. <!-- Tree link -->
  17. <th>&nbsp;&nbsp;&nbsp;<a
  18. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  19. <!-- Index link -->
  20. <th>&nbsp;&nbsp;&nbsp;<a
  21. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  22. <!-- Help link -->
  23. <th>&nbsp;&nbsp;&nbsp;<a
  24. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  25. <!-- Project homepage -->
  26. <th class="navbar" align="right" width="100%">
  27. <table border="0" cellpadding="0" cellspacing="0">
  28. <tr><th class="navbar" align="center"
  29. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  30. </tr></table></th>
  31. </tr>
  32. </table>
  33. <table width="100%" cellpadding="0" cellspacing="0">
  34. <tr valign="top">
  35. <td width="100%">
  36. <span class="breadcrumbs">
  37. <a href="echonest-module.html">Package&nbsp;echonest</a> ::
  38. <a href="echonest.audio-module.html">Module&nbsp;audio</a> ::
  39. Class&nbsp;AudioAnalysis
  40. </span>
  41. </td>
  42. <td>
  43. <table cellpadding="0" cellspacing="0">
  44. <!-- hide/show private -->
  45. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  46. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  47. <tr><td align="right"><span class="options"
  48. >[<a href="frames.html" target="_top">frames</a
  49. >]&nbsp;|&nbsp;<a href="echonest.audio.AudioAnalysis-class.html"
  50. target="_top">no&nbsp;frames</a>]</span></td></tr>
  51. </table>
  52. </td>
  53. </tr>
  54. </table>
  55. <!-- ==================== CLASS DESCRIPTION ==================== -->
  56. <h1 class="epydoc">Class AudioAnalysis</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis">source&nbsp;code</a></span></p>
  57. <center>
  58. </center>
  59. <hr />
  60. <p>This class wraps <code class="link">echonest.web</code> to allow transparent caching of the
  61. audio analysis of an audio file.</p>
  62. <p>For example, the following script will display the bars of a track
  63. twice:</p>
  64. <pre class="rst-literal-block">
  65. from echonest import *
  66. a = audio.AudioAnalysis('YOUR_TRACK_ID_HERE')
  67. a.bars
  68. a.bars
  69. </pre>
  70. <p>The first time <code class="link">a.bars</code> is called, a network request is made of the
  71. <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
  72. cached value is returned immediately.</p>
  73. <p>An <a href="echonest.audio.AudioAnalysis-class.html" class="link">AudioAnalysis</a> object can be created using an existing ID, as in
  74. the example above, or by specifying the audio file to upload in
  75. order to create the ID, as in:</p>
  76. <pre class="rst-literal-block">
  77. a = audio.AudioAnalysis('FULL_PATH_TO_AUDIO_FILE')
  78. </pre>
  79. <!-- ==================== INSTANCE METHODS ==================== -->
  80. <a name="section-InstanceMethods"></a>
  81. <table class="summary" border="1" cellpadding="3"
  82. cellspacing="0" width="100%" bgcolor="white">
  83. <tr bgcolor="#70b0f0" class="table-header">
  84. <td colspan="2" class="table-header">
  85. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  86. <tr valign="top">
  87. <td align="left"><span class="table-header">Instance Methods</span></td>
  88. <td align="right" valign="top"
  89. ><span class="options">[<a href="#section-InstanceMethods"
  90. class="privatelink" onclick="toggle_private();"
  91. >hide private</a>]</span></td>
  92. </tr>
  93. </table>
  94. </td>
  95. </tr>
  96. <tr>
  97. <td width="15%" align="right" valign="top" class="summary">
  98. <span class="summary-type">&nbsp;</span>
  99. </td><td class="summary">
  100. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  101. <tr>
  102. <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>,
  103. <span class="summary-sig-arg">path_or_identifier</span>)</span><br />
  104. Constructor.</td>
  105. <td align="right" valign="top">
  106. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__init__">source&nbsp;code</a></span>
  107. </td>
  108. </tr>
  109. </table>
  110. </td>
  111. </tr>
  112. <tr>
  113. <td width="15%" align="right" valign="top" class="summary">
  114. <span class="summary-type">&nbsp;</span>
  115. </td><td class="summary">
  116. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  117. <tr>
  118. <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 />
  119. Eliminates the circular reference for pickling.</td>
  120. <td align="right" valign="top">
  121. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__getstate__">source&nbsp;code</a></span>
  122. </td>
  123. </tr>
  124. </table>
  125. </td>
  126. </tr>
  127. <tr>
  128. <td width="15%" align="right" valign="top" class="summary">
  129. <span class="summary-type">&nbsp;</span>
  130. </td><td class="summary">
  131. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  132. <tr>
  133. <td><span class="summary-sig"><a name="__setstate__"></a><span class="summary-sig-name">__setstate__</span>(<span class="summary-sig-arg">self</span>,
  134. <span class="summary-sig-arg">state</span>)</span><br />
  135. Recreates circular references after unpickling.</td>
  136. <td align="right" valign="top">
  137. <span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__setstate__">source&nbsp;code</a></span>
  138. </td>
  139. </tr>
  140. </table>
  141. </td>
  142. </tr>
  143. <tr>
  144. <td colspan="2" class="summary">
  145. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  146. <code>__delattr__</code>,
  147. <code>__format__</code>,
  148. <code>__getattribute__</code>,
  149. <code>__hash__</code>,
  150. <code>__new__</code>,
  151. <code>__reduce__</code>,
  152. <code>__reduce_ex__</code>,
  153. <code>__repr__</code>,
  154. <code>__setattr__</code>,
  155. <code>__sizeof__</code>,
  156. <code>__str__</code>,
  157. <code>__subclasshook__</code>
  158. </p>
  159. </td>
  160. </tr>
  161. </table>
  162. <!-- ==================== PROPERTIES ==================== -->
  163. <a name="section-Properties"></a>
  164. <table class="summary" border="1" cellpadding="3"
  165. cellspacing="0" width="100%" bgcolor="white">
  166. <tr bgcolor="#70b0f0" class="table-header">
  167. <td colspan="2" class="table-header">
  168. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  169. <tr valign="top">
  170. <td align="left"><span class="table-header">Properties</span></td>
  171. <td align="right" valign="top"
  172. ><span class="options">[<a href="#section-Properties"
  173. class="privatelink" onclick="toggle_private();"
  174. >hide private</a>]</span></td>
  175. </tr>
  176. </table>
  177. </td>
  178. </tr>
  179. <tr>
  180. <td width="15%" align="right" valign="top" class="summary">
  181. <span class="summary-type">&nbsp;</span>
  182. </td><td class="summary">
  183. <a href="echonest.audio.AudioAnalysis-class.html#bars" class="summary-name">bars</a>
  184. </td>
  185. </tr>
  186. <tr>
  187. <td width="15%" align="right" valign="top" class="summary">
  188. <span class="summary-type">&nbsp;</span>
  189. </td><td class="summary">
  190. <a href="echonest.audio.AudioAnalysis-class.html#beats" class="summary-name">beats</a>
  191. </td>
  192. </tr>
  193. <tr>
  194. <td width="15%" align="right" valign="top" class="summary">
  195. <span class="summary-type">&nbsp;</span>
  196. </td><td class="summary">
  197. <a href="echonest.audio.AudioAnalysis-class.html#tatums" class="summary-name">tatums</a>
  198. </td>
  199. </tr>
  200. <tr>
  201. <td width="15%" align="right" valign="top" class="summary">
  202. <span class="summary-type">&nbsp;</span>
  203. </td><td class="summary">
  204. <a href="echonest.audio.AudioAnalysis-class.html#sections" class="summary-name">sections</a>
  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. <a href="echonest.audio.AudioAnalysis-class.html#segments" class="summary-name">segments</a>
  212. </td>
  213. </tr>
  214. <tr>
  215. <td colspan="2" class="summary">
  216. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  217. <code>__class__</code>
  218. </p>
  219. </td>
  220. </tr>
  221. </table>
  222. <!-- ==================== METHOD DETAILS ==================== -->
  223. <a name="section-MethodDetails"></a>
  224. <table class="details" border="1" cellpadding="3"
  225. cellspacing="0" width="100%" bgcolor="white">
  226. <tr bgcolor="#70b0f0" class="table-header">
  227. <td colspan="2" class="table-header">
  228. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  229. <tr valign="top">
  230. <td align="left"><span class="table-header">Method Details</span></td>
  231. <td align="right" valign="top"
  232. ><span class="options">[<a href="#section-MethodDetails"
  233. class="privatelink" onclick="toggle_private();"
  234. >hide private</a>]</span></td>
  235. </tr>
  236. </table>
  237. </td>
  238. </tr>
  239. </table>
  240. <a name="__init__"></a>
  241. <div>
  242. <table class="details" border="1" cellpadding="3"
  243. cellspacing="0" width="100%" bgcolor="white">
  244. <tr><td>
  245. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  246. <tr valign="top"><td>
  247. <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
  248. <span class="sig-arg">path_or_identifier</span>)</span>
  249. <br /><em class="fname">(Constructor)</em>
  250. </h3>
  251. </td><td align="right" valign="top"
  252. ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioAnalysis.__init__">source&nbsp;code</a></span>&nbsp;
  253. </td>
  254. </tr></table>
  255. <p>Constructor. If the argument is a valid local path or a URL,
  256. 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>
  257. <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
  258. the track ID.</p>
  259. <dl class="fields">
  260. <dt>Parameters:</dt>
  261. <dd><ul class="nomargin-top">
  262. <li><strong class="pname"><code>path_or_identifier</code></strong> - A string representing either a path to a local
  263. file, or the ID of a file that has already
  264. been uploaded for analysis.</li>
  265. </ul></dd>
  266. <dt>Overrides:
  267. object.__init__
  268. </dt>
  269. </dl>
  270. </td></tr></table>
  271. </div>
  272. <br />
  273. <!-- ==================== PROPERTY DETAILS ==================== -->
  274. <a name="section-PropertyDetails"></a>
  275. <table class="details" border="1" cellpadding="3"
  276. cellspacing="0" width="100%" bgcolor="white">
  277. <tr bgcolor="#70b0f0" class="table-header">
  278. <td colspan="2" class="table-header">
  279. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  280. <tr valign="top">
  281. <td align="left"><span class="table-header">Property Details</span></td>
  282. <td align="right" valign="top"
  283. ><span class="options">[<a href="#section-PropertyDetails"
  284. class="privatelink" onclick="toggle_private();"
  285. >hide private</a>]</span></td>
  286. </tr>
  287. </table>
  288. </td>
  289. </tr>
  290. </table>
  291. <a name="bars"></a>
  292. <div>
  293. <table class="details" border="1" cellpadding="3"
  294. cellspacing="0" width="100%" bgcolor="white">
  295. <tr><td>
  296. <h3 class="epydoc">bars</h3>
  297. <dl class="fields">
  298. <dt>Get Method:</dt>
  299. <dd class="value"><span class="summary-sig"><i>unreachable</i>.bars(<span class="summary-sig-arg">self</span>)</span>
  300. </dd>
  301. </dl>
  302. </td></tr></table>
  303. </div>
  304. <a name="beats"></a>
  305. <div>
  306. <table class="details" border="1" cellpadding="3"
  307. cellspacing="0" width="100%" bgcolor="white">
  308. <tr><td>
  309. <h3 class="epydoc">beats</h3>
  310. <dl class="fields">
  311. <dt>Get Method:</dt>
  312. <dd class="value"><span class="summary-sig"><i>unreachable</i>.beats(<span class="summary-sig-arg">self</span>)</span>
  313. </dd>
  314. </dl>
  315. </td></tr></table>
  316. </div>
  317. <a name="tatums"></a>
  318. <div>
  319. <table class="details" border="1" cellpadding="3"
  320. cellspacing="0" width="100%" bgcolor="white">
  321. <tr><td>
  322. <h3 class="epydoc">tatums</h3>
  323. <dl class="fields">
  324. <dt>Get Method:</dt>
  325. <dd class="value"><span class="summary-sig"><i>unreachable</i>.tatums(<span class="summary-sig-arg">self</span>)</span>
  326. </dd>
  327. </dl>
  328. </td></tr></table>
  329. </div>
  330. <a name="sections"></a>
  331. <div>
  332. <table class="details" border="1" cellpadding="3"
  333. cellspacing="0" width="100%" bgcolor="white">
  334. <tr><td>
  335. <h3 class="epydoc">sections</h3>
  336. <dl class="fields">
  337. <dt>Get Method:</dt>
  338. <dd class="value"><span class="summary-sig"><i>unreachable</i>.sections(<span class="summary-sig-arg">self</span>)</span>
  339. </dd>
  340. </dl>
  341. </td></tr></table>
  342. </div>
  343. <a name="segments"></a>
  344. <div>
  345. <table class="details" border="1" cellpadding="3"
  346. cellspacing="0" width="100%" bgcolor="white">
  347. <tr><td>
  348. <h3 class="epydoc">segments</h3>
  349. <dl class="fields">
  350. <dt>Get Method:</dt>
  351. <dd class="value"><span class="summary-sig"><i>unreachable</i>.segments(<span class="summary-sig-arg">self</span>)</span>
  352. </dd>
  353. </dl>
  354. </td></tr></table>
  355. </div>
  356. <br />
  357. <!-- ==================== NAVIGATION BAR ==================== -->
  358. <table class="navbar" border="0" width="100%" cellpadding="0"
  359. bgcolor="#a0c0ff" cellspacing="0">
  360. <tr valign="middle">
  361. <!-- Tree link -->
  362. <th>&nbsp;&nbsp;&nbsp;<a
  363. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  364. <!-- Index link -->
  365. <th>&nbsp;&nbsp;&nbsp;<a
  366. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  367. <!-- Help link -->
  368. <th>&nbsp;&nbsp;&nbsp;<a
  369. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  370. <!-- Project homepage -->
  371. <th class="navbar" align="right" width="100%">
  372. <table border="0" cellpadding="0" cellspacing="0">
  373. <tr><th class="navbar" align="center"
  374. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  375. </tr></table></th>
  376. </tr>
  377. </table>
  378. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  379. <tr>
  380. <td align="left" class="footer">
  381. Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:58 2010
  382. </td>
  383. <td align="right" class="footer">
  384. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  385. >http://epydoc.sourceforge.net</a>
  386. </td>
  387. </tr>
  388. </table>
  389. <script type="text/javascript">
  390. <!--
  391. // Private objects are initially displayed (because if
  392. // javascript is turned off then we want them to be
  393. // visible); but by default, we want to hide them. So hide
  394. // them unless we have a cookie that says to show them.
  395. checkCookie();
  396. // -->
  397. </script>
  398. </body>
  399. </html>