jurjenwerk/mazegame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
45749775fa508e685c429d2c425a20a18473be53
mazegame/engine/doc/html/files/device/wavegame-h.html
T

81 lines
8.4 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><meta http-equiv="X-UA-Compatible" content="IE=edge"><title>wavegame.h</title><link rel="stylesheet" type="text/css" href="../../styles/main.css" /><script type="text/javascript" src="../../styles/main.js"></script><script type="text/javascript">NDLoader.LoadJS("Content", "../../styles/");</script></head>
<!-- Generated by Natural Docs, version 2.2 -->
<!-- saved from url=(0016)http://localhost -->
<body onload="NDLoader.OnLoad('Content');" class="NDPage NDContentPage">
<a name="Functions"></a><a name="Topic51"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Functions</div>
</div>
<a name="WaveGame_GetVersion"></a><a name="Topic52"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_GetVersion</div>
<div id="NDPrototype52" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 WaveGame_GetVersion()</div></div>
<div class="CBody"><p>Get the version of the MSX PICO WaveGame firmware Note that WaveGame version 1 is needed</p><div class="CHeading">Return</div><p>WaveGame version</p><pre class="CText">0: Firmware v1.49 / v2.05 / v2.06<br />1: Firmware v1.50 / v2.07 and higher</pre></div>
</div>
<a name="WaveGame_Stop"></a><a name="Topic53"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_Stop</div>
<div id="NDPrototype53" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_Stop()</div></div>
<div class="CBody"><p>Stop music (actually a 1-second fade out)</p></div>
</div>
<a name="WaveGame_Fade"></a><a name="Topic54"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_Fade</div>
<div id="NDPrototype54" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_Fade(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">sec</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Fade out music in xxxx seconds</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">sec<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Number of seconds to fade out (0-15)</p></td></tr></table></div>
</div>
<a name="WaveGame_PlayOnce"></a><a name="Topic55"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_PlayOnce</div>
<div id="NDPrototype55" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_PlayOnce(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">song</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Play song xxxxxx once (for instance command 01000101 will play 05.wav once)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">song<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Song number to play (0-63)</p></td></tr></table></div>
</div>
<a name="WaveGame_PlayLoop"></a><a name="Topic56"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_PlayLoop</div>
<div id="NDPrototype56" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_PlayLoop(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">song</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Play song xxxxxx in a loop (for instance command 10000101 will play 05.wav continuously)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">song<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Song number to play (0-63)</p></td></tr></table></div>
</div>
<a name="WaveGame_Play"></a><a name="Topic57"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_Play</div>
<div id="NDPrototype57" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_Play(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">song,</td></tr><tr><td class="PType first"><span class="SHKeyword">bool</span>&nbsp;</td><td class="PName last">loop</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Play song xxxxxx (for instance command 10000101 will play 05.wav continuously)</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">song<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Song number to play (0-63)</p></td></tr><tr><td class="CDLEntry">loop<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>true to play in a loop, false to play once</p></td></tr></table></div>
</div>
<a name="WaveGame_Pause"></a><a name="Topic58"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_Pause</div>
<div id="NDPrototype58" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_Pause()</div></div>
<div class="CBody"><p>Toggle pause</p></div>
</div>
<a name="WaveGame_PlayPause"></a><a name="Topic59"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_PlayPause</div>
<div id="NDPrototype59" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_PlayPause()</div></div>
<div class="CBody"><p>Play pause.wav sound (use 11100000 to continue previous song)</p></div>
</div>
<a name="WaveGame_Continue"></a><a name="Topic60"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_Continue</div>
<div id="NDPrototype60" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_Continue()</div></div>
<div class="CBody"><p>Continue previous song with a 1-second fade in</p></div>
</div>
<a name="WaveGame_StoreNext"></a><a name="Topic61"></a><div class="CTopic TFunction LC">
<div class="CTitle">WaveGame_StoreNext</div>
<div id="NDPrototype61" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_StoreNext()</div></div>
<div class="CBody"><p>Next command received will be temporarily stored and executed after the current song stops playing, or already has stopped</p></div>
</div>
<a name="WaveGame_PlayNext"></a><a name="Topic62"></a><div class="CTopic TFunction LC last">
<div class="CTitle">WaveGame_PlayNext</div>
<div id="NDPrototype62" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> WaveGame_PlayNext(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">song,</td></tr><tr><td class="PType first"><span class="SHKeyword">bool</span>&nbsp;</td><td class="PName last">loop</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Play song xxxxxx (for instance command 10000101 will play 05.wav continuously) when current music ends</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">song<div class="CDLParameterType">u8</div></td><td class="CDLDefinition"><p>Song number to play (0-63)</p></td></tr><tr><td class="CDLEntry">loop<div class="CDLParameterType"><span class="SHKeyword">bool</span></div></td><td class="CDLDefinition"><p>true to play in a loop, false to play once</p></td></tr></table></div>
</div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink