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

http://echo-nest-remix.googlecode.com/ · HTML · 327 lines · 283 code · 21 blank · 23 comment · 0 complexity · 7809c221517a1c8424d90a874cbcca83 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.AudioRenderable</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;AudioRenderable
    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.AudioRenderable-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 AudioRenderable</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#AudioRenderable">source&nbsp;code</a></span></p>
    62. 

  62. <center>
    63. 

  63. 

  64. </center>
    65. 

  65. <hr />
    66. 

  66. <p>An object that gives an <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> in response to a call to its <code class="link">render</code>()
    67. 

  67. method.
    68. 

  68. Intended to be an abstract class that helps enforce the <a href="echonest.audio.AudioRenderable-class.html" class="link">AudioRenderable</a>
    69. 

  69. protocol. Picked up a couple of convenience methods common to many descendants.</p>
    70. 

  70. <p>Every <a href="echonest.audio.AudioRenderable-class.html" class="link">AudioRenderable</a> must provide three things:</p>
    71. 

  71. <dl class="rst-docutils">
    72. 

  72. <dt>render()</dt>
    73. 

  73. <dd>A method returning the <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> for the object. The rhythmic duration (point
    74. 

  74. at which any following audio is appended) is signified by the <code class="link">endindex</code> accessor,
    75. 

  75. measured in samples.</dd>
    76. 

  76. <dt>source</dt>
    77. 

  77. <dd>An accessor pointing to the <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> that contains the original sample data of
    78. 

  78. (a superset of) this audio object.</dd>
    79. 

  79. <dt>duration</dt>
    80. 

  80. <dd>An accessor returning the rhythmic duration (in seconds) of the audio object.</dd>
    81. 

  81. </dl>
    82. 

  82. 

  83. <!-- ==================== INSTANCE METHODS ==================== -->
    84. 

  84. <a name="section-InstanceMethods"></a>
    85. 

  85. <table class="summary" border="1" cellpadding="3"
    86. 

  86.        cellspacing="0" width="100%" bgcolor="white">
    87. 

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

  88.   <td colspan="2" class="table-header">
    89. 

  89.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    90. 

  90.       <tr valign="top">
    91. 

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

  92.         <td align="right" valign="top"
    93. 

  93.          ><span class="options">[<a href="#section-InstanceMethods"
    94. 

  94.          class="privatelink" onclick="toggle_private();"
    95. 

  95.          >hide private</a>]</span></td>
    96. 

  96.       </tr>
    97. 

  97.     </table>
    98. 

  98.   </td>
    99. 

  99. </tr>
    100. 

  100. <tr>
    101. 

  101.     <td width="15%" align="right" valign="top" class="summary">
    102. 

  102.       <span class="summary-type">&nbsp;</span>
    103. 

  103.     </td><td class="summary">
    104. 

  104.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    105. 

  105.         <tr>
    106. 

  106.           <td><span class="summary-sig"><a href="echonest.audio.AudioRenderable-class.html#resolve_source" class="summary-sig-name">resolve_source</a>(<span class="summary-sig-arg">self</span>,
    107. 

  107.         <span class="summary-sig-arg">alt</span>)</span><br />
    108. 

  108.       Given an alternative, fallback <code class="link">alt</code> source, return either <code class="link">self</code>'s
    109. 

  109. source or the alternative.</td>
    110. 

  110.           <td align="right" valign="top">
    111. 

  111.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioRenderable.resolve_source">source&nbsp;code</a></span>
    112. 

  112.             
    113. 

  113.           </td>
    114. 

  114.         </tr>
    115. 

  115.       </table>
    116. 

  116.       
    117. 

  117.     </td>
    118. 

  118.   </tr>
    119. 

  119. <tr>
    120. 

  120.     <td width="15%" align="right" valign="top" class="summary">
    121. 

  121.       <span class="summary-type">&nbsp;</span>
    122. 

  122.     </td><td class="summary">
    123. 

  123.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    124. 

  124.         <tr>
    125. 

  125.           <td><span class="summary-sig"><a name="sources"></a><span class="summary-sig-name">sources</span>(<span class="summary-sig-arg">self</span>)</span></td>
    126. 

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

  127.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioRenderable.sources">source&nbsp;code</a></span>
    128. 

  128.             
    129. 

  129.           </td>
    130. 

  130.         </tr>
    131. 

  131.       </table>
    132. 

  132.       
    133. 

  133.     </td>
    134. 

  134.   </tr>
    135. 

  135. <tr>
    136. 

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

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

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

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

  140.         <tr>
    141. 

  141.           <td><span class="summary-sig"><a name="encode"></a><span class="summary-sig-name">encode</span>(<span class="summary-sig-arg">self</span>,
    142. 

  142.         <span class="summary-sig-arg">filename</span>)</span><br />
    143. 

  143.       Shortcut function that takes care of the need to obtain an <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a>
    144. 

  144. object first, through <code class="link">render</code>.</td>
    145. 

  145.           <td align="right" valign="top">
    146. 

  146.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioRenderable.encode">source&nbsp;code</a></span>
    147. 

  147.             
    148. 

  148.           </td>
    149. 

  149.         </tr>
    150. 

  150.       </table>
    151. 

  151.       
    152. 

  152.     </td>
    153. 

  153.   </tr>
    154. 

  154.   <tr>
    155. 

  155.     <td colspan="2" class="summary">
    156. 

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

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

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

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

  160.       <code>__hash__</code>,
    161. 

  161.       <code>__init__</code>,
    162. 

  162.       <code>__new__</code>,
    163. 

  163.       <code>__reduce__</code>,
    164. 

  164.       <code>__reduce_ex__</code>,
    165. 

  165.       <code>__repr__</code>,
    166. 

  166.       <code>__setattr__</code>,
    167. 

  167.       <code>__sizeof__</code>,
    168. 

  168.       <code>__str__</code>,
    169. 

  169.       <code>__subclasshook__</code>
    170. 

  170.       </p>
    171. 

  171.     </td>
    172. 

  172.   </tr>
    173. 

  173. </table>
    174. 

  174. <!-- ==================== STATIC METHODS ==================== -->
    175. 

  175. <a name="section-StaticMethods"></a>
    176. 

  176. <table class="summary" border="1" cellpadding="3"
    177. 

  177.        cellspacing="0" width="100%" bgcolor="white">
    178. 

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

  179.   <td colspan="2" class="table-header">
    180. 

  180.     <table border="0" cellpadding="0" cellspacing="0" width="100%">
    181. 

  181.       <tr valign="top">
    182. 

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

  183.         <td align="right" valign="top"
    184. 

  184.          ><span class="options">[<a href="#section-StaticMethods"
    185. 

  185.          class="privatelink" onclick="toggle_private();"
    186. 

  186.          >hide private</a>]</span></td>
    187. 

  187.       </tr>
    188. 

  188.     </table>
    189. 

  189.   </td>
    190. 

  190. </tr>
    191. 

  191. <tr>
    192. 

  192.     <td width="15%" align="right" valign="top" class="summary">
    193. 

  193.       <span class="summary-type">&nbsp;</span>
    194. 

  194.     </td><td class="summary">
    195. 

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

  196.         <tr>
    197. 

  197.           <td><span class="summary-sig"><a name="init_audio_data"></a><span class="summary-sig-name">init_audio_data</span>(<span class="summary-sig-arg">source</span>,
    198. 

  198.         <span class="summary-sig-arg">num_samples</span>)</span><br />
    199. 

  199.       Convenience function for rendering: return a pre-allocated, zeroed
    200. 

  200. <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a>.</td>
    201. 

  201.           <td align="right" valign="top">
    202. 

  202.             <span class="codelink"><a href="echonest.audio-pysrc.html#AudioRenderable.init_audio_data">source&nbsp;code</a></span>
    203. 

  203.             
    204. 

  204.           </td>
    205. 

  205.         </tr>
    206. 

  206.       </table>
    207. 

  207.       
    208. 

  208.     </td>
    209. 

  209.   </tr>
    210. 

  210. </table>
    211. 

  211. <!-- ==================== PROPERTIES ==================== -->
    212. 

  212. <a name="section-Properties"></a>
    213. 

  213. <table class="summary" border="1" cellpadding="3"
    214. 

  214.        cellspacing="0" width="100%" bgcolor="white">
    215. 

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

  216.   <td colspan="2" class="table-header">
    217. 

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

  218.       <tr valign="top">
    219. 

  219.         <td align="left"><span class="table-header">Properties</span></td>
    220. 

  220.         <td align="right" valign="top"
    221. 

  221.          ><span class="options">[<a href="#section-Properties"
    222. 

  222.          class="privatelink" onclick="toggle_private();"
    223. 

  223.          >hide private</a>]</span></td>
    224. 

  224.       </tr>
    225. 

  225.     </table>
    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="resolve_source"></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">resolve_source</span>(<span class="sig-arg">self</span>,
    262. 

  262.         <span class="sig-arg">alt</span>)</span>
    263. 

  263.   </h3>
    264. 

  264.   </td><td align="right" valign="top"
    265. 

  265.     ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioRenderable.resolve_source">source&nbsp;code</a></span>&nbsp;
    266. 

  266.     </td>
    267. 

  267.   </tr></table>
    268. 

  268.   
    269. 

  269.   <p>Given an alternative, fallback <code class="link">alt</code> source, return either <code class="link">self</code>'s
    270. 

  270. source or the alternative. Throw an informative error if no source
    271. 

  271. is found.</p>
    272. 

  272. <p>Utility code that ended up being replicated in several places, so
    273. 

  273. it ended up here. Not necessary for use in the RenderableAudioObject
    274. 

  274. protocol.</p>
    275. 

  275.   <dl class="fields">
    276. 

  276.   </dl>
    277. 

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

  278. </div>
    279. 

  279. <br />
    280. 

  280. <!-- ==================== NAVIGATION BAR ==================== -->
    281. 

  281. <table class="navbar" border="0" width="100%" cellpadding="0"
    282. 

  282.        bgcolor="#a0c0ff" cellspacing="0">
    283. 

  283.   <tr valign="middle">
    284. 

  284. 

  285.   <!-- Tree link -->
    286. 

  286.       <th>&nbsp;&nbsp;&nbsp;<a
    287. 

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

  288. 

  289.   <!-- Index link -->
    290. 

  290.       <th>&nbsp;&nbsp;&nbsp;<a
    291. 

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

  292. 

  293.   <!-- Help link -->
    294. 

  294.       <th>&nbsp;&nbsp;&nbsp;<a
    295. 

  295.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    296. 

  296. 

  297.   <!-- Project homepage -->
    298. 

  298.       <th class="navbar" align="right" width="100%">
    299. 

  299.         <table border="0" cellpadding="0" cellspacing="0">
    300. 

  300.           <tr><th class="navbar" align="center"
    301. 

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

  302.           </tr></table></th>
    303. 

  303.   </tr>
    304. 

  304. </table>
    305. 

  305. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    306. 

  306.   <tr>
    307. 

  307.     <td align="left" class="footer">
    308. 

  308.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
    309. 

  309.     </td>
    310. 

  310.     <td align="right" class="footer">
    311. 

  311.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    312. 

  312.         >http://epydoc.sourceforge.net</a>
    313. 

  313.     </td>
    314. 

  314.   </tr>
    315. 

  315. </table>
    316. 

  316. 

  317. <script type="text/javascript">
    318. 

  318.   <!--
    319. 

  319.   // Private objects are initially displayed (because if
    320. 

  320.   // javascript is turned off then we want them to be
    321. 

  321.   // visible); but by default, we want to hide them.  So hide
    322. 

  322.   // them unless we have a cookie that says to show them.
    323. 

  323.   checkCookie();
    324. 

  324.   // -->
    325. 

  325. </script>
    326. 

  326. </body>
    327. 

  327. </html>
    328.