<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>libkmid: MidiTrack Class Reference (libkmid)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">libkmid</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">MidiTrack Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="MidiTrack" -->
<p>Stores a MIDI track.
<a href="classMidiTrack.html#details">More...</a></p>
<p><code>#include <<a class="el" href="track_8h_source.html">track.h</a>></code></p>
<p><a href="classMidiTrack-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#a3677511da0dd4c08a0e3a70cda570773">MidiTrack</a> (FILE *file, int tpcn, int Id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#aaa9f15c2fe33ed0f44e0a78b2d1f0bf4">~MidiTrack</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#ac35021f7a4b41cee4324e5cc9d23d052">ticksPassed</a> (ulong ticks)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#aec31e2a8a91224f95d9157f0ebbd2082">msPassed</a> (ulong ms)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#a3853ed58cfeddeb48a3ec9c00875d984">currentMs</a> (double ms)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ulong </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#a300ce66ac5591239483513b613ab6e9f">waitTicks</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#afae662342050ef7a5621af73a45dffb5">absMsOfNextEvent</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#ae299d7d5d937e69dda16c36f9ff9498a">changeTempo</a> (ulong t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#a0116697d2b63b1369b980dcbb12ce9b4">readEvent</a> (<a class="el" href="structMidiEvent.html">MidiEvent</a> *ev)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#a1066b85a0a6835a7243ff07a6362a931">init</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMidiTrack.html#a01cd05333977c42eaf60bf53860e0078">clear</a> (void)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Stores a MIDI track. </p>
<p>This can be thought of as a list of MIDI events.</p>
<p>The data types used to store the track is similar to how events are stored on a MIDI file, but used in a way that allows for faster parses.</p>
<p>This class is used on <a class="el" href="classMidiPlayer.html#a149fe0c46adc94a95c4b80f595b6abf5" title="Loads a Song, and parses it (it the parse wasn't disabled with setParseSong() ) .">MidiPlayer::loadSong()</a> to load the song and later play it with <a class="el" href="classMidiPlayer.html#a3c291cfbf2f58c940707771ad62ba564" title="Plays the song using the DeviceManager object supplied in the constructor.">MidiPlayer::play()</a>.</p>
<p>Stores a MIDI track with a simple API </p>
<dl class="version"><dt><b>Version:</b></dt><dd>0.9.5 17/01/2000 </dd></dl>
<dl class="author"><dt><b>Author:</b></dt><dd>Antonio Larrosa Jimenez <<a href="mailto:larrosa@kde.org">larrosa@kde.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="track_8h_source.html#l00126">126</a> of file <a class="el" href="track_8h_source.html">track.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a3677511da0dd4c08a0e3a70cda570773"></a><!-- doxytag: member="MidiTrack::MidiTrack" ref="a3677511da0dd4c08a0e3a70cda570773" args="(FILE *file, int tpcn, int Id)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MidiTrack::MidiTrack </td>
<td>(</td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>tpcn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>Id</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">file</td><td>the file to read the track from. It should be ready at the start of a track. <a class="el" href="classMidiTrack.html" title="Stores a MIDI track.">MidiTrack</a> reads just that track and the file is left at the end of this track). </td></tr>
<tr><td class="paramname">tpcn</td><td>the ticks per cuarter note used in this file. </td></tr>
<tr><td class="paramname">Id</td><td>the ID for this track. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00049">49</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aaa9f15c2fe33ed0f44e0a78b2d1f0bf4"></a><!-- doxytag: member="MidiTrack::~MidiTrack" ref="aaa9f15c2fe33ed0f44e0a78b2d1f0bf4" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MidiTrack::~MidiTrack </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00088">88</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="afae662342050ef7a5621af73a45dffb5"></a><!-- doxytag: member="MidiTrack::absMsOfNextEvent" ref="afae662342050ef7a5621af73a45dffb5" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double MidiTrack::absMsOfNextEvent </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the absolute number of milliseconds of the next event. </p>
<p>Definition at line <a class="el" href="track_8h_source.html#l00212">212</a> of file <a class="el" href="track_8h_source.html">track.h</a>.</p>
</div>
</div>
<a class="anchor" id="ae299d7d5d937e69dda16c36f9ff9498a"></a><!-- doxytag: member="MidiTrack::changeTempo" ref="ae299d7d5d937e69dda16c36f9ff9498a" args="(ulong t)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiTrack::changeTempo </td>
<td>(</td>
<td class="paramtype">ulong </td>
<td class="paramname"><em>t</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Change the tempo of the song. </p>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00544">544</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a01cd05333977c42eaf60bf53860e0078"></a><!-- doxytag: member="MidiTrack::clear" ref="a01cd05333977c42eaf60bf53860e0078" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiTrack::clear </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears the internal variables. </p>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00498">498</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a3853ed58cfeddeb48a3ec9c00875d984"></a><!-- doxytag: member="MidiTrack::currentMs" ref="a3853ed58cfeddeb48a3ec9c00875d984" args="(double ms)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MidiTrack::currentMs </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"><em>ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current millisecond which the iterator is at. </p>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00174">174</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a1066b85a0a6835a7243ff07a6362a931"></a><!-- doxytag: member="MidiTrack::init" ref="a1066b85a0a6835a7243ff07a6362a931" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiTrack::init </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes the iterator. </p>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00519">519</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="aec31e2a8a91224f95d9157f0ebbd2082"></a><!-- doxytag: member="MidiTrack::msPassed" ref="aec31e2a8a91224f95d9157f0ebbd2082" args="(ulong ms)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MidiTrack::msPassed </td>
<td>(</td>
<td class="paramtype">ulong </td>
<td class="paramname"><em>ms</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes the iterator advance the given number of milliseconds. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if OK, and 1 if you didn't handle this track well and you forgot to take an event (thing that will never happen if you use <a class="el" href="classMidiPlayer.html#a3c291cfbf2f58c940707771ad62ba564" title="Plays the song using the DeviceManager object supplied in the constructor.">MidiPlayer::play()</a> ). </dd></dl>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00158">158</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a0116697d2b63b1369b980dcbb12ce9b4"></a><!-- doxytag: member="MidiTrack::readEvent" ref="a0116697d2b63b1369b980dcbb12ce9b4" args="(MidiEvent *ev)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MidiTrack::readEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structMidiEvent.html">MidiEvent</a> * </td>
<td class="paramname"><em>ev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reads the event at the iterator position, and puts it on the structure pointed to by <code>ev</code>. </p>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00190">190</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="ac35021f7a4b41cee4324e5cc9d23d052"></a><!-- doxytag: member="MidiTrack::ticksPassed" ref="ac35021f7a4b41cee4324e5cc9d23d052" args="(ulong ticks)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int MidiTrack::ticksPassed </td>
<td>(</td>
<td class="paramtype">ulong </td>
<td class="paramname"><em>ticks</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes the iterator advance the given number of ticks. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>0 if OK, and 1 if you didn't handle this track well and you forgot to take an event (thing that will never happen if you use <a class="el" href="classMidiPlayer.html#a3c291cfbf2f58c940707771ad62ba564" title="Plays the song using the DeviceManager object supplied in the constructor.">MidiPlayer::play()</a> ). </dd></dl>
<p>Definition at line <a class="el" href="track_8cc_source.html#l00146">146</a> of file <a class="el" href="track_8cc_source.html">track.cc</a>.</p>
</div>
</div>
<a class="anchor" id="a300ce66ac5591239483513b613ab6e9f"></a><!-- doxytag: member="MidiTrack::waitTicks" ref="a300ce66ac5591239483513b613ab6e9f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ulong MidiTrack::waitTicks </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of ticks left for the next event. </p>
<p>Definition at line <a class="el" href="track_8h_source.html#l00205">205</a> of file <a class="el" href="track_8h_source.html">track.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="track_8h_source.html">track.h</a></li>
<li><a class="el" href="track_8cc_source.html">track.cc</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>libkmid</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classAlsaOut.html">alsaout</option>, <option value="classDeviceManager.html">devicemanager</option>, <option value="classFMOut.html">fmout</option>, <option value="classGUSOut.html">gusout</option>, <option value="classMidiMapper.html">midimapper</option>, <option value="classMidiOut.html">midiout</option>, <option value="classMidiPlayer.html">midiplayer</option>, <option value="classMidiStatus.html">midistatus</option>, <option value="classMidiTrack.html">miditrack</option>, <option value="classNoteArray.html">notearray</option>, <option value="classSynthOut.html">synthout</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
