/apidocs/echonest.support.midi.example_transpose_octave.Transposer-class.html

http://echo-nest-remix.googlecode.com/ · HTML · 326 lines · 285 code · 20 blank · 21 comment · 0 complexity · 00c8ec6ce6b91194857dfdc92e275fe0 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.example_transpose_octave.Transposer</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. <a href="echonest.support.midi.example_transpose_octave-module.html">Module&nbsp;example_transpose_octave</a> ::
  41. Class&nbsp;Transposer
  42. </span>
  43. </td>
  44. <td>
  45. <table cellpadding="0" cellspacing="0">
  46. <!-- hide/show private -->
  47. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  48. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  49. <tr><td align="right"><span class="options"
  50. >[<a href="frames.html" target="_top">frames</a
  51. >]&nbsp;|&nbsp;<a href="echonest.support.midi.example_transpose_octave.Transposer-class.html"
  52. target="_top">no&nbsp;frames</a>]</span></td></tr>
  53. </table>
  54. </td>
  55. </tr>
  56. </table>
  57. <!-- ==================== CLASS DESCRIPTION ==================== -->
  58. <h1 class="epydoc">Class Transposer</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.support.midi.example_transpose_octave-pysrc.html#Transposer">source&nbsp;code</a></span></p>
  59. <center>
  60. </center>
  61. <hr />
  62. Transposes all notes by 1 octave
  63. <!-- ==================== INSTANCE METHODS ==================== -->
  64. <a name="section-InstanceMethods"></a>
  65. <table class="summary" border="1" cellpadding="3"
  66. cellspacing="0" width="100%" bgcolor="white">
  67. <tr bgcolor="#70b0f0" class="table-header">
  68. <td colspan="2" class="table-header">
  69. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  70. <tr valign="top">
  71. <td align="left"><span class="table-header">Instance Methods</span></td>
  72. <td align="right" valign="top"
  73. ><span class="options">[<a href="#section-InstanceMethods"
  74. class="privatelink" onclick="toggle_private();"
  75. >hide private</a>]</span></td>
  76. </tr>
  77. </table>
  78. </td>
  79. </tr>
  80. <tr class="private">
  81. <td width="15%" align="right" valign="top" class="summary">
  82. <span class="summary-type">&nbsp;</span>
  83. </td><td class="summary">
  84. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  85. <tr>
  86. <td><span class="summary-sig"><a name="_transp"></a><span class="summary-sig-name">_transp</span>(<span class="summary-sig-arg">self</span>,
  87. <span class="summary-sig-arg">ch</span>,
  88. <span class="summary-sig-arg">note</span>)</span></td>
  89. <td align="right" valign="top">
  90. <span class="codelink"><a href="echonest.support.midi.example_transpose_octave-pysrc.html#Transposer._transp">source&nbsp;code</a></span>
  91. </td>
  92. </tr>
  93. </table>
  94. </td>
  95. </tr>
  96. <tr>
  97. <td width="15%" align="right" valign="top" class="summary">
  98. <span class="summary-type">&nbsp;</span>
  99. </td><td class="summary">
  100. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  101. <tr>
  102. <td><span class="summary-sig"><a href="echonest.support.midi.example_transpose_octave.Transposer-class.html#note_on" class="summary-sig-name">note_on</a>(<span class="summary-sig-arg">self</span>,
  103. <span class="summary-sig-arg">channel</span>=<span class="summary-sig-default">0</span>,
  104. <span class="summary-sig-arg">note</span>=<span class="summary-sig-default">0x40</span>,
  105. <span class="summary-sig-arg">velocity</span>=<span class="summary-sig-default">0x40</span>)</span><br />
  106. channel: 0-15
  107. note, velocity: 0-127</td>
  108. <td align="right" valign="top">
  109. <span class="codelink"><a href="echonest.support.midi.example_transpose_octave-pysrc.html#Transposer.note_on">source&nbsp;code</a></span>
  110. </td>
  111. </tr>
  112. </table>
  113. </td>
  114. </tr>
  115. <tr>
  116. <td width="15%" align="right" valign="top" class="summary">
  117. <span class="summary-type">&nbsp;</span>
  118. </td><td class="summary">
  119. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  120. <tr>
  121. <td><span class="summary-sig"><a href="echonest.support.midi.example_transpose_octave.Transposer-class.html#note_off" class="summary-sig-name">note_off</a>(<span class="summary-sig-arg">self</span>,
  122. <span class="summary-sig-arg">channel</span>=<span class="summary-sig-default">0</span>,
  123. <span class="summary-sig-arg">note</span>=<span class="summary-sig-default">0x40</span>,
  124. <span class="summary-sig-arg">velocity</span>=<span class="summary-sig-default">0x40</span>)</span><br />
  125. channel: 0-15
  126. note, velocity: 0-127</td>
  127. <td align="right" valign="top">
  128. <span class="codelink"><a href="echonest.support.midi.example_transpose_octave-pysrc.html#Transposer.note_off">source&nbsp;code</a></span>
  129. </td>
  130. </tr>
  131. </table>
  132. </td>
  133. </tr>
  134. <tr>
  135. <td colspan="2" class="summary">
  136. <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html">MidiOutFile.MidiOutFile</a></code></b>:
  137. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#__init__">__init__</a></code>,
  138. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#aftertouch">aftertouch</a></code>,
  139. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#channel_pressure">channel_pressure</a></code>,
  140. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#continuous_controller">continuous_controller</a></code>,
  141. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#copyright">copyright</a></code>,
  142. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#cuepoint">cuepoint</a></code>,
  143. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#end_of_track">end_of_track</a></code>,
  144. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#eof">eof</a></code>,
  145. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#event_slice">event_slice</a></code>,
  146. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#header">header</a></code>,
  147. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#instrument_name">instrument_name</a></code>,
  148. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#key_signature">key_signature</a></code>,
  149. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#lyric">lyric</a></code>,
  150. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#marker">marker</a></code>,
  151. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#meta_event">meta_event</a></code>,
  152. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#meta_slice">meta_slice</a></code>,
  153. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#midi_ch_prefix">midi_ch_prefix</a></code>,
  154. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#midi_port">midi_port</a></code>,
  155. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#midi_time_code">midi_time_code</a></code>,
  156. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#patch_change">patch_change</a></code>,
  157. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#pitch_bend">pitch_bend</a></code>,
  158. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#sequence_name">sequence_name</a></code>,
  159. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#sequence_number">sequence_number</a></code>,
  160. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#sequencer_specific">sequencer_specific</a></code>,
  161. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#smtp_offset">smtp_offset</a></code>,
  162. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#song_position_pointer">song_position_pointer</a></code>,
  163. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#song_select">song_select</a></code>,
  164. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#start_of_track">start_of_track</a></code>,
  165. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#system_exclusive">system_exclusive</a></code>,
  166. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#tempo">tempo</a></code>,
  167. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#text">text</a></code>,
  168. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#time_signature">time_signature</a></code>,
  169. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#tuning_request">tuning_request</a></code>,
  170. <code><a href="echonest.support.midi.MidiOutFile.MidiOutFile-class.html#write">write</a></code>
  171. </p>
  172. <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html">MidiOutStream.MidiOutStream</a></code></b>:
  173. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#abs_time">abs_time</a></code>,
  174. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#active_sensing">active_sensing</a></code>,
  175. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#channel_message">channel_message</a></code>,
  176. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#get_current_track">get_current_track</a></code>,
  177. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#get_run_stat">get_run_stat</a></code>,
  178. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#rel_time">rel_time</a></code>,
  179. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#reset_run_stat">reset_run_stat</a></code>,
  180. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#reset_time">reset_time</a></code>,
  181. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#set_current_track">set_current_track</a></code>,
  182. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#set_run_stat">set_run_stat</a></code>,
  183. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#song_continue">song_continue</a></code>,
  184. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#song_start">song_start</a></code>,
  185. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#song_stop">song_stop</a></code>,
  186. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#system_reset">system_reset</a></code>,
  187. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#timing_clock">timing_clock</a></code>,
  188. <code><a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#update_time">update_time</a></code>
  189. </p>
  190. </td>
  191. </tr>
  192. </table>
  193. <!-- ==================== METHOD DETAILS ==================== -->
  194. <a name="section-MethodDetails"></a>
  195. <table class="details" border="1" cellpadding="3"
  196. cellspacing="0" width="100%" bgcolor="white">
  197. <tr bgcolor="#70b0f0" class="table-header">
  198. <td colspan="2" class="table-header">
  199. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  200. <tr valign="top">
  201. <td align="left"><span class="table-header">Method Details</span></td>
  202. <td align="right" valign="top"
  203. ><span class="options">[<a href="#section-MethodDetails"
  204. class="privatelink" onclick="toggle_private();"
  205. >hide private</a>]</span></td>
  206. </tr>
  207. </table>
  208. </td>
  209. </tr>
  210. </table>
  211. <a name="note_on"></a>
  212. <div>
  213. <table class="details" border="1" cellpadding="3"
  214. cellspacing="0" width="100%" bgcolor="white">
  215. <tr><td>
  216. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  217. <tr valign="top"><td>
  218. <h3 class="epydoc"><span class="sig"><span class="sig-name">note_on</span>(<span class="sig-arg">self</span>,
  219. <span class="sig-arg">channel</span>=<span class="sig-default">0</span>,
  220. <span class="sig-arg">note</span>=<span class="sig-default">0x40</span>,
  221. <span class="sig-arg">velocity</span>=<span class="sig-default">0x40</span>)</span>
  222. </h3>
  223. </td><td align="right" valign="top"
  224. ><span class="codelink"><a href="echonest.support.midi.example_transpose_octave-pysrc.html#Transposer.note_on">source&nbsp;code</a></span>&nbsp;
  225. </td>
  226. </tr></table>
  227. channel: 0-15
  228. note, velocity: 0-127
  229. <dl class="fields">
  230. <dt>Overrides:
  231. <a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#note_on">MidiOutStream.MidiOutStream.note_on</a>
  232. <dd><em class="note">(inherited documentation)</em></dd>
  233. </dt>
  234. </dl>
  235. </td></tr></table>
  236. </div>
  237. <a name="note_off"></a>
  238. <div>
  239. <table class="details" border="1" cellpadding="3"
  240. cellspacing="0" width="100%" bgcolor="white">
  241. <tr><td>
  242. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  243. <tr valign="top"><td>
  244. <h3 class="epydoc"><span class="sig"><span class="sig-name">note_off</span>(<span class="sig-arg">self</span>,
  245. <span class="sig-arg">channel</span>=<span class="sig-default">0</span>,
  246. <span class="sig-arg">note</span>=<span class="sig-default">0x40</span>,
  247. <span class="sig-arg">velocity</span>=<span class="sig-default">0x40</span>)</span>
  248. </h3>
  249. </td><td align="right" valign="top"
  250. ><span class="codelink"><a href="echonest.support.midi.example_transpose_octave-pysrc.html#Transposer.note_off">source&nbsp;code</a></span>&nbsp;
  251. </td>
  252. </tr></table>
  253. channel: 0-15
  254. note, velocity: 0-127
  255. <dl class="fields">
  256. <dt>Overrides:
  257. <a href="echonest.support.midi.MidiOutStream.MidiOutStream-class.html#note_off">MidiOutStream.MidiOutStream.note_off</a>
  258. <dd><em class="note">(inherited documentation)</em></dd>
  259. </dt>
  260. </dl>
  261. </td></tr></table>
  262. </div>
  263. <br />
  264. <!-- ==================== NAVIGATION BAR ==================== -->
  265. <table class="navbar" border="0" width="100%" cellpadding="0"
  266. bgcolor="#a0c0ff" cellspacing="0">
  267. <tr valign="middle">
  268. <!-- Tree link -->
  269. <th>&nbsp;&nbsp;&nbsp;<a
  270. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  271. <!-- Index link -->
  272. <th>&nbsp;&nbsp;&nbsp;<a
  273. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  274. <!-- Help link -->
  275. <th>&nbsp;&nbsp;&nbsp;<a
  276. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  277. <!-- Project homepage -->
  278. <th class="navbar" align="right" width="100%">
  279. <table border="0" cellpadding="0" cellspacing="0">
  280. <tr><th class="navbar" align="center"
  281. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  282. </tr></table></th>
  283. </tr>
  284. </table>
  285. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  286. <tr>
  287. <td align="left" class="footer">
  288. Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:59 2010
  289. </td>
  290. <td align="right" class="footer">
  291. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  292. >http://epydoc.sourceforge.net</a>
  293. </td>
  294. </tr>
  295. </table>
  296. <script type="text/javascript">
  297. <!--
  298. // Private objects are initially displayed (because if
  299. // javascript is turned off then we want them to be
  300. // visible); but by default, we want to hide them. So hide
  301. // them unless we have a cookie that says to show them.
  302. checkCookie();
  303. // -->
  304. </script>
  305. </body>
  306. </html>