/apidocs/echonest.cloud-module.html

http://echo-nest-remix.googlecode.com/ · HTML · 266 lines · 219 code · 25 blank · 22 comment · 0 complexity · cb5857432247a9f95a9877565263e4aa MD5 · raw file 

    

  1. <?xml version="1.0" encoding="ascii"?>
    2. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.           "DTD/xhtml1-transitional.dtd">
    4. 

  4. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    5. 

  5. <head>
    6. 

  6.   <title>echonest.cloud</title>
    7. 

  7.   <link rel="stylesheet" href="epydoc.css" type="text/css" />
    8. 

  8.   <script type="text/javascript" src="epydoc.js"></script>
    9. 

  9. </head>
    10. 

  10. 

  11. <body bgcolor="white" text="black" link="blue" vlink="#204080"
    12. 

  12.       alink="#204080">
    13. 

  13. <!-- ==================== NAVIGATION BAR ==================== -->
    14. 

  14. <table class="navbar" border="0" width="100%" cellpadding="0"
    15. 

  15.        bgcolor="#a0c0ff" cellspacing="0">
    16. 

  16.   <tr valign="middle">
    17. 

  17. 

  18.   <!-- Tree link -->
    19. 

  19.       <th>&nbsp;&nbsp;&nbsp;<a
    20. 

  20.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    21. 

  21. 

  22.   <!-- Index link -->
    23. 

  23.       <th>&nbsp;&nbsp;&nbsp;<a
    24. 

  24.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    25. 

  25. 

  26.   <!-- Help link -->
    27. 

  27.       <th>&nbsp;&nbsp;&nbsp;<a
    28. 

  28.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    29. 

  29. 

  30.   <!-- Project homepage -->
    31. 

  31.       <th class="navbar" align="right" width="100%">
    32. 

  32.         <table border="0" cellpadding="0" cellspacing="0">
    33. 

  33.           <tr><th class="navbar" align="center"
    34. 

  34.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
    35. 

  35.           </tr></table></th>
    36. 

  36.   </tr>
    37. 

  37. </table>
    38. 

  38. <table width="100%" cellpadding="0" cellspacing="0">
    39. 

  39.   <tr valign="top">
    40. 

  40.     <td width="100%">
    41. 

  41.       <span class="breadcrumbs">
    42. 

  42.         <a href="echonest-module.html">Package&nbsp;echonest</a> ::
    43. 

  43.         Module&nbsp;cloud
    44. 

  44.       </span>
    45. 

  45.     </td>
    46. 

  46.     <td>
    47. 

  47.       <table cellpadding="0" cellspacing="0">
    48. 

  48.         <!-- hide/show private -->
    49. 

  49.         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    50. 

  50.     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
    51. 

  51.         <tr><td align="right"><span class="options"
    52. 

  52.             >[<a href="frames.html" target="_top">frames</a
    53. 

  53.             >]&nbsp;|&nbsp;<a href="echonest.cloud-module.html"
    54. 

  54.             target="_top">no&nbsp;frames</a>]</span></td></tr>
    55. 

  55.       </table>
    56. 

  56.     </td>
    57. 

  57.   </tr>
    58. 

  58. </table>
    59. 

  59. <!-- ==================== MODULE DESCRIPTION ==================== -->
    60. 

  60. <h1 class="epydoc">Module cloud</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.cloud-pysrc.html">source&nbsp;code</a></span></p>
    61. 

  61. <pre class="literalblock">
    62. 

  62. 

  63. Convenience methods for creating Remix audio objects by searching.
    64. 

  64. Created 2010-04-12 by Jason Sundram
    65. 

  65. 

  66. See the docs here for how to use the api directly:
    67. 

  67. http://beta.developer.echonest.com/song.html#search
    68. 

  68. 

  69. </pre>
    70. 

  70. 

  71. <!-- ==================== FUNCTIONS ==================== -->
    72. 

  72. <a name="section-Functions"></a>
    73. 

  73. <table class="summary" border="1" cellpadding="3"
    74. 

  74.        cellspacing="0" width="100%" bgcolor="white">
    75. 

  75. <tr bgcolor="#70b0f0" class="table-header">
    76. 

  76.   <td colspan="2" class="table-header">
    77. 

  77.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    78. 

  78.       <tr valign="top">
    79. 

  79.         <td align="left"><span class="table-header">Functions</span></td>
    80. 

  80.         <td align="right" valign="top"
    81. 

  81.          ><span class="options">[<a href="#section-Functions"
    82. 

  82.          class="privatelink" onclick="toggle_private();"
    83. 

  83.          >hide private</a>]</span></td>
    84. 

  84.       </tr>
    85. 

  85.     </table>
    86. 

  86.   </td>
    87. 

  87. </tr>
    88. 

  88. <tr>
    89. 

  89.     <td width="15%" align="right" valign="top" class="summary">
    90. 

  90.       <span class="summary-type">&nbsp;</span>
    91. 

  91.     </td><td class="summary">
    92. 

  92.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    93. 

  93.         <tr>
    94. 

  94.           <td><span class="summary-sig"><a name="find_track"></a><span class="summary-sig-name">find_track</span>(<span class="summary-sig-arg">artist</span>,
    95. 

  95.         <span class="summary-sig-arg">title</span>,
    96. 

  96.         <span class="summary-sig-arg">catalog</span>)</span><br />
    97. 

  97.       Given an artist and title, uses v4 pyechonest to get a song object,
    98. 

  98. download the track and audio analysis for that song from the given 
    99. 

  99. catalog, and return an AudioData-type thing.</td>
    100. 

  100.           <td align="right" valign="top">
    101. 

  101.             <span class="codelink"><a href="echonest.cloud-pysrc.html#find_track">source&nbsp;code</a></span>
    102. 

  102.             
    103. 

  103.           </td>
    104. 

  104.         </tr>
    105. 

  105.       </table>
    106. 

  106.       
    107. 

  107.     </td>
    108. 

  108.   </tr>
    109. 

  109. <tr>
    110. 

  110.     <td width="15%" align="right" valign="top" class="summary">
    111. 

  111.       <span class="summary-type">&nbsp;</span>
    112. 

  112.     </td><td class="summary">
    113. 

  113.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    114. 

  114.         <tr>
    115. 

  115.           <td><span class="summary-sig"><a href="echonest.cloud-module.html#make_track" class="summary-sig-name">make_track</a>(<span class="summary-sig-arg">s</span>,
    116. 

  116.         <span class="summary-sig-arg">catalog</span>)</span><br />
    117. 

  117.       Takes a song object, created by manipulating v4 pyechonest.</td>
    118. 

  118.           <td align="right" valign="top">
    119. 

  119.             <span class="codelink"><a href="echonest.cloud-pysrc.html#make_track">source&nbsp;code</a></span>
    120. 

  120.             
    121. 

  121.           </td>
    122. 

  122.         </tr>
    123. 

  123.       </table>
    124. 

  124.       
    125. 

  125.     </td>
    126. 

  126.   </tr>
    127. 

  127. <tr>
    128. 

  128.     <td width="15%" align="right" valign="top" class="summary">
    129. 

  129.       <span class="summary-type">&nbsp;</span>
    130. 

  130.     </td><td class="summary">
    131. 

  131.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    132. 

  132.         <tr>
    133. 

  133.           <td><span class="summary-sig"><a name="download"></a><span class="summary-sig-name">download</span>(<span class="summary-sig-arg">url</span>)</span><br />
    134. 

  134.       Copy the contents of a file from a given URL to a local file in the current directory and returns the filename</td>
    135. 

  135.           <td align="right" valign="top">
    136. 

  136.             <span class="codelink"><a href="echonest.cloud-pysrc.html#download">source&nbsp;code</a></span>
    137. 

  137.             
    138. 

  138.           </td>
    139. 

  139.         </tr>
    140. 

  140.       </table>
    141. 

  141.       
    142. 

  142.     </td>
    143. 

  143.   </tr>
    144. 

  144. </table>
    145. 

  145. <!-- ==================== VARIABLES ==================== -->
    146. 

  146. <a name="section-Variables"></a>
    147. 

  147. <table class="summary" border="1" cellpadding="3"
    148. 

  148.        cellspacing="0" width="100%" bgcolor="white">
    149. 

  149. <tr bgcolor="#70b0f0" class="table-header">
    150. 

  150.   <td colspan="2" class="table-header">
    151. 

  151.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    152. 

  152.       <tr valign="top">
    153. 

  153.         <td align="left"><span class="table-header">Variables</span></td>
    154. 

  154.         <td align="right" valign="top"
    155. 

  155.          ><span class="options">[<a href="#section-Variables"
    156. 

  156.          class="privatelink" onclick="toggle_private();"
    157. 

  157.          >hide private</a>]</span></td>
    158. 

  158.       </tr>
    159. 

  159.     </table>
    160. 

  160.   </td>
    161. 

  161. </tr>
    162. 

  162. <tr>
    163. 

  163.     <td width="15%" align="right" valign="top" class="summary">
    164. 

  164.       <span class="summary-type">&nbsp;</span>
    165. 

  165.     </td><td class="summary">
    166. 

  166.         <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'echonest'"><code class="variable-quote">'</code><code class="variable-string">echonest</code><code class="variable-quote">'</code></code>
    167. 

  167.     </td>
    168. 

  168.   </tr>
    169. 

  169. </table>
    170. 

  170. <!-- ==================== FUNCTION DETAILS ==================== -->
    171. 

  171. <a name="section-FunctionDetails"></a>
    172. 

  172. <table class="details" border="1" cellpadding="3"
    173. 

  173.        cellspacing="0" width="100%" bgcolor="white">
    174. 

  174. <tr bgcolor="#70b0f0" class="table-header">
    175. 

  175.   <td colspan="2" class="table-header">
    176. 

  176.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    177. 

  177.       <tr valign="top">
    178. 

  178.         <td align="left"><span class="table-header">Function Details</span></td>
    179. 

  179.         <td align="right" valign="top"
    180. 

  180.          ><span class="options">[<a href="#section-FunctionDetails"
    181. 

  181.          class="privatelink" onclick="toggle_private();"
    182. 

  182.          >hide private</a>]</span></td>
    183. 

  183.       </tr>
    184. 

  184.     </table>
    185. 

  185.   </td>
    186. 

  186. </tr>
    187. 

  187. </table>
    188. 

  188. <a name="make_track"></a>
    189. 

  189. <div>
    190. 

  190. <table class="details" border="1" cellpadding="3"
    191. 

  191.        cellspacing="0" width="100%" bgcolor="white">
    192. 

  192. <tr><td>
    193. 

  193.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    194. 

  194.   <tr valign="top"><td>
    195. 

  195.   <h3 class="epydoc"><span class="sig"><span class="sig-name">make_track</span>(<span class="sig-arg">s</span>,
    196. 

  196.         <span class="sig-arg">catalog</span>)</span>
    197. 

  197.   </h3>
    198. 

  198.   </td><td align="right" valign="top"
    199. 

  199.     ><span class="codelink"><a href="echonest.cloud-pysrc.html#make_track">source&nbsp;code</a></span>&nbsp;
    200. 

  200.     </td>
    201. 

  201.   </tr></table>
    202. 

  202.   
    203. 

  203.   <pre class="literalblock">
    204. 

  204. 

  205. Takes a song object, created by manipulating v4 pyechonest.
    206. 

  206. Downloads the audio for the song, as well as the full analysis.
    207. 

  207. Synthesizes those into the return value, a remix AudioData object.
    208. 

  208. 

  209. returns None if either the audio or the analysis could not be found.
    210. 

  210. 

  211. Catalog specifies the audio source.
    212. 

  212. 

  213. </pre>
    214. 

  214.   <dl class="fields">
    215. 

  215.   </dl>
    216. 

  216. </td></tr></table>
    217. 

  217. </div>
    218. 

  218. <br />
    219. 

  219. <!-- ==================== NAVIGATION BAR ==================== -->
    220. 

  220. <table class="navbar" border="0" width="100%" cellpadding="0"
    221. 

  221.        bgcolor="#a0c0ff" cellspacing="0">
    222. 

  222.   <tr valign="middle">
    223. 

  223. 

  224.   <!-- Tree link -->
    225. 

  225.       <th>&nbsp;&nbsp;&nbsp;<a
    226. 

  226.         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
    227. 

  227. 

  228.   <!-- Index link -->
    229. 

  229.       <th>&nbsp;&nbsp;&nbsp;<a
    230. 

  230.         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
    231. 

  231. 

  232.   <!-- Help link -->
    233. 

  233.       <th>&nbsp;&nbsp;&nbsp;<a
    234. 

  234.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    235. 

  235. 

  236.   <!-- Project homepage -->
    237. 

  237.       <th class="navbar" align="right" width="100%">
    238. 

  238.         <table border="0" cellpadding="0" cellspacing="0">
    239. 

  239.           <tr><th class="navbar" align="center"
    240. 

  240.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">The Echo Nest Remix API, SVN Revision: 448</a></th>
    241. 

  241.           </tr></table></th>
    242. 

  242.   </tr>
    243. 

  243. </table>
    244. 

  244. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    245. 

  245.   <tr>
    246. 

  246.     <td align="left" class="footer">
    247. 

  247.     Generated by Epydoc 3.0.1 on Wed May 26 12:17:55 2010
    248. 

  248.     </td>
    249. 

  249.     <td align="right" class="footer">
    250. 

  250.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    251. 

  251.         >http://epydoc.sourceforge.net</a>
    252. 

  252.     </td>
    253. 

  253.   </tr>
    254. 

  254. </table>
    255. 

  255. 

  256. <script type="text/javascript">
    257. 

  257.   <!--
    258. 

  258.   // Private objects are initially displayed (because if
    259. 

  259.   // javascript is turned off then we want them to be
    260. 

  260.   // visible); but by default, we want to hide them.  So hide
    261. 

  261.   // them unless we have a cookie that says to show them.
    262. 

  262.   checkCookie();
    263. 

  263.   // -->
    264. 

  264. </script>
    265. 

  265. </body>
    266. 

  266. </html>
    267.