/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. <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="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
  38. Module&nbsp;track
  39. </span>
  40. </td>
  41. <td>
  42. <table cellpadding="0" cellspacing="0">
  43. <!-- hide/show private -->
  44. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  45. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  46. <tr><td align="right"><span class="options"
  47. >[<a href="frames.html" target="_top">frames</a
  48. >]&nbsp;|&nbsp;<a href="pyechonest.track-module.html"
  49. target="_top">no&nbsp;frames</a>]</span></td></tr>
  50. </table>
  51. </td>
  52. </tr>
  53. </table>
  54. <!-- ==================== MODULE DESCRIPTION ==================== -->
  55. <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>
  56. <!-- ==================== CLASSES ==================== -->
  57. <a name="section-Classes"></a>
  58. <table class="summary" border="1" cellpadding="3"
  59. cellspacing="0" width="100%" bgcolor="white">
  60. <tr bgcolor="#70b0f0" class="table-header">
  61. <td colspan="2" class="table-header">
  62. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  63. <tr valign="top">
  64. <td align="left"><span class="table-header">Classes</span></td>
  65. <td align="right" valign="top"
  66. ><span class="options">[<a href="#section-Classes"
  67. class="privatelink" onclick="toggle_private();"
  68. >hide private</a>]</span></td>
  69. </tr>
  70. </table>
  71. </td>
  72. </tr>
  73. <tr>
  74. <td width="15%" align="right" valign="top" class="summary">
  75. <span class="summary-type">&nbsp;</span>
  76. </td><td class="summary">
  77. <a href="pyechonest.track.Track-class.html" class="summary-name">Track</a><br />
  78. Represents an audio analysis from The Echo Nest.
  79. </td>
  80. </tr>
  81. </table>
  82. <!-- ==================== FUNCTIONS ==================== -->
  83. <a name="section-Functions"></a>
  84. <table class="summary" border="1" cellpadding="3"
  85. cellspacing="0" width="100%" bgcolor="white">
  86. <tr bgcolor="#70b0f0" class="table-header">
  87. <td colspan="2" class="table-header">
  88. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  89. <tr valign="top">
  90. <td align="left"><span class="table-header">Functions</span></td>
  91. <td align="right" valign="top"
  92. ><span class="options">[<a href="#section-Functions"
  93. class="privatelink" onclick="toggle_private();"
  94. >hide private</a>]</span></td>
  95. </tr>
  96. </table>
  97. </td>
  98. </tr>
  99. <tr class="private">
  100. <td width="15%" align="right" valign="top" class="summary">
  101. <span class="summary-type">&nbsp;</span>
  102. </td><td class="summary">
  103. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  104. <tr>
  105. <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 />
  106. This is the function that actually creates the track object</td>
  107. <td align="right" valign="top">
  108. <span class="codelink"><a href="pyechonest.track-pysrc.html#_track_from_response">source&nbsp;code</a></span>
  109. </td>
  110. </tr>
  111. </table>
  112. </td>
  113. </tr>
  114. <tr class="private">
  115. <td width="15%" align="right" valign="top" class="summary">
  116. <span class="summary-type">&nbsp;</span>
  117. </td><td class="summary">
  118. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  119. <tr>
  120. <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>,
  121. <span class="summary-sig-arg">data</span>=<span class="summary-sig-default">None</span>)</span><br />
  122. Calls upload either with a local audio file,
  123. or a url.</td>
  124. <td align="right" valign="top">
  125. <span class="codelink"><a href="pyechonest.track-pysrc.html#_upload">source&nbsp;code</a></span>
  126. </td>
  127. </tr>
  128. </table>
  129. </td>
  130. </tr>
  131. <tr class="private">
  132. <td width="15%" align="right" valign="top" class="summary">
  133. <span class="summary-type">&nbsp;</span>
  134. </td><td class="summary">
  135. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  136. <tr>
  137. <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>
  138. <td align="right" valign="top">
  139. <span class="codelink"><a href="pyechonest.track-pysrc.html#_profile">source&nbsp;code</a></span>
  140. </td>
  141. </tr>
  142. </table>
  143. </td>
  144. </tr>
  145. <tr class="private">
  146. <td width="15%" align="right" valign="top" class="summary">
  147. <span class="summary-type">&nbsp;</span>
  148. </td><td class="summary">
  149. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  150. <tr>
  151. <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>
  152. <td align="right" valign="top">
  153. <span class="codelink"><a href="pyechonest.track-pysrc.html#_analyze">source&nbsp;code</a></span>
  154. </td>
  155. </tr>
  156. </table>
  157. </td>
  158. </tr>
  159. <tr class="private">
  160. <td width="15%" align="right" valign="top" class="summary">
  161. <span class="summary-type">&nbsp;</span>
  162. </td><td class="summary">
  163. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  164. <tr>
  165. <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>,
  166. <span class="summary-sig-arg">filetype</span>)</span></td>
  167. <td align="right" valign="top">
  168. <span class="codelink"><a href="pyechonest.track-pysrc.html#_track_from_string">source&nbsp;code</a></span>
  169. </td>
  170. </tr>
  171. </table>
  172. </td>
  173. </tr>
  174. <tr>
  175. <td width="15%" align="right" valign="top" class="summary">
  176. <span class="summary-type">&nbsp;</span>
  177. </td><td class="summary">
  178. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  179. <tr>
  180. <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>,
  181. <span class="summary-sig-arg">filetype</span>)</span><br />
  182. Convenience function for creating a track object from a file-like object</td>
  183. <td align="right" valign="top">
  184. <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_file">source&nbsp;code</a></span>
  185. </td>
  186. </tr>
  187. </table>
  188. </td>
  189. </tr>
  190. <tr>
  191. <td width="15%" align="right" valign="top" class="summary">
  192. <span class="summary-type">&nbsp;</span>
  193. </td><td class="summary">
  194. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  195. <tr>
  196. <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>,
  197. <span class="summary-sig-arg">filetype</span>=<span class="summary-sig-default">None</span>)</span><br />
  198. Convenience function for creating a track object from a file path
  199. if the filetype is none, we will get it from the extension</td>
  200. <td align="right" valign="top">
  201. <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_filename">source&nbsp;code</a></span>
  202. </td>
  203. </tr>
  204. </table>
  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_url"></a><span class="summary-sig-name">track_from_url</span>(<span class="summary-sig-arg">url</span>)</span><br />
  214. Convenience function for creating a track object from a public http url</td>
  215. <td align="right" valign="top">
  216. <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_url">source&nbsp;code</a></span>
  217. </td>
  218. </tr>
  219. </table>
  220. </td>
  221. </tr>
  222. <tr>
  223. <td width="15%" align="right" valign="top" class="summary">
  224. <span class="summary-type">&nbsp;</span>
  225. </td><td class="summary">
  226. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  227. <tr>
  228. <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 />
  229. Convenience function for creating a track object from an id, like TRXXHTJ1294CD8F3B3</td>
  230. <td align="right" valign="top">
  231. <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_id">source&nbsp;code</a></span>
  232. </td>
  233. </tr>
  234. </table>
  235. </td>
  236. </tr>
  237. <tr>
  238. <td width="15%" align="right" valign="top" class="summary">
  239. <span class="summary-type">&nbsp;</span>
  240. </td><td class="summary">
  241. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  242. <tr>
  243. <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 />
  244. Convenience function for creating a track object from an md5</td>
  245. <td align="right" valign="top">
  246. <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_md5">source&nbsp;code</a></span>
  247. </td>
  248. </tr>
  249. </table>
  250. </td>
  251. </tr>
  252. <tr>
  253. <td width="15%" align="right" valign="top" class="summary">
  254. <span class="summary-type">&nbsp;</span>
  255. </td><td class="summary">
  256. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  257. <tr>
  258. <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 />
  259. Convenience function for reanalzying an already uploaded track</td>
  260. <td align="right" valign="top">
  261. <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_reanalyzing_id">source&nbsp;code</a></span>
  262. </td>
  263. </tr>
  264. </table>
  265. </td>
  266. </tr>
  267. <tr>
  268. <td width="15%" align="right" valign="top" class="summary">
  269. <span class="summary-type">&nbsp;</span>
  270. </td><td class="summary">
  271. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  272. <tr>
  273. <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 />
  274. Convenience function for reanalzying an already uploaded track</td>
  275. <td align="right" valign="top">
  276. <span class="codelink"><a href="pyechonest.track-pysrc.html#track_from_reanalyzing_md5">source&nbsp;code</a></span>
  277. </td>
  278. </tr>
  279. </table>
  280. </td>
  281. </tr>
  282. </table>
  283. <!-- ==================== VARIABLES ==================== -->
  284. <a name="section-Variables"></a>
  285. <table class="summary" border="1" cellpadding="3"
  286. cellspacing="0" width="100%" bgcolor="white">
  287. <tr bgcolor="#70b0f0" class="table-header">
  288. <td colspan="2" class="table-header">
  289. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  290. <tr valign="top">
  291. <td align="left"><span class="table-header">Variables</span></td>
  292. <td align="right" valign="top"
  293. ><span class="options">[<a href="#section-Variables"
  294. class="privatelink" onclick="toggle_private();"
  295. >hide private</a>]</span></td>
  296. </tr>
  297. </table>
  298. </td>
  299. </tr>
  300. <tr>
  301. <td width="15%" align="right" valign="top" class="summary">
  302. <span class="summary-type">&nbsp;</span>
  303. </td><td class="summary">
  304. <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>
  305. </td>
  306. </tr>
  307. </table>
  308. <!-- ==================== FUNCTION DETAILS ==================== -->
  309. <a name="section-FunctionDetails"></a>
  310. <table class="details" border="1" cellpadding="3"
  311. cellspacing="0" width="100%" bgcolor="white">
  312. <tr bgcolor="#70b0f0" class="table-header">
  313. <td colspan="2" class="table-header">
  314. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  315. <tr valign="top">
  316. <td align="left"><span class="table-header">Function Details</span></td>
  317. <td align="right" valign="top"
  318. ><span class="options">[<a href="#section-FunctionDetails"
  319. class="privatelink" onclick="toggle_private();"
  320. >hide private</a>]</span></td>
  321. </tr>
  322. </table>
  323. </td>
  324. </tr>
  325. </table>
  326. <a name="_upload"></a>
  327. <div class="private">
  328. <table class="details" border="1" cellpadding="3"
  329. cellspacing="0" width="100%" bgcolor="white">
  330. <tr><td>
  331. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  332. <tr valign="top"><td>
  333. <h3 class="epydoc"><span class="sig"><span class="sig-name">_upload</span>(<span class="sig-arg">param_dict</span>,
  334. <span class="sig-arg">data</span>=<span class="sig-default">None</span>)</span>
  335. </h3>
  336. </td><td align="right" valign="top"
  337. ><span class="codelink"><a href="pyechonest.track-pysrc.html#_upload">source&nbsp;code</a></span>&nbsp;
  338. </td>
  339. </tr></table>
  340. Calls upload either with a local audio file,
  341. or a url. Returns a track object.
  342. <dl class="fields">
  343. </dl>
  344. </td></tr></table>
  345. </div>
  346. <br />
  347. <!-- ==================== NAVIGATION BAR ==================== -->
  348. <table class="navbar" border="0" width="100%" cellpadding="0"
  349. bgcolor="#a0c0ff" cellspacing="0">
  350. <tr valign="middle">
  351. <!-- Tree link -->
  352. <th>&nbsp;&nbsp;&nbsp;<a
  353. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  354. <!-- Index link -->
  355. <th>&nbsp;&nbsp;&nbsp;<a
  356. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  357. <!-- Help link -->
  358. <th>&nbsp;&nbsp;&nbsp;<a
  359. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  360. <!-- Project homepage -->
  361. <th class="navbar" align="right" width="100%">
  362. <table border="0" cellpadding="0" cellspacing="0">
  363. <tr><th class="navbar" align="center"
  364. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  365. </tr></table></th>
  366. </tr>
  367. </table>
  368. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  369. <tr>
  370. <td align="left" class="footer">
  371. Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:57 2010
  372. </td>
  373. <td align="right" class="footer">
  374. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  375. >http://epydoc.sourceforge.net</a>
  376. </td>
  377. </tr>
  378. </table>
  379. <script type="text/javascript">
  380. <!--
  381. // Private objects are initially displayed (because if
  382. // javascript is turned off then we want them to be
  383. // visible); but by default, we want to hide them. So hide
  384. // them unless we have a cookie that says to show them.
  385. checkCookie();
  386. // -->
  387. </script>
  388. </body>
  389. </html>