/apidocs/echonest.modify.Modify-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 424 lines · 370 code · 32 blank · 22 comment · 0 complexity · 770f0f438258bf226cd1a4c90cefb174 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.modify.Modify</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.modify-module.html">Module&nbsp;modify</a> ::
  39. Class&nbsp;Modify
  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.modify.Modify-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 Modify</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.modify-pysrc.html#Modify">source&nbsp;code</a></span></p>
  57. <center>
  58. </center>
  59. <hr />
  60. <!-- ==================== INSTANCE METHODS ==================== -->
  61. <a name="section-InstanceMethods"></a>
  62. <table class="summary" border="1" cellpadding="3"
  63. cellspacing="0" width="100%" bgcolor="white">
  64. <tr bgcolor="#70b0f0" class="table-header">
  65. <td colspan="2" class="table-header">
  66. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  67. <tr valign="top">
  68. <td align="left"><span class="table-header">Instance Methods</span></td>
  69. <td align="right" valign="top"
  70. ><span class="options">[<a href="#section-InstanceMethods"
  71. class="privatelink" onclick="toggle_private();"
  72. >hide private</a>]</span></td>
  73. </tr>
  74. </table>
  75. </td>
  76. </tr>
  77. <tr>
  78. <td width="15%" align="right" valign="top" class="summary">
  79. <span class="summary-type">&nbsp;</span>
  80. </td><td class="summary">
  81. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  82. <tr>
  83. <td><span class="summary-sig"><a href="echonest.modify.Modify-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
  84. <span class="summary-sig-arg">sampleRate</span>=<span class="summary-sig-default">44100</span>,
  85. <span class="summary-sig-arg">numChannels</span>=<span class="summary-sig-default">1</span>,
  86. <span class="summary-sig-arg">blockSize</span>=<span class="summary-sig-default">10000</span>)</span><br />
  87. x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
  88. <td align="right" valign="top">
  89. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.__init__">source&nbsp;code</a></span>
  90. </td>
  91. </tr>
  92. </table>
  93. </td>
  94. </tr>
  95. <tr>
  96. <td width="15%" align="right" valign="top" class="summary">
  97. <span class="summary-type">&nbsp;</span>
  98. </td><td class="summary">
  99. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  100. <tr>
  101. <td><span class="summary-sig"><a name="doInBlocks"></a><span class="summary-sig-name">doInBlocks</span>(<span class="summary-sig-arg">self</span>,
  102. <span class="summary-sig-arg">f</span>,
  103. <span class="summary-sig-arg">in_data</span>,
  104. <span class="summary-sig-arg">arg</span>)</span></td>
  105. <td align="right" valign="top">
  106. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.doInBlocks">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="processAudio"></a><span class="summary-sig-name">processAudio</span>(<span class="summary-sig-arg">self</span>,
  119. <span class="summary-sig-arg">f</span>,
  120. <span class="summary-sig-arg">data</span>,
  121. <span class="summary-sig-arg">arg</span>)</span></td>
  122. <td align="right" valign="top">
  123. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.processAudio">source&nbsp;code</a></span>
  124. </td>
  125. </tr>
  126. </table>
  127. </td>
  128. </tr>
  129. <tr>
  130. <td width="15%" align="right" valign="top" class="summary">
  131. <span class="summary-type">&nbsp;</span>
  132. </td><td class="summary">
  133. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  134. <tr>
  135. <td><span class="summary-sig"><a name="shiftRate"></a><span class="summary-sig-name">shiftRate</span>(<span class="summary-sig-arg">self</span>,
  136. <span class="summary-sig-arg">audio_data</span>,
  137. <span class="summary-sig-arg">ratio</span>=<span class="summary-sig-default">1</span>)</span></td>
  138. <td align="right" valign="top">
  139. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftRate">source&nbsp;code</a></span>
  140. </td>
  141. </tr>
  142. </table>
  143. </td>
  144. </tr>
  145. <tr>
  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="shiftTempo"></a><span class="summary-sig-name">shiftTempo</span>(<span class="summary-sig-arg">self</span>,
  152. <span class="summary-sig-arg">audio_data</span>,
  153. <span class="summary-sig-arg">ratio</span>)</span></td>
  154. <td align="right" valign="top">
  155. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftTempo">source&nbsp;code</a></span>
  156. </td>
  157. </tr>
  158. </table>
  159. </td>
  160. </tr>
  161. <tr>
  162. <td width="15%" align="right" valign="top" class="summary">
  163. <span class="summary-type">&nbsp;</span>
  164. </td><td class="summary">
  165. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  166. <tr>
  167. <td><span class="summary-sig"><a name="shiftRateChange"></a><span class="summary-sig-name">shiftRateChange</span>(<span class="summary-sig-arg">self</span>,
  168. <span class="summary-sig-arg">audio_data</span>,
  169. <span class="summary-sig-arg">percent</span>)</span></td>
  170. <td align="right" valign="top">
  171. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftRateChange">source&nbsp;code</a></span>
  172. </td>
  173. </tr>
  174. </table>
  175. </td>
  176. </tr>
  177. <tr>
  178. <td width="15%" align="right" valign="top" class="summary">
  179. <span class="summary-type">&nbsp;</span>
  180. </td><td class="summary">
  181. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  182. <tr>
  183. <td><span class="summary-sig"><a name="shiftTempoChange"></a><span class="summary-sig-name">shiftTempoChange</span>(<span class="summary-sig-arg">self</span>,
  184. <span class="summary-sig-arg">audio_data</span>,
  185. <span class="summary-sig-arg">percent</span>)</span></td>
  186. <td align="right" valign="top">
  187. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftTempoChange">source&nbsp;code</a></span>
  188. </td>
  189. </tr>
  190. </table>
  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. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  198. <tr>
  199. <td><span class="summary-sig"><a name="shiftPitchSemiTones"></a><span class="summary-sig-name">shiftPitchSemiTones</span>(<span class="summary-sig-arg">self</span>,
  200. <span class="summary-sig-arg">audio_data</span>,
  201. <span class="summary-sig-arg">semitones</span>=<span class="summary-sig-default">0</span>)</span></td>
  202. <td align="right" valign="top">
  203. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftPitchSemiTones">source&nbsp;code</a></span>
  204. </td>
  205. </tr>
  206. </table>
  207. </td>
  208. </tr>
  209. <tr>
  210. <td width="15%" align="right" valign="top" class="summary">
  211. <span class="summary-type">&nbsp;</span>
  212. </td><td class="summary">
  213. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  214. <tr>
  215. <td><span class="summary-sig"><a name="shiftPitchOctaves"></a><span class="summary-sig-name">shiftPitchOctaves</span>(<span class="summary-sig-arg">self</span>,
  216. <span class="summary-sig-arg">audio_data</span>,
  217. <span class="summary-sig-arg">octaves</span>=<span class="summary-sig-default">0</span>)</span></td>
  218. <td align="right" valign="top">
  219. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftPitchOctaves">source&nbsp;code</a></span>
  220. </td>
  221. </tr>
  222. </table>
  223. </td>
  224. </tr>
  225. <tr>
  226. <td width="15%" align="right" valign="top" class="summary">
  227. <span class="summary-type">&nbsp;</span>
  228. </td><td class="summary">
  229. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  230. <tr>
  231. <td><span class="summary-sig"><a name="shiftPitch"></a><span class="summary-sig-name">shiftPitch</span>(<span class="summary-sig-arg">self</span>,
  232. <span class="summary-sig-arg">audio_data</span>,
  233. <span class="summary-sig-arg">ratio</span>=<span class="summary-sig-default">1</span>)</span></td>
  234. <td align="right" valign="top">
  235. <span class="codelink"><a href="echonest.modify-pysrc.html#Modify.shiftPitch">source&nbsp;code</a></span>
  236. </td>
  237. </tr>
  238. </table>
  239. </td>
  240. </tr>
  241. <tr>
  242. <td colspan="2" class="summary">
  243. <p class="indent-wrapped-lines"><b>Inherited from <code>soundtouch.SoundTouch</code></b>:
  244. <code>__new__</code>,
  245. <code>clear</code>,
  246. <code>flush</code>,
  247. <code>getSetting</code>,
  248. <code>isEmpty</code>,
  249. <code>numSamples</code>,
  250. <code>numUnprocessedSamples</code>,
  251. <code>putSamples</code>,
  252. <code>receiveSamples</code>,
  253. <code>setChannels</code>,
  254. <code>setPitch</code>,
  255. <code>setPitchOctaves</code>,
  256. <code>setPitchSemiTones</code>,
  257. <code>setRate</code>,
  258. <code>setRateChange</code>,
  259. <code>setSampleRate</code>,
  260. <code>setSetting</code>,
  261. <code>setTempo</code>,
  262. <code>setTempoChange</code>
  263. </p>
  264. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  265. <code>__delattr__</code>,
  266. <code>__format__</code>,
  267. <code>__getattribute__</code>,
  268. <code>__hash__</code>,
  269. <code>__reduce__</code>,
  270. <code>__reduce_ex__</code>,
  271. <code>__repr__</code>,
  272. <code>__setattr__</code>,
  273. <code>__sizeof__</code>,
  274. <code>__str__</code>,
  275. <code>__subclasshook__</code>
  276. </p>
  277. </td>
  278. </tr>
  279. </table>
  280. <!-- ==================== PROPERTIES ==================== -->
  281. <a name="section-Properties"></a>
  282. <table class="summary" border="1" cellpadding="3"
  283. cellspacing="0" width="100%" bgcolor="white">
  284. <tr bgcolor="#70b0f0" class="table-header">
  285. <td colspan="2" class="table-header">
  286. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  287. <tr valign="top">
  288. <td align="left"><span class="table-header">Properties</span></td>
  289. <td align="right" valign="top"
  290. ><span class="options">[<a href="#section-Properties"
  291. class="privatelink" onclick="toggle_private();"
  292. >hide private</a>]</span></td>
  293. </tr>
  294. </table>
  295. </td>
  296. </tr>
  297. <tr>
  298. <td colspan="2" class="summary">
  299. <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
  300. <code>__class__</code>
  301. </p>
  302. </td>
  303. </tr>
  304. </table>
  305. <!-- ==================== METHOD DETAILS ==================== -->
  306. <a name="section-MethodDetails"></a>
  307. <table class="details" border="1" cellpadding="3"
  308. cellspacing="0" width="100%" bgcolor="white">
  309. <tr bgcolor="#70b0f0" class="table-header">
  310. <td colspan="2" class="table-header">
  311. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  312. <tr valign="top">
  313. <td align="left"><span class="table-header">Method Details</span></td>
  314. <td align="right" valign="top"
  315. ><span class="options">[<a href="#section-MethodDetails"
  316. class="privatelink" onclick="toggle_private();"
  317. >hide private</a>]</span></td>
  318. </tr>
  319. </table>
  320. </td>
  321. </tr>
  322. </table>
  323. <a name="__init__"></a>
  324. <div>
  325. <table class="details" border="1" cellpadding="3"
  326. cellspacing="0" width="100%" bgcolor="white">
  327. <tr><td>
  328. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  329. <tr valign="top"><td>
  330. <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
  331. <span class="sig-arg">sampleRate</span>=<span class="sig-default">44100</span>,
  332. <span class="sig-arg">numChannels</span>=<span class="sig-default">1</span>,
  333. <span class="sig-arg">blockSize</span>=<span class="sig-default">10000</span>)</span>
  334. <br /><em class="fname">(Constructor)</em>
  335. </h3>
  336. </td><td align="right" valign="top"
  337. ><span class="codelink"><a href="echonest.modify-pysrc.html#Modify.__init__">source&nbsp;code</a></span>&nbsp;
  338. </td>
  339. </tr></table>
  340. x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  341. <dl class="fields">
  342. <dt>Overrides:
  343. object.__init__
  344. <dd><em class="note">(inherited documentation)</em></dd>
  345. </dt>
  346. </dl>
  347. </td></tr></table>
  348. </div>
  349. <br />
  350. <!-- ==================== NAVIGATION BAR ==================== -->
  351. <table class="navbar" border="0" width="100%" cellpadding="0"
  352. bgcolor="#a0c0ff" cellspacing="0">
  353. <tr valign="middle">
  354. <!-- Tree link -->
  355. <th>&nbsp;&nbsp;&nbsp;<a
  356. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  357. <!-- Index link -->
  358. <th>&nbsp;&nbsp;&nbsp;<a
  359. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  360. <!-- Help link -->
  361. <th>&nbsp;&nbsp;&nbsp;<a
  362. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  363. <!-- Project homepage -->
  364. <th class="navbar" align="right" width="100%">
  365. <table border="0" cellpadding="0" cellspacing="0">
  366. <tr><th class="navbar" align="center"
  367. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  368. </tr></table></th>
  369. </tr>
  370. </table>
  371. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  372. <tr>
  373. <td align="left" class="footer">
  374. Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:58 2010
  375. </td>
  376. <td align="right" class="footer">
  377. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  378. >http://epydoc.sourceforge.net</a>
  379. </td>
  380. </tr>
  381. </table>
  382. <script type="text/javascript">
  383. <!--
  384. // Private objects are initially displayed (because if
  385. // javascript is turned off then we want them to be
  386. // visible); but by default, we want to hide them. So hide
  387. // them unless we have a cookie that says to show them.
  388. checkCookie();
  389. // -->
  390. </script>
  391. </body>
  392. </html>