/apidocs/echonest.support.midi.EventDispatcher.EventDispatcher-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 334 lines · 282 code · 32 blank · 20 comment · 0 complexity · c8e6960fd04a8abca86054c3247112f2 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.support.midi.EventDispatcher.EventDispatcher</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.support-module.html">Package&nbsp;support</a> ::
    44. 

  44.         <a href="echonest.support.midi-module.html">Package&nbsp;midi</a> ::
    45. 

  45.         <a href="echonest.support.midi.EventDispatcher-module.html">Module&nbsp;EventDispatcher</a> ::
    46. 

  46.         Class&nbsp;EventDispatcher
    47. 

  47.       </span>
    48. 

  48.     </td>
    49. 

  49.     <td>
    50. 

  50.       <table cellpadding="0" cellspacing="0">
    51. 

  51.         <!-- hide/show private -->
    52. 

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

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

  54.         <tr><td align="right"><span class="options"
    55. 

  55.             >[<a href="frames.html" target="_top">frames</a
    56. 

  56.             >]&nbsp;|&nbsp;<a href="echonest.support.midi.EventDispatcher.EventDispatcher-class.html"
    57. 

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

  58.       </table>
    59. 

  59.     </td>
    60. 

  60.   </tr>
    61. 

  61. </table>
    62. 

  62. <!-- ==================== CLASS DESCRIPTION ==================== -->
    63. 

  63. <h1 class="epydoc">Class EventDispatcher</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher">source&nbsp;code</a></span></p>
    64. 

  64. <!-- ==================== INSTANCE METHODS ==================== -->
    65. 

  65. <a name="section-InstanceMethods"></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">Instance Methods</span></td>
    73. 

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

  74.          ><span class="options">[<a href="#section-InstanceMethods"
    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.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    86. 

  86.         <tr>
    87. 

  87.           <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>,
    88. 

  88.         <span class="summary-sig-arg">outstream</span>)</span><br />
    89. 

  89.       The event dispatcher generates events on the outstream.</td>
    90. 

  90.           <td align="right" valign="top">
    91. 

  91.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.__init__">source&nbsp;code</a></span>
    92. 

  92.             
    93. 

  93.           </td>
    94. 

  94.         </tr>
    95. 

  95.       </table>
    96. 

  96.       
    97. 

  97.     </td>
    98. 

  98.   </tr>
    99. 

  99. <tr>
    100. 

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

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

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

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

  104.         <tr>
    105. 

  105.           <td><span class="summary-sig"><a name="header"></a><span class="summary-sig-name">header</span>(<span class="summary-sig-arg">self</span>,
    106. 

  106.         <span class="summary-sig-arg">format</span>,
    107. 

  107.         <span class="summary-sig-arg">nTracks</span>,
    108. 

  108.         <span class="summary-sig-arg">division</span>)</span><br />
    109. 

  109.       Triggers the header event</td>
    110. 

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

  111.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.header">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="start_of_track"></a><span class="summary-sig-name">start_of_track</span>(<span class="summary-sig-arg">self</span>,
    126. 

  126.         <span class="summary-sig-arg">current_track</span>)</span><br />
    127. 

  127.       Triggers the start of track event</td>
    128. 

  128.           <td align="right" valign="top">
    129. 

  129.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.start_of_track">source&nbsp;code</a></span>
    130. 

  130.             
    131. 

  131.           </td>
    132. 

  132.         </tr>
    133. 

  133.       </table>
    134. 

  134.       
    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.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    142. 

  142.         <tr>
    143. 

  143.           <td><span class="summary-sig"><a name="sysex_event"></a><span class="summary-sig-name">sysex_event</span>(<span class="summary-sig-arg">self</span>,
    144. 

  144.         <span class="summary-sig-arg">data</span>)</span><br />
    145. 

  145.       Dispatcher for sysex events</td>
    146. 

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

  147.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.sysex_event">source&nbsp;code</a></span>
    148. 

  148.             
    149. 

  149.           </td>
    150. 

  150.         </tr>
    151. 

  151.       </table>
    152. 

  152.       
    153. 

  153.     </td>
    154. 

  154.   </tr>
    155. 

  155. <tr>
    156. 

  156.     <td width="15%" align="right" valign="top" class="summary">
    157. 

  157.       <span class="summary-type">&nbsp;</span>
    158. 

  158.     </td><td class="summary">
    159. 

  159.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    160. 

  160.         <tr>
    161. 

  161.           <td><span class="summary-sig"><a name="eof"></a><span class="summary-sig-name">eof</span>(<span class="summary-sig-arg">self</span>)</span><br />
    162. 

  162.       End of file!</td>
    163. 

  163.           <td align="right" valign="top">
    164. 

  164.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.eof">source&nbsp;code</a></span>
    165. 

  165.             
    166. 

  166.           </td>
    167. 

  167.         </tr>
    168. 

  168.       </table>
    169. 

  169.       
    170. 

  170.     </td>
    171. 

  171.   </tr>
    172. 

  172. <tr>
    173. 

  173.     <td width="15%" align="right" valign="top" class="summary">
    174. 

  174.       <span class="summary-type">&nbsp;</span>
    175. 

  175.     </td><td class="summary">
    176. 

  176.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    177. 

  177.         <tr>
    178. 

  178.           <td><span class="summary-sig"><a name="update_time"></a><span class="summary-sig-name">update_time</span>(<span class="summary-sig-arg">self</span>,
    179. 

  179.         <span class="summary-sig-arg">new_time</span>=<span class="summary-sig-default">0</span>,
    180. 

  180.         <span class="summary-sig-arg">relative</span>=<span class="summary-sig-default">1</span>)</span><br />
    181. 

  181.       Updates relative/absolute time.</td>
    182. 

  182.           <td align="right" valign="top">
    183. 

  183.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.update_time">source&nbsp;code</a></span>
    184. 

  184.             
    185. 

  185.           </td>
    186. 

  186.         </tr>
    187. 

  187.       </table>
    188. 

  188.       
    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="reset_time"></a><span class="summary-sig-name">reset_time</span>(<span class="summary-sig-arg">self</span>)</span><br />
    198. 

  198.       Updates relative/absolute time.</td>
    199. 

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

  200.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.reset_time">source&nbsp;code</a></span>
    201. 

  201.             
    202. 

  202.           </td>
    203. 

  203.         </tr>
    204. 

  204.       </table>
    205. 

  205.       
    206. 

  206.     </td>
    207. 

  207.   </tr>
    208. 

  208. <tr>
    209. 

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

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

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

  212.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    213. 

  213.         <tr>
    214. 

  214.           <td><span class="summary-sig"><a name="channel_messages"></a><span class="summary-sig-name">channel_messages</span>(<span class="summary-sig-arg">self</span>,
    215. 

  215.         <span class="summary-sig-arg">hi_nible</span>,
    216. 

  216.         <span class="summary-sig-arg">channel</span>,
    217. 

  217.         <span class="summary-sig-arg">data</span>)</span><br />
    218. 

  218.       Dispatches channel messages</td>
    219. 

  219.           <td align="right" valign="top">
    220. 

  220.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.channel_messages">source&nbsp;code</a></span>
    221. 

  221.             
    222. 

  222.           </td>
    223. 

  223.         </tr>
    224. 

  224.       </table>
    225. 

  225.       
    226. 

  226.     </td>
    227. 

  227.   </tr>
    228. 

  228. <tr>
    229. 

  229.     <td width="15%" align="right" valign="top" class="summary">
    230. 

  230.       <span class="summary-type">&nbsp;</span>
    231. 

  231.     </td><td class="summary">
    232. 

  232.       <table width="100%" cellpadding="0" cellspacing="0" border="0">
    233. 

  233.         <tr>
    234. 

  234.           <td><span class="summary-sig"><a name="continuous_controllers"></a><span class="summary-sig-name">continuous_controllers</span>(<span class="summary-sig-arg">self</span>,
    235. 

  235.         <span class="summary-sig-arg">channel</span>,
    236. 

  236.         <span class="summary-sig-arg">controller</span>,
    237. 

  237.         <span class="summary-sig-arg">value</span>)</span><br />
    238. 

  238.       Dispatches channel messages</td>
    239. 

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

  240.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.continuous_controllers">source&nbsp;code</a></span>
    241. 

  241.             
    242. 

  242.           </td>
    243. 

  243.         </tr>
    244. 

  244.       </table>
    245. 

  245.       
    246. 

  246.     </td>
    247. 

  247.   </tr>
    248. 

  248. <tr>
    249. 

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

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

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

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

  253.         <tr>
    254. 

  254.           <td><span class="summary-sig"><a name="system_commons"></a><span class="summary-sig-name">system_commons</span>(<span class="summary-sig-arg">self</span>,
    255. 

  255.         <span class="summary-sig-arg">common_type</span>,
    256. 

  256.         <span class="summary-sig-arg">common_data</span>)</span><br />
    257. 

  257.       Dispatches system common messages</td>
    258. 

  258.           <td align="right" valign="top">
    259. 

  259.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.system_commons">source&nbsp;code</a></span>
    260. 

  260.             
    261. 

  261.           </td>
    262. 

  262.         </tr>
    263. 

  263.       </table>
    264. 

  264.       
    265. 

  265.     </td>
    266. 

  266.   </tr>
    267. 

  267. <tr>
    268. 

  268.     <td width="15%" align="right" valign="top" class="summary">
    269. 

  269.       <span class="summary-type">&nbsp;</span>
    270. 

  270.     </td><td class="summary">
    271. 

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

  272.         <tr>
    273. 

  273.           <td><span class="summary-sig"><a name="meta_event"></a><span class="summary-sig-name">meta_event</span>(<span class="summary-sig-arg">self</span>,
    274. 

  274.         <span class="summary-sig-arg">meta_type</span>,
    275. 

  275.         <span class="summary-sig-arg">data</span>)</span><br />
    276. 

  276.       Dispatches meta events</td>
    277. 

  277.           <td align="right" valign="top">
    278. 

  278.             <span class="codelink"><a href="echonest.support.midi.EventDispatcher-pysrc.html#EventDispatcher.meta_event">source&nbsp;code</a></span>
    279. 

  279.             
    280. 

  280.           </td>
    281. 

  281.         </tr>
    282. 

  282.       </table>
    283. 

  283.       
    284. 

  284.     </td>
    285. 

  285.   </tr>
    286. 

  286. </table>
    287. 

  287. <!-- ==================== NAVIGATION BAR ==================== -->
    288. 

  288. <table class="navbar" border="0" width="100%" cellpadding="0"
    289. 

  289.        bgcolor="#a0c0ff" cellspacing="0">
    290. 

  290.   <tr valign="middle">
    291. 

  291. 

  292.   <!-- Tree link -->
    293. 

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

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

  295. 

  296.   <!-- Index link -->
    297. 

  297.       <th>&nbsp;&nbsp;&nbsp;<a
    298. 

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

  299. 

  300.   <!-- Help link -->
    301. 

  301.       <th>&nbsp;&nbsp;&nbsp;<a
    302. 

  302.         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
    303. 

  303. 

  304.   <!-- Project homepage -->
    305. 

  305.       <th class="navbar" align="right" width="100%">
    306. 

  306.         <table border="0" cellpadding="0" cellspacing="0">
    307. 

  307.           <tr><th class="navbar" align="center"
    308. 

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

  309.           </tr></table></th>
    310. 

  310.   </tr>
    311. 

  311. </table>
    312. 

  312. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
    313. 

  313.   <tr>
    314. 

  314.     <td align="left" class="footer">
    315. 

  315.     Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
    316. 

  316.     </td>
    317. 

  317.     <td align="right" class="footer">
    318. 

  318.       <a target="mainFrame" href="http://epydoc.sourceforge.net"
    319. 

  319.         >http://epydoc.sourceforge.net</a>
    320. 

  320.     </td>
    321. 

  321.   </tr>
    322. 

  322. </table>
    323. 

  323. 

  324. <script type="text/javascript">
    325. 

  325.   <!--
    326. 

  326.   // Private objects are initially displayed (because if
    327. 

  327.   // javascript is turned off then we want them to be
    328. 

  328.   // visible); but by default, we want to hide them.  So hide
    329. 

  329.   // them unless we have a cookie that says to show them.
    330. 

  330.   checkCookie();
    331. 

  331.   // -->
    332. 

  332. </script>
    333. 

  333. </body>
    334. 

  334. </html>
    335.