nephele
/
haiku-website
0
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
haiku-website/static/legacy-docs/bebook/BMidiText.html

23 lines
13 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Be Book - Classes And Methods - The Midi Kit</title><link rel="stylesheet" href="be_book.css" type="text/css" media="all" /><link rel="shortcut icon" type="image/vnd.microsoft.icon" href="./images/favicon.ico" /><!--[if IE]>
<link rel="stylesheet" type="text/css" href="be_book_ie.css" />
<![endif]--><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><meta name="keywords" content="Access, BeOS, BeBook, API" /><link rel="start" href="index.html" title="The Be Book" /><link rel="up" href="TheMidiKit.html" title="The Midi Kit" /><link rel="prev" href="BMidiSynthFile.html" title="BMidiSynthFile" /><link rel="next" href="BSamples.html" title="BSamples" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="BMidiSynthFile.html" title="BMidiSynthFile"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a accesskey="u" href="TheMidiKit.html" title="The Midi Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a accesskey="n" href="BSamples.html" title="BSamples"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="headerTR"><div id="navigpeople"><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div><div class="navigboxed" id="navigindex"><a accesskey="i" href="ClassIndex.html" title="Index">I</a></div><div class="navigboxed" id="naviglang" title="English">en</div></div><div id="headerTC">The Be Book - Classes And Methods - The Midi Kit</div></div><div id="headerB">Prev: <a href="BMidiSynthFile.html">BMidiSynthFile</a>  Up: <a href="TheMidiKit.html">The Midi Kit</a>  Next: <a href="BSamples.html">BSamples</a></div><hr /></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h2 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BMidiText"></a>BMidiText</h2></div></div></div><a id="id1200894" class="indexterm"></a><div class="classheader"><table border="0"><colgroup><col /><col /></colgroup><tbody><tr><td><table width="100%" border="0"><colgroup><col /><col /></colgroup><tbody><tr><td>Derived From:</td><td><a class="link" href="BMidi.html" title="BMidi"><code class="classname">BMidi</code></a></td></tr><tr><td>Mix-in Classes:</td><td>–</td></tr><tr><td>Declared In:</td><td><code class="filename">midi/MidiText.h</code></td></tr><tr><td>Library:</td><td><code class="filename">libmidi.so</code></td></tr><tr><td>Allocation:</td><td>–</td></tr></tbody></table></td><td>
<a class="link overview" href="BMidiText_Overview.html" title="BMidiText">Class Overview</a>
<div class="toc"><ul><li><span class="section"><a href="BMidiText.html#BMidiText_ConstructorDestructor">Constructor and Destructor</a></span></li><li><span class="section"><a href="BMidiText.html#BMidiText_MemberFunctions">Member Functions</a></span></li><li><span class="section"><a href="BMidiText.html#BMidiText_OutputText">Output Text</a></span></li></ul></div>
</td></tr></tbody></table></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BMidiText_ConstructorDestructor"></a>Constructor and Destructor</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BMidiText_Constructor"></a>BMidiText()</h4></div></div></div><code class="constructorsynopsis cpp"><span class="methodname">BMidiText</span>();</code><p>The constructor creates a new <code class="classname">BMidiText</code>
object. The object's timer is set to zero and doesn't start ticking until
the first message is received. To force the timer to start, call
<span class="code"><a class="link" href="BMidiText.html#BMidiText_ResetTimer" title="ResetTimer()"><code class="methodname">ResetTimer</code></a>(<code class="constant">true</code>)</span>.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BMidiText_Destructor"></a>~BMidiText()</h4></div></div></div><code class="destructorsynopsis cpp"><span class="modifier">virtual </span><span class="methodname">~BMidiText</span>();</code><p>The destructor destroys the object.</p></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BMidiText_MemberFunctions"></a>Member Functions</h3></div></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BMidiText_ResetTimer"></a>ResetTimer()</h4></div></div></div><code class="methodsynopsis cpp"><span class="void">void </span><span class="methodname">AllNotesOff</span>(<span class="methodparam"><span class="type">bool </span><span class="parameter">start</span><span class="initializer"> = <span class="constant">false</span></span></span>);</code><p>Sets the object's internal timer to zero. If
<code class="parameter">start</code> is <code class="constant">false</code> the
timer doesn't start ticking until the next MIDI message is received. If
<code class="parameter">start</code> is <code class="constant">true</code>, the
timer begins immediately.</p><p>The timer value is used to compute the timestamp that's displayed
at the beginning of each message description.</p></div></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><hr /><div xmlns:d="http://docbook.org/ns/docbook"><h3 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BMidiText_OutputText"></a>Output Text</h3></div></div></div><p>The text strings that a <code class="classname">BMidiText</code> object
displays are shown below, listed by MIDI event</p><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201241"></a>Channel Pressure</h4></div></div></div><pre class="screen">timestamp: CHANNEL PRESSURE; channel = channel, pressure = pressure</pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201253"></a>Control Change</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: CONTROL CHANGE; channel = <em class="replaceable"><code>channel</code></em>, control = <em class="replaceable"><code>ctrl_num</code></em>,
value = <em class="replaceable"><code>ctrl_value</code></em></pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201277"></a>Key Pressure</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: KEY PRESSURE; channel = <em class="replaceable"><code>channel</code></em>, note = <em class="replaceable"><code>note</code></em>, pressure =
<em class="replaceable"><code>pressure</code></em></pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201301"></a>Note Off</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: NOTE OFF; channel = <em class="replaceable"><code>channel</code></em>, note = <em class="replaceable"><code>note</code></em>, velocity = <em class="replaceable"><code>velocity</code></em></pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201325"></a>Note On</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: NOTE ON; channel = <em class="replaceable"><code>channel</code></em>, note = <em class="replaceable"><code>note</code></em>, velocity = <em class="replaceable"><code>velocity</code></em></pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201348"></a>Pitch Bend</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: PITCH BEND; channel = <em class="replaceable"><code>channel</code></em>, lsb = <em class="replaceable"><code>lsb</code></em>, msb = <em class="replaceable"><code>msb</code></em></pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201372"></a>Program Change</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: PROGRAM CHANGE; channel = <em class="replaceable"><code>channel</code></em>, program = <em class="replaceable"><code>program_num</code></em></pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201392"></a>System Common</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: SYSTEM COMMON; status = <em class="replaceable"><code>status</code></em>, data1 = <em class="replaceable"><code>data1</code></em>, data2= <em class="replaceable"><code>data2</code></em></pre></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201416"></a>System Exclusive</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: SYSTEM EXCLUSIVE;</pre><p>Followed by the data itself (in hex, byte-by-byte), starting on the next
line.</p></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h4 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="id1201435"></a>SystemRealTime()</h4></div></div></div><pre class="screen"><em class="replaceable"><code>timestamp</code></em>: SYSTEM REAL TIME; status = <em class="replaceable"><code>status</code></em></pre></div></div></div><div id="footer"><hr /><div id="footerT">Prev: <a href="BMidiSynthFile.html">BMidiSynthFile</a>  Up: <a href="TheMidiKit.html">The Midi Kit</a>  Next: <a href="BSamples.html">BSamples</a> </div><div id="footerB"><div id="footerBL"><a href="BMidiSynthFile.html" title="BMidiSynthFile"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a href="TheMidiKit.html" title="The Midi Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a href="BSamples.html" title="BSamples"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="footerBR"><div><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div></div><div id="footerBC"><a href="http://www.access-company.com/home.html" title="ACCESS Co."><img alt="Access Company" src="./images/access_logo.png" /></a></div></div></div><div id="licenseFooter"><div id="licenseFooterBL"><a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/" title="Creative Commons License"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by-nc-nd/3.0/88x31.png" /></a></div><div id="licenseFooterBR"><a href="./LegalNotice.html">Legal Notice</a></div><div id="licenseFooterBC"><span id="licenseText">This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/">Creative
Commons Attribution-Non commercial-No Derivative Works 3.0 License</a>.</span></div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink