/apidocs/echonest.action-module.html

http://echo-nest-remix.googlecode.com/ · HTML · 376 lines · 329 code · 24 blank · 23 comment · 0 complexity · 84b8cda09e3ccbb714a4ff5b0501592f 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.action</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="echonest-module.html">Package&nbsp;echonest</a> ::
    43. 

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

  61. <p>action.py</p>
    62. 

  62. <p>Created by Tristan Jehan and Jason Sundram.</p>
    63. 

  63. 

  64. <!-- ==================== CLASSES ==================== -->
    65. 

  65. <a name="section-Classes"></a>
    66. 

  66. <table class="summary" border="1" cellpadding="3"
    67. 

  67.        cellspacing="0" width="100%" bgcolor="white">
    68. 

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

  69.   <td colspan="2" class="table-header">
    70. 

  70.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    71. 

  71.       <tr valign="top">
    72. 

  72.         <td align="left"><span class="table-header">Classes</span></td>
    73. 

  73.         <td align="right" valign="top"
    74. 

  74.          ><span class="options">[<a href="#section-Classes"
    75. 

  75.          class="privatelink" onclick="toggle_private();"
    76. 

  76.          >hide private</a>]</span></td>
    77. 

  77.       </tr>
    78. 

  78.     </table>
    79. 

  79.   </td>
    80. 

  80. </tr>
    81. 

  81. <tr>
    82. 

  82.     <td width="15%" align="right" valign="top" class="summary">
    83. 

  83.       <span class="summary-type">&nbsp;</span>
    84. 

  84.     </td><td class="summary">
    85. 

  85.         <a href="echonest.action.Playback-class.html" class="summary-name">Playback</a><br />
    86. 

  86.       A snippet of the given track with start and duration.
    87. 

  87.     </td>
    88. 

  88.   </tr>
    89. 

  89. <tr>
    90. 

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

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

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

  93.         <a href="echonest.action.Fadeout-class.html" class="summary-name">Fadeout</a><br />
    94. 

  94.       Fadeout
    95. 

  95.     </td>
    96. 

  96.   </tr>
    97. 

  97. <tr>
    98. 

  98.     <td width="15%" align="right" valign="top" class="summary">
    99. 

  99.       <span class="summary-type">&nbsp;</span>
    100. 

  100.     </td><td class="summary">
    101. 

  101.         <a href="echonest.action.Fadein-class.html" class="summary-name">Fadein</a><br />
    102. 

  102.       Fadein
    103. 

  103.     </td>
    104. 

  104.   </tr>
    105. 

  105. <tr>
    106. 

  106.     <td width="15%" align="right" valign="top" class="summary">
    107. 

  107.       <span class="summary-type">&nbsp;</span>
    108. 

  108.     </td><td class="summary">
    109. 

  109.         <a href="echonest.action.Edit-class.html" class="summary-name">Edit</a><br />
    110. 

  110.       Refer to a snippet of audio
    111. 

  111.     </td>
    112. 

  112.   </tr>
    113. 

  113. <tr>
    114. 

  114.     <td width="15%" align="right" valign="top" class="summary">
    115. 

  115.       <span class="summary-type">&nbsp;</span>
    116. 

  116.     </td><td class="summary">
    117. 

  117.         <a href="echonest.action.Crossfade-class.html" class="summary-name">Crossfade</a><br />
    118. 

  118.       Crossfades between two tracks, at the start points specified, for the given duration
    119. 

  119.     </td>
    120. 

  120.   </tr>
    121. 

  121. <tr>
    122. 

  122.     <td width="15%" align="right" valign="top" class="summary">
    123. 

  123.       <span class="summary-type">&nbsp;</span>
    124. 

  124.     </td><td class="summary">
    125. 

  125.         <a href="echonest.action.Jump-class.html" class="summary-name">Jump</a><br />
    126. 

  126.       Move from one point
    127. 

  127.     </td>
    128. 

  128.   </tr>
    129. 

  129. <tr>
    130. 

  130.     <td width="15%" align="right" valign="top" class="summary">
    131. 

  131.       <span class="summary-type">&nbsp;</span>
    132. 

  132.     </td><td class="summary">
    133. 

  133.         <a href="echonest.action.Blend-class.html" class="summary-name">Blend</a><br />
    134. 

  134.       Mix together two lists of beats
    135. 

  135.     </td>
    136. 

  136.   </tr>
    137. 

  137. <tr>
    138. 

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

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

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

  141.         <a href="echonest.action.Crossmatch-class.html" class="summary-name">Crossmatch</a><br />
    142. 

  142.       Makes a beat-matched crossfade between the two input tracks.
    143. 

  143.     </td>
    144. 

  144.   </tr>
    145. 

  145. </table>
    146. 

  146. <!-- ==================== FUNCTIONS ==================== -->
    147. 

  147. <a name="section-Functions"></a>
    148. 

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

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

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

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

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

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

  154.         <td align="left"><span class="table-header">Functions</span></td>
    155. 

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

  156.          ><span class="options">[<a href="#section-Functions"
    157. 

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

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

  159.       </tr>
    160. 

  160.     </table>
    161. 

  161.   </td>
    162. 

  162. </tr>
    163. 

  163. <tr>
    164. 

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

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

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

  167.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    168. 

  168.         <tr>
    169. 

  169.           <td><span class="summary-sig"><a name="rows"></a><span class="summary-sig-name">rows</span>(<span class="summary-sig-arg">m</span>)</span><br />
    170. 

  170.       returns the # of rows in a numpy matrix</td>
    171. 

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

  172.             <span class="codelink"><a href="echonest.action-pysrc.html#rows">source&nbsp;code</a></span>
    173. 

  173.             
    174. 

  174.           </td>
    175. 

  175.         </tr>
    176. 

  176.       </table>
    177. 

  177.       
    178. 

  178.     </td>
    179. 

  179.   </tr>
    180. 

  180. <tr>
    181. 

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

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

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

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

  185.         <tr>
    186. 

  186.           <td><span class="summary-sig"><a name="make_mono"></a><span class="summary-sig-name">make_mono</span>(<span class="summary-sig-arg">track</span>)</span><br />
    187. 

  187.       Converts stereo tracks to mono; leaves mono tracks alone.</td>
    188. 

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

  189.             <span class="codelink"><a href="echonest.action-pysrc.html#make_mono">source&nbsp;code</a></span>
    190. 

  190.             
    191. 

  191.           </td>
    192. 

  192.         </tr>
    193. 

  193.       </table>
    194. 

  194.       
    195. 

  195.     </td>
    196. 

  196.   </tr>
    197. 

  197. <tr>
    198. 

  198.     <td width="15%" align="right" valign="top" class="summary">
    199. 

  199.       <span class="summary-type">&nbsp;</span>
    200. 

  200.     </td><td class="summary">
    201. 

  201.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    202. 

  202.         <tr>
    203. 

  203.           <td><span class="summary-sig"><a href="echonest.action-module.html#make_stereo" class="summary-sig-name">make_stereo</a>(<span class="summary-sig-arg">track</span>)</span><br />
    204. 

  204.       If the track is mono, doubles it.</td>
    205. 

  205.           <td align="right" valign="top">
    206. 

  206.             <span class="codelink"><a href="echonest.action-pysrc.html#make_stereo">source&nbsp;code</a></span>
    207. 

  207.             
    208. 

  208.           </td>
    209. 

  209.         </tr>
    210. 

  210.       </table>
    211. 

  211.       
    212. 

  212.     </td>
    213. 

  213.   </tr>
    214. 

  214. <tr>
    215. 

  215.     <td width="15%" align="right" valign="top" class="summary">
    216. 

  216.       <span class="summary-type">&nbsp;</span>
    217. 

  217.     </td><td class="summary">
    218. 

  218.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    219. 

  219.         <tr>
    220. 

  220.           <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">actions</span>,
    221. 

  221.         <span class="summary-sig-arg">filename</span>)</span><br />
    222. 

  222.       Calls render on each action in actions, concatenates the results, renders an audio file, and returns a path to the file</td>
    223. 

  223.           <td align="right" valign="top">
    224. 

  224.             <span class="codelink"><a href="echonest.action-pysrc.html#render">source&nbsp;code</a></span>
    225. 

  225.             
    226. 

  226.           </td>
    227. 

  227.         </tr>
    228. 

  228.       </table>
    229. 

  229.       
    230. 

  230.     </td>
    231. 

  231.   </tr>
    232. 

  232. <tr>
    233. 

  233.     <td width="15%" align="right" valign="top" class="summary">
    234. 

  234.       <span class="summary-type">&nbsp;</span>
    235. 

  235.     </td><td class="summary">
    236. 

  236.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    237. 

  237.         <tr>
    238. 

  238.           <td><span class="summary-sig"><a name="humanize_time"></a><span class="summary-sig-name">humanize_time</span>(<span class="summary-sig-arg">secs</span>)</span><br />
    239. 

  239.       Turns seconds into a string of the form HH:MM:SS, or MM:SS if less than one hour.</td>
    240. 

  240.           <td align="right" valign="top">
    241. 

  241.             <span class="codelink"><a href="echonest.action-pysrc.html#humanize_time">source&nbsp;code</a></span>
    242. 

  242.             
    243. 

  243.           </td>
    244. 

  244.         </tr>
    245. 

  245.       </table>
    246. 

  246.       
    247. 

  247.     </td>
    248. 

  248.   </tr>
    249. 

  249. <tr>
    250. 

  250.     <td width="15%" align="right" valign="top" class="summary">
    251. 

  251.       <span class="summary-type">&nbsp;</span>
    252. 

  252.     </td><td class="summary">
    253. 

  253.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    254. 

  254.         <tr>
    255. 

  255.           <td><span class="summary-sig"><a name="display_actions"></a><span class="summary-sig-name">display_actions</span>(<span class="summary-sig-arg">actions</span>)</span></td>
    256. 

  256.           <td align="right" valign="top">
    257. 

  257.             <span class="codelink"><a href="echonest.action-pysrc.html#display_actions">source&nbsp;code</a></span>
    258. 

  258.             
    259. 

  259.           </td>
    260. 

  260.         </tr>
    261. 

  261.       </table>
    262. 

  262.       
    263. 

  263.     </td>
    264. 

  264.   </tr>
    265. 

  265. </table>
    266. 

  266. <!-- ==================== VARIABLES ==================== -->
    267. 

  267. <a name="section-Variables"></a>
    268. 

  268. <table class="summary" border="1" cellpadding="3"
    269. 

  269.        cellspacing="0" width="100%" bgcolor="white">
    270. 

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

  271.   <td colspan="2" class="table-header">
    272. 

  272.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    273. 

  273.       <tr valign="top">
    274. 

  274.         <td align="left"><span class="table-header">Variables</span></td>
    275. 

  275.         <td align="right" valign="top"
    276. 

  276.          ><span class="options">[<a href="#section-Variables"
    277. 

  277.          class="privatelink" onclick="toggle_private();"
    278. 

  278.          >hide private</a>]</span></td>
    279. 

  279.       </tr>
    280. 

  280.     </table>
    281. 

  281.   </td>
    282. 

  282. </tr>
    283. 

  283. <tr>
    284. 

  284.     <td width="15%" align="right" valign="top" class="summary">
    285. 

  285.       <span class="summary-type">&nbsp;</span>
    286. 

  286.     </td><td class="summary">
    287. 

  287.         <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>
    288. 

  288.     </td>
    289. 

  289.   </tr>
    290. 

  290. </table>
    291. 

  291. <!-- ==================== FUNCTION DETAILS ==================== -->
    292. 

  292. <a name="section-FunctionDetails"></a>
    293. 

  293. <table class="details" border="1" cellpadding="3"
    294. 

  294.        cellspacing="0" width="100%" bgcolor="white">
    295. 

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

  296.   <td colspan="2" class="table-header">
    297. 

  297.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    298. 

  298.       <tr valign="top">
    299. 

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

  300.         <td align="right" valign="top"
    301. 

  301.          ><span class="options">[<a href="#section-FunctionDetails"
    302. 

  302.          class="privatelink" onclick="toggle_private();"
    303. 

  303.          >hide private</a>]</span></td>
    304. 

  304.       </tr>
    305. 

  305.     </table>
    306. 

  306.   </td>
    307. 

  307. </tr>
    308. 

  308. </table>
    309. 

  309. <a name="make_stereo"></a>
    310. 

  310. <div>
    311. 

  311. <table class="details" border="1" cellpadding="3"
    312. 

  312.        cellspacing="0" width="100%" bgcolor="white">
    313. 

  313. <tr><td>
    314. 

  314.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    315. 

  315.   <tr valign="top"><td>
    316. 

  316.   <h3 class="epydoc"><span class="sig"><span class="sig-name">make_stereo</span>(<span class="sig-arg">track</span>)</span>
    317. 

  317.   </h3>
    318. 

  318.   </td><td align="right" valign="top"
    319. 

  319.     ><span class="codelink"><a href="echonest.action-pysrc.html#make_stereo">source&nbsp;code</a></span>&nbsp;
    320. 

  320.     </td>
    321. 

  321.   </tr></table>
    322. 

  322.   
    323. 

  323.   If the track is mono, doubles it. otherwise, does nothing.
    324. 

  324.   <dl class="fields">
    325. 

  325.   </dl>
    326. 

  326. </td></tr></table>
    327. 

  327. </div>
    328. 

  328. <br />
    329. 

  329. <!-- ==================== NAVIGATION BAR ==================== -->
    330. 

  330. <table class="navbar" border="0" width="100%" cellpadding="0"
    331. 

  331.        bgcolor="#a0c0ff" cellspacing="0">
    332. 

  332.   <tr valign="middle">
    333. 

  333. 

  334.   <!-- Tree link -->
    335. 

  335.       <th>&nbsp;&nbsp;&nbsp;<a
    336. 

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

  337. 

  338.   <!-- Index link -->
    339. 

  339.       <th>&nbsp;&nbsp;&nbsp;<a
    340. 

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

  341. 

  342.   <!-- Help link -->
    343. 

  343.       <th>&nbsp;&nbsp;&nbsp;<a
    344. 

  344.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    345. 

  345. 

  346.   <!-- Project homepage -->
    347. 

  347.       <th class="navbar" align="right" width="100%">
    348. 

  348.         <table border="0" cellpadding="0" cellspacing="0">
    349. 

  349.           <tr><th class="navbar" align="center"
    350. 

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

  351.           </tr></table></th>
    352. 

  352.   </tr>
    353. 

  353. </table>
    354. 

  354. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    355. 

  355.   <tr>
    356. 

  356.     <td align="left" class="footer">
    357. 

  357.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
    358. 

  358.     </td>
    359. 

  359.     <td align="right" class="footer">
    360. 

  360.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    361. 

  361.         >http://epydoc.sourceforge.net</a>
    362. 

  362.     </td>
    363. 

  363.   </tr>
    364. 

  364. </table>
    365. 

  365. 

  366. <script type="text/javascript">
    367. 

  367.   <!--
    368. 

  368.   // Private objects are initially displayed (because if
    369. 

  369.   // javascript is turned off then we want them to be
    370. 

  370.   // visible); but by default, we want to hide them.  So hide
    371. 

  371.   // them unless we have a cookie that says to show them.
    372. 

  372.   checkCookie();
    373. 

  373.   // -->
    374. 

  374. </script>
    375. 

  375. </body>
    376. 

  376. </html>
    377.