/apidocs/echonest.audio.ModifiedRenderable-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 389 lines · 343 code · 22 blank · 24 comment · 0 complexity · c2b48e4aed560bb3ed38066e53cf7068 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.audio.ModifiedRenderable</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.         <a href="echonest.audio-module.html">Module&nbsp;audio</a> ::
    44. 

  44.         Class&nbsp;ModifiedRenderable
    45. 

  45.       </span>
    46. 

  46.     </td>
    47. 

  47.     <td>
    48. 

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

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

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

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

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

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

  54.             >]&nbsp;|&nbsp;<a href="echonest.audio.ModifiedRenderable-class.html"
    55. 

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

  56.       </table>
    57. 

  57.     </td>
    58. 

  58.   </tr>
    59. 

  59. </table>
    60. 

  60. <!-- ==================== CLASS DESCRIPTION ==================== -->
    61. 

  61. <h1 class="epydoc">Class ModifiedRenderable</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable">source&nbsp;code</a></span></p>
    62. 

  62. <center>
    63. 

  63. 

  64. </center>
    65. 

  65. <hr />
    66. 

  66. Class that contains any AudioRenderable, but overrides the
    67. 

  67. render() method with nested effects, called sequentially on the
    68. 

  68. result of the preceeding effect.
    69. 

  69. 

  70. <!-- ==================== INSTANCE METHODS ==================== -->
    71. 

  71. <a name="section-InstanceMethods"></a>
    72. 

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

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

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

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

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

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

  78.         <td align="left"><span class="table-header">Instance Methods</span></td>
    79. 

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

  80.          ><span class="options">[<a href="#section-InstanceMethods"
    81. 

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

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

  83.       </tr>
    84. 

  84.     </table>
    85. 

  85.   </td>
    86. 

  86. </tr>
    87. 

  87. <tr>
    88. 

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

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

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

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

  92.         <tr>
    93. 

  93.           <td><span class="summary-sig"><a href="echonest.audio.ModifiedRenderable-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
    94. 

  94.         <span class="summary-sig-arg">original</span>,
    95. 

  95.         <span class="summary-sig-arg">effects</span>=<span class="summary-sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span><br />
    96. 

  96.       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
    97. 

  97.           <td align="right" valign="top">
    98. 

  98.             <span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.__init__">source&nbsp;code</a></span>
    99. 

  99.             
    100. 

  100.           </td>
    101. 

  101.         </tr>
    102. 

  102.       </table>
    103. 

  103.       
    104. 

  104.     </td>
    105. 

  105.   </tr>
    106. 

  106. <tr>
    107. 

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

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

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

  110.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    111. 

  111.         <tr>
    112. 

  112.           <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">self</span>,
    113. 

  113.         <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0.0</span>,
    114. 

  114.         <span class="summary-sig-arg">to_audio</span>=<span class="summary-sig-default">None</span>,
    115. 

  115.         <span class="summary-sig-arg">with_source</span>=<span class="summary-sig-default">None</span>)</span></td>
    116. 

  116.           <td align="right" valign="top">
    117. 

  117.             <span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.render">source&nbsp;code</a></span>
    118. 

  118.             
    119. 

  119.           </td>
    120. 

  120.         </tr>
    121. 

  121.       </table>
    122. 

  122.       
    123. 

  123.     </td>
    124. 

  124.   </tr>
    125. 

  125. <tr>
    126. 

  126.     <td width="15%" align="right" valign="top" class="summary">
    127. 

  127.       <span class="summary-type">&nbsp;</span>
    128. 

  128.     </td><td class="summary">
    129. 

  129.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    130. 

  130.         <tr>
    131. 

  131.           <td><span class="summary-sig"><a name="toxml"></a><span class="summary-sig-name">toxml</span>(<span class="summary-sig-arg">self</span>,
    132. 

  132.         <span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>)</span></td>
    133. 

  133.           <td align="right" valign="top">
    134. 

  134.             <span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.toxml">source&nbsp;code</a></span>
    135. 

  135.             
    136. 

  136.           </td>
    137. 

  137.         </tr>
    138. 

  138.       </table>
    139. 

  139.       
    140. 

  140.     </td>
    141. 

  141.   </tr>
    142. 

  142.   <tr>
    143. 

  143.     <td colspan="2" class="summary">
    144. 

  144.     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
    145. 

  145.       <code><a href="echonest.audio.AudioRenderable-class.html#encode">encode</a></code>,
    146. 

  146.       <code><a href="echonest.audio.AudioRenderable-class.html#resolve_source">resolve_source</a></code>
    147. 

  147.       </p>
    148. 

  148.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    149. 

  149.       <code>__delattr__</code>,
    150. 

  150.       <code>__format__</code>,
    151. 

  151.       <code>__getattribute__</code>,
    152. 

  152.       <code>__hash__</code>,
    153. 

  153.       <code>__new__</code>,
    154. 

  154.       <code>__reduce__</code>,
    155. 

  155.       <code>__reduce_ex__</code>,
    156. 

  156.       <code>__repr__</code>,
    157. 

  157.       <code>__setattr__</code>,
    158. 

  158.       <code>__sizeof__</code>,
    159. 

  159.       <code>__str__</code>,
    160. 

  160.       <code>__subclasshook__</code>
    161. 

  161.       </p>
    162. 

  162.     </td>
    163. 

  163.   </tr>
    164. 

  164. </table>
    165. 

  165. <!-- ==================== STATIC METHODS ==================== -->
    166. 

  166. <a name="section-StaticMethods"></a>
    167. 

  167. <table class="summary" border="1" cellpadding="3"
    168. 

  168.        cellspacing="0" width="100%" bgcolor="white">
    169. 

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

  170.   <td colspan="2" class="table-header">
    171. 

  171.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    172. 

  172.       <tr valign="top">
    173. 

  173.         <td align="left"><span class="table-header">Static Methods</span></td>
    174. 

  174.         <td align="right" valign="top"
    175. 

  175.          ><span class="options">[<a href="#section-StaticMethods"
    176. 

  176.          class="privatelink" onclick="toggle_private();"
    177. 

  177.          >hide private</a>]</span></td>
    178. 

  178.       </tr>
    179. 

  179.     </table>
    180. 

  180.   </td>
    181. 

  181. </tr>
    182. 

  182.   <tr>
    183. 

  183.     <td colspan="2" class="summary">
    184. 

  184.     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
    185. 

  185.       <code><a href="echonest.audio.AudioRenderable-class.html#init_audio_data">init_audio_data</a></code>
    186. 

  186.       </p>
    187. 

  187.     </td>
    188. 

  188.   </tr>
    189. 

  189. </table>
    190. 

  190. <!-- ==================== PROPERTIES ==================== -->
    191. 

  191. <a name="section-Properties"></a>
    192. 

  192. <table class="summary" border="1" cellpadding="3"
    193. 

  193.        cellspacing="0" width="100%" bgcolor="white">
    194. 

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

  195.   <td colspan="2" class="table-header">
    196. 

  196.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    197. 

  197.       <tr valign="top">
    198. 

  198.         <td align="left"><span class="table-header">Properties</span></td>
    199. 

  199.         <td align="right" valign="top"
    200. 

  200.          ><span class="options">[<a href="#section-Properties"
    201. 

  201.          class="privatelink" onclick="toggle_private();"
    202. 

  202.          >hide private</a>]</span></td>
    203. 

  203.       </tr>
    204. 

  204.     </table>
    205. 

  205.   </td>
    206. 

  206. </tr>
    207. 

  207. <tr>
    208. 

  208.     <td width="15%" align="right" valign="top" class="summary">
    209. 

  209.       <span class="summary-type">&nbsp;</span>
    210. 

  210.     </td><td class="summary">
    211. 

  211.         <a href="echonest.audio.ModifiedRenderable-class.html#duration" class="summary-name">duration</a>
    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.         <a href="echonest.audio.ModifiedRenderable-class.html#source" class="summary-name">source</a>
    219. 

  219.     </td>
    220. 

  220.   </tr>
    221. 

  221. <tr>
    222. 

  222.     <td width="15%" align="right" valign="top" class="summary">
    223. 

  223.       <span class="summary-type">&nbsp;</span>
    224. 

  224.     </td><td class="summary">
    225. 

  225.         <a href="echonest.audio.ModifiedRenderable-class.html#sources" class="summary-name">sources</a>
    226. 

  226.     </td>
    227. 

  227.   </tr>
    228. 

  228.   <tr>
    229. 

  229.     <td colspan="2" class="summary">
    230. 

  230.     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
    231. 

  231.       <code>__class__</code>
    232. 

  232.       </p>
    233. 

  233.     </td>
    234. 

  234.   </tr>
    235. 

  235. </table>
    236. 

  236. <!-- ==================== METHOD DETAILS ==================== -->
    237. 

  237. <a name="section-MethodDetails"></a>
    238. 

  238. <table class="details" border="1" cellpadding="3"
    239. 

  239.        cellspacing="0" width="100%" bgcolor="white">
    240. 

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

  241.   <td colspan="2" class="table-header">
    242. 

  242.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    243. 

  243.       <tr valign="top">
    244. 

  244.         <td align="left"><span class="table-header">Method Details</span></td>
    245. 

  245.         <td align="right" valign="top"
    246. 

  246.          ><span class="options">[<a href="#section-MethodDetails"
    247. 

  247.          class="privatelink" onclick="toggle_private();"
    248. 

  248.          >hide private</a>]</span></td>
    249. 

  249.       </tr>
    250. 

  250.     </table>
    251. 

  251.   </td>
    252. 

  252. </tr>
    253. 

  253. </table>
    254. 

  254. <a name="__init__"></a>
    255. 

  255. <div>
    256. 

  256. <table class="details" border="1" cellpadding="3"
    257. 

  257.        cellspacing="0" width="100%" bgcolor="white">
    258. 

  258. <tr><td>
    259. 

  259.   <table width="100%" cellpadding="0" cellspacing="0" border="0">
    260. 

  260.   <tr valign="top"><td>
    261. 

  261.   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
    262. 

  262.         <span class="sig-arg">original</span>,
    263. 

  263.         <span class="sig-arg">effects</span>=<span class="sig-default"><code class="variable-group">[</code><code class="variable-group">]</code></span>)</span>
    264. 

  264.     <br /><em class="fname">(Constructor)</em>
    265. 

  265.   </h3>
    266. 

  266.   </td><td align="right" valign="top"
    267. 

  267.     ><span class="codelink"><a href="echonest.audio-pysrc.html#ModifiedRenderable.__init__">source&nbsp;code</a></span>&nbsp;
    268. 

  268.     </td>
    269. 

  269.   </tr></table>
    270. 

  270.   
    271. 

  271.   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
    272. 

  272.   <dl class="fields">
    273. 

  273.     <dt>Overrides:
    274. 

  274.         object.__init__
    275. 

  275.         <dd><em class="note">(inherited documentation)</em></dd>
    276. 

  276.     </dt>
    277. 

  277.   </dl>
    278. 

  278. </td></tr></table>
    279. 

  279. </div>
    280. 

  280. <br />
    281. 

  281. <!-- ==================== PROPERTY DETAILS ==================== -->
    282. 

  282. <a name="section-PropertyDetails"></a>
    283. 

  283. <table class="details" border="1" cellpadding="3"
    284. 

  284.        cellspacing="0" width="100%" bgcolor="white">
    285. 

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

  286.   <td colspan="2" class="table-header">
    287. 

  287.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    288. 

  288.       <tr valign="top">
    289. 

  289.         <td align="left"><span class="table-header">Property Details</span></td>
    290. 

  290.         <td align="right" valign="top"
    291. 

  291.          ><span class="options">[<a href="#section-PropertyDetails"
    292. 

  292.          class="privatelink" onclick="toggle_private();"
    293. 

  293.          >hide private</a>]</span></td>
    294. 

  294.       </tr>
    295. 

  295.     </table>
    296. 

  296.   </td>
    297. 

  297. </tr>
    298. 

  298. </table>
    299. 

  299. <a name="duration"></a>
    300. 

  300. <div>
    301. 

  301. <table class="details" border="1" cellpadding="3"
    302. 

  302.        cellspacing="0" width="100%" bgcolor="white">
    303. 

  303. <tr><td>
    304. 

  304.   <h3 class="epydoc">duration</h3>
    305. 

  305.   
    306. 

  306.   <dl class="fields">
    307. 

  307.     <dt>Get Method:</dt>
    308. 

  308.     <dd class="value"><span class="summary-sig"><i>unreachable</i>.duration(<span class="summary-sig-arg">self</span>)</span>
    309. 

  309.     </dd>
    310. 

  310.   </dl>
    311. 

  311. </td></tr></table>
    312. 

  312. </div>
    313. 

  313. <a name="source"></a>
    314. 

  314. <div>
    315. 

  315. <table class="details" border="1" cellpadding="3"
    316. 

  316.        cellspacing="0" width="100%" bgcolor="white">
    317. 

  317. <tr><td>
    318. 

  318.   <h3 class="epydoc">source</h3>
    319. 

  319.   
    320. 

  320.   <dl class="fields">
    321. 

  321.     <dt>Get Method:</dt>
    322. 

  322.     <dd class="value"><span class="summary-sig"><i>unreachable</i>.source(<span class="summary-sig-arg">self</span>)</span>
    323. 

  323.     </dd>
    324. 

  324.   </dl>
    325. 

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

  326. </div>
    327. 

  327. <a name="sources"></a>
    328. 

  328. <div>
    329. 

  329. <table class="details" border="1" cellpadding="3"
    330. 

  330.        cellspacing="0" width="100%" bgcolor="white">
    331. 

  331. <tr><td>
    332. 

  332.   <h3 class="epydoc">sources</h3>
    333. 

  333.   
    334. 

  334.   <dl class="fields">
    335. 

  335.     <dt>Get Method:</dt>
    336. 

  336.     <dd class="value"><span class="summary-sig"><i>unreachable</i>.sources(<span class="summary-sig-arg">self</span>)</span>
    337. 

  337.     </dd>
    338. 

  338.   </dl>
    339. 

  339. </td></tr></table>
    340. 

  340. </div>
    341. 

  341. <br />
    342. 

  342. <!-- ==================== NAVIGATION BAR ==================== -->
    343. 

  343. <table class="navbar" border="0" width="100%" cellpadding="0"
    344. 

  344.        bgcolor="#a0c0ff" cellspacing="0">
    345. 

  345.   <tr valign="middle">
    346. 

  346. 

  347.   <!-- Tree link -->
    348. 

  348.       <th>&nbsp;&nbsp;&nbsp;<a
    349. 

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

  350. 

  351.   <!-- Index link -->
    352. 

  352.       <th>&nbsp;&nbsp;&nbsp;<a
    353. 

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

  354. 

  355.   <!-- Help link -->
    356. 

  356.       <th>&nbsp;&nbsp;&nbsp;<a
    357. 

  357.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    358. 

  358. 

  359.   <!-- Project homepage -->
    360. 

  360.       <th class="navbar" align="right" width="100%">
    361. 

  361.         <table border="0" cellpadding="0" cellspacing="0">
    362. 

  362.           <tr><th class="navbar" align="center"
    363. 

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

  364.           </tr></table></th>
    365. 

  365.   </tr>
    366. 

  366. </table>
    367. 

  367. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    368. 

  368.   <tr>
    369. 

  369.     <td align="left" class="footer">
    370. 

  370.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
    371. 

  371.     </td>
    372. 

  372.     <td align="right" class="footer">
    373. 

  373.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    374. 

  374.         >http://epydoc.sourceforge.net</a>
    375. 

  375.     </td>
    376. 

  376.   </tr>
    377. 

  377. </table>
    378. 

  378. 

  379. <script type="text/javascript">
    380. 

  380.   <!--
    381. 

  381.   // Private objects are initially displayed (because if
    382. 

  382.   // javascript is turned off then we want them to be
    383. 

  383.   // visible); but by default, we want to hide them.  So hide
    384. 

  384.   // them unless we have a cookie that says to show them.
    385. 

  385.   checkCookie();
    386. 

  386.   // -->
    387. 

  387. </script>
    388. 

  388. </body>
    389. 

  389. </html>
    390.