The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-02-22 04:37:17 +01:00
Code Issues Packages Projects Releases Wiki Activity
N64FlashcartMenu/sound_8h.html
networkfusion 3ce6d9c131 deploy: 276efa38eadf1b2389e90dfd03b10c2a3cb6495e
2025-01-25 00:07:05 +00:00

320 lines
17 KiB
HTML
Raw Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>N64FlashcartMenu: sound.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">N64FlashcartMenu
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_1a56cc8cdc1689899910be5fa4716ee4.html">menu</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sound.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Menu Sound.
<a href="#details">More...</a></p>
<p><a href="sound_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ab67be06d848428483d4b2712c45885c8" id="r_ab67be06d848428483d4b2712c45885c8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#ab67be06d848428483d4b2712c45885c8">SOUND_MP3_PLAYER_CHANNEL</a>&#160;&#160;&#160;(0)</td></tr>
<tr class="separator:ab67be06d848428483d4b2712c45885c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a415f608e6f630c3a50cd31f0c3751f91" id="r_a415f608e6f630c3a50cd31f0c3751f91"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#a415f608e6f630c3a50cd31f0c3751f91">SOUND_SFX_CHANNEL</a>&#160;&#160;&#160;(2)</td></tr>
<tr class="separator:a415f608e6f630c3a50cd31f0c3751f91"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:af629aea8228f169d2ce1fdef5d0ec406" id="r_af629aea8228f169d2ce1fdef5d0ec406"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406">sound_effect_t</a> { <br />
&#160;&#160;<a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406a9d4aa27d32da0ac737d975e8ccb5b825">SFX_CURSOR</a>
, <a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406ac12e9ab893630c9c94142457231db412">SFX_ERROR</a>
, <a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406ad41cea2f6b2365b3b15c8d2a910389fb">SFX_ENTER</a>
, <a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406a0cb778155e61d21f66c2fbd3e64f0e5e">SFX_EXIT</a>
, <br />
&#160;&#160;<a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406ac177735c7f8eb5599230c6849a60af8d">SFX_SETTING</a>
<br />
}</td></tr>
<tr class="memdesc:af629aea8228f169d2ce1fdef5d0ec406"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enumeration of available sound effects for menu interactions. <a href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406">More...</a><br /></td></tr>
<tr class="separator:af629aea8228f169d2ce1fdef5d0ec406"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a07821cfe30ceff25ea3ced58e082c338" id="r_a07821cfe30ceff25ea3ced58e082c338"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#a07821cfe30ceff25ea3ced58e082c338">sound_init_default</a> (void)</td></tr>
<tr class="memdesc:a07821cfe30ceff25ea3ced58e082c338"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the default sound system. <br /></td></tr>
<tr class="separator:a07821cfe30ceff25ea3ced58e082c338"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aab8b9e403b653c8c710e13b208a15079" id="r_aab8b9e403b653c8c710e13b208a15079"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#aab8b9e403b653c8c710e13b208a15079">sound_init_mp3_playback</a> (void)</td></tr>
<tr class="memdesc:aab8b9e403b653c8c710e13b208a15079"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the MP3 playback system. <br /></td></tr>
<tr class="separator:aab8b9e403b653c8c710e13b208a15079"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0d1a8383f0881f72b4bf2dabbafd7b4e" id="r_a0d1a8383f0881f72b4bf2dabbafd7b4e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#a0d1a8383f0881f72b4bf2dabbafd7b4e">sound_init_sfx</a> (void)</td></tr>
<tr class="memdesc:a0d1a8383f0881f72b4bf2dabbafd7b4e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize the sound effects system. <br /></td></tr>
<tr class="separator:a0d1a8383f0881f72b4bf2dabbafd7b4e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aee86d15559278545acf0e7dec7505249" id="r_aee86d15559278545acf0e7dec7505249"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#aee86d15559278545acf0e7dec7505249">sound_use_sfx</a> (bool)</td></tr>
<tr class="memdesc:aee86d15559278545acf0e7dec7505249"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable or disable sound effects. <br /></td></tr>
<tr class="separator:aee86d15559278545acf0e7dec7505249"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0da25fd87321991846c52b383f6f13bc" id="r_a0da25fd87321991846c52b383f6f13bc"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sound_8h.html#a0da25fd87321991846c52b383f6f13bc">sound_play_effect</a> (<a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406">sound_effect_t</a> sfx)</td></tr>
<tr class="memdesc:a0da25fd87321991846c52b383f6f13bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Play a specified sound effect. <br /></td></tr>
<tr class="separator:a0da25fd87321991846c52b383f6f13bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd219b8e5c2adacbfd2ea3e9c5f564c0" id="r_abd219b8e5c2adacbfd2ea3e9c5f564c0"><td class="memItemLeft" align="right" valign="top"><a id="abd219b8e5c2adacbfd2ea3e9c5f564c0" name="abd219b8e5c2adacbfd2ea3e9c5f564c0"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>sound_deinit</b> (void)</td></tr>
<tr class="separator:abd219b8e5c2adacbfd2ea3e9c5f564c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ae7bee1ef1dc3362f68f2b5eb7a1259" id="r_a7ae7bee1ef1dc3362f68f2b5eb7a1259"><td class="memItemLeft" align="right" valign="top"><a id="a7ae7bee1ef1dc3362f68f2b5eb7a1259" name="a7ae7bee1ef1dc3362f68f2b5eb7a1259"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>sound_poll</b> (void)</td></tr>
<tr class="separator:a7ae7bee1ef1dc3362f68f2b5eb7a1259"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Menu Sound. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ab67be06d848428483d4b2712c45885c8" name="ab67be06d848428483d4b2712c45885c8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab67be06d848428483d4b2712c45885c8">&#9670;&#160;</a></span>SOUND_MP3_PLAYER_CHANNEL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOUND_MP3_PLAYER_CHANNEL&#160;&#160;&#160;(0)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Channel for MP3 player sound </p>
</div>
</div>
<a id="a415f608e6f630c3a50cd31f0c3751f91" name="a415f608e6f630c3a50cd31f0c3751f91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a415f608e6f630c3a50cd31f0c3751f91">&#9670;&#160;</a></span>SOUND_SFX_CHANNEL</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SOUND_SFX_CHANNEL&#160;&#160;&#160;(2)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Channel for sound effects </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="af629aea8228f169d2ce1fdef5d0ec406" name="af629aea8228f169d2ce1fdef5d0ec406"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af629aea8228f169d2ce1fdef5d0ec406">&#9670;&#160;</a></span>sound_effect_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406">sound_effect_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enumeration of available sound effects for menu interactions. </p>
<p>This enumeration defines the different sound effects that can be used for menu interactions. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="af629aea8228f169d2ce1fdef5d0ec406a9d4aa27d32da0ac737d975e8ccb5b825" name="af629aea8228f169d2ce1fdef5d0ec406a9d4aa27d32da0ac737d975e8ccb5b825"></a>SFX_CURSOR&#160;</td><td class="fielddoc"><p>Sound effect for cursor movement </p>
</td></tr>
<tr><td class="fieldname"><a id="af629aea8228f169d2ce1fdef5d0ec406ac12e9ab893630c9c94142457231db412" name="af629aea8228f169d2ce1fdef5d0ec406ac12e9ab893630c9c94142457231db412"></a>SFX_ERROR&#160;</td><td class="fielddoc"><p>Sound effect for error </p>
</td></tr>
<tr><td class="fieldname"><a id="af629aea8228f169d2ce1fdef5d0ec406ad41cea2f6b2365b3b15c8d2a910389fb" name="af629aea8228f169d2ce1fdef5d0ec406ad41cea2f6b2365b3b15c8d2a910389fb"></a>SFX_ENTER&#160;</td><td class="fielddoc"><p>Sound effect for entering a menu </p>
</td></tr>
<tr><td class="fieldname"><a id="af629aea8228f169d2ce1fdef5d0ec406a0cb778155e61d21f66c2fbd3e64f0e5e" name="af629aea8228f169d2ce1fdef5d0ec406a0cb778155e61d21f66c2fbd3e64f0e5e"></a>SFX_EXIT&#160;</td><td class="fielddoc"><p>Sound effect for exiting a menu </p>
</td></tr>
<tr><td class="fieldname"><a id="af629aea8228f169d2ce1fdef5d0ec406ac177735c7f8eb5599230c6849a60af8d" name="af629aea8228f169d2ce1fdef5d0ec406ac177735c7f8eb5599230c6849a60af8d"></a>SFX_SETTING&#160;</td><td class="fielddoc"><p>Sound effect for changing a setting </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a07821cfe30ceff25ea3ced58e082c338" name="a07821cfe30ceff25ea3ced58e082c338"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07821cfe30ceff25ea3ced58e082c338">&#9670;&#160;</a></span>sound_init_default()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sound_init_default </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the default sound system. </p>
<p>This function initializes the default sound system, setting up necessary resources and configurations. </p>
</div>
</div>
<a id="aab8b9e403b653c8c710e13b208a15079" name="aab8b9e403b653c8c710e13b208a15079"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab8b9e403b653c8c710e13b208a15079">&#9670;&#160;</a></span>sound_init_mp3_playback()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sound_init_mp3_playback </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the MP3 playback system. </p>
<p>This function initializes the MP3 playback system, preparing it for playing MP3 files. </p>
</div>
</div>
<a id="a0d1a8383f0881f72b4bf2dabbafd7b4e" name="a0d1a8383f0881f72b4bf2dabbafd7b4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0d1a8383f0881f72b4bf2dabbafd7b4e">&#9670;&#160;</a></span>sound_init_sfx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sound_init_sfx </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the sound effects system. </p>
<p>This function initializes the sound effects system, setting up necessary resources and configurations for playing sound effects. </p>
</div>
</div>
<a id="aee86d15559278545acf0e7dec7505249" name="aee86d15559278545acf0e7dec7505249"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee86d15559278545acf0e7dec7505249">&#9670;&#160;</a></span>sound_use_sfx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sound_use_sfx </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable or disable sound effects. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">enable</td><td>True to enable sound effects, false to disable. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0da25fd87321991846c52b383f6f13bc" name="a0da25fd87321991846c52b383f6f13bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0da25fd87321991846c52b383f6f13bc">&#9670;&#160;</a></span>sound_play_effect()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void sound_play_effect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sound_8h.html#af629aea8228f169d2ce1fdef5d0ec406">sound_effect_t</a>&#160;</td>
<td class="paramname"><em>sfx</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Play a specified sound effect. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sfx</td><td>The sound effect to play, as defined in sound_effect_t. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 25 2025 00:07:04 for N64FlashcartMenu by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink