jurjenwerk/mazegame
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
cdc7bc545d7c48f70629f33ff24bcca07ef366aa
mazegame/engine/doc/html/files/ayfx/ayfx_player-h.html
T

81 lines
7.7 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>ayfx_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="Functions"></a><a name="Topic34"></a><div class="CTopic TGroup LC first">
<div class="CTitle">Functions</div>
</div>
<a name="ayFX_InitBank"></a><a name="Topic35"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_InitBank</div>
<div id="NDPrototype35" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> ayFX_InitBank(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">void</span>*&nbsp;</td><td class="PName last">bank</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Setup the ayFX replayer</p><div class="CHeading">Paramaters</div><table class="CDefinitionList"><tr><td class="CDLEntry">bank</td><td class="CDLDefinition"><p>Pointer to the ayFX bank data</p></td></tr></table></div>
</div>
<a name="ayFX_PlayBank"></a><a name="Topic36"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_PlayBank</div>
<div id="NDPrototype36" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters">u8 ayFX_PlayBank(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">id,</td></tr><tr><td class="PType first">u8&nbsp;</td><td class="PName last">prio</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Play a ayFX sound</p><div class="CHeading">Paramaters</div><table class="CDefinitionList"><tr><td class="CDLEntry">id</td><td class="CDLDefinition"><p>Sound index in the bank</p></td></tr><tr><td class="CDLEntry">prio</td><td class="CDLDefinition"><p>Priority of the sound (0-15). 0 is the highest priority.</p></td></tr></table><div class="CHeading">Return</div><p>Error number (if any). See &lt;AYFX_ERROR&gt;.</p></div>
</div>
<a name="ayFX_Play"></a><a name="Topic37"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_Play</div>
<div id="NDPrototype37" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">void</span> ayFX_Play(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first"><span class="SHKeyword">void</span>*&nbsp;</td><td class="PName last">data</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Play a SFX directly from data pointer</p><div class="CHeading">Paramaters</div><table class="CDefinitionList"><tr><td class="CDLEntry">file</td><td class="CDLDefinition"><p>Pointer to AFX file data</p></td></tr></table></div>
</div>
<a name="ayFX_Stop"></a><a name="Topic38"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_Stop</div>
<div id="NDPrototype38" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> ayFX_Stop()</div></div>
<div class="CBody"><p>Stop the sound playback</p></div>
</div>
<a name="ayFX_Mute"></a><a name="Topic39"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_Mute</div>
<div id="NDPrototype39" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> ayFX_Mute()</div></div>
<div class="CBody"><p>Stop the sound playback and mute the channel</p></div>
</div>
<a name="ayFX_Update"></a><a name="Topic40"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_Update</div>
<div id="NDPrototype40" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">void</span> ayFX_Update()</div></div>
<div class="CBody"><p>Play a frame of an ayFX stream</p></div>
</div>
<a name="ayFX_SetMode"></a><a name="Topic41"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_SetMode</div>
<div id="NDPrototype41" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> ayFX_SetMode(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">mode</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set channel mode</p><div class="CHeading">Paramaters</div><table class="CDefinitionList"><tr><td class="CDLEntry">mode</td><td class="CDLDefinition"><p>Playback mode. See &lt;AYFX_MODE&gt;.</p></td></tr></table></div>
</div>
<a name="ayFX_SetChannel"></a><a name="Topic42"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_SetChannel</div>
<div id="NDPrototype42" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> ayFX_SetChannel(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">u8&nbsp;</td><td class="PName last">chan</td></tr></table></td><td class="PAfterParameters">)</td></tr></table></div></div>
<div class="CBody"><p>Set the channel to use for sound playback</p><div class="CHeading">Paramaters</div><table class="CDefinitionList"><tr><td class="CDLEntry">chan</td><td class="CDLDefinition"><p>Channel number for sound playback.</p></td></tr></table></div>
</div>
<a name="ayFX_GetChannel"></a><a name="Topic43"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_GetChannel</div>
<div id="NDPrototype43" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 ayFX_GetChannel()</div></div>
<div class="CBody"><p>Get the channel used for sound playback</p><div class="CHeading">Return</div><p>Channel numberused for sound playback.</p></div>
</div>
<a name="ayFX_GetBankNumber"></a><a name="Topic44"></a><div class="CTopic TFunction LC">
<div class="CTitle">ayFX_GetBankNumber</div>
<div id="NDPrototype44" class="NDPrototype"><div class="PSection PPlainSection"><span class="SHKeyword">inline</span> u8 ayFX_GetBankNumber()</div></div>
<div class="CBody"><p>Get number of sound in the bank</p><div class="CHeading">Return</div><p>Number of sound in the bank</p></div>
</div>
<a name="ayFX_SetFinishCB"></a><a name="Topic45"></a><div class="CTopic TFunction LC last">
<div class="CTitle">ayFX_SetFinishCB</div>
<div id="NDPrototype45" class="NDPrototype WideForm"><div class="PSection PParameterSection CStyle"><table><tr><td class="PBeforeParameters"><span class="SHKeyword">inline</span> <span class="SHKeyword">void</span> ayFX_SetFinishCB(</td><td class="PParametersParentCell"><table class="PParameters"><tr><td class="PType first">callback&nbsp;</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 call when a sound ended</p><div class="CHeading">Paramaters</div><table class="CDefinitionList"><tr><td class="CDLEntry">cb</td><td class="CDLDefinition"><p>Function pointer to be called when sound end</p></td></tr></table></div>
</div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink