Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
136 lines
10 KiB
HTML
136 lines
10 KiB
HTML
<!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>lvgm_player.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="Macros"></a><a name="Topic442"></a><div class="CTopic TGroup LC first">
|
|
<div class="CTitle">Macros</div>
|
|
</div>
|
|
|
|
<a name="LVGM_GET_FREQ"></a><a name="Topic443"></a><div class="CTopic TMacro LC">
|
|
<div class="CTitle">LVGM_GET_FREQ</div>
|
|
<div class="CBody"><p>Get frequency from option</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_GET_VER"></a><a name="Topic444"></a><div class="CTopic TMacro LC">
|
|
<div class="CTitle">LVGM_GET_VER</div>
|
|
<div class="CBody"><p>Get format version from option</p></div>
|
|
</div>
|
|
|
|
<a name="Functions"></a><a name="Topic445"></a><div class="CTopic TGroup LC">
|
|
<div class="CTitle">Functions</div>
|
|
</div>
|
|
|
|
<a name="LVGM_Play"></a><a name="Topic446"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_Play</div>
|
|
<div id="NDPrototype446" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">bool</span> LVGM_Play(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType"><span class="SHKeyword">void</span>* </td><td class="PName last">addr,</td></tr><tr><td class="first"></td><td class="PType"><span class="SHKeyword">bool</span> </td><td class="PName last">loop</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Start music playback.</p><div class="CHeading">Paramaters</div><table class="CDefinitionList"><tr><td class="CDLEntry">addr</td><td class="CDLDefinition"><p>Address of source data</p></td></tr><tr><td class="CDLEntry">loop</td><td class="CDLDefinition"><p>Is music looping?</p></td></tr></table><div class="CHeading">Return</div><p>TRUE if playback started correctly.</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_Stop"></a><a name="Topic447"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_Stop</div>
|
|
<div id="NDPrototype447" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> LVGM_Stop()</div></div>
|
|
<div class="CBody"><p>Stop music playback.</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_SetFrequency50Hz"></a><a name="Topic448"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_SetFrequency50Hz</div>
|
|
<div id="NDPrototype448" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> LVGM_SetFrequency50Hz()</div></div>
|
|
<div class="CBody"><p>Change frequency to 50 Hz.</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_IsFrequency50Hz"></a><a name="Topic449"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_IsFrequency50Hz</div>
|
|
<div id="NDPrototype449" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> LVGM_IsFrequency50Hz()</div></div>
|
|
<div class="CBody"><p>Check if frequency is 50 Hz.</p><div class="CHeading">Return</div><p>FALSE if frequency is not 50 Hz.</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_SetFrequency60Hz"></a><a name="Topic450"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_SetFrequency60Hz</div>
|
|
<div id="NDPrototype450" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> LVGM_SetFrequency60Hz()</div></div>
|
|
<div class="CBody"><p>Change frequency to 60 Hz.</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_SetFrequency60Hz(2)"></a><a name="Topic451"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_SetFrequency60Hz</div>
|
|
<div class="CBody"><p>Check if frequency is 60 Hz.</p><div class="CHeading">Return</div><p>TRUE if frequency is 60 Hz.</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_IsPlaying"></a><a name="Topic452"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_IsPlaying</div>
|
|
<div id="NDPrototype452" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> LVGM_IsPlaying()</div></div>
|
|
<div class="CBody"><p>Check if music playing</p><div class="CHeading">Return</div><p>FALSE if music is not playing</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_Resume"></a><a name="Topic453"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_Resume</div>
|
|
<div id="NDPrototype453" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> LVGM_Resume()</div></div>
|
|
<div class="CBody"><p>Resume music playback</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_Pause"></a><a name="Topic454"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_Pause</div>
|
|
<div id="NDPrototype454" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> LVGM_Pause()</div></div>
|
|
<div class="CBody"><p>Pause music playback</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_Decode"></a><a name="Topic455"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_Decode</div>
|
|
<div id="NDPrototype455" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> LVGM_Decode()</div></div>
|
|
<div class="CBody"><p>Decode a frame of music</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_SetPointer"></a><a name="Topic456"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_SetPointer</div>
|
|
<div id="NDPrototype456" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> LVGM_SetPointer(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PModifierQualifier first"><span class="SHKeyword">const</span> </td><td class="PType">u8* </td><td class="PName last">ptr</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Jump to a specific position in the music data</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">ptr<div class="CDLParameterType"><span class="SHKeyword">const</span> u8*</div></td><td class="CDLDefinition"><p>Pointer to the new position</p></td></tr></table></div>
|
|
</div>
|
|
|
|
<a name="LVGM_GetDevices"></a><a name="Topic457"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_GetDevices</div>
|
|
<div id="NDPrototype457" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 LVGM_GetDevices()</div></div>
|
|
<div class="CBody"><p>Get devices list</p><div class="CHeading">Return</div><p>Device list (see <LVGM_CHIP>)</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_IncludePSG"></a><a name="Topic458"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_IncludePSG</div>
|
|
<div id="NDPrototype458" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> LVGM_IncludePSG()</div></div>
|
|
<div class="CBody"><p>Is music including PSG data</p><div class="CHeading">Return</div><p>TRUE is current music include PSG data</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_IncludeOPLL"></a><a name="Topic459"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_IncludeOPLL</div>
|
|
<div id="NDPrototype459" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> LVGM_IncludeOPLL()</div></div>
|
|
<div class="CBody"><p>Is music including OPLL/MSX-Music data</p><div class="CHeading">Return</div><p>TRUE is current music include OPLL data</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_IncludeOPL"></a><a name="Topic460"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_IncludeOPL</div>
|
|
<div id="NDPrototype460" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> LVGM_IncludeOPL()</div></div>
|
|
<div class="CBody"><p>Is music including OPL/MSX-Audio data</p><div class="CHeading">Return</div><p>TRUE is current music include OPL data</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_IncludeSCC"></a><a name="Topic461"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_IncludeSCC</div>
|
|
<div id="NDPrototype461" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> <span class="SHKeyword">bool</span> LVGM_IncludeSCC()</div></div>
|
|
<div class="CBody"><p>Is music including SCC data</p><div class="CHeading">Return</div><p>TRUE is current music include SCC data</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_GetDefaultPSGValue"></a><a name="Topic462"></a><div class="CTopic TFunction LC">
|
|
<div class="CTitle">LVGM_GetDefaultPSGValue</div>
|
|
<div id="NDPrototype462" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 LVGM_GetDefaultPSGValue()</div></div>
|
|
<div class="CBody"><p>Get default PSG value used to optimized more commun data</p><div class="CHeading">Return</div><p>Default value for PSG data</p></div>
|
|
</div>
|
|
|
|
<a name="LVGM_SetNotifyCallback"></a><a name="Topic463"></a><div class="CTopic TFunction LC last">
|
|
<div class="CTitle">LVGM_SetNotifyCallback</div>
|
|
<div id="NDPrototype463" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> LVGM_SetNotifyCallback(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">LVGM_NotifyCB </td><td class="PName last">cb</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
|
|
<div class="CBody"><p>Set the function to be called when a notification is triggered</p><div class="CHeading">Parameters</div><table class="CDefinitionList"><tr><td class="CDLEntry">cb<div class="CDLParameterType">LVGM_NotifyCB</div></td><td class="CDLDefinition"><p>Callback function</p></td></tr></table></div>
|
|
</div>
|
|
|
|
</body></html> |