PageRenderTime 28ms CodeModel.GetById 12ms app.highlight 11ms RepoModel.GetById 2ms app.codeStats 0ms

/apidocs/echonest.support.midi-module.html

http://echo-nest-remix.googlecode.com/
HTML | 206 lines | 173 code | 12 blank | 21 comment | 0 complexity | 687d66b71d7267bdc542904112f20fab 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</title>
  7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8  <script type="text/javascript" src="epydoc.js"></script>
  9</head>
 10
 11<body bgcolor="white" text="black" link="blue" vlink="#204080"
 12      alink="#204080">
 13<!-- ==================== NAVIGATION BAR ==================== -->
 14<table class="navbar" border="0" width="100%" cellpadding="0"
 15       bgcolor="#a0c0ff" cellspacing="0">
 16  <tr valign="middle">
 17
 18  <!-- Tree link -->
 19      <th>&nbsp;&nbsp;&nbsp;<a
 20        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 21
 22  <!-- Index link -->
 23      <th>&nbsp;&nbsp;&nbsp;<a
 24        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 25
 26  <!-- Help link -->
 27      <th>&nbsp;&nbsp;&nbsp;<a
 28        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 29
 30  <!-- Project homepage -->
 31      <th class="navbar" align="right" width="100%">
 32        <table border="0" cellpadding="0" cellspacing="0">
 33          <tr><th class="navbar" align="center"
 34            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
 35          </tr></table></th>
 36  </tr>
 37</table>
 38<table width="100%" cellpadding="0" cellspacing="0">
 39  <tr valign="top">
 40    <td width="100%">
 41      <span class="breadcrumbs">
 42        <a href="echonest-module.html">Package&nbsp;echonest</a> ::
 43        <a href="echonest.support-module.html">Package&nbsp;support</a> ::
 44        Package&nbsp;midi
 45      </span>
 46    </td>
 47    <td>
 48      <table cellpadding="0" cellspacing="0">
 49        <!-- hide/show private -->
 50        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 51    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 52        <tr><td align="right"><span class="options"
 53            >[<a href="frames.html" target="_top">frames</a
 54            >]&nbsp;|&nbsp;<a href="echonest.support.midi-module.html"
 55            target="_top">no&nbsp;frames</a>]</span></td></tr>
 56      </table>
 57    </td>
 58  </tr>
 59</table>
 60<!-- ==================== PACKAGE DESCRIPTION ==================== -->
 61<h1 class="epydoc">Package midi</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.support.midi-pysrc.html">source&nbsp;code</a></span></p>
 62<div class="rst-section" id="rst-this-is-the-documentation-for-the-midi-package">
 63<h1 class="heading">This is the documentation for the midi package</h1>
 64<p>The modules follows the following naming convention:</p>
 65<div class="rst-section" id="rst-midiin-streamtype-py">
 66<h2 class="heading">MidiIn&lt;StreamType&gt;.py</h2>
 67<p>The MidiIn modules reads midi content for a specific type of stream. Ie. a file or a midi port. It then generates events and triggers them on a MidiOutStream.</p>
 68</div>
 69<div class="rst-section" id="rst-midiout-streamtype-py">
 70<h2 class="heading">MidiOut&lt;StreamType&gt;.py</h2>
 71<p>The MidiOut modules are event handlers, that reacts to events generated by a a Midi in module.</p>
 72</div>
 73<div class="rst-section" id="rst-midiinbase-py">
 74<h2 class="heading">MidiInBase.py</h2>
 75<p>The base class for input streams.</p>
 76</div>
 77<div class="rst-section" id="rst-midioutbase-py">
 78<h2 class="heading">MidiOutBase.py</h2>
 79<p>The base class for the output streams.</p>
 80</div>
 81</div>
 82<div class="rst-section" id="rst-internal-modules">
 83<h1 class="heading">Internal modules</h1>
 84<div class="rst-section" id="rst-datatypeconverters-py">
 85<h2 class="heading">DataTypeConverters.py</h2>
 86<p>A collection of functions that converts the special data types used in midi files to and from strings.</p>
 87</div>
 88<div class="rst-section" id="rst-constants-py">
 89<h2 class="heading">constants.py</h2>
 90<p>A collection of constants from the midi spec.</p>
 91</div>
 92</div>
 93
 94<!-- ==================== SUBMODULES ==================== -->
 95<a name="section-Submodules"></a>
 96<table class="summary" border="1" cellpadding="3"
 97       cellspacing="0" width="100%" bgcolor="white">
 98<tr bgcolor="#70b0f0" class="table-header">
 99  <td colspan="2" class="table-header">
100    <table border="0" cellpadding="0" cellspacing="0" width="100%">
101      <tr valign="top">
102        <td align="left"><span class="table-header">Submodules</span></td>
103        <td align="right" valign="top"
104         ><span class="options">[<a href="#section-Submodules"
105         class="privatelink" onclick="toggle_private();"
106         >hide private</a>]</span></td>
107      </tr>
108    </table>
109  </td>
110</tr>
111  <tr><td class="summary">
112  <ul class="nomargin">
113    <li> <strong class="uidlink"><a href="echonest.support.midi.DataTypeConverters-module.html">echonest.support.midi.DataTypeConverters</a></strong>    </li>
114    <li> <strong class="uidlink"><a href="echonest.support.midi.EventDispatcher-module.html">echonest.support.midi.EventDispatcher</a></strong>    </li>
115    <li> <strong class="uidlink"><a href="echonest.support.midi.MidiFileParser-module.html">echonest.support.midi.MidiFileParser</a></strong>    </li>
116    <li> <strong class="uidlink"><a href="echonest.support.midi.MidiInFile-module.html">echonest.support.midi.MidiInFile</a></strong>    </li>
117    <li> <strong class="uidlink"><a href="echonest.support.midi.MidiInStream-module.html">echonest.support.midi.MidiInStream</a></strong>    </li>
118    <li> <strong class="uidlink"><a href="echonest.support.midi.MidiOutFile-module.html">echonest.support.midi.MidiOutFile</a></strong>    </li>
119    <li> <strong class="uidlink"><a href="echonest.support.midi.MidiOutStream-module.html">echonest.support.midi.MidiOutStream</a></strong>    </li>
120    <li> <strong class="uidlink"><a href="echonest.support.midi.MidiToText-module.html">echonest.support.midi.MidiToText</a></strong>    </li>
121    <li> <strong class="uidlink"><a href="echonest.support.midi.RawInstreamFile-module.html">echonest.support.midi.RawInstreamFile</a></strong>    </li>
122    <li> <strong class="uidlink"><a href="echonest.support.midi.RawOutstreamFile-module.html">echonest.support.midi.RawOutstreamFile</a></strong>    </li>
123    <li> <strong class="uidlink"><a href="echonest.support.midi.constants-module.html">echonest.support.midi.constants</a></strong>    </li>
124    <li> <strong class="uidlink"><a href="echonest.support.midi.example_mimimal_type0-module.html">echonest.support.midi.example_mimimal_type0</a></strong>    </li>
125    <li> <strong class="uidlink"><a href="echonest.support.midi.example_print_channel_0-module.html">echonest.support.midi.example_print_channel_0</a></strong>    </li>
126    <li> <strong class="uidlink"><a href="echonest.support.midi.example_print_events-module.html">echonest.support.midi.example_print_events</a></strong>    </li>
127    <li> <strong class="uidlink"><a href="echonest.support.midi.example_print_file-module.html">echonest.support.midi.example_print_file</a></strong>: <em class="summary">This is an example that uses the MidiToText eventhandler.</em>    </li>
128    <li> <strong class="uidlink"><a href="echonest.support.midi.example_transpose_octave-module.html">echonest.support.midi.example_transpose_octave</a></strong>    </li>
129  </ul></td></tr>
130</table>
131
132<br />
133<!-- ==================== VARIABLES ==================== -->
134<a name="section-Variables"></a>
135<table class="summary" border="1" cellpadding="3"
136       cellspacing="0" width="100%" bgcolor="white">
137<tr bgcolor="#70b0f0" class="table-header">
138  <td colspan="2" class="table-header">
139    <table border="0" cellpadding="0" cellspacing="0" width="100%">
140      <tr valign="top">
141        <td align="left"><span class="table-header">Variables</span></td>
142        <td align="right" valign="top"
143         ><span class="options">[<a href="#section-Variables"
144         class="privatelink" onclick="toggle_private();"
145         >hide private</a>]</span></td>
146      </tr>
147    </table>
148  </td>
149</tr>
150<tr>
151    <td width="15%" align="right" valign="top" class="summary">
152      <span class="summary-type">&nbsp;</span>
153    </td><td class="summary">
154        <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
155      hash(x)
156    </td>
157  </tr>
158</table>
159<!-- ==================== NAVIGATION BAR ==================== -->
160<table class="navbar" border="0" width="100%" cellpadding="0"
161       bgcolor="#a0c0ff" cellspacing="0">
162  <tr valign="middle">
163
164  <!-- Tree link -->
165      <th>&nbsp;&nbsp;&nbsp;<a
166        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
167
168  <!-- Index link -->
169      <th>&nbsp;&nbsp;&nbsp;<a
170        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
171
172  <!-- Help link -->
173      <th>&nbsp;&nbsp;&nbsp;<a
174        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
175
176  <!-- Project homepage -->
177      <th class="navbar" align="right" width="100%">
178        <table border="0" cellpadding="0" cellspacing="0">
179          <tr><th class="navbar" align="center"
180            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
181          </tr></table></th>
182  </tr>
183</table>
184<table border="0" cellpadding="0" cellspacing="0" width="100%%">
185  <tr>
186    <td align="left" class="footer">
187    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:57 2010
188    </td>
189    <td align="right" class="footer">
190      <a target="mainFrame" href="http://epydoc.sourceforge.net"
191        >http://epydoc.sourceforge.net</a>
192    </td>
193  </tr>
194</table>
195
196<script type="text/javascript">
197  <!--
198  // Private objects are initially displayed (because if
199  // javascript is turned off then we want them to be
200  // visible); but by default, we want to hide them.  So hide
201  // them unless we have a cookie that says to show them.
202  checkCookie();
203  // -->
204</script>
205</body>
206</html>