Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 1f9eb832ba1e4b88d9a5c2b384813bb4 > files > 6983

kdelibs3-apidocs-3.5.10-31.fc15.noarch.rpm

<?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: SpecialEvent Struct 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-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<div class="title">SpecialEvent Struct Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="SpecialEvent" -->
<p>This struct stores text, lyrics and change tempo events among others.  
 <a href="structSpecialEvent.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="player_8h_source.html">player.h</a>&gt;</code></p>

<p><a href="structSpecialEvent-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#ae99bf52fc76952d257e93d0e2d29386e">id</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ulong&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#ac2fae285709f685d06590520642d08dc">diffmilliseconds</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ulong&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#ab38473129e31721939864806f504bc51">absmilliseconds</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#a3761e64f20c79e26bc1746a56896f2ad">ticks</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#acf342fb2a34e0b118a1376c41848b2db">type</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#a70be72dd69b6733c85b4519f92b1a06f">text</a> [1024]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">ulong&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#a40d1ef921f86a255e03bf0008caa4d99">tempo</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#a83e447c45a8189d739bd8543fe1faa8a">num</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#a8c4a74e1a0a5c39e339a981e0b453273">den</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structSpecialEvent.html">SpecialEvent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structSpecialEvent.html#a84bce740da459beb1be0f558818614ef">next</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>This struct stores text, lyrics and change tempo events among others. </p>
<p>It includes the main information for an event. That is, the absolute millisecond at which this event is played (from the beginning of the song), the delta milliseconds from the previous <a class="el" href="structSpecialEvent.html" title="This struct stores text, lyrics and change tempo events among others.">SpecialEvent</a>, an ID, etc.</p>
<p>This struct is used as nodes for a linked list, which you can get using <a class="el" href="classMidiPlayer.html#a4f470b8b9146bba3981e09d616b2e9d0" title="Returns the linked list of SpecialEvents objects .">MidiPlayer::specialEvents()</a>.</p>
<p>Struct used to store certain events </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 &lt;<a href="mailto:larrosa@kde.org">larrosa@kde.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="player_8h_source.html#l00048">48</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>
</div><hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="ab38473129e31721939864806f504bc51"></a><!-- doxytag: member="SpecialEvent::absmilliseconds" ref="ab38473129e31721939864806f504bc51" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ulong <a class="el" href="structSpecialEvent.html#ab38473129e31721939864806f504bc51">SpecialEvent::absmilliseconds</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>The absolute millisecond (from the beginning of the song) at which this <a class="el" href="structSpecialEvent.html" title="This struct stores text, lyrics and change tempo events among others.">SpecialEvent</a> object is played. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structSpecialEvent.html#ac2fae285709f685d06590520642d08dc" title="Delta milliseconds from the previous SpecialEvent.">diffmilliseconds</a> </dd></dl>

<p>Definition at line <a class="el" href="player_8h_source.html#l00068">68</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8c4a74e1a0a5c39e339a981e0b453273"></a><!-- doxytag: member="SpecialEvent::den" ref="a8c4a74e1a0a5c39e339a981e0b453273" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSpecialEvent.html#a8c4a74e1a0a5c39e339a981e0b453273">SpecialEvent::den</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Denominator . </p>
<p>It has a meaning only for Change number of beats per measure and beat events. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00109">109</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac2fae285709f685d06590520642d08dc"></a><!-- doxytag: member="SpecialEvent::diffmilliseconds" ref="ac2fae285709f685d06590520642d08dc" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ulong <a class="el" href="structSpecialEvent.html#ac2fae285709f685d06590520642d08dc">SpecialEvent::diffmilliseconds</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Delta milliseconds from the previous <a class="el" href="structSpecialEvent.html" title="This struct stores text, lyrics and change tempo events among others.">SpecialEvent</a>. </p>
<dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="structSpecialEvent.html#ab38473129e31721939864806f504bc51" title="The absolute millisecond (from the beginning of the song) at which this SpecialEvent object is played...">absmilliseconds</a> </dd></dl>

<p>Definition at line <a class="el" href="player_8h_source.html#l00060">60</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae99bf52fc76952d257e93d0e2d29386e"></a><!-- doxytag: member="SpecialEvent::id" ref="ae99bf52fc76952d257e93d0e2d29386e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSpecialEvent.html#ae99bf52fc76952d257e93d0e2d29386e">SpecialEvent::id</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>An integer ID, that is assigned in order to each <a class="el" href="structSpecialEvent.html" title="This struct stores text, lyrics and change tempo events among others.">SpecialEvent</a>. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00053">53</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="a84bce740da459beb1be0f558818614ef"></a><!-- doxytag: member="SpecialEvent::next" ref="a84bce740da459beb1be0f558818614ef" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structSpecialEvent.html">SpecialEvent</a>* <a class="el" href="structSpecialEvent.html#a84bce740da459beb1be0f558818614ef">SpecialEvent::next</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>This struct stores text, lyrics and change tempo events among others. </p>
<p>It includes the main information for an event. That is, the absolute millisecond at which this event is played (from the beginning of the song), the delta milliseconds from the previous <a class="el" href="structSpecialEvent.html" title="This struct stores text, lyrics and change tempo events among others.">SpecialEvent</a>, an ID, etc.</p>
<p>This struct is used as nodes for a linked list, which you can get using <a class="el" href="classMidiPlayer.html#a4f470b8b9146bba3981e09d616b2e9d0" title="Returns the linked list of SpecialEvents objects .">MidiPlayer::specialEvents()</a>. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00121">121</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="a83e447c45a8189d739bd8543fe1faa8a"></a><!-- doxytag: member="SpecialEvent::num" ref="a83e447c45a8189d739bd8543fe1faa8a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSpecialEvent.html#a83e447c45a8189d739bd8543fe1faa8a">SpecialEvent::num</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Numerator . </p>
<p>It has a meaning only for Change number of beats per measure and beat events. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00104">104</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="a40d1ef921f86a255e03bf0008caa4d99"></a><!-- doxytag: member="SpecialEvent::tempo" ref="a40d1ef921f86a255e03bf0008caa4d99" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ulong <a class="el" href="structSpecialEvent.html#a40d1ef921f86a255e03bf0008caa4d99">SpecialEvent::tempo</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Tempo field . </p>
<p>It has a meaning only for Change Tempo events. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00099">99</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="a70be72dd69b6733c85b4519f92b1a06f"></a><!-- doxytag: member="SpecialEvent::text" ref="a70be72dd69b6733c85b4519f92b1a06f" args="[1024]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="structSpecialEvent.html#a70be72dd69b6733c85b4519f92b1a06f">SpecialEvent::text</a>[1024]</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Text field . </p>
<p>It has a meaning only for Text and Lyrics events. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00094">94</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="a3761e64f20c79e26bc1746a56896f2ad"></a><!-- doxytag: member="SpecialEvent::ticks" ref="a3761e64f20c79e26bc1746a56896f2ad" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSpecialEvent.html#a3761e64f20c79e26bc1746a56896f2ad">SpecialEvent::ticks</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>MIDI ticks (from the beginning of the song) at which this event is played. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00073">73</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<a class="anchor" id="acf342fb2a34e0b118a1376c41848b2db"></a><!-- doxytag: member="SpecialEvent::type" ref="acf342fb2a34e0b118a1376c41848b2db" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structSpecialEvent.html#acf342fb2a34e0b118a1376c41848b2db">SpecialEvent::type</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Type of event. </p>
<p>This currently includes:</p>
<ul>
<li>0 - Nothing, end of linked list. </li>
<li>1 - Text Event . See text. </li>
<li>3 - Change Tempo Event . See tempo. </li>
<li>5 - Lyrics Event . See text. </li>
<li>6 - Change number of beats per measure . See num and den. </li>
<li>7 - Beat . See num and den.</li>
</ul>
<p>The "Change number of beats per measure" and "beat" events are not really in the midi file, but they are added to the linked list in case you have an use for it. </p>

<p>Definition at line <a class="el" href="player_8h_source.html#l00089">89</a> of file <a class="el" href="player_8h_source.html">player.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="player_8h_source.html">player.h</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>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li>&nbsp;&nbsp;<a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li>&nbsp;&nbsp;<a href="../../kio/kfile/html/index.html">kfile</a></li><li>&nbsp;&nbsp;<a href="../../kio/kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/kioexec/html/index.html">kioexec</a></li><li>&nbsp;&nbsp;<a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li>&nbsp;&nbsp;<a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>