/apidocs/echonest.support.midi.MidiInStream-pysrc.html

http://echo-nest-remix.googlecode.com/ · HTML · 171 lines · 140 code · 10 blank · 21 comment · 0 complexity · 55079f8dc7fea22b5178186eb38da5b7 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.support.midi.MidiInStream</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.support-module.html">Package&nbsp;support</a> ::
  39. <a href="echonest.support.midi-module.html">Package&nbsp;midi</a> ::
  40. Module&nbsp;MidiInStream
  41. </span>
  42. </td>
  43. <td>
  44. <table cellpadding="0" cellspacing="0">
  45. <!-- hide/show private -->
  46. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  47. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  48. <tr><td align="right"><span class="options"
  49. >[<a href="frames.html" target="_top">frames</a
  50. >]&nbsp;|&nbsp;<a href="echonest.support.midi.MidiInStream-pysrc.html"
  51. target="_top">no&nbsp;frames</a>]</span></td></tr>
  52. </table>
  53. </td>
  54. </tr>
  55. </table>
  56. <h1 class="epydoc">Source Code for <a href="echonest.support.midi.MidiInStream-module.html">Module echonest.support.midi.MidiInStream</a></h1>
  57. <pre class="py-src">
  58. <a name="L1"></a><tt class="py-lineno"> 1</tt> <tt class="py-line"><tt class="py-comment"># -*- coding: ISO-8859-1 -*-</tt> </tt>
  59. <a name="L2"></a><tt class="py-lineno"> 2</tt> <tt class="py-line"> </tt>
  60. <a name="L3"></a><tt class="py-lineno"> 3</tt> <tt class="py-line"><tt class="py-keyword">from</tt> <tt id="link-0" class="py-name" targets="Module echonest.support.midi.MidiOutStream=echonest.support.midi.MidiOutStream-module.html,Class echonest.support.midi.MidiOutStream.MidiOutStream=echonest.support.midi.MidiOutStream.MidiOutStream-class.html"><a title="echonest.support.midi.MidiOutStream
  61. echonest.support.midi.MidiOutStream.MidiOutStream" class="py-name" href="#" onclick="return doclink('link-0', 'MidiOutStream', 'link-0');">MidiOutStream</a></tt> <tt class="py-keyword">import</tt> <tt id="link-1" class="py-name"><a title="echonest.support.midi.MidiOutStream
  62. echonest.support.midi.MidiOutStream.MidiOutStream" class="py-name" href="#" onclick="return doclink('link-1', 'MidiOutStream', 'link-0');">MidiOutStream</a></tt> </tt>
  63. <a name="L4"></a><tt class="py-lineno"> 4</tt> <tt class="py-line"> </tt>
  64. <a name="MidiInStream"></a><div id="MidiInStream-def"><a name="L5"></a><tt class="py-lineno"> 5</tt> <a class="py-toggle" href="#" id="MidiInStream-toggle" onclick="return toggle('MidiInStream');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="echonest.support.midi.MidiInStream.MidiInStream-class.html">MidiInStream</a><tt class="py-op">:</tt> </tt>
  65. </div><div id="MidiInStream-collapsed" style="display:none;" pad="++" indent="++++"></div><div id="MidiInStream-expanded"><a name="L6"></a><tt class="py-lineno"> 6</tt> <tt class="py-line"> </tt>
  66. <a name="L7"></a><tt class="py-lineno"> 7</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
  67. <a name="L8"></a><tt class="py-lineno"> 8</tt> <tt class="py-line"><tt class="py-docstring"> Takes midi events from the midi input and calls the apropriate </tt> </tt>
  68. <a name="L9"></a><tt class="py-lineno"> 9</tt> <tt class="py-line"><tt class="py-docstring"> method in the eventhandler object </tt> </tt>
  69. <a name="L10"></a><tt class="py-lineno">10</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
  70. <a name="L11"></a><tt class="py-lineno">11</tt> <tt class="py-line"> </tt>
  71. <a name="MidiInStream.__init__"></a><div id="MidiInStream.__init__-def"><a name="L12"></a><tt class="py-lineno">12</tt> <a class="py-toggle" href="#" id="MidiInStream.__init__-toggle" onclick="return toggle('MidiInStream.__init__');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="echonest.support.midi.MidiInStream.MidiInStream-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">midiOutStream</tt><tt class="py-op">,</tt> <tt class="py-param">device</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
  72. </div><div id="MidiInStream.__init__-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MidiInStream.__init__-expanded"><a name="L13"></a><tt class="py-lineno">13</tt> <tt class="py-line"> </tt>
  73. <a name="L14"></a><tt class="py-lineno">14</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
  74. <a name="L15"></a><tt class="py-lineno">15</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  75. <a name="L16"></a><tt class="py-lineno">16</tt> <tt class="py-line"><tt class="py-docstring"> Sets a default output stream, and sets the device from where </tt> </tt>
  76. <a name="L17"></a><tt class="py-lineno">17</tt> <tt class="py-line"><tt class="py-docstring"> the input comes </tt> </tt>
  77. <a name="L18"></a><tt class="py-lineno">18</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  78. <a name="L19"></a><tt class="py-lineno">19</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
  79. <a name="L20"></a><tt class="py-lineno">20</tt> <tt class="py-line"> </tt>
  80. <a name="L21"></a><tt class="py-lineno">21</tt> <tt class="py-line"> <tt class="py-keyword">if</tt> <tt class="py-name">midiOutStream</tt> <tt class="py-keyword">is</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
  81. <a name="L22"></a><tt class="py-lineno">22</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">midiOutStream</tt> <tt class="py-op">=</tt> <tt id="link-2" class="py-name"><a title="echonest.support.midi.MidiOutStream
  82. echonest.support.midi.MidiOutStream.MidiOutStream" class="py-name" href="#" onclick="return doclink('link-2', 'MidiOutStream', 'link-0');">MidiOutStream</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
  83. <a name="L23"></a><tt class="py-lineno">23</tt> <tt class="py-line"> <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
  84. <a name="L24"></a><tt class="py-lineno">24</tt> <tt class="py-line"> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">midiOutStream</tt> <tt class="py-op">=</tt> <tt class="py-name">midiOutStream</tt> </tt>
  85. </div><a name="L25"></a><tt class="py-lineno">25</tt> <tt class="py-line"> </tt>
  86. <a name="L26"></a><tt class="py-lineno">26</tt> <tt class="py-line"> </tt>
  87. <a name="MidiInStream.close"></a><div id="MidiInStream.close-def"><a name="L27"></a><tt class="py-lineno">27</tt> <a class="py-toggle" href="#" id="MidiInStream.close-toggle" onclick="return toggle('MidiInStream.close');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="echonest.support.midi.MidiInStream.MidiInStream-class.html#close">close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
  88. </div><div id="MidiInStream.close-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MidiInStream.close-expanded"><a name="L28"></a><tt class="py-lineno">28</tt> <tt class="py-line"> </tt>
  89. <a name="L29"></a><tt class="py-lineno">29</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
  90. <a name="L30"></a><tt class="py-lineno">30</tt> <tt class="py-line"><tt class="py-docstring"> Stop the MidiInstream </tt> </tt>
  91. <a name="L31"></a><tt class="py-lineno">31</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
  92. </div><a name="L32"></a><tt class="py-lineno">32</tt> <tt class="py-line"> </tt>
  93. <a name="L33"></a><tt class="py-lineno">33</tt> <tt class="py-line"> </tt>
  94. <a name="MidiInStream.read"></a><div id="MidiInStream.read-def"><a name="L34"></a><tt class="py-lineno">34</tt> <a class="py-toggle" href="#" id="MidiInStream.read-toggle" onclick="return toggle('MidiInStream.read');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="echonest.support.midi.MidiInStream.MidiInStream-class.html#read">read</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">time</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
  95. </div><div id="MidiInStream.read-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MidiInStream.read-expanded"><a name="L35"></a><tt class="py-lineno">35</tt> <tt class="py-line"> </tt>
  96. <a name="L36"></a><tt class="py-lineno">36</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
  97. <a name="L37"></a><tt class="py-lineno">37</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  98. <a name="L38"></a><tt class="py-lineno">38</tt> <tt class="py-line"><tt class="py-docstring"> Start the MidiInstream. </tt> </tt>
  99. <a name="L39"></a><tt class="py-lineno">39</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  100. <a name="L40"></a><tt class="py-lineno">40</tt> <tt class="py-line"><tt class="py-docstring"> "time" sets timer to specific start value. </tt> </tt>
  101. <a name="L41"></a><tt class="py-lineno">41</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  102. <a name="L42"></a><tt class="py-lineno">42</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
  103. </div><a name="L43"></a><tt class="py-lineno">43</tt> <tt class="py-line"> </tt>
  104. <a name="L44"></a><tt class="py-lineno">44</tt> <tt class="py-line"> </tt>
  105. <a name="MidiInStream.resetTimer"></a><div id="MidiInStream.resetTimer-def"><a name="L45"></a><tt class="py-lineno">45</tt> <a class="py-toggle" href="#" id="MidiInStream.resetTimer-toggle" onclick="return toggle('MidiInStream.resetTimer');">-</a><tt class="py-line"> <tt class="py-keyword">def</tt> <a class="py-def-name" href="echonest.support.midi.MidiInStream.MidiInStream-class.html#resetTimer">resetTimer</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">time</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
  106. </div><div id="MidiInStream.resetTimer-collapsed" style="display:none;" pad="++" indent="++++++++"></div><div id="MidiInStream.resetTimer-expanded"><a name="L46"></a><tt class="py-lineno">46</tt> <tt class="py-line"> <tt class="py-docstring">""" </tt> </tt>
  107. <a name="L47"></a><tt class="py-lineno">47</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  108. <a name="L48"></a><tt class="py-lineno">48</tt> <tt class="py-line"><tt class="py-docstring"> Resets the timer, probably a good idea if there is some kind </tt> </tt>
  109. <a name="L49"></a><tt class="py-lineno">49</tt> <tt class="py-line"><tt class="py-docstring"> of looping going on </tt> </tt>
  110. <a name="L50"></a><tt class="py-lineno">50</tt> <tt class="py-line"><tt class="py-docstring"> </tt> </tt>
  111. <a name="L51"></a><tt class="py-lineno">51</tt> <tt class="py-line"><tt class="py-docstring"> """</tt> </tt>
  112. </div></div><a name="L52"></a><tt class="py-lineno">52</tt> <tt class="py-line"> </tt><script type="text/javascript">
  113. <!--
  114. expandto(location.href);
  115. // -->
  116. </script>
  117. </pre>
  118. <br />
  119. <!-- ==================== NAVIGATION BAR ==================== -->
  120. <table class="navbar" border="0" width="100%" cellpadding="0"
  121. bgcolor="#a0c0ff" cellspacing="0">
  122. <tr valign="middle">
  123. <!-- Tree link -->
  124. <th>&nbsp;&nbsp;&nbsp;<a
  125. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  126. <!-- Index link -->
  127. <th>&nbsp;&nbsp;&nbsp;<a
  128. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  129. <!-- Help link -->
  130. <th>&nbsp;&nbsp;&nbsp;<a
  131. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  132. <!-- Project homepage -->
  133. <th class="navbar" align="right" width="100%">
  134. <table border="0" cellpadding="0" cellspacing="0">
  135. <tr><th class="navbar" align="center"
  136. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  137. </tr></table></th>
  138. </tr>
  139. </table>
  140. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  141. <tr>
  142. <td align="left" class="footer">
  143. Generated by Epydoc 3.0.1 on Wed Sep 1 16:09:00 2010
  144. </td>
  145. <td align="right" class="footer">
  146. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  147. >http://epydoc.sourceforge.net</a>
  148. </td>
  149. </tr>
  150. </table>
  151. <script type="text/javascript">
  152. <!--
  153. // Private objects are initially displayed (because if
  154. // javascript is turned off then we want them to be
  155. // visible); but by default, we want to hide them. So hide
  156. // them unless we have a cookie that says to show them.
  157. checkCookie();
  158. // -->
  159. </script>
  160. </body>
  161. </html>