/apidocs/pyechonest.song-module.html

http://echo-nest-remix.googlecode.com/ · HTML · 271 lines · 232 code · 17 blank · 22 comment · 0 complexity · 08800f44fb4b66c983865113d6aef8bb 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>pyechonest.song</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/">Project Homepage</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="pyechonest-module.html">Package&nbsp;pyechonest</a> ::
    43. 

  43.         Module&nbsp;song
    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="pyechonest.song-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 song</h1><p class="nomargin-top"><span class="codelink"><a href="pyechonest.song-pysrc.html">source&nbsp;code</a></span></p>
    61. 

  61. <p>Copyright (c) 2010 The Echo Nest. All rights reserved.
    62. 

  62. Created by Tyler Williams on 2010-04-25.</p>
    63. 

  63. <p>The Song module loosely covers <a class="rst-reference external" href="http://developer.echonest.com/docs/v4/song.html" target="_top">http://developer.echonest.com/docs/v4/song.html</a>
    64. 

  64. Refer to the official api documentation if you are unsure about something.</p>
    65. 

  65. 

  66. <!-- ==================== CLASSES ==================== -->
    67. 

  67. <a name="section-Classes"></a>
    68. 

  68. <table class="summary" border="1" cellpadding="3"
    69. 

  69.        cellspacing="0" width="100%" bgcolor="white">
    70. 

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

  71.   <td colspan="2" class="table-header">
    72. 

  72.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    73. 

  73.       <tr valign="top">
    74. 

  74.         <td align="left"><span class="table-header">Classes</span></td>
    75. 

  75.         <td align="right" valign="top"
    76. 

  76.          ><span class="options">[<a href="#section-Classes"
    77. 

  77.          class="privatelink" onclick="toggle_private();"
    78. 

  78.          >hide private</a>]</span></td>
    79. 

  79.       </tr>
    80. 

  80.     </table>
    81. 

  81.   </td>
    82. 

  82. </tr>
    83. 

  83. <tr>
    84. 

  84.     <td width="15%" align="right" valign="top" class="summary">
    85. 

  85.       <span class="summary-type">&nbsp;</span>
    86. 

  86.     </td><td class="summary">
    87. 

  87.         <a href="pyechonest.song.Song-class.html" class="summary-name">Song</a><br />
    88. 

  88.       A Song object
    89. 

  89.     </td>
    90. 

  90.   </tr>
    91. 

  91. </table>
    92. 

  92. <!-- ==================== FUNCTIONS ==================== -->
    93. 

  93. <a name="section-Functions"></a>
    94. 

  94. <table class="summary" border="1" cellpadding="3"
    95. 

  95.        cellspacing="0" width="100%" bgcolor="white">
    96. 

  96. <tr bgcolor="#70b0f0" class="table-header">
    97. 

  97.   <td colspan="2" class="table-header">
    98. 

  98.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    99. 

  99.       <tr valign="top">
    100. 

  100.         <td align="left"><span class="table-header">Functions</span></td>
    101. 

  101.         <td align="right" valign="top"
    102. 

  102.          ><span class="options">[<a href="#section-Functions"
    103. 

  103.          class="privatelink" onclick="toggle_private();"
    104. 

  104.          >hide private</a>]</span></td>
    105. 

  105.       </tr>
    106. 

  106.     </table>
    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 name="identify"></a><span class="summary-sig-name">identify</span>(<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">None</span>,
    116. 

  116.         <span class="summary-sig-arg">query_obj</span>=<span class="summary-sig-default">None</span>,
    117. 

  117.         <span class="summary-sig-arg">code</span>=<span class="summary-sig-default">None</span>,
    118. 

  118.         <span class="summary-sig-arg">artist</span>=<span class="summary-sig-default">None</span>,
    119. 

  119.         <span class="summary-sig-arg">title</span>=<span class="summary-sig-default">None</span>,
    120. 

  120.         <span class="summary-sig-arg">release</span>=<span class="summary-sig-default">None</span>,
    121. 

  121.         <span class="summary-sig-arg">duration</span>=<span class="summary-sig-default">None</span>,
    122. 

  122.         <span class="summary-sig-arg">genre</span>=<span class="summary-sig-default">None</span>,
    123. 

  123.         <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
    124. 

  124.         <span class="summary-sig-arg">alt</span>=<span class="summary-sig-default">None</span>,
    125. 

  125.         <span class="summary-sig-arg">codegen_start</span>=<span class="summary-sig-default">0</span>,
    126. 

  126.         <span class="summary-sig-arg">codegen_duration</span>=<span class="summary-sig-default">30</span>)</span></td>
    127. 

  127.           <td align="right" valign="top">
    128. 

  128.             <span class="codelink"><a href="pyechonest.song-pysrc.html#identify">source&nbsp;code</a></span>
    129. 

  129.             
    130. 

  130.           </td>
    131. 

  131.         </tr>
    132. 

  132.       </table>
    133. 

  133.       
    134. 

  134.     </td>
    135. 

  135.   </tr>
    136. 

  136. <tr>
    137. 

  137.     <td width="15%" align="right" valign="top" class="summary">
    138. 

  138.       <span class="summary-type">&nbsp;</span>
    139. 

  139.     </td><td class="summary">
    140. 

  140.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    141. 

  141.         <tr>
    142. 

  142.           <td><span class="summary-sig"><a name="search"></a><span class="summary-sig-name">search</span>(<span class="summary-sig-arg">title</span>=<span class="summary-sig-default">None</span>,
    143. 

  143.         <span class="summary-sig-arg">artist</span>=<span class="summary-sig-default">None</span>,
    144. 

  144.         <span class="summary-sig-arg">artist_id</span>=<span class="summary-sig-default">None</span>,
    145. 

  145.         <span class="summary-sig-arg">combined</span>=<span class="summary-sig-default">None</span>,
    146. 

  146.         <span class="summary-sig-arg">description</span>=<span class="summary-sig-default">None</span>,
    147. 

  147.         <span class="summary-sig-arg">results</span>=<span class="summary-sig-default">None</span>,
    148. 

  148.         <span class="summary-sig-arg">max_tempo</span>=<span class="summary-sig-default">None</span>,
    149. 

  149.         <span class="summary-sig-arg">min_tempo</span>=<span class="summary-sig-default">None</span>,
    150. 

  150.         <span class="summary-sig-arg">max_duration</span>=<span class="summary-sig-default">None</span>,
    151. 

  151.         <span class="summary-sig-arg">min_duration</span>=<span class="summary-sig-default">None</span>,
    152. 

  152.         <span class="summary-sig-arg">max_loudness</span>=<span class="summary-sig-default">None</span>,
    153. 

  153.         <span class="summary-sig-arg">min_loudness</span>=<span class="summary-sig-default">None</span>,
    154. 

  154.         <span class="summary-sig-arg">artist_max_familiarity</span>=<span class="summary-sig-default">None</span>,
    155. 

  155.         <span class="summary-sig-arg">artist_min_familiarity</span>=<span class="summary-sig-default">None</span>,
    156. 

  156.         <span class="summary-sig-arg">artist_max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
    157. 

  157.         <span class="summary-sig-arg">artist_min_hotttnesss</span>=<span class="summary-sig-default">None</span>,
    158. 

  158.         <span class="summary-sig-arg">song_max_hotttnesss</span>=<span class="summary-sig-default">None</span>,
    159. 

  159.         <span class="summary-sig-arg">song_min_hotttnesss</span>=<span class="summary-sig-default">None</span>,
    160. 

  160.         <span class="summary-sig-arg">mode</span>=<span class="summary-sig-default">None</span>,
    161. 

  161.         <span class="summary-sig-arg">key</span>=<span class="summary-sig-default">None</span>,
    162. 

  162.         <span class="summary-sig-arg">max_latitude</span>=<span class="summary-sig-default">None</span>,
    163. 

  163.         <span class="summary-sig-arg">min_latitude</span>=<span class="summary-sig-default">None</span>,
    164. 

  164.         <span class="summary-sig-arg">max_longitude</span>=<span class="summary-sig-default">None</span>,
    165. 

  165.         <span class="summary-sig-arg">min_longitude</span>=<span class="summary-sig-default">None</span>,
    166. 

  166.         <span class="summary-sig-arg">sort</span>=<span class="summary-sig-default">None</span>,
    167. 

  167.         <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
    168. 

  168.         <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>)</span><br />
    169. 

  169.       search for songs</td>
    170. 

  170.           <td align="right" valign="top">
    171. 

  171.             <span class="codelink"><a href="pyechonest.song-pysrc.html#search">source&nbsp;code</a></span>
    172. 

  172.             
    173. 

  173.           </td>
    174. 

  174.         </tr>
    175. 

  175.       </table>
    176. 

  176.       
    177. 

  177.     </td>
    178. 

  178.   </tr>
    179. 

  179. <tr>
    180. 

  180.     <td width="15%" align="right" valign="top" class="summary">
    181. 

  181.       <span class="summary-type">&nbsp;</span>
    182. 

  182.     </td><td class="summary">
    183. 

  183.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    184. 

  184.         <tr>
    185. 

  185.           <td><span class="summary-sig"><a name="profile"></a><span class="summary-sig-name">profile</span>(<span class="summary-sig-arg">ids</span>,
    186. 

  186.         <span class="summary-sig-arg">buckets</span>=<span class="summary-sig-default">None</span>,
    187. 

  187.         <span class="summary-sig-arg">limit</span>=<span class="summary-sig-default">False</span>)</span><br />
    188. 

  188.       get the profiles for multiple songs at once</td>
    189. 

  189.           <td align="right" valign="top">
    190. 

  190.             <span class="codelink"><a href="pyechonest.song-pysrc.html#profile">source&nbsp;code</a></span>
    191. 

  191.             
    192. 

  192.           </td>
    193. 

  193.         </tr>
    194. 

  194.       </table>
    195. 

  195.       
    196. 

  196.     </td>
    197. 

  197.   </tr>
    198. 

  198. </table>
    199. 

  199. <!-- ==================== VARIABLES ==================== -->
    200. 

  200. <a name="section-Variables"></a>
    201. 

  201. <table class="summary" border="1" cellpadding="3"
    202. 

  202.        cellspacing="0" width="100%" bgcolor="white">
    203. 

  203. <tr bgcolor="#70b0f0" class="table-header">
    204. 

  204.   <td colspan="2" class="table-header">
    205. 

  205.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    206. 

  206.       <tr valign="top">
    207. 

  207.         <td align="left"><span class="table-header">Variables</span></td>
    208. 

  208.         <td align="right" valign="top"
    209. 

  209.          ><span class="options">[<a href="#section-Variables"
    210. 

  210.          class="privatelink" onclick="toggle_private();"
    211. 

  211.          >hide private</a>]</span></td>
    212. 

  212.       </tr>
    213. 

  213.     </table>
    214. 

  214.   </td>
    215. 

  215. </tr>
    216. 

  216. <tr>
    217. 

  217.     <td width="15%" align="right" valign="top" class="summary">
    218. 

  218.       <span class="summary-type">&nbsp;</span>
    219. 

  219.     </td><td class="summary">
    220. 

  220.         <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>
    221. 

  221.     </td>
    222. 

  222.   </tr>
    223. 

  223. </table>
    224. 

  224. <!-- ==================== NAVIGATION BAR ==================== -->
    225. 

  225. <table class="navbar" border="0" width="100%" cellpadding="0"
    226. 

  226.        bgcolor="#a0c0ff" cellspacing="0">
    227. 

  227.   <tr valign="middle">
    228. 

  228. 

  229.   <!-- Tree link -->
    230. 

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

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

  232. 

  233.   <!-- Index link -->
    234. 

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

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

  236. 

  237.   <!-- Help link -->
    238. 

  238.       <th>&nbsp;&nbsp;&nbsp;<a
    239. 

  239.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    240. 

  240. 

  241.   <!-- Project homepage -->
    242. 

  242.       <th class="navbar" align="right" width="100%">
    243. 

  243.         <table border="0" cellpadding="0" cellspacing="0">
    244. 

  244.           <tr><th class="navbar" align="center"
    245. 

  245.             ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
    246. 

  246.           </tr></table></th>
    247. 

  247.   </tr>
    248. 

  248. </table>
    249. 

  249. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    250. 

  250.   <tr>
    251. 

  251.     <td align="left" class="footer">
    252. 

  252.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
    253. 

  253.     </td>
    254. 

  254.     <td align="right" class="footer">
    255. 

  255.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    256. 

  256.         >http://epydoc.sourceforge.net</a>
    257. 

  257.     </td>
    258. 

  258.   </tr>
    259. 

  259. </table>
    260. 

  260. 

  261. <script type="text/javascript">
    262. 

  262.   <!--
    263. 

  263.   // Private objects are initially displayed (because if
    264. 

  264.   // javascript is turned off then we want them to be
    265. 

  265.   // visible); but by default, we want to hide them.  So hide
    266. 

  266.   // them unless we have a cookie that says to show them.
    267. 

  267.   checkCookie();
    268. 

  268.   // -->
    269. 

  269. </script>
    270. 

  270. </body>
    271. 

  271. </html>
    272.