/apidocs/class-tree.html

http://echo-nest-remix.googlecode.com/ · HTML · 332 lines · 304 code · 10 blank · 18 comment · 0 complexity · 7ab476a9b50896452b288050be1f73d0 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>Class Hierarchy</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 bgcolor="#70b0f0" class="navbar-select"
    20. 

  20.           >&nbsp;&nbsp;&nbsp;Trees&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%">&nbsp;</td>
    41. 

  41.     <td>
    42. 

  42.       <table cellpadding="0" cellspacing="0">
    43. 

  43.         <!-- hide/show private -->
    44. 

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

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

  46.         <tr><td align="right"><span class="options"
    47. 

  47.             >[<a href="frames.html" target="_top">frames</a
    48. 

  48.             >]&nbsp;|&nbsp;<a href="class-tree.html"
    49. 

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

  50.       </table>
    51. 

  51.     </td>
    52. 

  52.   </tr>
    53. 

  53. </table>
    54. 

  54. <center><b>
    55. 

  55.  [ <a href="module-tree.html">Module Hierarchy</a>
    56. 

  56.  | <a href="class-tree.html">Class Hierarchy</a> ]
    57. 

  57. </b></center><br />
    58. 

  58. <h1 class="epydoc">Class Hierarchy</h1>
    59. 

  59. <ul class="nomargin-top">
    60. 

  60.     <li> <strong class="uidlink"><a href="echonest.support.midi.EventDispatcher.EventDispatcher-class.html">echonest.support.midi.EventDispatcher.EventDispatcher</a></strong>
    61. 

  61.     </li>
    62. 

  62.     <li> <strong class="uidlink"><a href="echonest.video.ImageSequence-class.html">echonest.video.ImageSequence</a></strong>
    63. 

  63.     <ul>
    64. 

  64.     <li> <strong class="uidlink"><a href="echonest.video.EditableFrames-class.html">echonest.video.EditableFrames</a></strong>:
    65. 

  65.       <em class="summary">Collection of frames that can be easily edited</em>
    66. 

  66.     </li>
    67. 

  67.     </ul>
    68. 

  68.     </li>
    69. 

  69.     <li> <strong class="uidlink"><a href="echonest.support.midi.MidiFileParser.MidiFileParser-class.html">echonest.support.midi.MidiFileParser.MidiFileParser</a></strong>:
    70. 

  70.       <em class="summary">The MidiFileParser is the lowest level parser that see the data as
    71. 

  71. midi data.</em>
    72. 

  72.     </li>
    73. 

  73.     <li> <strong class="uidlink"><a href="echonest.support.midi.MidiInFile.MidiInFile-class.html">echonest.support.midi.MidiInFile.MidiInFile</a></strong>:
    74. 

  74.       <em class="summary">Parses a midi file, and triggers the midi events on the outStream
    75. 

  75. object.</em>
    76. 

  76.     </li>
    77. 

  77.     <li> <strong class="uidlink"><a href="echonest.support.midi.MidiInStream.MidiInStream-class.html">echonest.support.midi.MidiInStream.MidiInStream</a></strong>:
    78. 

  78.       <em class="summary">Takes midi events from the midi input and calls the apropriate
    79. 

  79. method in the eventhandler object</em>
    80. 

  80.     </li>
    81. 

  81.     <li> <strong class="uidlink"><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html">echonest.support.midi.MidiOutStream.MidiOutStream</a></strong>:
    82. 

  82.       <em class="summary">MidiOutstream is Basically an eventhandler.</em>
    83. 

  83.     <ul>
    84. 

  84.     <li> <strong class="uidlink"><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html">echonest.support.midi.MidiOutFile.MidiOutFile</a></strong>:
    85. 

  85.       <em class="summary">MidiOutFile is an eventhandler that subclasses MidiOutStream.</em>
    86. 

  86.     </li>
    87. 

  87.     <li> <strong class="uidlink"><a href="echonest.support.midi.MidiToText.MidiToText-class.html">echonest.support.midi.MidiToText.MidiToText</a></strong>:
    88. 

  88.       <em class="summary">This class renders a midi file as text.</em>
    89. 

  89.     </li>
    90. 

  90.     </ul>
    91. 

  91.     </li>
    92. 

  92.     <li> <strong class="uidlink"><a href="echonest.support.midi.RawInstreamFile.RawInstreamFile-class.html">echonest.support.midi.RawInstreamFile.RawInstreamFile</a></strong>:
    93. 

  93.       <em class="summary">It parses and reads data from an input file.</em>
    94. 

  94.     </li>
    95. 

  95.     <li> <strong class="uidlink"><a href="echonest.support.midi.RawOutstreamFile.RawOutstreamFile-class.html">echonest.support.midi.RawOutstreamFile.RawOutstreamFile</a></strong>:
    96. 

  96.       <em class="summary">Writes a midi file to disk.</em>
    97. 

  97.     </li>
    98. 

  98.     <li> <strong class="uidlink"><a href="echonest.video.SynchronizedAV-class.html">echonest.video.SynchronizedAV</a></strong>:
    99. 

  99.       <em class="summary">SynchronizedAV has audio and video; cuts return new SynchronizedAV objects</em>
    100. 

  100.     </li>
    101. 

  101.     <li> <strong class="uidlink"><a href="echonest.video.VideoSettings-class.html">echonest.video.VideoSettings</a></strong>:
    102. 

  102.       <em class="summary">simple container for video settings</em>
    103. 

  103.     </li>
    104. 

  104.     <li> <strong class="uidlink">object</strong>:
    105. 

  105.       <em class="summary">The most base type</em>
    106. 

  106.     <ul>
    107. 

  107.     <li> <strong class="uidlink"><a href="echonest.audio.AudioAnalysis-class.html">echonest.audio.AudioAnalysis</a></strong>:
    108. 

  108.       <em class="summary">This class wraps <code class="link">echonest.web</code> to allow transparent caching of the
    109. 

  109. audio analysis of an audio file.</em>
    110. 

  110.     </li>
    111. 

  111.     <li> <strong class="uidlink"><a href="echonest.audio.AudioEffect-class.html">echonest.audio.AudioEffect</a></strong>
    112. 

  112.     <ul>
    113. 

  113.     <li> <strong class="uidlink"><a href="echonest.audio.AmplitudeFactor-class.html">echonest.audio.AmplitudeFactor</a></strong>
    114. 

  114.     </li>
    115. 

  115.     <li> <strong class="uidlink"><a href="echonest.audio.LevelDB-class.html">echonest.audio.LevelDB</a></strong>
    116. 

  116.     </li>
    117. 

  117.     <li> <strong class="uidlink"><a href="echonest.audio.TimeTruncateFactor-class.html">echonest.audio.TimeTruncateFactor</a></strong>
    118. 

  118.     </li>
    119. 

  119.     <li> <strong class="uidlink"><a href="echonest.audio.TimeTruncateLength-class.html">echonest.audio.TimeTruncateLength</a></strong>
    120. 

  120.     </li>
    121. 

  121.     </ul>
    122. 

  122.     </li>
    123. 

  123.     <li> <strong class="uidlink"><a href="echonest.audio.AudioRenderable-class.html">echonest.audio.AudioRenderable</a></strong>:
    124. 

  124.       <em class="summary">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>()
    125. 

  125. method.</em>
    126. 

  126.     <ul>
    127. 

  127.     <li> <strong class="uidlink"><a href="echonest.audio.AudioData-class.html">echonest.audio.AudioData</a></strong>:
    128. 

  128.       <em class="summary">Handles audio data transparently.</em>
    129. 

  129.     <ul>
    130. 

  130.     <li> <strong class="uidlink"><a href="echonest.audio.AudioData32-class.html">echonest.audio.AudioData32</a></strong>:
    131. 

  131.       <em class="summary">A 32-bit variant of AudioData, intended for data collection on
    132. 

  132. audio rendering with headroom.</em>
    133. 

  133.     </li>
    134. 

  134.     <li> <strong class="uidlink"><a href="echonest.audio.LocalAudioFile-class.html">echonest.audio.LocalAudioFile</a></strong>:
    135. 

  135.       <em class="summary">The basic do-everything class for remixing.</em>
    136. 

  136.     </li>
    137. 

  137.     </ul>
    138. 

  138.     </li>
    139. 

  139.     <li> <strong class="uidlink"><a href="echonest.audio.AudioQuantum-class.html">echonest.audio.AudioQuantum</a></strong>:
    140. 

  140.       <em class="summary">A unit of musical time, identified at minimum with a start time and
    141. 

  141. a duration, both in seconds.</em>
    142. 

  142.     <ul>
    143. 

  143.     <li> <strong class="uidlink"><a href="echonest.audio.AudioSegment-class.html">echonest.audio.AudioSegment</a></strong>:
    144. 

  144.       <em class="summary">Subclass of <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> for the data-rich segments returned by
    145. 

  145. the Analyze API.</em>
    146. 

  146.     </li>
    147. 

  147.     </ul>
    148. 

  148.     </li>
    149. 

  149.     <li> <strong class="uidlink"><a href="echonest.audio.AudioQuantumList-class.html">echonest.audio.AudioQuantumList</a></strong>:
    150. 

  150.       <em class="summary">A container that enables content-based selection and filtering.</em>
    151. 

  151.     <ul>
    152. 

  152.     <li> <strong class="uidlink"><a href="echonest.audio.Simultaneous-class.html">echonest.audio.Simultaneous</a></strong>:
    153. 

  153.       <em class="summary">Stacks all contained AudioQuanta atop one another, adding their respective
    154. 

  154. samples.</em>
    155. 

  155.     </li>
    156. 

  156.     </ul>
    157. 

  157.     </li>
    158. 

  158.     <li> <strong class="uidlink"><a href="echonest.audio.ModifiedRenderable-class.html">echonest.audio.ModifiedRenderable</a></strong>:
    159. 

  159.       <em class="summary">Class that contains any AudioRenderable, but overrides the
    160. 

  160. render() method with nested effects, called sequentially on the
    161. 

  161. result of the preceeding effect.</em>
    162. 

  162.     </li>
    163. 

  163.     </ul>
    164. 

  164.     </li>
    165. 

  165.     <li> <strong class="uidlink">exceptions.BaseException</strong>:
    166. 

  166.       <em class="summary">Common base class for all exceptions</em>
    167. 

  167.     <ul>
    168. 

  168.     <li> <strong class="uidlink">exceptions.Exception</strong>:
    169. 

  169.       <em class="summary">Common base class for all non-exit exceptions.</em>
    170. 

  170.     <ul>
    171. 

  171.     <li> <strong class="uidlink"><a href="pyechonest.util.EchoNestAPIError-class.html">pyechonest.util.EchoNestAPIError</a></strong>:
    172. 

  172.       <em class="summary">Generic API errors.</em>
    173. 

  173.     </li>
    174. 

  174.     <li> <strong class="uidlink"><a href="echonest.audio.EchoNestRemixError-class.html">echonest.audio.EchoNestRemixError</a></strong>:
    175. 

  175.       <em class="summary">Error raised by the Remix API.</em>
    176. 

  176.     </li>
    177. 

  177.     <li> <strong class="uidlink"><a href="echonest.audio.FileTypeError-class.html">echonest.audio.FileTypeError</a></strong>
    178. 

  178.     </li>
    179. 

  179.     </ul>
    180. 

  180.     </li>
    181. 

  181.     </ul>
    182. 

  182.     </li>
    183. 

  183.     <li> <strong class="uidlink"><a href="echonest.action.Blend-class.html">echonest.action.Blend</a></strong>:
    184. 

  184.       <em class="summary">Mix together two lists of beats</em>
    185. 

  185.     <ul>
    186. 

  186.     <li> <strong class="uidlink"><a href="echonest.action.Crossmatch-class.html">echonest.action.Crossmatch</a></strong>:
    187. 

  187.       <em class="summary">Makes a beat-matched crossfade between the two input tracks.</em>
    188. 

  188.     </li>
    189. 

  189.     </ul>
    190. 

  190.     </li>
    191. 

  191.     <li> <strong class="uidlink"><a href="echonest.action.Crossfade-class.html">echonest.action.Crossfade</a></strong>:
    192. 

  192.       <em class="summary">Crossfades between two tracks, at the start points specified, for the given duration</em>
    193. 

  193.     <ul>
    194. 

  194.     <li> <strong class="uidlink"><a href="echonest.action.Jump-class.html">echonest.action.Jump</a></strong>:
    195. 

  195.       <em class="summary">Move from one point</em>
    196. 

  196.     </li>
    197. 

  197.     </ul>
    198. 

  198.     </li>
    199. 

  199.     <li> <strong class="uidlink"><a href="echonest.action.Edit-class.html">echonest.action.Edit</a></strong>:
    200. 

  200.       <em class="summary">Refer to a snippet of audio</em>
    201. 

  201.     </li>
    202. 

  202.     <li> <strong class="uidlink"><a href="pyechonest.proxies.GenericProxy-class.html">pyechonest.proxies.GenericProxy</a></strong>
    203. 

  203.     <ul>
    204. 

  204.     <li> <strong class="uidlink"><a href="pyechonest.proxies.ArtistProxy-class.html">pyechonest.proxies.ArtistProxy</a></strong>
    205. 

  205.     <ul>
    206. 

  206.     <li> <strong class="uidlink"><a href="pyechonest.artist.Artist-class.html">pyechonest.artist.Artist</a></strong>:
    207. 

  207.       <em class="summary">An Artist object</em>
    208. 

  208.     </li>
    209. 

  209.     </ul>
    210. 

  210.     </li>
    211. 

  211.     <li> <strong class="uidlink"><a href="pyechonest.proxies.PlaylistProxy-class.html">pyechonest.proxies.PlaylistProxy</a></strong>
    212. 

  212.     <ul>
    213. 

  213.     <li> <strong class="uidlink"><a href="pyechonest.playlist.Playlist-class.html">pyechonest.playlist.Playlist</a></strong>:
    214. 

  214.       <em class="summary">A Dynamic Playlist object</em>
    215. 

  215.     </li>
    216. 

  216.     </ul>
    217. 

  217.     </li>
    218. 

  218.     <li> <strong class="uidlink"><a href="pyechonest.proxies.SongProxy-class.html">pyechonest.proxies.SongProxy</a></strong>
    219. 

  219.     <ul>
    220. 

  220.     <li> <strong class="uidlink"><a href="pyechonest.song.Song-class.html">pyechonest.song.Song</a></strong>:
    221. 

  221.       <em class="summary">A Song object</em>
    222. 

  222.     </li>
    223. 

  223.     </ul>
    224. 

  224.     </li>
    225. 

  225.     <li> <strong class="uidlink"><a href="pyechonest.proxies.TrackProxy-class.html">pyechonest.proxies.TrackProxy</a></strong>
    226. 

  226.     <ul>
    227. 

  227.     <li> <strong class="uidlink"><a href="pyechonest.track.Track-class.html">pyechonest.track.Track</a></strong>:
    228. 

  228.       <em class="summary">Represents an audio analysis from The Echo Nest.</em>
    229. 

  229.     </li>
    230. 

  230.     </ul>
    231. 

  231.     </li>
    232. 

  232.     </ul>
    233. 

  233.     </li>
    234. 

  234.     <li> <strong class="uidlink"><a href="echonest.audio.LocalAnalysis-class.html">echonest.audio.LocalAnalysis</a></strong>:
    235. 

  235.       <em class="summary">Like <a href="echonest.audio.LocalAudioFile-class.html" class="link">LocalAudioFile</a>, it conditionally uploads the file with which
    236. 

  236. it was initialized.</em>
    237. 

  237.     </li>
    238. 

  238.     <li> <strong class="uidlink"><a href="echonest.action.Playback-class.html">echonest.action.Playback</a></strong>:
    239. 

  239.       <em class="summary">A snippet of the given track with start and duration.</em>
    240. 

  240.     <ul>
    241. 

  241.     <li> <strong class="uidlink"><a href="echonest.action.Fadein-class.html">echonest.action.Fadein</a></strong>:
    242. 

  242.       <em class="summary">Fadein</em>
    243. 

  243.     </li>
    244. 

  244.     <li> <strong class="uidlink"><a href="echonest.action.Fadeout-class.html">echonest.action.Fadeout</a></strong>:
    245. 

  245.       <em class="summary">Fadeout</em>
    246. 

  246.     </li>
    247. 

  247.     </ul>
    248. 

  248.     </li>
    249. 

  249.     <li> <strong class="uidlink">soundtouch.SoundTouch</strong>:
    250. 

  250.       <em class="summary">SoundTouch - main class for tempo/pitch/rate adjusting routines.</em>
    251. 

  251.     <ul>
    252. 

  252.     <li> <strong class="uidlink"><a href="echonest.modify.Modify-class.html">echonest.modify.Modify</a></strong>
    253. 

  253.     </li>
    254. 

  254.     </ul>
    255. 

  255.     </li>
    256. 

  256.     <li> <strong class="uidlink">dict</strong>:
    257. 

  257.       <em class="summary">dict() -&gt; new empty dictionary.</em>
    258. 

  258.     <ul>
    259. 

  259.     <li> <strong class="uidlink"><a href="pyechonest.util.attrdict-class.html">pyechonest.util.attrdict</a></strong>
    260. 

  260.     <ul>
    261. 

  261.     <li> <strong class="uidlink"><a href="pyechonest.results.Result-class.html">pyechonest.results.Result</a></strong>
    262. 

  262.     </li>
    263. 

  263.     </ul>
    264. 

  264.     </li>
    265. 

  265.     </ul>
    266. 

  266.     </li>
    267. 

  267.     <li> <strong class="uidlink">list</strong>:
    268. 

  268.       <em class="summary">list() -&gt; new list
    269. 

  269. list(sequence) -&gt; new list initialized from sequence's items</em>
    270. 

  270.     <ul>
    271. 

  271.     <li> <strong class="uidlink"><a href="echonest.audio.AudioQuantumList-class.html">echonest.audio.AudioQuantumList</a></strong>:
    272. 

  272.       <em class="summary">A container that enables content-based selection and filtering.</em>
    273. 

  273.     <ul>
    274. 

  274.     <li> <strong class="uidlink"><a href="echonest.audio.Simultaneous-class.html">echonest.audio.Simultaneous</a></strong>:
    275. 

  275.       <em class="summary">Stacks all contained AudioQuanta atop one another, adding their respective
    276. 

  276. samples.</em>
    277. 

  277.     </li>
    278. 

  278.     </ul>
    279. 

  279.     </li>
    280. 

  280.     </ul>
    281. 

  281.     </li>
    282. 

  282.     </ul>
    283. 

  283.     </li>
    284. 

  284. </ul>
    285. 

  285. <!-- ==================== NAVIGATION BAR ==================== -->
    286. 

  286. <table class="navbar" border="0" width="100%" cellpadding="0"
    287. 

  287.        bgcolor="#a0c0ff" cellspacing="0">
    288. 

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

  289. 

  290.   <!-- Tree link -->
    291. 

  291.       <th bgcolor="#70b0f0" class="navbar-select"
    292. 

  292.           >&nbsp;&nbsp;&nbsp;Trees&nbsp;&nbsp;&nbsp;</th>
    293. 

  293. 

  294.   <!-- Index link -->
    295. 

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

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

  297. 

  298.   <!-- Help link -->
    299. 

  299.       <th>&nbsp;&nbsp;&nbsp;<a
    300. 

  300.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    301. 

  301. 

  302.   <!-- Project homepage -->
    303. 

  303.       <th class="navbar" align="right" width="100%">
    304. 

  304.         <table border="0" cellpadding="0" cellspacing="0">
    305. 

  305.           <tr><th class="navbar" align="center"
    306. 

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

  307.           </tr></table></th>
    308. 

  308.   </tr>
    309. 

  309. </table>
    310. 

  310. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    311. 

  311.   <tr>
    312. 

  312.     <td align="left" class="footer">
    313. 

  313.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
    314. 

  314.     </td>
    315. 

  315.     <td align="right" class="footer">
    316. 

  316.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    317. 

  317.         >http://epydoc.sourceforge.net</a>
    318. 

  318.     </td>
    319. 

  319.   </tr>
    320. 

  320. </table>
    321. 

  321. 

  322. <script type="text/javascript">
    323. 

  323.   <!--
    324. 

  324.   // Private objects are initially displayed (because if
    325. 

  325.   // javascript is turned off then we want them to be
    326. 

  326.   // visible); but by default, we want to hide them.  So hide
    327. 

  327.   // them unless we have a cookie that says to show them.
    328. 

  328.   checkCookie();
    329. 

  329.   // -->
    330. 

  330. </script>
    331. 

  331. </body>
    332. 

  332. </html>
    333.