2606 lines
479 KiB
HTML
2606 lines
479 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.6"/>
|
|
<title>PonyTracker: Fichier source de sources/fmod/include/fmod.h</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/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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 style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="vinyl.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">PonyTracker
|
|
</div>
|
|
<div id="projectbrief">Un projet de tracker de musique</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Généré par Doxygen 1.8.6 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Recherche');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Page principale</span></a></li>
|
|
<li><a href="annotated.html"><span>Structures de données</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Fichiers</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Recherche" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>Liste des fichiers</span></a></li>
|
|
<li><a href="globals.html"><span>Variables globale</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>Tout</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Structures de données</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Fichiers</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Fonctions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_08d237fc27d4ecd563f71c5d52f2fecc.html">sources</a></li><li class="navelem"><a class="el" href="dir_6c19ee39fd311a71af45ad229c43c5f0.html">fmod</a></li><li class="navelem"><a class="el" href="dir_3842d752ecd7b678829e19c90d796d7e.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">fmod.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*$ preserve start $*/</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> </div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">/* ============================================================================================ */</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">/* FMOD Ex - Main C/C++ header file. Copyright (c), Firelight Technologies Pty, Ltd. 2004-2014. */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">/* */</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/* This header is the base header for all other FMOD headers. If you are programming in C */</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/* use this exclusively, or if you are programming C++ use this in conjunction with FMOD.HPP */</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">/* */</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">/* ============================================================================================ */</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#ifndef _FMOD_H</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor"></span><span class="preprocessor">#define _FMOD_H</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> FMOD version number. Check this against FMOD::System::getVersion.</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> 0xaaaabbcc -> aaaa = major version number. bb = minor version number. cc = development version number.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define FMOD_VERSION 0x00044433</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> Compiler specific settings.</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#if defined(__CYGWIN32__)</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_CDECL __cdecl</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_STDCALL __stdcall</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DECLSPEC __declspec</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DLLEXPORT ( dllexport )</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span><span class="preprocessor">#elif defined(WIN32) || defined(_WIN32) || defined(__WIN32__) || defined(_WIN64)</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_CDECL _cdecl</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_STDCALL _stdcall</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DECLSPEC __declspec</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DLLEXPORT ( dllexport )</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor"></span><span class="preprocessor">#elif defined(__MACH__) || defined(__ANDROID__) || defined(__linux__) || defined(__QNX__)</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_CDECL</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_STDCALL</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DECLSPEC</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DLLEXPORT __attribute__ ((visibility("default")))</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_CDECL</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_STDCALL</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DECLSPEC</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_DLLEXPORT</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#ifdef DLL_EXPORTS</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor"></span><span class="preprocessor"> #if defined(__MACH__) || defined(__ANDROID__) || defined(__linux__) || defined(__QNX__)</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_API __attribute__ ((visibility("default")))</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor"></span><span class="preprocessor"> #else</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_API __declspec(dllexport) F_STDCALL</span></div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor"></span><span class="preprocessor"> #endif</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor"></span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor"></span><span class="preprocessor"> #define F_API F_STDCALL</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define F_CALLBACK F_STDCALL</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> FMOD types.</span></div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">typedef</span> <span class="keywordtype">int</span> FMOD_BOOL;</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_SYSTEM FMOD_SYSTEM;</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_SOUND FMOD_SOUND;</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_CHANNEL FMOD_CHANNEL;</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_CHANNELGROUP FMOD_CHANNELGROUP;</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_SOUNDGROUP FMOD_SOUNDGROUP;</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_REVERB FMOD_REVERB;</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_DSP FMOD_DSP;</div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_DSPCONNECTION FMOD_DSPCONNECTION;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_POLYGON FMOD_POLYGON;</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_GEOMETRY FMOD_GEOMETRY;</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>FMOD_SYNCPOINT FMOD_SYNCPOINT;</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FMOD_MODE;</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FMOD_TIMEUNIT;</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FMOD_INITFLAGS;</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FMOD_CAPS;</div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FMOD_DEBUGLEVEL;</div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keyword">typedef</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> FMOD_MEMORY_TYPE;</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment">/*$ fmod result start $*/</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> error codes. Returned from every function.</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> {</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  FMOD_OK, <span class="comment">/* No errors. */</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  FMOD_ERR_ALREADYLOCKED, <span class="comment">/* Tried to call lock a second time before unlock was called. */</span></div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  FMOD_ERR_BADCOMMAND, <span class="comment">/* Tried to call a function on a data type that does not allow this type of functionality (ie calling Sound::lock on a streaming sound). */</span></div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  FMOD_ERR_CDDA_DRIVERS, <span class="comment">/* Neither NTSCSI nor ASPI could be initialised. */</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  FMOD_ERR_CDDA_INIT, <span class="comment">/* An error occurred while initialising the CDDA subsystem. */</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  FMOD_ERR_CDDA_INVALID_DEVICE, <span class="comment">/* Couldn't find the specified device. */</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  FMOD_ERR_CDDA_NOAUDIO, <span class="comment">/* No audio tracks on the specified disc. */</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  FMOD_ERR_CDDA_NODEVICES, <span class="comment">/* No CD/DVD devices were found. */</span> </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  FMOD_ERR_CDDA_NODISC, <span class="comment">/* No disc present in the specified drive. */</span></div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  FMOD_ERR_CDDA_READ, <span class="comment">/* A CDDA read error occurred. */</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  FMOD_ERR_CHANNEL_ALLOC, <span class="comment">/* Error trying to allocate a channel. */</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  FMOD_ERR_CHANNEL_STOLEN, <span class="comment">/* The specified channel has been reused to play another sound. */</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  FMOD_ERR_COM, <span class="comment">/* A Win32 COM related error occured. COM failed to initialize or a QueryInterface failed meaning a Windows codec or driver was not installed properly. */</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  FMOD_ERR_DMA, <span class="comment">/* DMA Failure. See debug output for more information. */</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  FMOD_ERR_DSP_CONNECTION, <span class="comment">/* DSP connection error. Connection possibly caused a cyclic dependancy. Or tried to connect a tree too many units deep (more than 128). */</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  FMOD_ERR_DSP_FORMAT, <span class="comment">/* DSP Format error. A DSP unit may have attempted to connect to this network with the wrong format. */</span></div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  FMOD_ERR_DSP_NOTFOUND, <span class="comment">/* DSP connection error. Couldn't find the DSP unit specified. */</span></div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  FMOD_ERR_DSP_RUNNING, <span class="comment">/* DSP error. Cannot perform this operation while the network is in the middle of running. This will most likely happen if a connection or disconnection is attempted in a DSP callback. */</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>  FMOD_ERR_DSP_TOOMANYCONNECTIONS,<span class="comment">/* DSP connection error. The unit being connected to or disconnected should only have 1 input or output. */</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  FMOD_ERR_FILE_BAD, <span class="comment">/* Error loading file. */</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  FMOD_ERR_FILE_COULDNOTSEEK, <span class="comment">/* Couldn't perform seek operation. This is a limitation of the medium (ie netstreams) or the file format. */</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  FMOD_ERR_FILE_DISKEJECTED, <span class="comment">/* Media was ejected while reading. */</span></div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  FMOD_ERR_FILE_EOF, <span class="comment">/* End of file unexpectedly reached while trying to read essential data (truncated data?). */</span></div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  FMOD_ERR_FILE_NOTFOUND, <span class="comment">/* File not found. */</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  FMOD_ERR_FILE_UNWANTED, <span class="comment">/* Unwanted file access occured. */</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  FMOD_ERR_FORMAT, <span class="comment">/* Unsupported file or audio format. */</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  FMOD_ERR_HTTP, <span class="comment">/* A HTTP error occurred. This is a catch-all for HTTP errors not listed elsewhere. */</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  FMOD_ERR_HTTP_ACCESS, <span class="comment">/* The specified resource requires authentication or is forbidden. */</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  FMOD_ERR_HTTP_PROXY_AUTH, <span class="comment">/* Proxy authentication is required to access the specified resource. */</span></div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  FMOD_ERR_HTTP_SERVER_ERROR, <span class="comment">/* A HTTP server error occurred. */</span></div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  FMOD_ERR_HTTP_TIMEOUT, <span class="comment">/* The HTTP request timed out. */</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  FMOD_ERR_INITIALIZATION, <span class="comment">/* FMOD was not initialized correctly to support this function. */</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  FMOD_ERR_INITIALIZED, <span class="comment">/* Cannot call this command after System::init. */</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  FMOD_ERR_INTERNAL, <span class="comment">/* An error occured that wasn't supposed to. Contact support. */</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  FMOD_ERR_INVALID_ADDRESS, <span class="comment">/* On Xbox 360, this memory address passed to FMOD must be physical, (ie allocated with XPhysicalAlloc.) */</span></div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  FMOD_ERR_INVALID_FLOAT, <span class="comment">/* Value passed in was a NaN, Inf or denormalized float. */</span></div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  FMOD_ERR_INVALID_HANDLE, <span class="comment">/* An invalid object handle was used. */</span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  FMOD_ERR_INVALID_PARAM, <span class="comment">/* An invalid parameter was passed to this function. */</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  FMOD_ERR_INVALID_POSITION, <span class="comment">/* An invalid seek position was passed to this function. */</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  FMOD_ERR_INVALID_SPEAKER, <span class="comment">/* An invalid speaker was passed to this function based on the current speaker mode. */</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>  FMOD_ERR_INVALID_SYNCPOINT, <span class="comment">/* The syncpoint did not come from this sound handle. */</span></div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  FMOD_ERR_INVALID_VECTOR, <span class="comment">/* The vectors passed in are not unit length, or perpendicular. */</span></div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>  FMOD_ERR_MAXAUDIBLE, <span class="comment">/* Reached maximum audible playback count for this sound's soundgroup. */</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  FMOD_ERR_MEMORY, <span class="comment">/* Not enough memory or resources. */</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  FMOD_ERR_MEMORY_CANTPOINT, <span class="comment">/* Can't use FMOD_OPENMEMORY_POINT on non PCM source data, or non mp3/xma/adpcm data if FMOD_CREATECOMPRESSEDSAMPLE was used. */</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  FMOD_ERR_MEMORY_SRAM, <span class="comment">/* Not enough memory or resources on console sound ram. */</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  FMOD_ERR_NEEDS2D, <span class="comment">/* Tried to call a command on a 3d sound when the command was meant for 2d sound. */</span></div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  FMOD_ERR_NEEDS3D, <span class="comment">/* Tried to call a command on a 2d sound when the command was meant for 3d sound. */</span></div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  FMOD_ERR_NEEDSHARDWARE, <span class="comment">/* Tried to use a feature that requires hardware support. (ie trying to play a GCADPCM compressed sound in software on Wii). */</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  FMOD_ERR_NEEDSSOFTWARE, <span class="comment">/* Tried to use a feature that requires the software engine. Software engine has either been turned off, or command was executed on a hardware channel which does not support this feature. */</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  FMOD_ERR_NET_CONNECT, <span class="comment">/* Couldn't connect to the specified host. */</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  FMOD_ERR_NET_SOCKET_ERROR, <span class="comment">/* A socket error occurred. This is a catch-all for socket-related errors not listed elsewhere. */</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  FMOD_ERR_NET_URL, <span class="comment">/* The specified URL couldn't be resolved. */</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  FMOD_ERR_NET_WOULD_BLOCK, <span class="comment">/* Operation on a non-blocking socket could not complete immediately. */</span></div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  FMOD_ERR_NOTREADY, <span class="comment">/* Operation could not be performed because specified sound/DSP connection is not ready. */</span></div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  FMOD_ERR_OUTPUT_ALLOCATED, <span class="comment">/* Error initializing output device, but more specifically, the output device is already in use and cannot be reused. */</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  FMOD_ERR_OUTPUT_CREATEBUFFER, <span class="comment">/* Error creating hardware sound buffer. */</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  FMOD_ERR_OUTPUT_DRIVERCALL, <span class="comment">/* A call to a standard soundcard driver failed, which could possibly mean a bug in the driver or resources were missing or exhausted. */</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  FMOD_ERR_OUTPUT_ENUMERATION, <span class="comment">/* Error enumerating the available driver list. List may be inconsistent due to a recent device addition or removal. */</span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  FMOD_ERR_OUTPUT_FORMAT, <span class="comment">/* Soundcard does not support the minimum features needed for this soundsystem (16bit stereo output). */</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  FMOD_ERR_OUTPUT_INIT, <span class="comment">/* Error initializing output device. */</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  FMOD_ERR_OUTPUT_NOHARDWARE, <span class="comment">/* FMOD_HARDWARE was specified but the sound card does not have the resources necessary to play it. */</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  FMOD_ERR_OUTPUT_NOSOFTWARE, <span class="comment">/* Attempted to create a software sound but no software channels were specified in System::init. */</span></div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  FMOD_ERR_PAN, <span class="comment">/* Panning only works with mono or stereo sound sources. */</span></div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  FMOD_ERR_PLUGIN, <span class="comment">/* An unspecified error has been returned from a 3rd party plugin. */</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  FMOD_ERR_PLUGIN_INSTANCES, <span class="comment">/* The number of allowed instances of a plugin has been exceeded. */</span></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  FMOD_ERR_PLUGIN_MISSING, <span class="comment">/* A requested output, dsp unit type or codec was not available. */</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  FMOD_ERR_PLUGIN_RESOURCE, <span class="comment">/* A resource that the plugin requires cannot be found. (ie the DLS file for MIDI playback or other DLLs that it needs to load) */</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  FMOD_ERR_PRELOADED, <span class="comment">/* The specified sound is still in use by the event system, call EventSystem::unloadFSB before trying to release it. */</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span>  FMOD_ERR_PROGRAMMERSOUND, <span class="comment">/* The specified sound is still in use by the event system, wait for the event which is using it finish with it. */</span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  FMOD_ERR_RECORD, <span class="comment">/* An error occured trying to initialize the recording device. */</span></div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  FMOD_ERR_REVERB_INSTANCE, <span class="comment">/* Specified instance in FMOD_REVERB_PROPERTIES couldn't be set. Most likely because it is an invalid instance number or the reverb doesnt exist. */</span></div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  FMOD_ERR_SUBSOUND_ALLOCATED, <span class="comment">/* This subsound is already being used by another sound, you cannot have more than one parent to a sound. Null out the other parent's entry first. */</span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>  FMOD_ERR_SUBSOUND_CANTMOVE, <span class="comment">/* Shared subsounds cannot be replaced or moved from their parent stream, such as when the parent stream is an FSB file. */</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  FMOD_ERR_SUBSOUND_MODE, <span class="comment">/* The subsound's mode bits do not match with the parent sound's mode bits. See documentation for function that it was called with. */</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>  FMOD_ERR_SUBSOUNDS, <span class="comment">/* The error occured because the sound referenced contains subsounds when it shouldn't have, or it doesn't contain subsounds when it should have. The operation may also not be able to be performed on a parent sound, or a parent sound was played without setting up a sentence first. */</span></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  FMOD_ERR_TAGNOTFOUND, <span class="comment">/* The specified tag could not be found or there are no tags. */</span></div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  FMOD_ERR_TOOMANYCHANNELS, <span class="comment">/* The sound created exceeds the allowable input channel count. This can be increased using the maxinputchannels parameter in System::setSoftwareFormat. */</span></div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  FMOD_ERR_UNIMPLEMENTED, <span class="comment">/* Something in FMOD hasn't been implemented when it should be! contact support! */</span></div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  FMOD_ERR_UNINITIALIZED, <span class="comment">/* This command failed because System::init or System::setDriver was not called. */</span></div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  FMOD_ERR_UNSUPPORTED, <span class="comment">/* A command issued was not supported by this object. Possibly a plugin without certain callbacks specified. */</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  FMOD_ERR_UPDATE, <span class="comment">/* An error caused by System::update occured. */</span></div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  FMOD_ERR_VERSION, <span class="comment">/* The version number of this file format is not supported. */</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>  FMOD_ERR_EVENT_FAILED, <span class="comment">/* An Event failed to be retrieved, most likely due to 'just fail' being specified as the max playbacks behavior. */</span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  FMOD_ERR_EVENT_INFOONLY, <span class="comment">/* Can't execute this command on an EVENT_INFOONLY event. */</span></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>  FMOD_ERR_EVENT_INTERNAL, <span class="comment">/* An error occured that wasn't supposed to. See debug log for reason. */</span></div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  FMOD_ERR_EVENT_MAXSTREAMS, <span class="comment">/* Event failed because 'Max streams' was hit when FMOD_EVENT_INIT_FAIL_ON_MAXSTREAMS was specified. */</span></div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  FMOD_ERR_EVENT_MISMATCH, <span class="comment">/* FSB mismatches the FEV it was compiled with, the stream/sample mode it was meant to be created with was different, or the FEV was built for a different platform. */</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  FMOD_ERR_EVENT_NAMECONFLICT, <span class="comment">/* A category with the same name already exists. */</span></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  FMOD_ERR_EVENT_NOTFOUND, <span class="comment">/* The requested event, event group, event category or event property could not be found. */</span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  FMOD_ERR_EVENT_NEEDSSIMPLE, <span class="comment">/* Tried to call a function on a complex event that's only supported by simple events. */</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>  FMOD_ERR_EVENT_GUIDCONFLICT, <span class="comment">/* An event with the same GUID already exists. */</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  FMOD_ERR_EVENT_ALREADY_LOADED, <span class="comment">/* The specified project or bank has already been loaded. Having multiple copies of the same project loaded simultaneously is forbidden. */</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span> </div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  FMOD_ERR_MUSIC_UNINITIALIZED, <span class="comment">/* Music system is not initialized probably because no music data is loaded. */</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  FMOD_ERR_MUSIC_NOTFOUND, <span class="comment">/* The requested music entity could not be found. */</span></div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  FMOD_ERR_MUSIC_NOCALLBACK, <span class="comment">/* The music callback is required, but it has not been set. */</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  FMOD_RESULT_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> } FMOD_RESULT;</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span> <span class="comment">/*$ fmod result end $*/</span></div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> </div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> </div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"> Structure describing a point in 3D space.</span></div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> FMOD uses a left handed co-ordinate system by default.<br></span></div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> To use a right handed co-ordinate system specify FMOD_INIT_3D_RIGHTHANDED from FMOD_INITFLAGS in System::init.</span></div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> System::set3DListenerAttributes</span></div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> System::get3DListenerAttributes</span></div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> Channel::set3DAttributes</span></div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> Channel::get3DAttributes</span></div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> Channel::set3DCustomRolloff</span></div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"> Channel::get3DCustomRolloff</span></div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> Sound::set3DCustomRolloff</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> Sound::get3DCustomRolloff</span></div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> Geometry::addPolygon</span></div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> Geometry::setPolygonVertex</span></div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span> <span class="comment"> Geometry::getPolygonVertex</span></div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> Geometry::setRotation</span></div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> Geometry::getRotation</span></div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> Geometry::setPosition</span></div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> Geometry::getPosition</span></div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> Geometry::setScale</span></div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> Geometry::getScale</span></div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> FMOD_INITFLAGS</span></div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___v_e_c_t_o_r.html"> 237</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> {</div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span>  <span class="keywordtype">float</span> x; <span class="comment">/* X co-ordinate in 3D space. */</span></div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span>  <span class="keywordtype">float</span> y; <span class="comment">/* Y co-ordinate in 3D space. */</span></div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span>  <span class="keywordtype">float</span> z; <span class="comment">/* Z co-ordinate in 3D space. */</span></div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> } <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a>;</div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> </div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"> 247</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"> Structure describing a globally unique identifier.</span></div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"> 254</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment"> System::getDriverInfo</span></div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___g_u_i_d.html"> 259</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> {</div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"> 261</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Data1; <span class="comment">/* Specifies the first 8 hexadecimal digits of the GUID */</span></div>
|
|
<div class="line"><a name="l00262"></a><span class="lineno"> 262</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Data2; <span class="comment">/* Specifies the first group of 4 hexadecimal digits. */</span></div>
|
|
<div class="line"><a name="l00263"></a><span class="lineno"> 263</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> Data3; <span class="comment">/* Specifies the second group of 4 hexadecimal digits. */</span></div>
|
|
<div class="line"><a name="l00264"></a><span class="lineno"> 264</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Data4[8]; <span class="comment">/* Array of 8 bytes. The first 2 bytes contain the third group of 4 hexadecimal digits. The remaining 6 bytes contain the final 12 hexadecimal digits. */</span></div>
|
|
<div class="line"><a name="l00265"></a><span class="lineno"> 265</span> } <a class="code" href="struct_f_m_o_d___g_u_i_d.html">FMOD_GUID</a>;</div>
|
|
<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> </div>
|
|
<div class="line"><a name="l00267"></a><span class="lineno"> 267</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00268"></a><span class="lineno"> 268</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00270"></a><span class="lineno"> 270</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l00271"></a><span class="lineno"> 271</span> <span class="comment"> Structure that is passed into FMOD_FILE_ASYNCREADCALLBACK. Use the information in this structure to perform</span></div>
|
|
<div class="line"><a name="l00272"></a><span class="lineno"> 272</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00273"></a><span class="lineno"> 273</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00274"></a><span class="lineno"> 274</span> <span class="comment"> Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br></span></div>
|
|
<div class="line"><a name="l00275"></a><span class="lineno"> 275</span> <span class="comment"> Members marked with [w] mean the variable can be written to. The user can set the value.<br></span></div>
|
|
<div class="line"><a name="l00276"></a><span class="lineno"> 276</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00277"></a><span class="lineno"> 277</span> <span class="comment"> Instructions: write to 'buffer', and 'bytesread' <b>BEFORE</b> setting 'result'.<br> </span></div>
|
|
<div class="line"><a name="l00278"></a><span class="lineno"> 278</span> <span class="comment"> As soon as result is set, FMOD will asynchronously continue internally using the data provided in this structure.<br></span></div>
|
|
<div class="line"><a name="l00279"></a><span class="lineno"> 279</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00280"></a><span class="lineno"> 280</span> <span class="comment"> Set 'result' to the result expected from a normal file read callback.<br></span></div>
|
|
<div class="line"><a name="l00281"></a><span class="lineno"> 281</span> <span class="comment"> If the read was successful, set it to FMOD_OK.<br></span></div>
|
|
<div class="line"><a name="l00282"></a><span class="lineno"> 282</span> <span class="comment"> If it read some data but hit the end of the file, set it to FMOD_ERR_FILE_EOF.<br></span></div>
|
|
<div class="line"><a name="l00283"></a><span class="lineno"> 283</span> <span class="comment"> If a bad error occurred, return FMOD_ERR_FILE_BAD<br></span></div>
|
|
<div class="line"><a name="l00284"></a><span class="lineno"> 284</span> <span class="comment"> If a disk was ejected, return FMOD_ERR_FILE_DISKEJECTED.<br></span></div>
|
|
<div class="line"><a name="l00285"></a><span class="lineno"> 285</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00286"></a><span class="lineno"> 286</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00287"></a><span class="lineno"> 287</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00288"></a><span class="lineno"> 288</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00289"></a><span class="lineno"> 289</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00290"></a><span class="lineno"> 290</span> <span class="comment"> FMOD_FILE_ASYNCREADCALLBACK</span></div>
|
|
<div class="line"><a name="l00291"></a><span class="lineno"> 291</span> <span class="comment"> FMOD_FILE_ASYNCCANCELCALLBACK</span></div>
|
|
<div class="line"><a name="l00292"></a><span class="lineno"> 292</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00293"></a><span class="lineno"> 293</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00294"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___a_s_y_n_c_r_e_a_d_i_n_f_o.html"> 294</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00295"></a><span class="lineno"> 295</span> {</div>
|
|
<div class="line"><a name="l00296"></a><span class="lineno"> 296</span>  <span class="keywordtype">void</span> *handle; <span class="comment">/* [r] The file handle that was filled out in the open callback. */</span></div>
|
|
<div class="line"><a name="l00297"></a><span class="lineno"> 297</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> offset; <span class="comment">/* [r] Seek position, make sure you read from this file offset. */</span></div>
|
|
<div class="line"><a name="l00298"></a><span class="lineno"> 298</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sizebytes; <span class="comment">/* [r] how many bytes requested for read. */</span></div>
|
|
<div class="line"><a name="l00299"></a><span class="lineno"> 299</span>  <span class="keywordtype">int</span> priority; <span class="comment">/* [r] 0 = low importance. 100 = extremely important (ie 'must read now or stuttering may occur') */</span></div>
|
|
<div class="line"><a name="l00300"></a><span class="lineno"> 300</span> </div>
|
|
<div class="line"><a name="l00301"></a><span class="lineno"> 301</span>  <span class="keywordtype">void</span> *buffer; <span class="comment">/* [w] Buffer to read file data into. */</span></div>
|
|
<div class="line"><a name="l00302"></a><span class="lineno"> 302</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bytesread; <span class="comment">/* [w] Fill this in before setting result code to tell FMOD how many bytes were read. */</span></div>
|
|
<div class="line"><a name="l00303"></a><span class="lineno"> 303</span>  FMOD_RESULT result; <span class="comment">/* [r/w] Result code, FMOD_OK tells the system it is ready to consume the data. Set this last! Default value = FMOD_ERR_NOTREADY. */</span></div>
|
|
<div class="line"><a name="l00304"></a><span class="lineno"> 304</span> </div>
|
|
<div class="line"><a name="l00305"></a><span class="lineno"> 305</span>  <span class="keywordtype">void</span> *userdata; <span class="comment">/* [r] User data pointer. */</span></div>
|
|
<div class="line"><a name="l00306"></a><span class="lineno"> 306</span> } <a class="code" href="struct_f_m_o_d___a_s_y_n_c_r_e_a_d_i_n_f_o.html">FMOD_ASYNCREADINFO</a>;</div>
|
|
<div class="line"><a name="l00307"></a><span class="lineno"> 307</span> </div>
|
|
<div class="line"><a name="l00308"></a><span class="lineno"> 308</span> </div>
|
|
<div class="line"><a name="l00309"></a><span class="lineno"> 309</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00310"></a><span class="lineno"> 310</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00311"></a><span class="lineno"> 311</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00312"></a><span class="lineno"> 312</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00313"></a><span class="lineno"> 313</span> <span class="comment"> These output types are used with System::setOutput / System::getOutput, to choose which output method to use.</span></div>
|
|
<div class="line"><a name="l00314"></a><span class="lineno"> 314</span> <span class="comment"> </span></div>
|
|
<div class="line"><a name="l00315"></a><span class="lineno"> 315</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00316"></a><span class="lineno"> 316</span> <span class="comment"> To pass information to the driver when initializing fmod use the extradriverdata parameter in System::init for the following reasons.<br></span></div>
|
|
<div class="line"><a name="l00317"></a><span class="lineno"> 317</span> <span class="comment"> <li>FMOD_OUTPUTTYPE_WAVWRITER - extradriverdata is a pointer to a char * filename that the wav writer will output to.</span></div>
|
|
<div class="line"><a name="l00318"></a><span class="lineno"> 318</span> <span class="comment"> <li>FMOD_OUTPUTTYPE_WAVWRITER_NRT - extradriverdata is a pointer to a char * filename that the wav writer will output to.</span></div>
|
|
<div class="line"><a name="l00319"></a><span class="lineno"> 319</span> <span class="comment"> <li>FMOD_OUTPUTTYPE_DSOUND - extradriverdata is a pointer to a HWND so that FMOD can set the focus on the audio for a particular window.</span></div>
|
|
<div class="line"><a name="l00320"></a><span class="lineno"> 320</span> <span class="comment"> <li>FMOD_OUTPUTTYPE_PS3 - extradriverdata is a pointer to a FMOD_PS3_EXTRADRIVERDATA struct. This can be found in fmodps3.h.</span></div>
|
|
<div class="line"><a name="l00321"></a><span class="lineno"> 321</span> <span class="comment"> <li>FMOD_OUTPUTTYPE_GC - extradriverdata is a pointer to a FMOD_GC_INFO struct. This can be found in fmodgc.h.</span></div>
|
|
<div class="line"><a name="l00322"></a><span class="lineno"> 322</span> <span class="comment"> <li>FMOD_OUTPUTTYPE_WII - extradriverdata is a pointer to a FMOD_WII_INFO struct. This can be found in fmodwii.h.</span></div>
|
|
<div class="line"><a name="l00323"></a><span class="lineno"> 323</span> <span class="comment"> <li>FMOD_OUTPUTTYPE_ALSA - extradriverdata is a pointer to a FMOD_LINUX_EXTRADRIVERDATA struct. This can be found in fmodlinux.h.<br></span></div>
|
|
<div class="line"><a name="l00324"></a><span class="lineno"> 324</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00325"></a><span class="lineno"> 325</span> <span class="comment"> Currently these are the only FMOD drivers that take extra information. Other unknown plugins may have different requirements.</span></div>
|
|
<div class="line"><a name="l00326"></a><span class="lineno"> 326</span> <span class="comment"> <br><br></span></div>
|
|
<div class="line"><a name="l00327"></a><span class="lineno"> 327</span> <span class="comment"> Note! If FMOD_OUTPUTTYPE_WAVWRITER_NRT or FMOD_OUTPUTTYPE_NOSOUND_NRT are used, and if the System::update function is being called</span></div>
|
|
<div class="line"><a name="l00328"></a><span class="lineno"> 328</span> <span class="comment"> very quickly (ie for a non realtime decode) it may be being called too quickly for the FMOD streamer thread to respond to. </span></div>
|
|
<div class="line"><a name="l00329"></a><span class="lineno"> 329</span> <span class="comment"> The result will be a skipping/stuttering output in the captured audio.<br></span></div>
|
|
<div class="line"><a name="l00330"></a><span class="lineno"> 330</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00331"></a><span class="lineno"> 331</span> <span class="comment"> To remedy this, disable the FMOD Ex streamer thread, and use FMOD_INIT_STREAM_FROM_UPDATE to avoid skipping in the output stream,</span></div>
|
|
<div class="line"><a name="l00332"></a><span class="lineno"> 332</span> <span class="comment"> as it will lock the mixer and the streamer together in the same thread.</span></div>
|
|
<div class="line"><a name="l00333"></a><span class="lineno"> 333</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00334"></a><span class="lineno"> 334</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00335"></a><span class="lineno"> 335</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00336"></a><span class="lineno"> 336</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00337"></a><span class="lineno"> 337</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l00338"></a><span class="lineno"> 338</span> <span class="comment"> System::setOutput</span></div>
|
|
<div class="line"><a name="l00339"></a><span class="lineno"> 339</span> <span class="comment"> System::getOutput</span></div>
|
|
<div class="line"><a name="l00340"></a><span class="lineno"> 340</span> <span class="comment"> System::setSoftwareFormat</span></div>
|
|
<div class="line"><a name="l00341"></a><span class="lineno"> 341</span> <span class="comment"> System::getSoftwareFormat</span></div>
|
|
<div class="line"><a name="l00342"></a><span class="lineno"> 342</span> <span class="comment"> System::init</span></div>
|
|
<div class="line"><a name="l00343"></a><span class="lineno"> 343</span> <span class="comment"> System::update</span></div>
|
|
<div class="line"><a name="l00344"></a><span class="lineno"> 344</span> <span class="comment"> FMOD_INITFLAGS</span></div>
|
|
<div class="line"><a name="l00345"></a><span class="lineno"> 345</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00346"></a><span class="lineno"> 346</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00347"></a><span class="lineno"> 347</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00348"></a><span class="lineno"> 348</span> {</div>
|
|
<div class="line"><a name="l00349"></a><span class="lineno"> 349</span>  FMOD_OUTPUTTYPE_AUTODETECT, <span class="comment">/* Picks the best output mode for the platform. This is the default. */</span></div>
|
|
<div class="line"><a name="l00350"></a><span class="lineno"> 350</span>  </div>
|
|
<div class="line"><a name="l00351"></a><span class="lineno"> 351</span>  FMOD_OUTPUTTYPE_UNKNOWN, <span class="comment">/* All - 3rd party plugin, unknown. This is for use with System::getOutput only. */</span></div>
|
|
<div class="line"><a name="l00352"></a><span class="lineno"> 352</span>  FMOD_OUTPUTTYPE_NOSOUND, <span class="comment">/* All - All calls in this mode succeed but make no sound. */</span></div>
|
|
<div class="line"><a name="l00353"></a><span class="lineno"> 353</span>  FMOD_OUTPUTTYPE_WAVWRITER, <span class="comment">/* All - Writes output to fmodoutput.wav by default. Use the 'extradriverdata' parameter in System::init, by simply passing the filename as a string, to set the wav filename. */</span></div>
|
|
<div class="line"><a name="l00354"></a><span class="lineno"> 354</span>  FMOD_OUTPUTTYPE_NOSOUND_NRT, <span class="comment">/* All - Non-realtime version of FMOD_OUTPUTTYPE_NOSOUND. User can drive mixer with System::update at whatever rate they want. */</span></div>
|
|
<div class="line"><a name="l00355"></a><span class="lineno"> 355</span>  FMOD_OUTPUTTYPE_WAVWRITER_NRT, <span class="comment">/* All - Non-realtime version of FMOD_OUTPUTTYPE_WAVWRITER. User can drive mixer with System::update at whatever rate they want. */</span></div>
|
|
<div class="line"><a name="l00356"></a><span class="lineno"> 356</span>  </div>
|
|
<div class="line"><a name="l00357"></a><span class="lineno"> 357</span>  FMOD_OUTPUTTYPE_DSOUND, <span class="comment">/* Win32/Win64 - DirectSound output. (Default on Windows XP and below) */</span></div>
|
|
<div class="line"><a name="l00358"></a><span class="lineno"> 358</span>  FMOD_OUTPUTTYPE_WINMM, <span class="comment">/* Win32/Win64 - Windows Multimedia output. */</span></div>
|
|
<div class="line"><a name="l00359"></a><span class="lineno"> 359</span>  FMOD_OUTPUTTYPE_WASAPI, <span class="comment">/* Win32 - Windows Audio Session API. (Default on Windows Vista and above) */</span></div>
|
|
<div class="line"><a name="l00360"></a><span class="lineno"> 360</span>  FMOD_OUTPUTTYPE_ASIO, <span class="comment">/* Win32 - Low latency ASIO 2.0 driver. */</span></div>
|
|
<div class="line"><a name="l00361"></a><span class="lineno"> 361</span>  FMOD_OUTPUTTYPE_OSS, <span class="comment">/* Linux/Linux64 - Open Sound System output. (Default on Linux, third preference) */</span></div>
|
|
<div class="line"><a name="l00362"></a><span class="lineno"> 362</span>  FMOD_OUTPUTTYPE_ALSA, <span class="comment">/* Linux/Linux64 - Advanced Linux Sound Architecture output. (Default on Linux, second preference if available) */</span></div>
|
|
<div class="line"><a name="l00363"></a><span class="lineno"> 363</span>  FMOD_OUTPUTTYPE_ESD, <span class="comment">/* Linux/Linux64 - Enlightment Sound Daemon output. */</span></div>
|
|
<div class="line"><a name="l00364"></a><span class="lineno"> 364</span>  FMOD_OUTPUTTYPE_PULSEAUDIO, <span class="comment">/* Linux/Linux64 - PulseAudio output. (Default on Linux, first preference if available) */</span></div>
|
|
<div class="line"><a name="l00365"></a><span class="lineno"> 365</span>  FMOD_OUTPUTTYPE_COREAUDIO, <span class="comment">/* Mac - Macintosh CoreAudio output. (Default on Mac) */</span></div>
|
|
<div class="line"><a name="l00366"></a><span class="lineno"> 366</span>  FMOD_OUTPUTTYPE_XBOX360, <span class="comment">/* Xbox 360 - Native Xbox360 output. (Default on Xbox 360) */</span></div>
|
|
<div class="line"><a name="l00367"></a><span class="lineno"> 367</span>  FMOD_OUTPUTTYPE_PSP, <span class="comment">/* PSP - Native PSP output. (Default on PSP) */</span></div>
|
|
<div class="line"><a name="l00368"></a><span class="lineno"> 368</span>  FMOD_OUTPUTTYPE_PS3, <span class="comment">/* PS3 - Native PS3 output. (Default on PS3) */</span></div>
|
|
<div class="line"><a name="l00369"></a><span class="lineno"> 369</span>  FMOD_OUTPUTTYPE_NGP, <span class="comment">/* NGP - Native NGP output. (Default on NGP) */</span></div>
|
|
<div class="line"><a name="l00370"></a><span class="lineno"> 370</span>  FMOD_OUTPUTTYPE_WII, <span class="comment">/* Wii - Native Wii output. (Default on Wii) */</span></div>
|
|
<div class="line"><a name="l00371"></a><span class="lineno"> 371</span>  FMOD_OUTPUTTYPE_3DS, <span class="comment">/* 3DS - Native 3DS output (Default on 3DS) */</span></div>
|
|
<div class="line"><a name="l00372"></a><span class="lineno"> 372</span>  FMOD_OUTPUTTYPE_AUDIOTRACK, <span class="comment">/* Android - Java Audio Track output. (Default on Android 2.2 and below) */</span></div>
|
|
<div class="line"><a name="l00373"></a><span class="lineno"> 373</span>  FMOD_OUTPUTTYPE_OPENSL, <span class="comment">/* Android - OpenSL ES output. (Default on Android 2.3 and above) */</span> </div>
|
|
<div class="line"><a name="l00374"></a><span class="lineno"> 374</span>  FMOD_OUTPUTTYPE_NACL, <span class="comment">/* Native Client - Native Client output. (Default on Native Client) */</span></div>
|
|
<div class="line"><a name="l00375"></a><span class="lineno"> 375</span>  FMOD_OUTPUTTYPE_WIIU, <span class="comment">/* Wii U - Native Wii U output. (Default on Wii U) */</span></div>
|
|
<div class="line"><a name="l00376"></a><span class="lineno"> 376</span>  FMOD_OUTPUTTYPE_ASOUND, <span class="comment">/* BlackBerry - Native BlackBerry asound output. (Default on BlackBerry) */</span></div>
|
|
<div class="line"><a name="l00377"></a><span class="lineno"> 377</span>  FMOD_OUTPUTTYPE_AUDIOOUT, <span class="comment">/* Orbis - Audio Out output. (Default on Orbis) */</span></div>
|
|
<div class="line"><a name="l00378"></a><span class="lineno"> 378</span>  FMOD_OUTPUTTYPE_XAUDIO, <span class="comment">/* Durango - XAudio2 output. */</span></div>
|
|
<div class="line"><a name="l00379"></a><span class="lineno"> 379</span> </div>
|
|
<div class="line"><a name="l00380"></a><span class="lineno"> 380</span>  FMOD_OUTPUTTYPE_MAX, <span class="comment">/* Maximum number of output types supported. */</span></div>
|
|
<div class="line"><a name="l00381"></a><span class="lineno"> 381</span>  FMOD_OUTPUTTYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00382"></a><span class="lineno"> 382</span> } FMOD_OUTPUTTYPE;</div>
|
|
<div class="line"><a name="l00383"></a><span class="lineno"> 383</span> </div>
|
|
<div class="line"><a name="l00384"></a><span class="lineno"> 384</span> </div>
|
|
<div class="line"><a name="l00385"></a><span class="lineno"> 385</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00386"></a><span class="lineno"> 386</span> <span class="comment">[DEFINE] </span></div>
|
|
<div class="line"><a name="l00387"></a><span class="lineno"> 387</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00388"></a><span class="lineno"> 388</span> <span class="comment"> [NAME]</span></div>
|
|
<div class="line"><a name="l00389"></a><span class="lineno"> 389</span> <span class="comment"> FMOD_CAPS</span></div>
|
|
<div class="line"><a name="l00390"></a><span class="lineno"> 390</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00391"></a><span class="lineno"> 391</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00392"></a><span class="lineno"> 392</span> <span class="comment"> Bit fields to use with System::getDriverCaps to determine the capabilities of a card / output device.</span></div>
|
|
<div class="line"><a name="l00393"></a><span class="lineno"> 393</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00394"></a><span class="lineno"> 394</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00395"></a><span class="lineno"> 395</span> <span class="comment"> It is important to check FMOD_CAPS_HARDWARE_EMULATED on windows machines, to then adjust System::setDSPBufferSize to (1024, 10) to compensate for the higher latency.</span></div>
|
|
<div class="line"><a name="l00396"></a><span class="lineno"> 396</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00397"></a><span class="lineno"> 397</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00398"></a><span class="lineno"> 398</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00399"></a><span class="lineno"> 399</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00400"></a><span class="lineno"> 400</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00401"></a><span class="lineno"> 401</span> <span class="comment"> System::getDriverCaps</span></div>
|
|
<div class="line"><a name="l00402"></a><span class="lineno"> 402</span> <span class="comment"> System::setDSPBufferSize</span></div>
|
|
<div class="line"><a name="l00403"></a><span class="lineno"> 403</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00404"></a><span class="lineno"> 404</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00405"></a><span class="lineno"> 405</span> <span class="preprocessor">#define FMOD_CAPS_NONE 0x00000000 </span><span class="comment">/* Device has no special capabilities. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00406"></a><span class="lineno"> 406</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_HARDWARE 0x00000001 </span><span class="comment">/* Device supports hardware mixing. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00407"></a><span class="lineno"> 407</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_HARDWARE_EMULATED 0x00000002 </span><span class="comment">/* User has device set to 'Hardware acceleration = off' in control panel, and now extra 200ms latency is incurred. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00408"></a><span class="lineno"> 408</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_OUTPUT_MULTICHANNEL 0x00000004 </span><span class="comment">/* Device can do multichannel output, ie greater than 2 channels. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00409"></a><span class="lineno"> 409</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_OUTPUT_FORMAT_PCM8 0x00000008 </span><span class="comment">/* Device can output to 8bit integer PCM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00410"></a><span class="lineno"> 410</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_OUTPUT_FORMAT_PCM16 0x00000010 </span><span class="comment">/* Device can output to 16bit integer PCM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_OUTPUT_FORMAT_PCM24 0x00000020 </span><span class="comment">/* Device can output to 24bit integer PCM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_OUTPUT_FORMAT_PCM32 0x00000040 </span><span class="comment">/* Device can output to 32bit integer PCM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_OUTPUT_FORMAT_PCMFLOAT 0x00000080 </span><span class="comment">/* Device can output to 32bit floating point PCM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_REVERB_LIMITED 0x00002000 </span><span class="comment">/* Device supports some form of limited hardware reverb, maybe parameterless and only selectable by environment. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CAPS_LOOPBACK 0x00004000 </span><span class="comment">/* Device is a loopback recording device */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> </div>
|
|
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment">[DEFINE] </span></div>
|
|
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> [NAME]</span></div>
|
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> FMOD_DEBUGLEVEL</span></div>
|
|
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment"> Bit fields to use with FMOD::Debug_SetLevel / FMOD::Debug_GetLevel to control the level of tty debug output with logging versions of FMOD (fmodL).</span></div>
|
|
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> Debug_SetLevel </span></div>
|
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> Debug_GetLevel</span></div>
|
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="preprocessor">#define FMOD_DEBUG_LEVEL_NONE 0x00000000</span></div>
|
|
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_LEVEL_LOG 0x00000001 </span><span class="comment">/* Will display generic logging messages. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_LEVEL_ERROR 0x00000002 </span><span class="comment">/* Will display errors. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_LEVEL_WARNING 0x00000004 </span><span class="comment">/* Will display warnings that are not fatal. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_LEVEL_HINT 0x00000008 </span><span class="comment">/* Will hint to you if there is something possibly better you could be doing. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_LEVEL_ALL 0x000000FF </span></div>
|
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_TYPE_MEMORY 0x00000100 </span><span class="comment">/* Show FMOD memory related logging messages. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_TYPE_THREAD 0x00000200 </span><span class="comment">/* Show FMOD thread related logging messages. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_TYPE_FILE 0x00000400 </span><span class="comment">/* Show FMOD file system related logging messages. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_TYPE_NET 0x00000800 </span><span class="comment">/* Show FMOD network related logging messages. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_TYPE_EVENT 0x00001000 </span><span class="comment">/* Show FMOD Event related logging messages. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_TYPE_ALL 0x0000FFFF </span></div>
|
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_DISPLAY_TIMESTAMPS 0x01000000 </span><span class="comment">/* Display the timestamp of the log entry in milliseconds. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_DISPLAY_LINENUMBERS 0x02000000 </span><span class="comment">/* Display the FMOD Ex source code line numbers, for debugging purposes. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_DISPLAY_COMPRESS 0x04000000 </span><span class="comment">/* If a message is repeated more than 5 times it will stop displaying it and instead display the number of times the message was logged. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_DISPLAY_THREAD 0x08000000 </span><span class="comment">/* Display the thread ID of the calling function that caused this log entry to appear. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_DISPLAY_ALL 0x0F000000</span></div>
|
|
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_DEBUG_ALL 0xFFFFFFFF</span></div>
|
|
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span> </div>
|
|
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> </div>
|
|
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="comment">[DEFINE] </span></div>
|
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="comment"> [NAME]</span></div>
|
|
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span> <span class="comment"> FMOD_MEMORY_TYPE</span></div>
|
|
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="comment"> Bit fields for memory allocation type being passed into FMOD memory callbacks.</span></div>
|
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="comment"> Remember this is a bitfield. You may get more than 1 bit set (ie physical + persistent) so do not simply switch on the types! You must check each bit individually or clear out the bits that you do not want within the callback.<br></span></div>
|
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="comment"> Bits can be excluded if you want during Memory_Initialize so that you never get them.</span></div>
|
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="comment"> FMOD_MEMORY_ALLOCCALLBACK</span></div>
|
|
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span> <span class="comment"> FMOD_MEMORY_REALLOCCALLBACK</span></div>
|
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="comment"> FMOD_MEMORY_FREECALLBACK</span></div>
|
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span> <span class="comment"> Memory_Initialize</span></div>
|
|
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="comment"> </span></div>
|
|
<div class="line"><a name="l00480"></a><span class="lineno"> 480</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00481"></a><span class="lineno"> 481</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00482"></a><span class="lineno"> 482</span> <span class="preprocessor">#define FMOD_MEMORY_NORMAL 0x00000000 </span><span class="comment">/* Standard memory. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00483"></a><span class="lineno"> 483</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_STREAM_FILE 0x00000001 </span><span class="comment">/* Stream file buffer, size controllable with System::setStreamBufferSize. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00484"></a><span class="lineno"> 484</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_STREAM_DECODE 0x00000002 </span><span class="comment">/* Stream decode buffer, size controllable with FMOD_CREATESOUNDEXINFO::decodebuffersize. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00485"></a><span class="lineno"> 485</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_SAMPLEDATA 0x00000004 </span><span class="comment">/* Sample data buffer. Raw audio data, usually PCM/MPEG/ADPCM/XMA data. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00486"></a><span class="lineno"> 486</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_DSP_OUTPUTBUFFER 0x00000008 </span><span class="comment">/* DSP memory block allocated when more than 1 output exists on a DSP node. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00487"></a><span class="lineno"> 487</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_XBOX360_PHYSICAL 0x00100000 </span><span class="comment">/* Requires XPhysicalAlloc / XPhysicalFree. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00488"></a><span class="lineno"> 488</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_PERSISTENT 0x00200000 </span><span class="comment">/* Persistent memory. Memory will be freed when System::release is called. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00489"></a><span class="lineno"> 489</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_SECONDARY 0x00400000 </span><span class="comment">/* Secondary memory. Allocation should be in secondary memory. For example RSX on the PS3. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00490"></a><span class="lineno"> 490</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MEMORY_ALL 0xFFFFFFFF</span></div>
|
|
<div class="line"><a name="l00491"></a><span class="lineno"> 491</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l00492"></a><span class="lineno"> 492</span> </div>
|
|
<div class="line"><a name="l00493"></a><span class="lineno"> 493</span> </div>
|
|
<div class="line"><a name="l00494"></a><span class="lineno"> 494</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00495"></a><span class="lineno"> 495</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00496"></a><span class="lineno"> 496</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00497"></a><span class="lineno"> 497</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00498"></a><span class="lineno"> 498</span> <span class="comment"> These are speaker types defined for use with the System::setSpeakerMode or System::getSpeakerMode command.</span></div>
|
|
<div class="line"><a name="l00499"></a><span class="lineno"> 499</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00500"></a><span class="lineno"> 500</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00501"></a><span class="lineno"> 501</span> <span class="comment"> These are important notes on speaker modes in regards to sounds created with FMOD_SOFTWARE.<br></span></div>
|
|
<div class="line"><a name="l00502"></a><span class="lineno"> 502</span> <span class="comment"> Note below the phrase 'sound channels' is used. These are the subchannels inside a sound, they are not related and </span></div>
|
|
<div class="line"><a name="l00503"></a><span class="lineno"> 503</span> <span class="comment"> have nothing to do with the FMOD class "Channel".<br></span></div>
|
|
<div class="line"><a name="l00504"></a><span class="lineno"> 504</span> <span class="comment"> For example a mono sound has 1 sound channel, a stereo sound has 2 sound channels, and an AC3 or 6 channel wav file have 6 "sound channels".<br></span></div>
|
|
<div class="line"><a name="l00505"></a><span class="lineno"> 505</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00506"></a><span class="lineno"> 506</span> <span class="comment"> FMOD_SPEAKERMODE_RAW<br></span></div>
|
|
<div class="line"><a name="l00507"></a><span class="lineno"> 507</span> <span class="comment"> ---------------------<br></span></div>
|
|
<div class="line"><a name="l00508"></a><span class="lineno"> 508</span> <span class="comment"> This mode is for output devices that are not specifically mono/stereo/quad/surround/5.1 or 7.1, but are multichannel.<br></span></div>
|
|
<div class="line"><a name="l00509"></a><span class="lineno"> 509</span> <span class="comment"> Use System::setSoftwareFormat to specify the number of speakers you want to address, otherwise it will default to 2 (stereo).<br></span></div>
|
|
<div class="line"><a name="l00510"></a><span class="lineno"> 510</span> <span class="comment"> Sound channels map to speakers sequentially, so a mono sound maps to output speaker 0, stereo sound maps to output speaker 0 & 1.<br></span></div>
|
|
<div class="line"><a name="l00511"></a><span class="lineno"> 511</span> <span class="comment"> The user assumes knowledge of the speaker order. FMOD_SPEAKER enumerations may not apply, so raw channel indices should be used.<br></span></div>
|
|
<div class="line"><a name="l00512"></a><span class="lineno"> 512</span> <span class="comment"> Multichannel sounds map input channels to output channels 1:1. <br></span></div>
|
|
<div class="line"><a name="l00513"></a><span class="lineno"> 513</span> <span class="comment"> Channel::setPan and Channel::setSpeakerMix do not work.<br></span></div>
|
|
<div class="line"><a name="l00514"></a><span class="lineno"> 514</span> <span class="comment"> Speaker levels must be manually set with Channel::setSpeakerLevels.<br></span></div>
|
|
<div class="line"><a name="l00515"></a><span class="lineno"> 515</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00516"></a><span class="lineno"> 516</span> <span class="comment"> FMOD_SPEAKERMODE_MONO<br></span></div>
|
|
<div class="line"><a name="l00517"></a><span class="lineno"> 517</span> <span class="comment"> ---------------------<br></span></div>
|
|
<div class="line"><a name="l00518"></a><span class="lineno"> 518</span> <span class="comment"> This mode is for a 1 speaker arrangement.<br></span></div>
|
|
<div class="line"><a name="l00519"></a><span class="lineno"> 519</span> <span class="comment"> Panning does not work in this speaker mode.<br></span></div>
|
|
<div class="line"><a name="l00520"></a><span class="lineno"> 520</span> <span class="comment"> Mono, stereo and multichannel sounds have each sound channel played on the one speaker unity.<br></span></div>
|
|
<div class="line"><a name="l00521"></a><span class="lineno"> 521</span> <span class="comment"> Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels.<br></span></div>
|
|
<div class="line"><a name="l00522"></a><span class="lineno"> 522</span> <span class="comment"> Channel::setSpeakerMix does not work.<br></span></div>
|
|
<div class="line"><a name="l00523"></a><span class="lineno"> 523</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00524"></a><span class="lineno"> 524</span> <span class="comment"> FMOD_SPEAKERMODE_STEREO<br></span></div>
|
|
<div class="line"><a name="l00525"></a><span class="lineno"> 525</span> <span class="comment"> -----------------------<br></span></div>
|
|
<div class="line"><a name="l00526"></a><span class="lineno"> 526</span> <span class="comment"> This mode is for 2 speaker arrangements that have a left and right speaker.<br></span></div>
|
|
<div class="line"><a name="l00527"></a><span class="lineno"> 527</span> <span class="comment"> <li>Mono sounds default to an even distribution between left and right. They can be panned with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00528"></a><span class="lineno"> 528</span> <span class="comment"> <li>Stereo sounds default to the middle, or full left in the left speaker and full right in the right speaker. </span></div>
|
|
<div class="line"><a name="l00529"></a><span class="lineno"> 529</span> <span class="comment"> <li>They can be cross faded with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00530"></a><span class="lineno"> 530</span> <span class="comment"> <li>Multichannel sounds have each sound channel played on each speaker at unity.<br></span></div>
|
|
<div class="line"><a name="l00531"></a><span class="lineno"> 531</span> <span class="comment"> <li>Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels.<br></span></div>
|
|
<div class="line"><a name="l00532"></a><span class="lineno"> 532</span> <span class="comment"> <li>Channel::setSpeakerMix works but only front left and right parameters are used, the rest are ignored.<br></span></div>
|
|
<div class="line"><a name="l00533"></a><span class="lineno"> 533</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00534"></a><span class="lineno"> 534</span> <span class="comment"> FMOD_SPEAKERMODE_QUAD<br></span></div>
|
|
<div class="line"><a name="l00535"></a><span class="lineno"> 535</span> <span class="comment"> ------------------------<br></span></div>
|
|
<div class="line"><a name="l00536"></a><span class="lineno"> 536</span> <span class="comment"> This mode is for 4 speaker arrangements that have a front left, front right, rear left and a rear right speaker.<br></span></div>
|
|
<div class="line"><a name="l00537"></a><span class="lineno"> 537</span> <span class="comment"> <li>Mono sounds default to an even distribution between front left and front right. They can be panned with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00538"></a><span class="lineno"> 538</span> <span class="comment"> <li>Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right.<br></span></div>
|
|
<div class="line"><a name="l00539"></a><span class="lineno"> 539</span> <span class="comment"> <li>They can be cross faded with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00540"></a><span class="lineno"> 540</span> <span class="comment"> <li>Multichannel sounds default to all of their sound channels being played on each speaker in order of input.<br></span></div>
|
|
<div class="line"><a name="l00541"></a><span class="lineno"> 541</span> <span class="comment"> <li>Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels.<br></span></div>
|
|
<div class="line"><a name="l00542"></a><span class="lineno"> 542</span> <span class="comment"> <li>Channel::setSpeakerMix works but side left, side right, center and lfe are ignored.<br></span></div>
|
|
<div class="line"><a name="l00543"></a><span class="lineno"> 543</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00544"></a><span class="lineno"> 544</span> <span class="comment"> FMOD_SPEAKERMODE_SURROUND<br></span></div>
|
|
<div class="line"><a name="l00545"></a><span class="lineno"> 545</span> <span class="comment"> ------------------------<br></span></div>
|
|
<div class="line"><a name="l00546"></a><span class="lineno"> 546</span> <span class="comment"> This mode is for 5 speaker arrangements that have a left/right/center/rear left/rear right.<br></span></div>
|
|
<div class="line"><a name="l00547"></a><span class="lineno"> 547</span> <span class="comment"> <li>Mono sounds default to the center speaker. They can be panned with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00548"></a><span class="lineno"> 548</span> <span class="comment"> <li>Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right. </span></div>
|
|
<div class="line"><a name="l00549"></a><span class="lineno"> 549</span> <span class="comment"> <li>They can be cross faded with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00550"></a><span class="lineno"> 550</span> <span class="comment"> <li>Multichannel sounds default to all of their sound channels being played on each speaker in order of input. </span></div>
|
|
<div class="line"><a name="l00551"></a><span class="lineno"> 551</span> <span class="comment"> <li>Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels.<br></span></div>
|
|
<div class="line"><a name="l00552"></a><span class="lineno"> 552</span> <span class="comment"> <li>Channel::setSpeakerMix works but side left / side right are ignored.<br></span></div>
|
|
<div class="line"><a name="l00553"></a><span class="lineno"> 553</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00554"></a><span class="lineno"> 554</span> <span class="comment"> FMOD_SPEAKERMODE_5POINT1<br></span></div>
|
|
<div class="line"><a name="l00555"></a><span class="lineno"> 555</span> <span class="comment"> ------------------------<br></span></div>
|
|
<div class="line"><a name="l00556"></a><span class="lineno"> 556</span> <span class="comment"> This mode is for 5.1 speaker arrangements that have a left/right/center/rear left/rear right and a subwoofer speaker.<br></span></div>
|
|
<div class="line"><a name="l00557"></a><span class="lineno"> 557</span> <span class="comment"> <li>Mono sounds default to the center speaker. They can be panned with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00558"></a><span class="lineno"> 558</span> <span class="comment"> <li>Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right. </span></div>
|
|
<div class="line"><a name="l00559"></a><span class="lineno"> 559</span> <span class="comment"> <li>They can be cross faded with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00560"></a><span class="lineno"> 560</span> <span class="comment"> <li>Multichannel sounds default to all of their sound channels being played on each speaker in order of input. </span></div>
|
|
<div class="line"><a name="l00561"></a><span class="lineno"> 561</span> <span class="comment"> <li>Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels.<br></span></div>
|
|
<div class="line"><a name="l00562"></a><span class="lineno"> 562</span> <span class="comment"> <li>Channel::setSpeakerMix works but side left / side right are ignored.<br></span></div>
|
|
<div class="line"><a name="l00563"></a><span class="lineno"> 563</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00564"></a><span class="lineno"> 564</span> <span class="comment"> FMOD_SPEAKERMODE_7POINT1<br></span></div>
|
|
<div class="line"><a name="l00565"></a><span class="lineno"> 565</span> <span class="comment"> ------------------------<br></span></div>
|
|
<div class="line"><a name="l00566"></a><span class="lineno"> 566</span> <span class="comment"> This mode is for 7.1 speaker arrangements that have a left/right/center/rear left/rear right/side left/side right </span></div>
|
|
<div class="line"><a name="l00567"></a><span class="lineno"> 567</span> <span class="comment"> and a subwoofer speaker.<br></span></div>
|
|
<div class="line"><a name="l00568"></a><span class="lineno"> 568</span> <span class="comment"> <li>Mono sounds default to the center speaker. They can be panned with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00569"></a><span class="lineno"> 569</span> <span class="comment"> <li>Stereo sounds default to the left sound channel played on the front left, and the right sound channel played on the front right. </span></div>
|
|
<div class="line"><a name="l00570"></a><span class="lineno"> 570</span> <span class="comment"> <li>They can be cross faded with Channel::setPan.<br></span></div>
|
|
<div class="line"><a name="l00571"></a><span class="lineno"> 571</span> <span class="comment"> <li>Multichannel sounds default to all of their sound channels being played on each speaker in order of input. </span></div>
|
|
<div class="line"><a name="l00572"></a><span class="lineno"> 572</span> <span class="comment"> <li>Mix behavior for multichannel sounds can be set with Channel::setSpeakerLevels.<br></span></div>
|
|
<div class="line"><a name="l00573"></a><span class="lineno"> 573</span> <span class="comment"> <li>Channel::setSpeakerMix works and every parameter is used to set the balance of a sound in any speaker.<br></span></div>
|
|
<div class="line"><a name="l00574"></a><span class="lineno"> 574</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00575"></a><span class="lineno"> 575</span> <span class="comment"> FMOD_SPEAKERMODE_SRS5_1_MATRIX<br></span></div>
|
|
<div class="line"><a name="l00576"></a><span class="lineno"> 576</span> <span class="comment"> ------------------------------------------------------<br></span></div>
|
|
<div class="line"><a name="l00577"></a><span class="lineno"> 577</span> <span class="comment"> This mode is for mono, stereo, 5.1 and 6.1 speaker arrangements, as it is backwards and forwards compatible with </span></div>
|
|
<div class="line"><a name="l00578"></a><span class="lineno"> 578</span> <span class="comment"> stereo, but to get a surround effect a SRS 5.1, Prologic or Prologic 2 hardware decoder / amplifier is needed or </span></div>
|
|
<div class="line"><a name="l00579"></a><span class="lineno"> 579</span> <span class="comment"> a compatible SRS equipped device (e.g., laptop, TV, etc.) or accessory (e.g., headphone).<br></span></div>
|
|
<div class="line"><a name="l00580"></a><span class="lineno"> 580</span> <span class="comment"> Pan behavior is the same as FMOD_SPEAKERMODE_5POINT1.<br></span></div>
|
|
<div class="line"><a name="l00581"></a><span class="lineno"> 581</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00582"></a><span class="lineno"> 582</span> <span class="comment"> If this function is called the numoutputchannels setting in System::setSoftwareFormat is overwritten.<br></span></div>
|
|
<div class="line"><a name="l00583"></a><span class="lineno"> 583</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00584"></a><span class="lineno"> 584</span> <span class="comment"> Output rate must be 44100, 48000 or 96000 for this to work otherwise FMOD_ERR_OUTPUT_INIT will be returned.<br></span></div>
|
|
<div class="line"><a name="l00585"></a><span class="lineno"> 585</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00586"></a><span class="lineno"> 586</span> <span class="comment"> FMOD_SPEAKERMODE_DOLBY5_1_MATRIX<br></span></div>
|
|
<div class="line"><a name="l00587"></a><span class="lineno"> 587</span> <span class="comment"> ------------------------------------------------------<br></span></div>
|
|
<div class="line"><a name="l00588"></a><span class="lineno"> 588</span> <span class="comment"> This mode is for 5.1 speaker arrangements using a stereo signal, to get a surround effect a Dolby Pro Logic II</span></div>
|
|
<div class="line"><a name="l00589"></a><span class="lineno"> 589</span> <span class="comment"> hardware decoder / amplifier is needed.<br></span></div>
|
|
<div class="line"><a name="l00590"></a><span class="lineno"> 590</span> <span class="comment"> Pan behavior is the same as FMOD_SPEAKERMODE_5POINT1.<br></span></div>
|
|
<div class="line"><a name="l00591"></a><span class="lineno"> 591</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00592"></a><span class="lineno"> 592</span> <span class="comment"> If this function is called the numoutputchannels setting in System::setSoftwareFormat is overwritten.<br></span></div>
|
|
<div class="line"><a name="l00593"></a><span class="lineno"> 593</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00594"></a><span class="lineno"> 594</span> <span class="comment"> Output rate must be 32000, 44100 or 48000 for this to work otherwise FMOD_ERR_OUTPUT_INIT will be returned.<br></span></div>
|
|
<div class="line"><a name="l00595"></a><span class="lineno"> 595</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00596"></a><span class="lineno"> 596</span> <span class="comment"> FMOD_SPEAKERMODE_MYEARS<br></span></div>
|
|
<div class="line"><a name="l00597"></a><span class="lineno"> 597</span> <span class="comment"> ------------------------------------------------------<br></span></div>
|
|
<div class="line"><a name="l00598"></a><span class="lineno"> 598</span> <span class="comment"> This mode is for headphones. This will attempt to load a MyEars profile (see myears.net.au) and use it to generate</span></div>
|
|
<div class="line"><a name="l00599"></a><span class="lineno"> 599</span> <span class="comment"> surround sound on headphones using a personalized HRTF algorithm, for realistic 3d sound.<br></span></div>
|
|
<div class="line"><a name="l00600"></a><span class="lineno"> 600</span> <span class="comment"> Pan behavior is the same as FMOD_SPEAKERMODE_7POINT1.<br></span></div>
|
|
<div class="line"><a name="l00601"></a><span class="lineno"> 601</span> <span class="comment"> MyEars speaker mode will automatically be set if the speakermode is FMOD_SPEAKERMODE_STEREO and the MyEars profile exists.<br></span></div>
|
|
<div class="line"><a name="l00602"></a><span class="lineno"> 602</span> <span class="comment"> If this mode is set explicitly, FMOD_INIT_DISABLE_MYEARS_AUTODETECT has no effect.<br></span></div>
|
|
<div class="line"><a name="l00603"></a><span class="lineno"> 603</span> <span class="comment"> If this mode is set explicitly and the MyEars profile does not exist, FMOD_ERR_OUTPUT_DRIVERCALL will be returned.</span></div>
|
|
<div class="line"><a name="l00604"></a><span class="lineno"> 604</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00605"></a><span class="lineno"> 605</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00606"></a><span class="lineno"> 606</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00607"></a><span class="lineno"> 607</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00608"></a><span class="lineno"> 608</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00609"></a><span class="lineno"> 609</span> <span class="comment"> System::setSpeakerMode</span></div>
|
|
<div class="line"><a name="l00610"></a><span class="lineno"> 610</span> <span class="comment"> System::getSpeakerMode</span></div>
|
|
<div class="line"><a name="l00611"></a><span class="lineno"> 611</span> <span class="comment"> System::getDriverCaps</span></div>
|
|
<div class="line"><a name="l00612"></a><span class="lineno"> 612</span> <span class="comment"> System::setSoftwareFormat</span></div>
|
|
<div class="line"><a name="l00613"></a><span class="lineno"> 613</span> <span class="comment"> Channel::setSpeakerLevels</span></div>
|
|
<div class="line"><a name="l00614"></a><span class="lineno"> 614</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00615"></a><span class="lineno"> 615</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00616"></a><span class="lineno"> 616</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00617"></a><span class="lineno"> 617</span> {</div>
|
|
<div class="line"><a name="l00618"></a><span class="lineno"> 618</span>  FMOD_SPEAKERMODE_RAW, <span class="comment">/* There is no specific speakermode. Sound channels are mapped in order of input to output. Use System::setSoftwareFormat to specify speaker count. See remarks for more information. */</span></div>
|
|
<div class="line"><a name="l00619"></a><span class="lineno"> 619</span>  FMOD_SPEAKERMODE_MONO, <span class="comment">/* The speakers are monaural. */</span></div>
|
|
<div class="line"><a name="l00620"></a><span class="lineno"> 620</span>  FMOD_SPEAKERMODE_STEREO, <span class="comment">/* The speakers are stereo (DEFAULT). */</span></div>
|
|
<div class="line"><a name="l00621"></a><span class="lineno"> 621</span>  FMOD_SPEAKERMODE_QUAD, <span class="comment">/* 4 speaker setup. This includes front left, front right, rear left, rear right. */</span></div>
|
|
<div class="line"><a name="l00622"></a><span class="lineno"> 622</span>  FMOD_SPEAKERMODE_SURROUND, <span class="comment">/* 5 speaker setup. This includes front left, front right, center, rear left, rear right. */</span></div>
|
|
<div class="line"><a name="l00623"></a><span class="lineno"> 623</span>  FMOD_SPEAKERMODE_5POINT1, <span class="comment">/* 5.1 speaker setup. This includes front left, front right, center, rear left, rear right and a subwoofer. */</span></div>
|
|
<div class="line"><a name="l00624"></a><span class="lineno"> 624</span>  FMOD_SPEAKERMODE_7POINT1, <span class="comment">/* 7.1 speaker setup. This includes front left, front right, center, rear left, rear right, side left, side right and a subwoofer. */</span></div>
|
|
<div class="line"><a name="l00625"></a><span class="lineno"> 625</span>  </div>
|
|
<div class="line"><a name="l00626"></a><span class="lineno"> 626</span>  FMOD_SPEAKERMODE_SRS5_1_MATRIX, <span class="comment">/* Stereo compatible output, embedded with surround information. SRS 5.1/Prologic/Prologic2 decoders will split the signal into a 5.1 speaker set-up or SRS virtual surround will decode into a 2-speaker/headphone setup. See remarks about limitations.*/</span></div>
|
|
<div class="line"><a name="l00627"></a><span class="lineno"> 627</span>  FMOD_SPEAKERMODE_DOLBY5_1_MATRIX, <span class="comment">/* Stereo compatible output, embedded with surround information. Dolby Pro Logic II decoders will split the signal into a 5.1 speaker set-up. */</span></div>
|
|
<div class="line"><a name="l00628"></a><span class="lineno"> 628</span>  FMOD_SPEAKERMODE_MYEARS, <span class="comment">/* Stereo output, but data is encoded using personalized HRTF algorithms. See myears.net.au */</span></div>
|
|
<div class="line"><a name="l00629"></a><span class="lineno"> 629</span> </div>
|
|
<div class="line"><a name="l00630"></a><span class="lineno"> 630</span>  FMOD_SPEAKERMODE_MAX, <span class="comment">/* Maximum number of speaker modes supported. */</span></div>
|
|
<div class="line"><a name="l00631"></a><span class="lineno"> 631</span>  FMOD_SPEAKERMODE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00632"></a><span class="lineno"> 632</span> } FMOD_SPEAKERMODE;</div>
|
|
<div class="line"><a name="l00633"></a><span class="lineno"> 633</span> </div>
|
|
<div class="line"><a name="l00634"></a><span class="lineno"> 634</span> </div>
|
|
<div class="line"><a name="l00635"></a><span class="lineno"> 635</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00636"></a><span class="lineno"> 636</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00637"></a><span class="lineno"> 637</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00638"></a><span class="lineno"> 638</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00639"></a><span class="lineno"> 639</span> <span class="comment"> These are speaker types defined for use with the Channel::setSpeakerLevels command.</span></div>
|
|
<div class="line"><a name="l00640"></a><span class="lineno"> 640</span> <span class="comment"> It can also be used for speaker placement in the System::set3DSpeakerPosition command.</span></div>
|
|
<div class="line"><a name="l00641"></a><span class="lineno"> 641</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00642"></a><span class="lineno"> 642</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00643"></a><span class="lineno"> 643</span> <span class="comment"> If you are using FMOD_SPEAKERMODE_RAW and speaker assignments are meaningless, just cast a raw integer value to this type.<br></span></div>
|
|
<div class="line"><a name="l00644"></a><span class="lineno"> 644</span> <span class="comment"> For example (FMOD_SPEAKER)7 would use the 7th speaker (also the same as FMOD_SPEAKER_SIDE_RIGHT).<br></span></div>
|
|
<div class="line"><a name="l00645"></a><span class="lineno"> 645</span> <span class="comment"> Values higher than this can be used if an output system has more than 8 speaker types / output channels. 15 is the current maximum.<br></span></div>
|
|
<div class="line"><a name="l00646"></a><span class="lineno"> 646</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00647"></a><span class="lineno"> 647</span> <span class="comment"> NOTE: On Playstation 3 in 7.1, the extra 2 speakers are not side left/side right, they are 'surround back left'/'surround back right' which</span></div>
|
|
<div class="line"><a name="l00648"></a><span class="lineno"> 648</span> <span class="comment"> locate the speakers behind the listener instead of to the sides like on PC. FMOD_SPEAKER_SBL/FMOD_SPEAKER_SBR are provided to make it </span></div>
|
|
<div class="line"><a name="l00649"></a><span class="lineno"> 649</span> <span class="comment"> clearer what speaker is being addressed on that platform.</span></div>
|
|
<div class="line"><a name="l00650"></a><span class="lineno"> 650</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00651"></a><span class="lineno"> 651</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00652"></a><span class="lineno"> 652</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00653"></a><span class="lineno"> 653</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00654"></a><span class="lineno"> 654</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00655"></a><span class="lineno"> 655</span> <span class="comment"> FMOD_SPEAKERMODE</span></div>
|
|
<div class="line"><a name="l00656"></a><span class="lineno"> 656</span> <span class="comment"> Channel::setSpeakerLevels</span></div>
|
|
<div class="line"><a name="l00657"></a><span class="lineno"> 657</span> <span class="comment"> Channel::getSpeakerLevels</span></div>
|
|
<div class="line"><a name="l00658"></a><span class="lineno"> 658</span> <span class="comment"> System::set3DSpeakerPosition</span></div>
|
|
<div class="line"><a name="l00659"></a><span class="lineno"> 659</span> <span class="comment"> System::get3DSpeakerPosition</span></div>
|
|
<div class="line"><a name="l00660"></a><span class="lineno"> 660</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00661"></a><span class="lineno"> 661</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00662"></a><span class="lineno"> 662</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00663"></a><span class="lineno"> 663</span> {</div>
|
|
<div class="line"><a name="l00664"></a><span class="lineno"> 664</span>  FMOD_SPEAKER_FRONT_LEFT,</div>
|
|
<div class="line"><a name="l00665"></a><span class="lineno"> 665</span>  FMOD_SPEAKER_FRONT_RIGHT,</div>
|
|
<div class="line"><a name="l00666"></a><span class="lineno"> 666</span>  FMOD_SPEAKER_FRONT_CENTER,</div>
|
|
<div class="line"><a name="l00667"></a><span class="lineno"> 667</span>  FMOD_SPEAKER_LOW_FREQUENCY,</div>
|
|
<div class="line"><a name="l00668"></a><span class="lineno"> 668</span>  FMOD_SPEAKER_BACK_LEFT,</div>
|
|
<div class="line"><a name="l00669"></a><span class="lineno"> 669</span>  FMOD_SPEAKER_BACK_RIGHT,</div>
|
|
<div class="line"><a name="l00670"></a><span class="lineno"> 670</span>  FMOD_SPEAKER_SIDE_LEFT,</div>
|
|
<div class="line"><a name="l00671"></a><span class="lineno"> 671</span>  FMOD_SPEAKER_SIDE_RIGHT,</div>
|
|
<div class="line"><a name="l00672"></a><span class="lineno"> 672</span>  </div>
|
|
<div class="line"><a name="l00673"></a><span class="lineno"> 673</span>  FMOD_SPEAKER_MAX, <span class="comment">/* Maximum number of speaker types supported. */</span></div>
|
|
<div class="line"><a name="l00674"></a><span class="lineno"> 674</span>  FMOD_SPEAKER_MONO = FMOD_SPEAKER_FRONT_LEFT, <span class="comment">/* For use with FMOD_SPEAKERMODE_MONO and Channel::SetSpeakerLevels. Mapped to same value as FMOD_SPEAKER_FRONT_LEFT. */</span></div>
|
|
<div class="line"><a name="l00675"></a><span class="lineno"> 675</span>  FMOD_SPEAKER_NULL = 65535, <span class="comment">/* A non speaker. Use this with ASIO mapping to ignore a speaker. */</span></div>
|
|
<div class="line"><a name="l00676"></a><span class="lineno"> 676</span>  FMOD_SPEAKER_SBL = FMOD_SPEAKER_SIDE_LEFT, <span class="comment">/* For use with FMOD_SPEAKERMODE_7POINT1 on PS3 where the extra speakers are surround back inside of side speakers. */</span></div>
|
|
<div class="line"><a name="l00677"></a><span class="lineno"> 677</span>  FMOD_SPEAKER_SBR = FMOD_SPEAKER_SIDE_RIGHT, <span class="comment">/* For use with FMOD_SPEAKERMODE_7POINT1 on PS3 where the extra speakers are surround back inside of side speakers. */</span></div>
|
|
<div class="line"><a name="l00678"></a><span class="lineno"> 678</span>  FMOD_SPEAKER_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00679"></a><span class="lineno"> 679</span> } FMOD_SPEAKER;</div>
|
|
<div class="line"><a name="l00680"></a><span class="lineno"> 680</span> </div>
|
|
<div class="line"><a name="l00681"></a><span class="lineno"> 681</span> </div>
|
|
<div class="line"><a name="l00682"></a><span class="lineno"> 682</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00683"></a><span class="lineno"> 683</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00684"></a><span class="lineno"> 684</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00685"></a><span class="lineno"> 685</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00686"></a><span class="lineno"> 686</span> <span class="comment"> These are plugin types defined for use with the System::getNumPlugins, </span></div>
|
|
<div class="line"><a name="l00687"></a><span class="lineno"> 687</span> <span class="comment"> System::getPluginInfo and System::unloadPlugin functions.</span></div>
|
|
<div class="line"><a name="l00688"></a><span class="lineno"> 688</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00689"></a><span class="lineno"> 689</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00690"></a><span class="lineno"> 690</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00691"></a><span class="lineno"> 691</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00692"></a><span class="lineno"> 692</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00693"></a><span class="lineno"> 693</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00694"></a><span class="lineno"> 694</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00695"></a><span class="lineno"> 695</span> <span class="comment"> System::getNumPlugins</span></div>
|
|
<div class="line"><a name="l00696"></a><span class="lineno"> 696</span> <span class="comment"> System::getPluginInfo</span></div>
|
|
<div class="line"><a name="l00697"></a><span class="lineno"> 697</span> <span class="comment"> System::unloadPlugin</span></div>
|
|
<div class="line"><a name="l00698"></a><span class="lineno"> 698</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00699"></a><span class="lineno"> 699</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00700"></a><span class="lineno"> 700</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00701"></a><span class="lineno"> 701</span> {</div>
|
|
<div class="line"><a name="l00702"></a><span class="lineno"> 702</span>  FMOD_PLUGINTYPE_OUTPUT, <span class="comment">/* The plugin type is an output module. FMOD mixed audio will play through one of these devices */</span></div>
|
|
<div class="line"><a name="l00703"></a><span class="lineno"> 703</span>  FMOD_PLUGINTYPE_CODEC, <span class="comment">/* The plugin type is a file format codec. FMOD will use these codecs to load file formats for playback. */</span></div>
|
|
<div class="line"><a name="l00704"></a><span class="lineno"> 704</span>  FMOD_PLUGINTYPE_DSP, <span class="comment">/* The plugin type is a DSP unit. FMOD will use these plugins as part of its DSP network to apply effects to output or generate sound in realtime. */</span></div>
|
|
<div class="line"><a name="l00705"></a><span class="lineno"> 705</span> </div>
|
|
<div class="line"><a name="l00706"></a><span class="lineno"> 706</span>  FMOD_PLUGINTYPE_MAX, <span class="comment">/* Maximum number of plugin types supported. */</span></div>
|
|
<div class="line"><a name="l00707"></a><span class="lineno"> 707</span>  FMOD_PLUGINTYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00708"></a><span class="lineno"> 708</span> } FMOD_PLUGINTYPE;</div>
|
|
<div class="line"><a name="l00709"></a><span class="lineno"> 709</span> </div>
|
|
<div class="line"><a name="l00710"></a><span class="lineno"> 710</span> </div>
|
|
<div class="line"><a name="l00711"></a><span class="lineno"> 711</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00712"></a><span class="lineno"> 712</span> <span class="comment">[DEFINE]</span></div>
|
|
<div class="line"><a name="l00713"></a><span class="lineno"> 713</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00714"></a><span class="lineno"> 714</span> <span class="comment"> [NAME]</span></div>
|
|
<div class="line"><a name="l00715"></a><span class="lineno"> 715</span> <span class="comment"> FMOD_INITFLAGS</span></div>
|
|
<div class="line"><a name="l00716"></a><span class="lineno"> 716</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00717"></a><span class="lineno"> 717</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00718"></a><span class="lineno"> 718</span> <span class="comment"> Initialization flags. Use them with System::init in the flags parameter to change various behavior. </span></div>
|
|
<div class="line"><a name="l00719"></a><span class="lineno"> 719</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00720"></a><span class="lineno"> 720</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00721"></a><span class="lineno"> 721</span> <span class="comment"> Use System::setAdvancedSettings to adjust settings for some of the features that are enabled by these flags.</span></div>
|
|
<div class="line"><a name="l00722"></a><span class="lineno"> 722</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00723"></a><span class="lineno"> 723</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00724"></a><span class="lineno"> 724</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00725"></a><span class="lineno"> 725</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00726"></a><span class="lineno"> 726</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00727"></a><span class="lineno"> 727</span> <span class="comment"> System::init</span></div>
|
|
<div class="line"><a name="l00728"></a><span class="lineno"> 728</span> <span class="comment"> System::update </span></div>
|
|
<div class="line"><a name="l00729"></a><span class="lineno"> 729</span> <span class="comment"> System::setAdvancedSettings</span></div>
|
|
<div class="line"><a name="l00730"></a><span class="lineno"> 730</span> <span class="comment"> Channel::set3DOcclusion</span></div>
|
|
<div class="line"><a name="l00731"></a><span class="lineno"> 731</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00732"></a><span class="lineno"> 732</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00733"></a><span class="lineno"> 733</span> <span class="preprocessor">#define FMOD_INIT_NORMAL 0x00000000 </span><span class="comment">/* All platforms - Initialize normally */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00734"></a><span class="lineno"> 734</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_STREAM_FROM_UPDATE 0x00000001 </span><span class="comment">/* All platforms - No stream thread is created internally. Streams are driven from System::update. Mainly used with non-realtime outputs. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00735"></a><span class="lineno"> 735</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_3D_RIGHTHANDED 0x00000002 </span><span class="comment">/* All platforms - FMOD will treat +X as right, +Y as up and +Z as backwards (towards you). */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00736"></a><span class="lineno"> 736</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_SOFTWARE_DISABLE 0x00000004 </span><span class="comment">/* All platforms - Disable software mixer to save memory. Anything created with FMOD_SOFTWARE will fail and DSP will not work. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00737"></a><span class="lineno"> 737</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_OCCLUSION_LOWPASS 0x00000008 </span><span class="comment">/* All platforms - All FMOD_SOFTWARE (and FMOD_HARDWARE on 3DS and NGP) with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which is automatically used when Channel::set3DOcclusion is used or the geometry API. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00738"></a><span class="lineno"> 738</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_HRTF_LOWPASS 0x00000010 </span><span class="comment">/* All platforms - All FMOD_SOFTWARE (and FMOD_HARDWARE on 3DS and NGP) with FMOD_3D based voices will add a software lowpass filter effect into the DSP chain which causes sounds to sound duller when the sound goes behind the listener. Use System::setAdvancedSettings to adjust cutoff frequency. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00739"></a><span class="lineno"> 739</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_DISTANCE_FILTERING 0x00000200 </span><span class="comment">/* All platforms - All FMOD_SOFTWARE with FMOD_3D based voices will add a software lowpass and highpass filter effect into the DSP chain which will act as a distance-automated bandpass filter. Use System::setAdvancedSettings to adjust the center frequency. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00740"></a><span class="lineno"> 740</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_REVERB_PREALLOCBUFFERS 0x00000040 </span><span class="comment">/* All platforms - FMOD Software reverb will preallocate enough buffers for reverb per channel, rather than allocating them and freeing them at runtime. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00741"></a><span class="lineno"> 741</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_ENABLE_PROFILE 0x00000020 </span><span class="comment">/* All platforms - Enable TCP/IP based host which allows FMOD Designer or FMOD Profiler to connect to it, and view memory, CPU and the DSP network graph in real-time. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00742"></a><span class="lineno"> 742</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_VOL0_BECOMES_VIRTUAL 0x00000080 </span><span class="comment">/* All platforms - Any sounds that are 0 volume will go virtual and not be processed except for having their positions updated virtually. Use System::setAdvancedSettings to adjust what volume besides zero to switch to virtual at. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00743"></a><span class="lineno"> 743</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_WASAPI_EXCLUSIVE 0x00000100 </span><span class="comment">/* Win32 Vista only - for WASAPI output - Enable exclusive access to hardware, lower latency at the expense of excluding other applications from accessing the audio hardware. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00744"></a><span class="lineno"> 744</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_PS3_PREFERDTS 0x00800000 </span><span class="comment">/* PS3 only - Prefer DTS over Dolby Digital if both are supported. Note: 8 and 6 channel LPCM is always preferred over both DTS and Dolby Digital. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00745"></a><span class="lineno"> 745</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_PS3_FORCE2CHLPCM 0x01000000 </span><span class="comment">/* PS3 only - Force PS3 system output mode to 2 channel LPCM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00746"></a><span class="lineno"> 746</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_DISABLEDOLBY 0x00100000 </span><span class="comment">/* Wii / 3DS - Disable Dolby Pro Logic surround. Speakermode will be set to STEREO even if user has selected surround in the system settings. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00747"></a><span class="lineno"> 747</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_SYSTEM_MUSICMUTENOTPAUSE 0x00200000 </span><span class="comment">/* Xbox 360 / PS3 - The "music" channelgroup which by default pauses when custom 360 dashboard / PS3 BGM music is played, can be changed to mute (therefore continues playing) instead of pausing, by using this flag. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00748"></a><span class="lineno"> 748</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_SYNCMIXERWITHUPDATE 0x00400000 </span><span class="comment">/* Win32/Wii/PS3/Xbox/Xbox 360 - FMOD Mixer thread is woken up to do a mix when System::update is called rather than waking periodically on its own timer. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00749"></a><span class="lineno"> 749</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_GEOMETRY_USECLOSEST 0x04000000 </span><span class="comment">/* All platforms - With the geometry engine, only process the closest polygon rather than accumulating all polygons the sound to listener line intersects. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00750"></a><span class="lineno"> 750</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_DISABLE_MYEARS_AUTODETECT 0x08000000 </span><span class="comment">/* Win32 - Disables automatic setting of FMOD_SPEAKERMODE_STEREO to FMOD_SPEAKERMODE_MYEARS if the MyEars profile exists on the PC. MyEars is HRTF 7.1 downmixing through headphones. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00751"></a><span class="lineno"> 751</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_PS3_DISABLEDTS 0x10000000 </span><span class="comment">/* PS3 only - Disable DTS output mode selection */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00752"></a><span class="lineno"> 752</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_PS3_DISABLEDOLBYDIGITAL 0x20000000 </span><span class="comment">/* PS3 only - Disable Dolby Digital output mode selection */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00753"></a><span class="lineno"> 753</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_INIT_7POINT1_DOLBYMAPPING 0x40000000 </span><span class="comment">/* PS3/PS4 only - FMOD uses the WAVEFORMATEX Microsoft 7.1 speaker mapping where the last 2 pairs of speakers are 'rears' then 'sides', but on PS3/PS4 these are mapped to 'surrounds' and 'backs'. Use this flag to swap fmod's last 2 pair of speakers on PS3/PS4 to avoid needing to do a special case for these platforms. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00754"></a><span class="lineno"> 754</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l00755"></a><span class="lineno"> 755</span> </div>
|
|
<div class="line"><a name="l00756"></a><span class="lineno"> 756</span> </div>
|
|
<div class="line"><a name="l00757"></a><span class="lineno"> 757</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00758"></a><span class="lineno"> 758</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00759"></a><span class="lineno"> 759</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00760"></a><span class="lineno"> 760</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00761"></a><span class="lineno"> 761</span> <span class="comment"> These definitions describe the type of song being played.</span></div>
|
|
<div class="line"><a name="l00762"></a><span class="lineno"> 762</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00763"></a><span class="lineno"> 763</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00764"></a><span class="lineno"> 764</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00765"></a><span class="lineno"> 765</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00766"></a><span class="lineno"> 766</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00767"></a><span class="lineno"> 767</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00768"></a><span class="lineno"> 768</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l00769"></a><span class="lineno"> 769</span> <span class="comment"> Sound::getFormat</span></div>
|
|
<div class="line"><a name="l00770"></a><span class="lineno"> 770</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00771"></a><span class="lineno"> 771</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00772"></a><span class="lineno"> 772</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00773"></a><span class="lineno"> 773</span> {</div>
|
|
<div class="line"><a name="l00774"></a><span class="lineno"> 774</span>  FMOD_SOUND_TYPE_UNKNOWN, <span class="comment">/* 3rd party / unknown plugin format. */</span></div>
|
|
<div class="line"><a name="l00775"></a><span class="lineno"> 775</span>  FMOD_SOUND_TYPE_AIFF, <span class="comment">/* AIFF. */</span></div>
|
|
<div class="line"><a name="l00776"></a><span class="lineno"> 776</span>  FMOD_SOUND_TYPE_ASF, <span class="comment">/* Microsoft Advanced Systems Format (ie WMA/ASF/WMV). */</span></div>
|
|
<div class="line"><a name="l00777"></a><span class="lineno"> 777</span>  FMOD_SOUND_TYPE_AT3, <span class="comment">/* Sony ATRAC 3 format */</span></div>
|
|
<div class="line"><a name="l00778"></a><span class="lineno"> 778</span>  FMOD_SOUND_TYPE_CDDA, <span class="comment">/* Digital CD audio. */</span></div>
|
|
<div class="line"><a name="l00779"></a><span class="lineno"> 779</span>  FMOD_SOUND_TYPE_DLS, <span class="comment">/* Sound font / downloadable sound bank. */</span></div>
|
|
<div class="line"><a name="l00780"></a><span class="lineno"> 780</span>  FMOD_SOUND_TYPE_FLAC, <span class="comment">/* FLAC lossless codec. */</span></div>
|
|
<div class="line"><a name="l00781"></a><span class="lineno"> 781</span>  FMOD_SOUND_TYPE_FSB, <span class="comment">/* FMOD Sample Bank. */</span></div>
|
|
<div class="line"><a name="l00782"></a><span class="lineno"> 782</span>  FMOD_SOUND_TYPE_GCADPCM, <span class="comment">/* Nintendo GameCube/Wii ADPCM */</span></div>
|
|
<div class="line"><a name="l00783"></a><span class="lineno"> 783</span>  FMOD_SOUND_TYPE_IT, <span class="comment">/* Impulse Tracker. */</span></div>
|
|
<div class="line"><a name="l00784"></a><span class="lineno"> 784</span>  FMOD_SOUND_TYPE_MIDI, <span class="comment">/* MIDI. extracodecdata is a pointer to an FMOD_MIDI_EXTRACODECDATA structure. */</span></div>
|
|
<div class="line"><a name="l00785"></a><span class="lineno"> 785</span>  FMOD_SOUND_TYPE_MOD, <span class="comment">/* Protracker / Fasttracker MOD. */</span></div>
|
|
<div class="line"><a name="l00786"></a><span class="lineno"> 786</span>  FMOD_SOUND_TYPE_MPEG, <span class="comment">/* MP2/MP3 MPEG. */</span></div>
|
|
<div class="line"><a name="l00787"></a><span class="lineno"> 787</span>  FMOD_SOUND_TYPE_OGGVORBIS, <span class="comment">/* Ogg vorbis. */</span></div>
|
|
<div class="line"><a name="l00788"></a><span class="lineno"> 788</span>  FMOD_SOUND_TYPE_PLAYLIST, <span class="comment">/* Information only from ASX/PLS/M3U/WAX playlists */</span></div>
|
|
<div class="line"><a name="l00789"></a><span class="lineno"> 789</span>  FMOD_SOUND_TYPE_RAW, <span class="comment">/* Raw PCM data. */</span></div>
|
|
<div class="line"><a name="l00790"></a><span class="lineno"> 790</span>  FMOD_SOUND_TYPE_S3M, <span class="comment">/* ScreamTracker 3. */</span></div>
|
|
<div class="line"><a name="l00791"></a><span class="lineno"> 791</span>  FMOD_SOUND_TYPE_SF2, <span class="comment">/* Sound font 2 format. */</span></div>
|
|
<div class="line"><a name="l00792"></a><span class="lineno"> 792</span>  FMOD_SOUND_TYPE_USER, <span class="comment">/* User created sound. */</span></div>
|
|
<div class="line"><a name="l00793"></a><span class="lineno"> 793</span>  FMOD_SOUND_TYPE_WAV, <span class="comment">/* Microsoft WAV. */</span></div>
|
|
<div class="line"><a name="l00794"></a><span class="lineno"> 794</span>  FMOD_SOUND_TYPE_XM, <span class="comment">/* FastTracker 2 XM. */</span></div>
|
|
<div class="line"><a name="l00795"></a><span class="lineno"> 795</span>  FMOD_SOUND_TYPE_XMA, <span class="comment">/* Xbox360 XMA */</span></div>
|
|
<div class="line"><a name="l00796"></a><span class="lineno"> 796</span>  FMOD_SOUND_TYPE_VAG, <span class="comment">/* PlayStation Portable ADPCM VAG format. */</span></div>
|
|
<div class="line"><a name="l00797"></a><span class="lineno"> 797</span>  FMOD_SOUND_TYPE_AUDIOQUEUE, <span class="comment">/* iPhone hardware decoder, supports AAC, ALAC and MP3. extracodecdata is a pointer to an FMOD_AUDIOQUEUE_EXTRACODECDATA structure. */</span></div>
|
|
<div class="line"><a name="l00798"></a><span class="lineno"> 798</span>  FMOD_SOUND_TYPE_XWMA, <span class="comment">/* Xbox360 XWMA */</span></div>
|
|
<div class="line"><a name="l00799"></a><span class="lineno"> 799</span>  FMOD_SOUND_TYPE_BCWAV, <span class="comment">/* 3DS BCWAV container format for DSP ADPCM and PCM */</span></div>
|
|
<div class="line"><a name="l00800"></a><span class="lineno"> 800</span>  FMOD_SOUND_TYPE_AT9, <span class="comment">/* NGP ATRAC 9 format */</span></div>
|
|
<div class="line"><a name="l00801"></a><span class="lineno"> 801</span>  FMOD_SOUND_TYPE_VORBIS, <span class="comment">/* Raw vorbis */</span></div>
|
|
<div class="line"><a name="l00802"></a><span class="lineno"> 802</span>  FMOD_SOUND_TYPE_MEDIA_FOUNDATION,<span class="comment">/* Microsoft Media Foundation wrappers, supports ASF/WMA */</span></div>
|
|
<div class="line"><a name="l00803"></a><span class="lineno"> 803</span> </div>
|
|
<div class="line"><a name="l00804"></a><span class="lineno"> 804</span>  FMOD_SOUND_TYPE_MAX, <span class="comment">/* Maximum number of sound types supported. */</span></div>
|
|
<div class="line"><a name="l00805"></a><span class="lineno"> 805</span>  FMOD_SOUND_TYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00806"></a><span class="lineno"> 806</span> } FMOD_SOUND_TYPE;</div>
|
|
<div class="line"><a name="l00807"></a><span class="lineno"> 807</span> </div>
|
|
<div class="line"><a name="l00808"></a><span class="lineno"> 808</span> </div>
|
|
<div class="line"><a name="l00809"></a><span class="lineno"> 809</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00810"></a><span class="lineno"> 810</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00811"></a><span class="lineno"> 811</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00812"></a><span class="lineno"> 812</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00813"></a><span class="lineno"> 813</span> <span class="comment"> These definitions describe the native format of the hardware or software buffer that will be used.</span></div>
|
|
<div class="line"><a name="l00814"></a><span class="lineno"> 814</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00815"></a><span class="lineno"> 815</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00816"></a><span class="lineno"> 816</span> <span class="comment"> This is the format the native hardware or software buffer will be or is created in.</span></div>
|
|
<div class="line"><a name="l00817"></a><span class="lineno"> 817</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00818"></a><span class="lineno"> 818</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00819"></a><span class="lineno"> 819</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00820"></a><span class="lineno"> 820</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00821"></a><span class="lineno"> 821</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00822"></a><span class="lineno"> 822</span> <span class="comment"> System::createSound</span></div>
|
|
<div class="line"><a name="l00823"></a><span class="lineno"> 823</span> <span class="comment"> Sound::getFormat</span></div>
|
|
<div class="line"><a name="l00824"></a><span class="lineno"> 824</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00825"></a><span class="lineno"> 825</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00826"></a><span class="lineno"> 826</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00827"></a><span class="lineno"> 827</span> {</div>
|
|
<div class="line"><a name="l00828"></a><span class="lineno"> 828</span>  FMOD_SOUND_FORMAT_NONE, <span class="comment">/* Unitialized / unknown. */</span></div>
|
|
<div class="line"><a name="l00829"></a><span class="lineno"> 829</span>  FMOD_SOUND_FORMAT_PCM8, <span class="comment">/* 8bit integer PCM data. */</span></div>
|
|
<div class="line"><a name="l00830"></a><span class="lineno"> 830</span>  FMOD_SOUND_FORMAT_PCM16, <span class="comment">/* 16bit integer PCM data. */</span></div>
|
|
<div class="line"><a name="l00831"></a><span class="lineno"> 831</span>  FMOD_SOUND_FORMAT_PCM24, <span class="comment">/* 24bit integer PCM data. */</span></div>
|
|
<div class="line"><a name="l00832"></a><span class="lineno"> 832</span>  FMOD_SOUND_FORMAT_PCM32, <span class="comment">/* 32bit integer PCM data. */</span></div>
|
|
<div class="line"><a name="l00833"></a><span class="lineno"> 833</span>  FMOD_SOUND_FORMAT_PCMFLOAT, <span class="comment">/* 32bit floating point PCM data. */</span></div>
|
|
<div class="line"><a name="l00834"></a><span class="lineno"> 834</span>  FMOD_SOUND_FORMAT_GCADPCM, <span class="comment">/* Compressed Nintendo 3DS/Wii DSP data. */</span></div>
|
|
<div class="line"><a name="l00835"></a><span class="lineno"> 835</span>  FMOD_SOUND_FORMAT_IMAADPCM, <span class="comment">/* Compressed IMA ADPCM data. */</span></div>
|
|
<div class="line"><a name="l00836"></a><span class="lineno"> 836</span>  FMOD_SOUND_FORMAT_VAG, <span class="comment">/* Compressed PlayStation Portable ADPCM data. */</span></div>
|
|
<div class="line"><a name="l00837"></a><span class="lineno"> 837</span>  FMOD_SOUND_FORMAT_HEVAG, <span class="comment">/* Compressed PSVita ADPCM data. */</span></div>
|
|
<div class="line"><a name="l00838"></a><span class="lineno"> 838</span>  FMOD_SOUND_FORMAT_XMA, <span class="comment">/* Compressed Xbox360 XMA data. */</span></div>
|
|
<div class="line"><a name="l00839"></a><span class="lineno"> 839</span>  FMOD_SOUND_FORMAT_MPEG, <span class="comment">/* Compressed MPEG layer 2 or 3 data. */</span></div>
|
|
<div class="line"><a name="l00840"></a><span class="lineno"> 840</span>  FMOD_SOUND_FORMAT_CELT, <span class="comment">/* Compressed CELT data. */</span></div>
|
|
<div class="line"><a name="l00841"></a><span class="lineno"> 841</span>  FMOD_SOUND_FORMAT_AT9, <span class="comment">/* Compressed PSVita ATRAC9 data. */</span></div>
|
|
<div class="line"><a name="l00842"></a><span class="lineno"> 842</span>  FMOD_SOUND_FORMAT_XWMA, <span class="comment">/* Compressed Xbox360 xWMA data. */</span></div>
|
|
<div class="line"><a name="l00843"></a><span class="lineno"> 843</span>  FMOD_SOUND_FORMAT_VORBIS, <span class="comment">/* Compressed Vorbis data. */</span></div>
|
|
<div class="line"><a name="l00844"></a><span class="lineno"> 844</span> </div>
|
|
<div class="line"><a name="l00845"></a><span class="lineno"> 845</span>  FMOD_SOUND_FORMAT_MAX, <span class="comment">/* Maximum number of sound formats supported. */</span> </div>
|
|
<div class="line"><a name="l00846"></a><span class="lineno"> 846</span>  FMOD_SOUND_FORMAT_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00847"></a><span class="lineno"> 847</span> } FMOD_SOUND_FORMAT;</div>
|
|
<div class="line"><a name="l00848"></a><span class="lineno"> 848</span> </div>
|
|
<div class="line"><a name="l00849"></a><span class="lineno"> 849</span> </div>
|
|
<div class="line"><a name="l00850"></a><span class="lineno"> 850</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00851"></a><span class="lineno"> 851</span> <span class="comment">[DEFINE]</span></div>
|
|
<div class="line"><a name="l00852"></a><span class="lineno"> 852</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00853"></a><span class="lineno"> 853</span> <span class="comment"> [NAME] </span></div>
|
|
<div class="line"><a name="l00854"></a><span class="lineno"> 854</span> <span class="comment"> FMOD_MODE</span></div>
|
|
<div class="line"><a name="l00855"></a><span class="lineno"> 855</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00856"></a><span class="lineno"> 856</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00857"></a><span class="lineno"> 857</span> <span class="comment"> Sound description bitfields, bitwise OR them together for loading and describing sounds.</span></div>
|
|
<div class="line"><a name="l00858"></a><span class="lineno"> 858</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00859"></a><span class="lineno"> 859</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00860"></a><span class="lineno"> 860</span> <span class="comment"> By default a sound will open as a static sound that is decompressed fully into memory to PCM. (ie equivalent of FMOD_CREATESAMPLE)<br></span></div>
|
|
<div class="line"><a name="l00861"></a><span class="lineno"> 861</span> <span class="comment"> To have a sound stream instead, use FMOD_CREATESTREAM, or use the wrapper function System::createStream.<br></span></div>
|
|
<div class="line"><a name="l00862"></a><span class="lineno"> 862</span> <span class="comment"> Some opening modes (ie FMOD_OPENUSER, FMOD_OPENMEMORY, FMOD_OPENMEMORY_POINT, FMOD_OPENRAW) will need extra information.<br></span></div>
|
|
<div class="line"><a name="l00863"></a><span class="lineno"> 863</span> <span class="comment"> This can be provided using the FMOD_CREATESOUNDEXINFO structure.</span></div>
|
|
<div class="line"><a name="l00864"></a><span class="lineno"> 864</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00865"></a><span class="lineno"> 865</span> <span class="comment"> Specifying FMOD_OPENMEMORY_POINT will POINT to your memory rather allocating its own sound buffers and duplicating it internally.<br></span></div>
|
|
<div class="line"><a name="l00866"></a><span class="lineno"> 866</span> <span class="comment"> <b><u>This means you cannot free the memory while FMOD is using it, until after Sound::release is called.</b></u></span></div>
|
|
<div class="line"><a name="l00867"></a><span class="lineno"> 867</span> <span class="comment"> With FMOD_OPENMEMORY_POINT, for PCM formats, only WAV, FSB, and RAW are supported. For compressed formats, only those formats supported by FMOD_CREATECOMPRESSEDSAMPLE are supported.<br></span></div>
|
|
<div class="line"><a name="l00868"></a><span class="lineno"> 868</span> <span class="comment"> With FMOD_OPENMEMORY_POINT and FMOD_OPENRAW or PCM, if using them together, note that you must pad the data on each side by 16 bytes. This is so fmod can modify the ends of the data for looping/interpolation/mixing purposes. If a wav file, you will need to insert silence, and then reset loop points to stop the playback from playing that silence.<br></span></div>
|
|
<div class="line"><a name="l00869"></a><span class="lineno"> 869</span> <span class="comment"> With FMOD_OPENMEMORY_POINT, For Wii/PSP FMOD_HARDWARE supports this flag for the GCADPCM/VAG formats. On other platforms FMOD_SOFTWARE must be used.<br></span></div>
|
|
<div class="line"><a name="l00870"></a><span class="lineno"> 870</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00871"></a><span class="lineno"> 871</span> <span class="comment"> <b>Xbox 360 memory</b> On Xbox 360 Specifying FMOD_OPENMEMORY_POINT to a virtual memory address will cause FMOD_ERR_INVALID_ADDRESS</span></div>
|
|
<div class="line"><a name="l00872"></a><span class="lineno"> 872</span> <span class="comment"> to be returned. Use physical memory only for this functionality.<br></span></div>
|
|
<div class="line"><a name="l00873"></a><span class="lineno"> 873</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l00874"></a><span class="lineno"> 874</span> <span class="comment"> FMOD_LOWMEM is used on a sound if you want to minimize the memory overhead, by having FMOD not allocate memory for certain </span></div>
|
|
<div class="line"><a name="l00875"></a><span class="lineno"> 875</span> <span class="comment"> features that are not likely to be used in a game environment. These are :<br></span></div>
|
|
<div class="line"><a name="l00876"></a><span class="lineno"> 876</span> <span class="comment"> 1. Sound::getName functionality is removed. 256 bytes per sound is saved.<br></span></div>
|
|
<div class="line"><a name="l00877"></a><span class="lineno"> 877</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00878"></a><span class="lineno"> 878</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00879"></a><span class="lineno"> 879</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00880"></a><span class="lineno"> 880</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00881"></a><span class="lineno"> 881</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00882"></a><span class="lineno"> 882</span> <span class="comment"> System::createSound</span></div>
|
|
<div class="line"><a name="l00883"></a><span class="lineno"> 883</span> <span class="comment"> System::createStream</span></div>
|
|
<div class="line"><a name="l00884"></a><span class="lineno"> 884</span> <span class="comment"> Sound::setMode</span></div>
|
|
<div class="line"><a name="l00885"></a><span class="lineno"> 885</span> <span class="comment"> Sound::getMode</span></div>
|
|
<div class="line"><a name="l00886"></a><span class="lineno"> 886</span> <span class="comment"> Channel::setMode</span></div>
|
|
<div class="line"><a name="l00887"></a><span class="lineno"> 887</span> <span class="comment"> Channel::getMode</span></div>
|
|
<div class="line"><a name="l00888"></a><span class="lineno"> 888</span> <span class="comment"> Sound::set3DCustomRolloff</span></div>
|
|
<div class="line"><a name="l00889"></a><span class="lineno"> 889</span> <span class="comment"> Channel::set3DCustomRolloff</span></div>
|
|
<div class="line"><a name="l00890"></a><span class="lineno"> 890</span> <span class="comment"> Sound::getOpenState</span></div>
|
|
<div class="line"><a name="l00891"></a><span class="lineno"> 891</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00892"></a><span class="lineno"> 892</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00893"></a><span class="lineno"> 893</span> <span class="preprocessor">#define FMOD_DEFAULT 0x00000000 </span><span class="comment">/* Default for all modes listed below. FMOD_LOOP_OFF, FMOD_2D, FMOD_HARDWARE */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00894"></a><span class="lineno"> 894</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_LOOP_OFF 0x00000001 </span><span class="comment">/* For non looping sounds. (DEFAULT). Overrides FMOD_LOOP_NORMAL / FMOD_LOOP_BIDI. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00895"></a><span class="lineno"> 895</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_LOOP_NORMAL 0x00000002 </span><span class="comment">/* For forward looping sounds. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00896"></a><span class="lineno"> 896</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_LOOP_BIDI 0x00000004 </span><span class="comment">/* For bidirectional looping sounds. (only works on software mixed static sounds). */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00897"></a><span class="lineno"> 897</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_2D 0x00000008 </span><span class="comment">/* Ignores any 3d processing. (DEFAULT). */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00898"></a><span class="lineno"> 898</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D 0x00000010 </span><span class="comment">/* Makes the sound positionable in 3D. Overrides FMOD_2D. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00899"></a><span class="lineno"> 899</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_HARDWARE 0x00000020 </span><span class="comment">/* Attempts to make sounds use hardware acceleration. (DEFAULT). Note on platforms that don't support FMOD_HARDWARE (only 3DS, PS Vita, PSP, Wii and Wii U support FMOD_HARDWARE), this will be internally treated as FMOD_SOFTWARE. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00900"></a><span class="lineno"> 900</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_SOFTWARE 0x00000040 </span><span class="comment">/* Makes the sound be mixed by the FMOD CPU based software mixer. Overrides FMOD_HARDWARE. Use this for FFT, DSP, compressed sample support, 2D multi-speaker support and other software related features. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00901"></a><span class="lineno"> 901</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CREATESTREAM 0x00000080 </span><span class="comment">/* Decompress at runtime, streaming from the source provided (ie from disk). Overrides FMOD_CREATESAMPLE and FMOD_CREATECOMPRESSEDSAMPLE. Note a stream can only be played once at a time due to a stream only having 1 stream buffer and file handle. Open multiple streams to have them play concurrently. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00902"></a><span class="lineno"> 902</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CREATESAMPLE 0x00000100 </span><span class="comment">/* Decompress at loadtime, decompressing or decoding whole file into memory as the target sample format (ie PCM). Fastest for FMOD_SOFTWARE based playback and most flexible. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00903"></a><span class="lineno"> 903</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_CREATECOMPRESSEDSAMPLE 0x00000200 </span><span class="comment">/* Load MP2/MP3/IMAADPCM/CELT/Vorbis/AT9 or XMA into memory and leave it compressed. CELT/Vorbis/AT9 encoding only supported in the FSB file format. During playback the FMOD software mixer will decode it in realtime as a 'compressed sample'. Can only be used in combination with FMOD_SOFTWARE. Overrides FMOD_CREATESAMPLE. If the sound data is not one of the supported formats, it will behave as if it was created with FMOD_CREATESAMPLE and decode the sound into PCM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00904"></a><span class="lineno"> 904</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_OPENUSER 0x00000400 </span><span class="comment">/* Opens a user created static sample or stream. Use FMOD_CREATESOUNDEXINFO to specify format and/or read callbacks. If a user created 'sample' is created with no read callback, the sample will be empty. Use Sound::lock and Sound::unlock to place sound data into the sound if this is the case. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00905"></a><span class="lineno"> 905</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_OPENMEMORY 0x00000800 </span><span class="comment">/* "name_or_data" will be interpreted as a pointer to memory instead of filename for creating sounds. Use FMOD_CREATESOUNDEXINFO to specify length. If used with FMOD_CREATESAMPLE or FMOD_CREATECOMPRESSEDSAMPLE, FMOD duplicates the memory into its own buffers. Your own buffer can be freed after open. If used with FMOD_CREATESTREAM, FMOD will stream out of the buffer whose pointer you passed in. In this case, your own buffer should not be freed until you have finished with and released the stream.*/</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00906"></a><span class="lineno"> 906</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_OPENMEMORY_POINT 0x10000000 </span><span class="comment">/* "name_or_data" will be interpreted as a pointer to memory instead of filename for creating sounds. Use FMOD_CREATESOUNDEXINFO to specify length. This differs to FMOD_OPENMEMORY in that it uses the memory as is, without duplicating the memory into its own buffers. For Wii/PSP FMOD_HARDWARE supports this flag for the GCADPCM/VAG formats. On other platforms FMOD_SOFTWARE must be used, as sound hardware on the other platforms (ie PC) cannot access main ram. Cannot be freed after open, only after Sound::release. Will not work if the data is compressed and FMOD_CREATECOMPRESSEDSAMPLE is not used. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00907"></a><span class="lineno"> 907</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_OPENRAW 0x00001000 </span><span class="comment">/* Will ignore file format and treat as raw pcm. Use FMOD_CREATESOUNDEXINFO to specify format. Requires at least defaultfrequency, numchannels and format to be specified before it will open. Must be little endian data. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00908"></a><span class="lineno"> 908</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_OPENONLY 0x00002000 </span><span class="comment">/* Just open the file, dont prebuffer or read. Good for fast opens for info, or when sound::readData is to be used. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00909"></a><span class="lineno"> 909</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_ACCURATETIME 0x00004000 </span><span class="comment">/* For System::createSound - for accurate Sound::getLength/Channel::setPosition on VBR MP3, and MOD/S3M/XM/IT/MIDI files. Scans file first, so takes longer to open. FMOD_OPENONLY does not affect this. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00910"></a><span class="lineno"> 910</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_MPEGSEARCH 0x00008000 </span><span class="comment">/* For corrupted / bad MP3 files. This will search all the way through the file until it hits a valid MPEG header. Normally only searches for 4k. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00911"></a><span class="lineno"> 911</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_NONBLOCKING 0x00010000 </span><span class="comment">/* For opening sounds and getting streamed subsounds (seeking) asyncronously. Use Sound::getOpenState to poll the state of the sound as it opens or retrieves the subsound in the background. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00912"></a><span class="lineno"> 912</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_UNIQUE 0x00020000 </span><span class="comment">/* Unique sound, can only be played one at a time */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00913"></a><span class="lineno"> 913</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D_HEADRELATIVE 0x00040000 </span><span class="comment">/* Make the sound's position, velocity and orientation relative to the listener. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00914"></a><span class="lineno"> 914</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D_WORLDRELATIVE 0x00080000 </span><span class="comment">/* Make the sound's position, velocity and orientation absolute (relative to the world). (DEFAULT) */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00915"></a><span class="lineno"> 915</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D_INVERSEROLLOFF 0x00100000 </span><span class="comment">/* This sound will follow the inverse rolloff model where mindistance = full volume, maxdistance = where sound stops attenuating, and rolloff is fixed according to the global rolloff factor. (DEFAULT) */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00916"></a><span class="lineno"> 916</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D_LINEARROLLOFF 0x00200000 </span><span class="comment">/* This sound will follow a linear rolloff model where mindistance = full volume, maxdistance = silence. Rolloffscale is ignored. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00917"></a><span class="lineno"> 917</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D_LINEARSQUAREROLLOFF 0x00400000 </span><span class="comment">/* This sound will follow a linear-square rolloff model where mindistance = full volume, maxdistance = silence. Rolloffscale is ignored. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00918"></a><span class="lineno"> 918</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D_CUSTOMROLLOFF 0x04000000 </span><span class="comment">/* This sound will follow a rolloff model defined by Sound::set3DCustomRolloff / Channel::set3DCustomRolloff. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00919"></a><span class="lineno"> 919</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_3D_IGNOREGEOMETRY 0x40000000 </span><span class="comment">/* Is not affect by geometry occlusion. If not specified in Sound::setMode, or Channel::setMode, the flag is cleared and it is affected by geometry again. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00920"></a><span class="lineno"> 920</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_UNICODE 0x01000000 </span><span class="comment">/* Filename is double-byte unicode. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00921"></a><span class="lineno"> 921</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_IGNORETAGS 0x02000000 </span><span class="comment">/* Skips id3v2/asf/etc tag checks when opening a sound, to reduce seek/read overhead when opening files (helps with CD performance). */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00922"></a><span class="lineno"> 922</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_LOWMEM 0x08000000 </span><span class="comment">/* Removes some features from samples to give a lower memory overhead, like Sound::getName. See remarks. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00923"></a><span class="lineno"> 923</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_LOADSECONDARYRAM 0x20000000 </span><span class="comment">/* Load sound into the secondary RAM of supported platform. On PS3, sounds will be loaded into RSX/VRAM. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00924"></a><span class="lineno"> 924</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_VIRTUAL_PLAYFROMSTART 0x80000000 </span><span class="comment">/* For sounds that start virtual (due to being quiet or low importance), instead of swapping back to audible, and playing at the correct offset according to time, this flag makes the sound play from the start. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00925"></a><span class="lineno"> 925</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l00926"></a><span class="lineno"> 926</span> <span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l00927"></a><span class="lineno"> 927</span> </div>
|
|
<div class="line"><a name="l00928"></a><span class="lineno"> 928</span> </div>
|
|
<div class="line"><a name="l00929"></a><span class="lineno"> 929</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00930"></a><span class="lineno"> 930</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00931"></a><span class="lineno"> 931</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00932"></a><span class="lineno"> 932</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00933"></a><span class="lineno"> 933</span> <span class="comment"> These values describe what state a sound is in after FMOD_NONBLOCKING has been used to open it.</span></div>
|
|
<div class="line"><a name="l00934"></a><span class="lineno"> 934</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00935"></a><span class="lineno"> 935</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00936"></a><span class="lineno"> 936</span> <span class="comment"> With streams, if you are using FMOD_NONBLOCKING, note that if the user calls Sound::getSubSound, a stream will go into FMOD_OPENSTATE_SEEKING state and sound related commands will return FMOD_ERR_NOTREADY.<br></span></div>
|
|
<div class="line"><a name="l00937"></a><span class="lineno"> 937</span> <span class="comment"> With streams, if you are using FMOD_NONBLOCKING, note that if the user calls Channel::getPosition, a stream will go into FMOD_OPENSTATE_SETPOSITION state and sound related commands will return FMOD_ERR_NOTREADY.<br></span></div>
|
|
<div class="line"><a name="l00938"></a><span class="lineno"> 938</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00939"></a><span class="lineno"> 939</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00940"></a><span class="lineno"> 940</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00941"></a><span class="lineno"> 941</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00942"></a><span class="lineno"> 942</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l00943"></a><span class="lineno"> 943</span> <span class="comment"> Sound::getOpenState</span></div>
|
|
<div class="line"><a name="l00944"></a><span class="lineno"> 944</span> <span class="comment"> FMOD_MODE</span></div>
|
|
<div class="line"><a name="l00945"></a><span class="lineno"> 945</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00946"></a><span class="lineno"> 946</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00947"></a><span class="lineno"> 947</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l00948"></a><span class="lineno"> 948</span> {</div>
|
|
<div class="line"><a name="l00949"></a><span class="lineno"> 949</span>  FMOD_OPENSTATE_READY = 0, <span class="comment">/* Opened and ready to play. */</span></div>
|
|
<div class="line"><a name="l00950"></a><span class="lineno"> 950</span>  FMOD_OPENSTATE_LOADING, <span class="comment">/* Initial load in progress. */</span></div>
|
|
<div class="line"><a name="l00951"></a><span class="lineno"> 951</span>  FMOD_OPENSTATE_ERROR, <span class="comment">/* Failed to open - file not found, out of memory etc. See return value of Sound::getOpenState for what happened. */</span></div>
|
|
<div class="line"><a name="l00952"></a><span class="lineno"> 952</span>  FMOD_OPENSTATE_CONNECTING, <span class="comment">/* Connecting to remote host (internet sounds only). */</span></div>
|
|
<div class="line"><a name="l00953"></a><span class="lineno"> 953</span>  FMOD_OPENSTATE_BUFFERING, <span class="comment">/* Buffering data. */</span></div>
|
|
<div class="line"><a name="l00954"></a><span class="lineno"> 954</span>  FMOD_OPENSTATE_SEEKING, <span class="comment">/* Seeking to subsound and re-flushing stream buffer. */</span></div>
|
|
<div class="line"><a name="l00955"></a><span class="lineno"> 955</span>  FMOD_OPENSTATE_PLAYING, <span class="comment">/* Ready and playing, but not possible to release at this time without stalling the main thread. */</span></div>
|
|
<div class="line"><a name="l00956"></a><span class="lineno"> 956</span>  FMOD_OPENSTATE_SETPOSITION, <span class="comment">/* Seeking within a stream to a different position. */</span></div>
|
|
<div class="line"><a name="l00957"></a><span class="lineno"> 957</span> </div>
|
|
<div class="line"><a name="l00958"></a><span class="lineno"> 958</span>  FMOD_OPENSTATE_MAX, <span class="comment">/* Maximum number of open state types. */</span></div>
|
|
<div class="line"><a name="l00959"></a><span class="lineno"> 959</span>  FMOD_OPENSTATE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00960"></a><span class="lineno"> 960</span> } FMOD_OPENSTATE;</div>
|
|
<div class="line"><a name="l00961"></a><span class="lineno"> 961</span> </div>
|
|
<div class="line"><a name="l00962"></a><span class="lineno"> 962</span> </div>
|
|
<div class="line"><a name="l00963"></a><span class="lineno"> 963</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00964"></a><span class="lineno"> 964</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00965"></a><span class="lineno"> 965</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l00966"></a><span class="lineno"> 966</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l00967"></a><span class="lineno"> 967</span> <span class="comment"> These flags are used with SoundGroup::setMaxAudibleBehavior to determine what happens when more sounds </span></div>
|
|
<div class="line"><a name="l00968"></a><span class="lineno"> 968</span> <span class="comment"> are played than are specified with SoundGroup::setMaxAudible.</span></div>
|
|
<div class="line"><a name="l00969"></a><span class="lineno"> 969</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00970"></a><span class="lineno"> 970</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l00971"></a><span class="lineno"> 971</span> <span class="comment"> When using FMOD_SOUNDGROUP_BEHAVIOR_MUTE, SoundGroup::setMuteFadeSpeed can be used to stop a sudden transition. </span></div>
|
|
<div class="line"><a name="l00972"></a><span class="lineno"> 972</span> <span class="comment"> Instead, the time specified will be used to cross fade between the sounds that go silent and the ones that become audible.</span></div>
|
|
<div class="line"><a name="l00973"></a><span class="lineno"> 973</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00974"></a><span class="lineno"> 974</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l00975"></a><span class="lineno"> 975</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l00976"></a><span class="lineno"> 976</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l00977"></a><span class="lineno"> 977</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l00978"></a><span class="lineno"> 978</span> <span class="comment"> SoundGroup::setMaxAudibleBehavior</span></div>
|
|
<div class="line"><a name="l00979"></a><span class="lineno"> 979</span> <span class="comment"> SoundGroup::getMaxAudibleBehavior</span></div>
|
|
<div class="line"><a name="l00980"></a><span class="lineno"> 980</span> <span class="comment"> SoundGroup::setMaxAudible</span></div>
|
|
<div class="line"><a name="l00981"></a><span class="lineno"> 981</span> <span class="comment"> SoundGroup::getMaxAudible</span></div>
|
|
<div class="line"><a name="l00982"></a><span class="lineno"> 982</span> <span class="comment"> SoundGroup::setMuteFadeSpeed</span></div>
|
|
<div class="line"><a name="l00983"></a><span class="lineno"> 983</span> <span class="comment"> SoundGroup::getMuteFadeSpeed</span></div>
|
|
<div class="line"><a name="l00984"></a><span class="lineno"> 984</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l00985"></a><span class="lineno"> 985</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00986"></a><span class="lineno"> 986</span> <span class="keyword">typedef</span> <span class="keyword">enum</span> </div>
|
|
<div class="line"><a name="l00987"></a><span class="lineno"> 987</span> {</div>
|
|
<div class="line"><a name="l00988"></a><span class="lineno"> 988</span>  FMOD_SOUNDGROUP_BEHAVIOR_FAIL, <span class="comment">/* Any sound played that puts the sound count over the SoundGroup::setMaxAudible setting, will simply fail during System::playSound. */</span></div>
|
|
<div class="line"><a name="l00989"></a><span class="lineno"> 989</span>  FMOD_SOUNDGROUP_BEHAVIOR_MUTE, <span class="comment">/* Any sound played that puts the sound count over the SoundGroup::setMaxAudible setting, will be silent, then if another sound in the group stops the sound that was silent before becomes audible again. */</span></div>
|
|
<div class="line"><a name="l00990"></a><span class="lineno"> 990</span>  FMOD_SOUNDGROUP_BEHAVIOR_STEALLOWEST, <span class="comment">/* Any sound played that puts the sound count over the SoundGroup::setMaxAudible setting, will steal the quietest / least important sound playing in the group. */</span></div>
|
|
<div class="line"><a name="l00991"></a><span class="lineno"> 991</span> </div>
|
|
<div class="line"><a name="l00992"></a><span class="lineno"> 992</span>  FMOD_SOUNDGROUP_BEHAVIOR_MAX, <span class="comment">/* Maximum number of open state types. */</span></div>
|
|
<div class="line"><a name="l00993"></a><span class="lineno"> 993</span>  FMOD_SOUNDGROUP_BEHAVIOR_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l00994"></a><span class="lineno"> 994</span> } FMOD_SOUNDGROUP_BEHAVIOR;</div>
|
|
<div class="line"><a name="l00995"></a><span class="lineno"> 995</span> </div>
|
|
<div class="line"><a name="l00996"></a><span class="lineno"> 996</span> </div>
|
|
<div class="line"><a name="l00997"></a><span class="lineno"> 997</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00998"></a><span class="lineno"> 998</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l00999"></a><span class="lineno"> 999</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01000"></a><span class="lineno"> 1000</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01001"></a><span class="lineno"> 1001</span> <span class="comment"> These callback types are used with Channel::setCallback.</span></div>
|
|
<div class="line"><a name="l01002"></a><span class="lineno"> 1002</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01003"></a><span class="lineno"> 1003</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01004"></a><span class="lineno"> 1004</span> <span class="comment"> Each callback has commanddata parameters passed as int unique to the type of callback.<br></span></div>
|
|
<div class="line"><a name="l01005"></a><span class="lineno"> 1005</span> <span class="comment"> See reference to FMOD_CHANNEL_CALLBACK to determine what they might mean for each type of callback.<br></span></div>
|
|
<div class="line"><a name="l01006"></a><span class="lineno"> 1006</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01007"></a><span class="lineno"> 1007</span> <span class="comment"> <b>Note!</b> Currently the user must call System::update for these callbacks to trigger!</span></div>
|
|
<div class="line"><a name="l01008"></a><span class="lineno"> 1008</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01009"></a><span class="lineno"> 1009</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01010"></a><span class="lineno"> 1010</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01011"></a><span class="lineno"> 1011</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01012"></a><span class="lineno"> 1012</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01013"></a><span class="lineno"> 1013</span> <span class="comment"> Channel::setCallback</span></div>
|
|
<div class="line"><a name="l01014"></a><span class="lineno"> 1014</span> <span class="comment"> FMOD_CHANNEL_CALLBACK</span></div>
|
|
<div class="line"><a name="l01015"></a><span class="lineno"> 1015</span> <span class="comment"> System::update</span></div>
|
|
<div class="line"><a name="l01016"></a><span class="lineno"> 1016</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01017"></a><span class="lineno"> 1017</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01018"></a><span class="lineno"> 1018</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01019"></a><span class="lineno"> 1019</span> {</div>
|
|
<div class="line"><a name="l01020"></a><span class="lineno"> 1020</span>  FMOD_CHANNEL_CALLBACKTYPE_END, <span class="comment">/* Called when a sound ends. */</span></div>
|
|
<div class="line"><a name="l01021"></a><span class="lineno"> 1021</span>  FMOD_CHANNEL_CALLBACKTYPE_VIRTUALVOICE, <span class="comment">/* Called when a voice is swapped out or swapped in. */</span></div>
|
|
<div class="line"><a name="l01022"></a><span class="lineno"> 1022</span>  FMOD_CHANNEL_CALLBACKTYPE_SYNCPOINT, <span class="comment">/* Called when a syncpoint is encountered. Can be from wav file markers. */</span></div>
|
|
<div class="line"><a name="l01023"></a><span class="lineno"> 1023</span>  FMOD_CHANNEL_CALLBACKTYPE_OCCLUSION, <span class="comment">/* Called when the channel has its geometry occlusion value calculated. Can be used to clamp or change the value. */</span></div>
|
|
<div class="line"><a name="l01024"></a><span class="lineno"> 1024</span> </div>
|
|
<div class="line"><a name="l01025"></a><span class="lineno"> 1025</span>  FMOD_CHANNEL_CALLBACKTYPE_MAX, <span class="comment">/* Maximum number of callback types supported. */</span></div>
|
|
<div class="line"><a name="l01026"></a><span class="lineno"> 1026</span>  FMOD_CHANNEL_CALLBACKTYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l01027"></a><span class="lineno"> 1027</span> } FMOD_CHANNEL_CALLBACKTYPE;</div>
|
|
<div class="line"><a name="l01028"></a><span class="lineno"> 1028</span> </div>
|
|
<div class="line"><a name="l01029"></a><span class="lineno"> 1029</span> </div>
|
|
<div class="line"><a name="l01030"></a><span class="lineno"> 1030</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01031"></a><span class="lineno"> 1031</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01032"></a><span class="lineno"> 1032</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01033"></a><span class="lineno"> 1033</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01034"></a><span class="lineno"> 1034</span> <span class="comment"> These callback types are used with System::setCallback.</span></div>
|
|
<div class="line"><a name="l01035"></a><span class="lineno"> 1035</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01036"></a><span class="lineno"> 1036</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01037"></a><span class="lineno"> 1037</span> <span class="comment"> Each callback has commanddata parameters passed as void* unique to the type of callback.<br></span></div>
|
|
<div class="line"><a name="l01038"></a><span class="lineno"> 1038</span> <span class="comment"> See reference to FMOD_SYSTEM_CALLBACK to determine what they might mean for each type of callback.<br></span></div>
|
|
<div class="line"><a name="l01039"></a><span class="lineno"> 1039</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01040"></a><span class="lineno"> 1040</span> <span class="comment"> <b>Note!</b> Using FMOD_SYSTEM_CALLBACKTYPE_DEVICELISTCHANGED (on Mac only) requires the application to be running an event loop which will allow external changes to device list to be detected by FMOD.</span></div>
|
|
<div class="line"><a name="l01041"></a><span class="lineno"> 1041</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01042"></a><span class="lineno"> 1042</span> <span class="comment"> <b>Note!</b> The 'system' object pointer will be null for FMOD_SYSTEM_CALLBACKTYPE_MEMORYALLOCATIONFAILED callback.</span></div>
|
|
<div class="line"><a name="l01043"></a><span class="lineno"> 1043</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01044"></a><span class="lineno"> 1044</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01045"></a><span class="lineno"> 1045</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01046"></a><span class="lineno"> 1046</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01047"></a><span class="lineno"> 1047</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01048"></a><span class="lineno"> 1048</span> <span class="comment"> System::setCallback</span></div>
|
|
<div class="line"><a name="l01049"></a><span class="lineno"> 1049</span> <span class="comment"> FMOD_SYSTEM_CALLBACK</span></div>
|
|
<div class="line"><a name="l01050"></a><span class="lineno"> 1050</span> <span class="comment"> System::update</span></div>
|
|
<div class="line"><a name="l01051"></a><span class="lineno"> 1051</span> <span class="comment"> DSP::addInput</span></div>
|
|
<div class="line"><a name="l01052"></a><span class="lineno"> 1052</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01053"></a><span class="lineno"> 1053</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01054"></a><span class="lineno"> 1054</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01055"></a><span class="lineno"> 1055</span> {</div>
|
|
<div class="line"><a name="l01056"></a><span class="lineno"> 1056</span>  FMOD_SYSTEM_CALLBACKTYPE_DEVICELISTCHANGED, <span class="comment">/* Called from System::update when the enumerated list of devices has changed. */</span></div>
|
|
<div class="line"><a name="l01057"></a><span class="lineno"> 1057</span>  FMOD_SYSTEM_CALLBACKTYPE_DEVICELOST, <span class="comment">/* Called from System::update when an output device has been lost due to control panel parameter changes and FMOD cannot automatically recover. */</span></div>
|
|
<div class="line"><a name="l01058"></a><span class="lineno"> 1058</span>  FMOD_SYSTEM_CALLBACKTYPE_MEMORYALLOCATIONFAILED, <span class="comment">/* Called directly when a memory allocation fails somewhere in FMOD. (NOTE - 'system' will be NULL in this callback type.)*/</span></div>
|
|
<div class="line"><a name="l01059"></a><span class="lineno"> 1059</span>  FMOD_SYSTEM_CALLBACKTYPE_THREADCREATED, <span class="comment">/* Called directly when a thread is created. */</span></div>
|
|
<div class="line"><a name="l01060"></a><span class="lineno"> 1060</span>  FMOD_SYSTEM_CALLBACKTYPE_BADDSPCONNECTION, <span class="comment">/* Called when a bad connection was made with DSP::addInput. Usually called from mixer thread because that is where the connections are made. */</span></div>
|
|
<div class="line"><a name="l01061"></a><span class="lineno"> 1061</span>  FMOD_SYSTEM_CALLBACKTYPE_BADDSPLEVEL, <span class="comment">/* Called when too many effects were added exceeding the maximum tree depth of 128. This is most likely caused by accidentally adding too many DSP effects. Usually called from mixer thread because that is where the connections are made. */</span></div>
|
|
<div class="line"><a name="l01062"></a><span class="lineno"> 1062</span>  FMOD_SYSTEM_CALLBACKTYPE_THREADDESTROYED, <span class="comment">/* Called directly when a thread is destroyed. */</span></div>
|
|
<div class="line"><a name="l01063"></a><span class="lineno"> 1063</span> </div>
|
|
<div class="line"><a name="l01064"></a><span class="lineno"> 1064</span>  FMOD_SYSTEM_CALLBACKTYPE_MAX, <span class="comment">/* Maximum number of callback types supported. */</span></div>
|
|
<div class="line"><a name="l01065"></a><span class="lineno"> 1065</span>  FMOD_SYSTEM_CALLBACKTYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l01066"></a><span class="lineno"> 1066</span> } FMOD_SYSTEM_CALLBACKTYPE;</div>
|
|
<div class="line"><a name="l01067"></a><span class="lineno"> 1067</span> </div>
|
|
<div class="line"><a name="l01068"></a><span class="lineno"> 1068</span> </div>
|
|
<div class="line"><a name="l01069"></a><span class="lineno"> 1069</span> <span class="comment">/* </span></div>
|
|
<div class="line"><a name="l01070"></a><span class="lineno"> 1070</span> <span class="comment"> FMOD Callbacks</span></div>
|
|
<div class="line"><a name="l01071"></a><span class="lineno"> 1071</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01072"></a><span class="lineno"> 1072</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_SYSTEM_CALLBACK) (FMOD_SYSTEM *system, FMOD_SYSTEM_CALLBACKTYPE type, <span class="keywordtype">void</span> *commanddata1, <span class="keywordtype">void</span> *commanddata2);</div>
|
|
<div class="line"><a name="l01073"></a><span class="lineno"> 1073</span> </div>
|
|
<div class="line"><a name="l01074"></a><span class="lineno"> 1074</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_CHANNEL_CALLBACK) (FMOD_CHANNEL *channel, FMOD_CHANNEL_CALLBACKTYPE type, <span class="keywordtype">void</span> *commanddata1, <span class="keywordtype">void</span> *commanddata2);</div>
|
|
<div class="line"><a name="l01075"></a><span class="lineno"> 1075</span> </div>
|
|
<div class="line"><a name="l01076"></a><span class="lineno"> 1076</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_SOUND_NONBLOCKCALLBACK)(FMOD_SOUND *sound, FMOD_RESULT result);</div>
|
|
<div class="line"><a name="l01077"></a><span class="lineno"> 1077</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_SOUND_PCMREADCALLBACK)(FMOD_SOUND *sound, <span class="keywordtype">void</span> *data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> datalen);</div>
|
|
<div class="line"><a name="l01078"></a><span class="lineno"> 1078</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_SOUND_PCMSETPOSCALLBACK)(FMOD_SOUND *sound, <span class="keywordtype">int</span> subsound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> position, FMOD_TIMEUNIT postype);</div>
|
|
<div class="line"><a name="l01079"></a><span class="lineno"> 1079</span> </div>
|
|
<div class="line"><a name="l01080"></a><span class="lineno"> 1080</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_FILE_OPENCALLBACK) (<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> unicode, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *filesize, <span class="keywordtype">void</span> **handle, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l01081"></a><span class="lineno"> 1081</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_FILE_CLOSECALLBACK) (<span class="keywordtype">void</span> *handle, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l01082"></a><span class="lineno"> 1082</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_FILE_READCALLBACK) (<span class="keywordtype">void</span> *handle, <span class="keywordtype">void</span> *buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> sizebytes, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bytesread, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l01083"></a><span class="lineno"> 1083</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_FILE_SEEKCALLBACK) (<span class="keywordtype">void</span> *handle, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pos, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l01084"></a><span class="lineno"> 1084</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_FILE_ASYNCREADCALLBACK)(<a class="code" href="struct_f_m_o_d___a_s_y_n_c_r_e_a_d_i_n_f_o.html">FMOD_ASYNCREADINFO</a> *info, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l01085"></a><span class="lineno"> 1085</span> <span class="keyword">typedef</span> FMOD_RESULT (F_CALLBACK *FMOD_FILE_ASYNCCANCELCALLBACK)(<span class="keywordtype">void</span> *handle, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l01086"></a><span class="lineno"> 1086</span> </div>
|
|
<div class="line"><a name="l01087"></a><span class="lineno"> 1087</span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> * (F_CALLBACK *FMOD_MEMORY_ALLOCCALLBACK) (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, FMOD_MEMORY_TYPE type, <span class="keyword">const</span> <span class="keywordtype">char</span> *sourcestr);</div>
|
|
<div class="line"><a name="l01088"></a><span class="lineno"> 1088</span> <span class="keyword">typedef</span> <span class="keywordtype">void</span> * (F_CALLBACK *FMOD_MEMORY_REALLOCCALLBACK)(<span class="keywordtype">void</span> *ptr, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size, FMOD_MEMORY_TYPE type, <span class="keyword">const</span> <span class="keywordtype">char</span> *sourcestr);</div>
|
|
<div class="line"><a name="l01089"></a><span class="lineno"> 1089</span> <span class="keyword">typedef</span> void (F_CALLBACK *FMOD_MEMORY_FREECALLBACK) (<span class="keywordtype">void</span> *ptr, FMOD_MEMORY_TYPE type, <span class="keyword">const</span> <span class="keywordtype">char</span> *sourcestr);</div>
|
|
<div class="line"><a name="l01090"></a><span class="lineno"> 1090</span> </div>
|
|
<div class="line"><a name="l01091"></a><span class="lineno"> 1091</span> <span class="keyword">typedef</span> float (F_CALLBACK *FMOD_3D_ROLLOFFCALLBACK) (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> distance);</div>
|
|
<div class="line"><a name="l01092"></a><span class="lineno"> 1092</span> </div>
|
|
<div class="line"><a name="l01093"></a><span class="lineno"> 1093</span> </div>
|
|
<div class="line"><a name="l01094"></a><span class="lineno"> 1094</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01095"></a><span class="lineno"> 1095</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01096"></a><span class="lineno"> 1096</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01097"></a><span class="lineno"> 1097</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01098"></a><span class="lineno"> 1098</span> <span class="comment"> List of windowing methods used in spectrum analysis to reduce leakage / transient signals intefering with the analysis.<br></span></div>
|
|
<div class="line"><a name="l01099"></a><span class="lineno"> 1099</span> <span class="comment"> This is a problem with analysis of continuous signals that only have a small portion of the signal sample (the fft window size).<br></span></div>
|
|
<div class="line"><a name="l01100"></a><span class="lineno"> 1100</span> <span class="comment"> Windowing the signal with a curve or triangle tapers the sides of the fft window to help alleviate this problem.</span></div>
|
|
<div class="line"><a name="l01101"></a><span class="lineno"> 1101</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01102"></a><span class="lineno"> 1102</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01103"></a><span class="lineno"> 1103</span> <span class="comment"> Cyclic signals such as a sine wave that repeat their cycle in a multiple of the window size do not need windowing.<br></span></div>
|
|
<div class="line"><a name="l01104"></a><span class="lineno"> 1104</span> <span class="comment"> I.e. If the sine wave repeats every 1024, 512, 256 etc samples and the FMOD fft window is 1024, then the signal would not need windowing.<br></span></div>
|
|
<div class="line"><a name="l01105"></a><span class="lineno"> 1105</span> <span class="comment"> Not windowing is the same as FMOD_DSP_FFT_WINDOW_RECT, which is the default.<br></span></div>
|
|
<div class="line"><a name="l01106"></a><span class="lineno"> 1106</span> <span class="comment"> If the cycle of the signal (ie the sine wave) is not a multiple of the window size, it will cause frequency abnormalities, so a different windowing method is needed.<br></span></div>
|
|
<div class="line"><a name="l01107"></a><span class="lineno"> 1107</span> <span class="comment"> <exclude></span></div>
|
|
<div class="line"><a name="l01108"></a><span class="lineno"> 1108</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01109"></a><span class="lineno"> 1109</span> <span class="comment"> FMOD_DSP_FFT_WINDOW_RECT.<br></span></div>
|
|
<div class="line"><a name="l01110"></a><span class="lineno"> 1110</span> <span class="comment"> <img src="..\static\rectangle.gif"></img><br></span></div>
|
|
<div class="line"><a name="l01111"></a><span class="lineno"> 1111</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01112"></a><span class="lineno"> 1112</span> <span class="comment"> FMOD_DSP_FFT_WINDOW_TRIANGLE.<br></span></div>
|
|
<div class="line"><a name="l01113"></a><span class="lineno"> 1113</span> <span class="comment"> <img src="..\static\triangle.gif"></img><br></span></div>
|
|
<div class="line"><a name="l01114"></a><span class="lineno"> 1114</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01115"></a><span class="lineno"> 1115</span> <span class="comment"> FMOD_DSP_FFT_WINDOW_HAMMING.<br></span></div>
|
|
<div class="line"><a name="l01116"></a><span class="lineno"> 1116</span> <span class="comment"> <img src="..\static\hamming.gif"></img><br></span></div>
|
|
<div class="line"><a name="l01117"></a><span class="lineno"> 1117</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01118"></a><span class="lineno"> 1118</span> <span class="comment"> FMOD_DSP_FFT_WINDOW_HANNING.<br></span></div>
|
|
<div class="line"><a name="l01119"></a><span class="lineno"> 1119</span> <span class="comment"> <img src="..\static\hanning.gif"></img><br></span></div>
|
|
<div class="line"><a name="l01120"></a><span class="lineno"> 1120</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01121"></a><span class="lineno"> 1121</span> <span class="comment"> FMOD_DSP_FFT_WINDOW_BLACKMAN.<br></span></div>
|
|
<div class="line"><a name="l01122"></a><span class="lineno"> 1122</span> <span class="comment"> <img src="..\static\blackman.gif"></img><br></span></div>
|
|
<div class="line"><a name="l01123"></a><span class="lineno"> 1123</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01124"></a><span class="lineno"> 1124</span> <span class="comment"> FMOD_DSP_FFT_WINDOW_BLACKMANHARRIS.<br></span></div>
|
|
<div class="line"><a name="l01125"></a><span class="lineno"> 1125</span> <span class="comment"> <img src="..\static\blackmanharris.gif"></img></span></div>
|
|
<div class="line"><a name="l01126"></a><span class="lineno"> 1126</span> <span class="comment"> </exclude></span></div>
|
|
<div class="line"><a name="l01127"></a><span class="lineno"> 1127</span> <span class="comment"> </span></div>
|
|
<div class="line"><a name="l01128"></a><span class="lineno"> 1128</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01129"></a><span class="lineno"> 1129</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01130"></a><span class="lineno"> 1130</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01131"></a><span class="lineno"> 1131</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01132"></a><span class="lineno"> 1132</span> <span class="comment"> System::getSpectrum</span></div>
|
|
<div class="line"><a name="l01133"></a><span class="lineno"> 1133</span> <span class="comment"> Channel::getSpectrum</span></div>
|
|
<div class="line"><a name="l01134"></a><span class="lineno"> 1134</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01135"></a><span class="lineno"> 1135</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01136"></a><span class="lineno"> 1136</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01137"></a><span class="lineno"> 1137</span> {</div>
|
|
<div class="line"><a name="l01138"></a><span class="lineno"> 1138</span>  FMOD_DSP_FFT_WINDOW_RECT, <span class="comment">/* w[n] = 1.0 */</span></div>
|
|
<div class="line"><a name="l01139"></a><span class="lineno"> 1139</span>  FMOD_DSP_FFT_WINDOW_TRIANGLE, <span class="comment">/* w[n] = TRI(2n/N) */</span></div>
|
|
<div class="line"><a name="l01140"></a><span class="lineno"> 1140</span>  FMOD_DSP_FFT_WINDOW_HAMMING, <span class="comment">/* w[n] = 0.54 - (0.46 * COS(n/N) ) */</span></div>
|
|
<div class="line"><a name="l01141"></a><span class="lineno"> 1141</span>  FMOD_DSP_FFT_WINDOW_HANNING, <span class="comment">/* w[n] = 0.5 * (1.0 - COS(n/N) ) */</span></div>
|
|
<div class="line"><a name="l01142"></a><span class="lineno"> 1142</span>  FMOD_DSP_FFT_WINDOW_BLACKMAN, <span class="comment">/* w[n] = 0.42 - (0.5 * COS(n/N) ) + (0.08 * COS(2.0 * n/N) ) */</span></div>
|
|
<div class="line"><a name="l01143"></a><span class="lineno"> 1143</span>  FMOD_DSP_FFT_WINDOW_BLACKMANHARRIS, <span class="comment">/* w[n] = 0.35875 - (0.48829 * COS(1.0 * n/N)) + (0.14128 * COS(2.0 * n/N)) - (0.01168 * COS(3.0 * n/N)) */</span></div>
|
|
<div class="line"><a name="l01144"></a><span class="lineno"> 1144</span>  </div>
|
|
<div class="line"><a name="l01145"></a><span class="lineno"> 1145</span>  FMOD_DSP_FFT_WINDOW_MAX, <span class="comment">/* Maximum number of FFT window types supported. */</span></div>
|
|
<div class="line"><a name="l01146"></a><span class="lineno"> 1146</span>  FMOD_DSP_FFT_WINDOW_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l01147"></a><span class="lineno"> 1147</span> } FMOD_DSP_FFT_WINDOW;</div>
|
|
<div class="line"><a name="l01148"></a><span class="lineno"> 1148</span> </div>
|
|
<div class="line"><a name="l01149"></a><span class="lineno"> 1149</span> </div>
|
|
<div class="line"><a name="l01150"></a><span class="lineno"> 1150</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01151"></a><span class="lineno"> 1151</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01152"></a><span class="lineno"> 1152</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01153"></a><span class="lineno"> 1153</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01154"></a><span class="lineno"> 1154</span> <span class="comment"> List of interpolation types that the FMOD Ex software mixer supports. </span></div>
|
|
<div class="line"><a name="l01155"></a><span class="lineno"> 1155</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01156"></a><span class="lineno"> 1156</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01157"></a><span class="lineno"> 1157</span> <span class="comment"> The default resampler type is FMOD_DSP_RESAMPLER_LINEAR.<br></span></div>
|
|
<div class="line"><a name="l01158"></a><span class="lineno"> 1158</span> <span class="comment"> Use System::setSoftwareFormat to tell FMOD the resampling quality you require for FMOD_SOFTWARE based sounds.</span></div>
|
|
<div class="line"><a name="l01159"></a><span class="lineno"> 1159</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01160"></a><span class="lineno"> 1160</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01161"></a><span class="lineno"> 1161</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01162"></a><span class="lineno"> 1162</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01163"></a><span class="lineno"> 1163</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01164"></a><span class="lineno"> 1164</span> <span class="comment"> System::setSoftwareFormat</span></div>
|
|
<div class="line"><a name="l01165"></a><span class="lineno"> 1165</span> <span class="comment"> System::getSoftwareFormat</span></div>
|
|
<div class="line"><a name="l01166"></a><span class="lineno"> 1166</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01167"></a><span class="lineno"> 1167</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01168"></a><span class="lineno"> 1168</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01169"></a><span class="lineno"> 1169</span> {</div>
|
|
<div class="line"><a name="l01170"></a><span class="lineno"> 1170</span>  FMOD_DSP_RESAMPLER_NOINTERP, <span class="comment">/* No interpolation. High frequency aliasing hiss will be audible depending on the sample rate of the sound. */</span></div>
|
|
<div class="line"><a name="l01171"></a><span class="lineno"> 1171</span>  FMOD_DSP_RESAMPLER_LINEAR, <span class="comment">/* Linear interpolation (default method). Fast and good quality, causes very slight lowpass effect on low frequency sounds. */</span></div>
|
|
<div class="line"><a name="l01172"></a><span class="lineno"> 1172</span>  FMOD_DSP_RESAMPLER_CUBIC, <span class="comment">/* Cubic interpolation. Slower than linear interpolation but better quality. */</span></div>
|
|
<div class="line"><a name="l01173"></a><span class="lineno"> 1173</span>  FMOD_DSP_RESAMPLER_SPLINE, <span class="comment">/* 5 point spline interpolation. Slowest resampling method but best quality. */</span></div>
|
|
<div class="line"><a name="l01174"></a><span class="lineno"> 1174</span> </div>
|
|
<div class="line"><a name="l01175"></a><span class="lineno"> 1175</span>  FMOD_DSP_RESAMPLER_MAX, <span class="comment">/* Maximum number of resample methods supported. */</span></div>
|
|
<div class="line"><a name="l01176"></a><span class="lineno"> 1176</span>  FMOD_DSP_RESAMPLER_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l01177"></a><span class="lineno"> 1177</span> } FMOD_DSP_RESAMPLER;</div>
|
|
<div class="line"><a name="l01178"></a><span class="lineno"> 1178</span> </div>
|
|
<div class="line"><a name="l01179"></a><span class="lineno"> 1179</span> </div>
|
|
<div class="line"><a name="l01180"></a><span class="lineno"> 1180</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01181"></a><span class="lineno"> 1181</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01182"></a><span class="lineno"> 1182</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01183"></a><span class="lineno"> 1183</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01184"></a><span class="lineno"> 1184</span> <span class="comment"> List of tag types that could be stored within a sound. These include id3 tags, metadata from netstreams and vorbis/asf data.</span></div>
|
|
<div class="line"><a name="l01185"></a><span class="lineno"> 1185</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01186"></a><span class="lineno"> 1186</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01187"></a><span class="lineno"> 1187</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01188"></a><span class="lineno"> 1188</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01189"></a><span class="lineno"> 1189</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01190"></a><span class="lineno"> 1190</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01191"></a><span class="lineno"> 1191</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01192"></a><span class="lineno"> 1192</span> <span class="comment"> Sound::getTag</span></div>
|
|
<div class="line"><a name="l01193"></a><span class="lineno"> 1193</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01194"></a><span class="lineno"> 1194</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01195"></a><span class="lineno"> 1195</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01196"></a><span class="lineno"> 1196</span> {</div>
|
|
<div class="line"><a name="l01197"></a><span class="lineno"> 1197</span>  FMOD_TAGTYPE_UNKNOWN = 0,</div>
|
|
<div class="line"><a name="l01198"></a><span class="lineno"> 1198</span>  FMOD_TAGTYPE_ID3V1,</div>
|
|
<div class="line"><a name="l01199"></a><span class="lineno"> 1199</span>  FMOD_TAGTYPE_ID3V2,</div>
|
|
<div class="line"><a name="l01200"></a><span class="lineno"> 1200</span>  FMOD_TAGTYPE_VORBISCOMMENT,</div>
|
|
<div class="line"><a name="l01201"></a><span class="lineno"> 1201</span>  FMOD_TAGTYPE_SHOUTCAST,</div>
|
|
<div class="line"><a name="l01202"></a><span class="lineno"> 1202</span>  FMOD_TAGTYPE_ICECAST,</div>
|
|
<div class="line"><a name="l01203"></a><span class="lineno"> 1203</span>  FMOD_TAGTYPE_ASF,</div>
|
|
<div class="line"><a name="l01204"></a><span class="lineno"> 1204</span>  FMOD_TAGTYPE_MIDI,</div>
|
|
<div class="line"><a name="l01205"></a><span class="lineno"> 1205</span>  FMOD_TAGTYPE_PLAYLIST,</div>
|
|
<div class="line"><a name="l01206"></a><span class="lineno"> 1206</span>  FMOD_TAGTYPE_FMOD,</div>
|
|
<div class="line"><a name="l01207"></a><span class="lineno"> 1207</span>  FMOD_TAGTYPE_USER,</div>
|
|
<div class="line"><a name="l01208"></a><span class="lineno"> 1208</span> </div>
|
|
<div class="line"><a name="l01209"></a><span class="lineno"> 1209</span>  FMOD_TAGTYPE_MAX, <span class="comment">/* Maximum number of tag types supported. */</span></div>
|
|
<div class="line"><a name="l01210"></a><span class="lineno"> 1210</span>  FMOD_TAGTYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l01211"></a><span class="lineno"> 1211</span> } FMOD_TAGTYPE;</div>
|
|
<div class="line"><a name="l01212"></a><span class="lineno"> 1212</span> </div>
|
|
<div class="line"><a name="l01213"></a><span class="lineno"> 1213</span> </div>
|
|
<div class="line"><a name="l01214"></a><span class="lineno"> 1214</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01215"></a><span class="lineno"> 1215</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01216"></a><span class="lineno"> 1216</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01217"></a><span class="lineno"> 1217</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01218"></a><span class="lineno"> 1218</span> <span class="comment"> List of data types that can be returned by Sound::getTag</span></div>
|
|
<div class="line"><a name="l01219"></a><span class="lineno"> 1219</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01220"></a><span class="lineno"> 1220</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01221"></a><span class="lineno"> 1221</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01222"></a><span class="lineno"> 1222</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01223"></a><span class="lineno"> 1223</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01224"></a><span class="lineno"> 1224</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01225"></a><span class="lineno"> 1225</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01226"></a><span class="lineno"> 1226</span> <span class="comment"> Sound::getTag</span></div>
|
|
<div class="line"><a name="l01227"></a><span class="lineno"> 1227</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01228"></a><span class="lineno"> 1228</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01229"></a><span class="lineno"> 1229</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01230"></a><span class="lineno"> 1230</span> {</div>
|
|
<div class="line"><a name="l01231"></a><span class="lineno"> 1231</span>  FMOD_TAGDATATYPE_BINARY = 0,</div>
|
|
<div class="line"><a name="l01232"></a><span class="lineno"> 1232</span>  FMOD_TAGDATATYPE_INT,</div>
|
|
<div class="line"><a name="l01233"></a><span class="lineno"> 1233</span>  FMOD_TAGDATATYPE_FLOAT,</div>
|
|
<div class="line"><a name="l01234"></a><span class="lineno"> 1234</span>  FMOD_TAGDATATYPE_STRING,</div>
|
|
<div class="line"><a name="l01235"></a><span class="lineno"> 1235</span>  FMOD_TAGDATATYPE_STRING_UTF16,</div>
|
|
<div class="line"><a name="l01236"></a><span class="lineno"> 1236</span>  FMOD_TAGDATATYPE_STRING_UTF16BE,</div>
|
|
<div class="line"><a name="l01237"></a><span class="lineno"> 1237</span>  FMOD_TAGDATATYPE_STRING_UTF8,</div>
|
|
<div class="line"><a name="l01238"></a><span class="lineno"> 1238</span>  FMOD_TAGDATATYPE_CDTOC,</div>
|
|
<div class="line"><a name="l01239"></a><span class="lineno"> 1239</span> </div>
|
|
<div class="line"><a name="l01240"></a><span class="lineno"> 1240</span>  FMOD_TAGDATATYPE_MAX, <span class="comment">/* Maximum number of tag datatypes supported. */</span></div>
|
|
<div class="line"><a name="l01241"></a><span class="lineno"> 1241</span>  FMOD_TAGDATATYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l01242"></a><span class="lineno"> 1242</span> } FMOD_TAGDATATYPE;</div>
|
|
<div class="line"><a name="l01243"></a><span class="lineno"> 1243</span> </div>
|
|
<div class="line"><a name="l01244"></a><span class="lineno"> 1244</span> </div>
|
|
<div class="line"><a name="l01245"></a><span class="lineno"> 1245</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01246"></a><span class="lineno"> 1246</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01247"></a><span class="lineno"> 1247</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01248"></a><span class="lineno"> 1248</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01249"></a><span class="lineno"> 1249</span> <span class="comment"> Types of delay that can be used with Channel::setDelay / Channel::getDelay.</span></div>
|
|
<div class="line"><a name="l01250"></a><span class="lineno"> 1250</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01251"></a><span class="lineno"> 1251</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01252"></a><span class="lineno"> 1252</span> <span class="comment"> If you haven't called Channel::setDelay yet, if you call Channel::getDelay with FMOD_DELAYTYPE_DSPCLOCK_START it will return the </span></div>
|
|
<div class="line"><a name="l01253"></a><span class="lineno"> 1253</span> <span class="comment"> equivalent global DSP clock value to determine when a channel started, so that you can use it for other channels to sync against.<br></span></div>
|
|
<div class="line"><a name="l01254"></a><span class="lineno"> 1254</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01255"></a><span class="lineno"> 1255</span> <span class="comment"> Use System::getDSPClock to also get the current dspclock time, a base for future calls to Channel::setDelay.<br></span></div>
|
|
<div class="line"><a name="l01256"></a><span class="lineno"> 1256</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01257"></a><span class="lineno"> 1257</span> <span class="comment"> Use FMOD_64BIT_ADD or FMOD_64BIT_SUB to add a hi/lo combination together and cope with wraparound.</span></div>
|
|
<div class="line"><a name="l01258"></a><span class="lineno"> 1258</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01259"></a><span class="lineno"> 1259</span> <span class="comment"> If FMOD_DELAYTYPE_END_MS is specified, the value is not treated as a 64 bit number, just the delayhi value is used and it is treated as milliseconds.</span></div>
|
|
<div class="line"><a name="l01260"></a><span class="lineno"> 1260</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01261"></a><span class="lineno"> 1261</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01262"></a><span class="lineno"> 1262</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01263"></a><span class="lineno"> 1263</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01264"></a><span class="lineno"> 1264</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01265"></a><span class="lineno"> 1265</span> <span class="comment"> Channel::setDelay</span></div>
|
|
<div class="line"><a name="l01266"></a><span class="lineno"> 1266</span> <span class="comment"> Channel::getDelay</span></div>
|
|
<div class="line"><a name="l01267"></a><span class="lineno"> 1267</span> <span class="comment"> System::getDSPClock</span></div>
|
|
<div class="line"><a name="l01268"></a><span class="lineno"> 1268</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01269"></a><span class="lineno"> 1269</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01270"></a><span class="lineno"> 1270</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01271"></a><span class="lineno"> 1271</span> {</div>
|
|
<div class="line"><a name="l01272"></a><span class="lineno"> 1272</span>  FMOD_DELAYTYPE_END_MS, <span class="comment">/* Delay at the end of the sound in milliseconds. Use delayhi only. Channel::isPlaying will remain true until this delay has passed even though the sound itself has stopped playing.*/</span></div>
|
|
<div class="line"><a name="l01273"></a><span class="lineno"> 1273</span>  FMOD_DELAYTYPE_DSPCLOCK_START, <span class="comment">/* Time the sound started if Channel::getDelay is used, or if Channel::setDelay is used, the sound will delay playing until this exact tick. */</span></div>
|
|
<div class="line"><a name="l01274"></a><span class="lineno"> 1274</span>  FMOD_DELAYTYPE_DSPCLOCK_END, <span class="comment">/* Time the sound should end. If this is non-zero, the channel will go silent at this exact tick. */</span></div>
|
|
<div class="line"><a name="l01275"></a><span class="lineno"> 1275</span>  FMOD_DELAYTYPE_DSPCLOCK_PAUSE, <span class="comment">/* Time the sound should pause. If this is non-zero, the channel will pause at this exact tick. */</span></div>
|
|
<div class="line"><a name="l01276"></a><span class="lineno"> 1276</span> </div>
|
|
<div class="line"><a name="l01277"></a><span class="lineno"> 1277</span>  FMOD_DELAYTYPE_MAX, <span class="comment">/* Maximum number of tag datatypes supported. */</span></div>
|
|
<div class="line"><a name="l01278"></a><span class="lineno"> 1278</span>  FMOD_DELAYTYPE_FORCEINT = 65536 <span class="comment">/* Makes sure this enum is signed 32bit. */</span></div>
|
|
<div class="line"><a name="l01279"></a><span class="lineno"> 1279</span> } FMOD_DELAYTYPE;</div>
|
|
<div class="line"><a name="l01280"></a><span class="lineno"> 1280</span> </div>
|
|
<div class="line"><a name="l01281"></a><span class="lineno"> 1281</span> </div>
|
|
<div class="line"><a name="l01282"></a><span class="lineno"> 1282</span> <span class="preprocessor">#define FMOD_64BIT_ADD(_hi1, _lo1, _hi2, _lo2) _hi1 += ((_hi2) + ((((_lo1) + (_lo2)) < (_lo1)) ? 1 : 0)); (_lo1) += (_lo2);</span></div>
|
|
<div class="line"><a name="l01283"></a><span class="lineno"> 1283</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_64BIT_SUB(_hi1, _lo1, _hi2, _lo2) _hi1 -= ((_hi2) + ((((_lo1) - (_lo2)) > (_lo1)) ? 1 : 0)); (_lo1) -= (_lo2);</span></div>
|
|
<div class="line"><a name="l01284"></a><span class="lineno"> 1284</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01285"></a><span class="lineno"> 1285</span> </div>
|
|
<div class="line"><a name="l01286"></a><span class="lineno"> 1286</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01287"></a><span class="lineno"> 1287</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l01288"></a><span class="lineno"> 1288</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01289"></a><span class="lineno"> 1289</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01290"></a><span class="lineno"> 1290</span> <span class="comment"> Structure describing a piece of tag data.</span></div>
|
|
<div class="line"><a name="l01291"></a><span class="lineno"> 1291</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01292"></a><span class="lineno"> 1292</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01293"></a><span class="lineno"> 1293</span> <span class="comment"> Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br></span></div>
|
|
<div class="line"><a name="l01294"></a><span class="lineno"> 1294</span> <span class="comment"> Members marked with [w] mean the variable can be written to. The user can set the value.<br></span></div>
|
|
<div class="line"><a name="l01295"></a><span class="lineno"> 1295</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01296"></a><span class="lineno"> 1296</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01297"></a><span class="lineno"> 1297</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01298"></a><span class="lineno"> 1298</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01299"></a><span class="lineno"> 1299</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01300"></a><span class="lineno"> 1300</span> <span class="comment"> Sound::getTag</span></div>
|
|
<div class="line"><a name="l01301"></a><span class="lineno"> 1301</span> <span class="comment"> FMOD_TAGTYPE</span></div>
|
|
<div class="line"><a name="l01302"></a><span class="lineno"> 1302</span> <span class="comment"> FMOD_TAGDATATYPE</span></div>
|
|
<div class="line"><a name="l01303"></a><span class="lineno"> 1303</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01304"></a><span class="lineno"> 1304</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01305"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___t_a_g.html"> 1305</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_f_m_o_d___t_a_g.html">FMOD_TAG</a></div>
|
|
<div class="line"><a name="l01306"></a><span class="lineno"> 1306</span> {</div>
|
|
<div class="line"><a name="l01307"></a><span class="lineno"> 1307</span>  FMOD_TAGTYPE type; <span class="comment">/* [r] The type of this tag. */</span></div>
|
|
<div class="line"><a name="l01308"></a><span class="lineno"> 1308</span>  FMOD_TAGDATATYPE datatype; <span class="comment">/* [r] The type of data that this tag contains */</span></div>
|
|
<div class="line"><a name="l01309"></a><span class="lineno"> 1309</span>  <span class="keywordtype">char</span> *name; <span class="comment">/* [r] The name of this tag i.e. "TITLE", "ARTIST" etc. */</span></div>
|
|
<div class="line"><a name="l01310"></a><span class="lineno"> 1310</span>  <span class="keywordtype">void</span> *data; <span class="comment">/* [r] Pointer to the tag data - its format is determined by the datatype member */</span></div>
|
|
<div class="line"><a name="l01311"></a><span class="lineno"> 1311</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> datalen; <span class="comment">/* [r] Length of the data contained in this tag */</span></div>
|
|
<div class="line"><a name="l01312"></a><span class="lineno"> 1312</span>  FMOD_BOOL updated; <span class="comment">/* [r] True if this tag has been updated since last being accessed with Sound::getTag */</span></div>
|
|
<div class="line"><a name="l01313"></a><span class="lineno"> 1313</span> } <a class="code" href="struct_f_m_o_d___t_a_g.html">FMOD_TAG</a>;</div>
|
|
<div class="line"><a name="l01314"></a><span class="lineno"> 1314</span> </div>
|
|
<div class="line"><a name="l01315"></a><span class="lineno"> 1315</span> </div>
|
|
<div class="line"><a name="l01316"></a><span class="lineno"> 1316</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01317"></a><span class="lineno"> 1317</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l01318"></a><span class="lineno"> 1318</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01319"></a><span class="lineno"> 1319</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01320"></a><span class="lineno"> 1320</span> <span class="comment"> Structure describing a CD/DVD table of contents</span></div>
|
|
<div class="line"><a name="l01321"></a><span class="lineno"> 1321</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01322"></a><span class="lineno"> 1322</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01323"></a><span class="lineno"> 1323</span> <span class="comment"> Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br></span></div>
|
|
<div class="line"><a name="l01324"></a><span class="lineno"> 1324</span> <span class="comment"> Members marked with [w] mean the variable can be written to. The user can set the value.<br></span></div>
|
|
<div class="line"><a name="l01325"></a><span class="lineno"> 1325</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01326"></a><span class="lineno"> 1326</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01327"></a><span class="lineno"> 1327</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01328"></a><span class="lineno"> 1328</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01329"></a><span class="lineno"> 1329</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01330"></a><span class="lineno"> 1330</span> <span class="comment"> Sound::getTag</span></div>
|
|
<div class="line"><a name="l01331"></a><span class="lineno"> 1331</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01332"></a><span class="lineno"> 1332</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01333"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___c_d_t_o_c.html"> 1333</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_f_m_o_d___c_d_t_o_c.html">FMOD_CDTOC</a></div>
|
|
<div class="line"><a name="l01334"></a><span class="lineno"> 1334</span> {</div>
|
|
<div class="line"><a name="l01335"></a><span class="lineno"> 1335</span>  <span class="keywordtype">int</span> numtracks; <span class="comment">/* [r] The number of tracks on the CD */</span></div>
|
|
<div class="line"><a name="l01336"></a><span class="lineno"> 1336</span>  <span class="keywordtype">int</span> min[100]; <span class="comment">/* [r] The start offset of each track in minutes */</span></div>
|
|
<div class="line"><a name="l01337"></a><span class="lineno"> 1337</span>  <span class="keywordtype">int</span> sec[100]; <span class="comment">/* [r] The start offset of each track in seconds */</span></div>
|
|
<div class="line"><a name="l01338"></a><span class="lineno"> 1338</span>  <span class="keywordtype">int</span> frame[100]; <span class="comment">/* [r] The start offset of each track in frames */</span></div>
|
|
<div class="line"><a name="l01339"></a><span class="lineno"> 1339</span> } <a class="code" href="struct_f_m_o_d___c_d_t_o_c.html">FMOD_CDTOC</a>;</div>
|
|
<div class="line"><a name="l01340"></a><span class="lineno"> 1340</span> </div>
|
|
<div class="line"><a name="l01341"></a><span class="lineno"> 1341</span> </div>
|
|
<div class="line"><a name="l01342"></a><span class="lineno"> 1342</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01343"></a><span class="lineno"> 1343</span> <span class="comment">[DEFINE]</span></div>
|
|
<div class="line"><a name="l01344"></a><span class="lineno"> 1344</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01345"></a><span class="lineno"> 1345</span> <span class="comment"> [NAME]</span></div>
|
|
<div class="line"><a name="l01346"></a><span class="lineno"> 1346</span> <span class="comment"> FMOD_TIMEUNIT</span></div>
|
|
<div class="line"><a name="l01347"></a><span class="lineno"> 1347</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01348"></a><span class="lineno"> 1348</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01349"></a><span class="lineno"> 1349</span> <span class="comment"> List of time types that can be returned by Sound::getLength and used with Channel::setPosition or Channel::getPosition.</span></div>
|
|
<div class="line"><a name="l01350"></a><span class="lineno"> 1350</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01351"></a><span class="lineno"> 1351</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01352"></a><span class="lineno"> 1352</span> <span class="comment"> FMOD_TIMEUNIT_SENTENCE_MS, FMOD_TIMEUNIT_SENTENCE_PCM, FMOD_TIMEUNIT_SENTENCE_PCMBYTES, FMOD_TIMEUNIT_SENTENCE and FMOD_TIMEUNIT_SENTENCE_SUBSOUND are only supported by Channel functions.</span></div>
|
|
<div class="line"><a name="l01353"></a><span class="lineno"> 1353</span> <span class="comment"> Do not combine flags except FMOD_TIMEUNIT_BUFFERED.</span></div>
|
|
<div class="line"><a name="l01354"></a><span class="lineno"> 1354</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01355"></a><span class="lineno"> 1355</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01356"></a><span class="lineno"> 1356</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01357"></a><span class="lineno"> 1357</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01358"></a><span class="lineno"> 1358</span> <span class="comment"> [SEE_ALSO] </span></div>
|
|
<div class="line"><a name="l01359"></a><span class="lineno"> 1359</span> <span class="comment"> Sound::getLength</span></div>
|
|
<div class="line"><a name="l01360"></a><span class="lineno"> 1360</span> <span class="comment"> Channel::setPosition</span></div>
|
|
<div class="line"><a name="l01361"></a><span class="lineno"> 1361</span> <span class="comment"> Channel::getPosition</span></div>
|
|
<div class="line"><a name="l01362"></a><span class="lineno"> 1362</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01363"></a><span class="lineno"> 1363</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01364"></a><span class="lineno"> 1364</span> <span class="preprocessor">#define FMOD_TIMEUNIT_MS 0x00000001 </span><span class="comment">/* Milliseconds. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01365"></a><span class="lineno"> 1365</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_PCM 0x00000002 </span><span class="comment">/* PCM samples, related to milliseconds * samplerate / 1000. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01366"></a><span class="lineno"> 1366</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_PCMBYTES 0x00000004 </span><span class="comment">/* Bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes). */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01367"></a><span class="lineno"> 1367</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_RAWBYTES 0x00000008 </span><span class="comment">/* Raw file bytes of (compressed) sound data (does not include headers). Only used by Sound::getLength and Channel::getPosition. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01368"></a><span class="lineno"> 1368</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_PCMFRACTION 0x00000010 </span><span class="comment">/* Fractions of 1 PCM sample. Unsigned int range 0 to 0xFFFFFFFF. Used for sub-sample granularity for DSP purposes. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01369"></a><span class="lineno"> 1369</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_MODORDER 0x00000100 </span><span class="comment">/* MOD/S3M/XM/IT. Order in a sequenced module format. Use Sound::getFormat to determine the PCM format being decoded to. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01370"></a><span class="lineno"> 1370</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_MODROW 0x00000200 </span><span class="comment">/* MOD/S3M/XM/IT. Current row in a sequenced module format. Sound::getLength will return the number of rows in the currently playing or seeked to pattern. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01371"></a><span class="lineno"> 1371</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_MODPATTERN 0x00000400 </span><span class="comment">/* MOD/S3M/XM/IT. Current pattern in a sequenced module format. Sound::getLength will return the number of patterns in the song and Channel::getPosition will return the currently playing pattern. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01372"></a><span class="lineno"> 1372</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_SENTENCE_MS 0x00010000 </span><span class="comment">/* Currently playing subsound in a sentence time in milliseconds. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01373"></a><span class="lineno"> 1373</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_SENTENCE_PCM 0x00020000 </span><span class="comment">/* Currently playing subsound in a sentence time in PCM Samples, related to milliseconds * samplerate / 1000. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01374"></a><span class="lineno"> 1374</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_SENTENCE_PCMBYTES 0x00040000 </span><span class="comment">/* Currently playing subsound in a sentence time in bytes, related to PCM samples * channels * datawidth (ie 16bit = 2 bytes). */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01375"></a><span class="lineno"> 1375</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_SENTENCE 0x00080000 </span><span class="comment">/* Currently playing sentence index according to the channel. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01376"></a><span class="lineno"> 1376</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_SENTENCE_SUBSOUND 0x00100000 </span><span class="comment">/* Currently playing subsound index in a sentence. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01377"></a><span class="lineno"> 1377</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_TIMEUNIT_BUFFERED 0x10000000 </span><span class="comment">/* Time value as seen by buffered stream. This is always ahead of audible time, and is only used for processing. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01378"></a><span class="lineno"> 1378</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l01379"></a><span class="lineno"> 1379</span> </div>
|
|
<div class="line"><a name="l01380"></a><span class="lineno"> 1380</span> </div>
|
|
<div class="line"><a name="l01381"></a><span class="lineno"> 1381</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01382"></a><span class="lineno"> 1382</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01383"></a><span class="lineno"> 1383</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01384"></a><span class="lineno"> 1384</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01385"></a><span class="lineno"> 1385</span> <span class="comment"> When creating a multichannel sound, FMOD will pan them to their default speaker locations, for example a 6 channel sound will default to one channel per 5.1 output speaker.<br></span></div>
|
|
<div class="line"><a name="l01386"></a><span class="lineno"> 1386</span> <span class="comment"> Another example is a stereo sound. It will default to left = front left, right = front right.<br></span></div>
|
|
<div class="line"><a name="l01387"></a><span class="lineno"> 1387</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01388"></a><span class="lineno"> 1388</span> <span class="comment"> This is for sounds that are not 'default'. For example you might have a sound that is 6 channels but actually made up of 3 stereo pairs, that should all be located in front left, front right only.</span></div>
|
|
<div class="line"><a name="l01389"></a><span class="lineno"> 1389</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01390"></a><span class="lineno"> 1390</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01391"></a><span class="lineno"> 1391</span> <span class="comment"> For full flexibility of speaker assignments, use Channel::setSpeakerLevels.</span></div>
|
|
<div class="line"><a name="l01392"></a><span class="lineno"> 1392</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01393"></a><span class="lineno"> 1393</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01394"></a><span class="lineno"> 1394</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01395"></a><span class="lineno"> 1395</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01396"></a><span class="lineno"> 1396</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01397"></a><span class="lineno"> 1397</span> <span class="comment"> FMOD_CREATESOUNDEXINFO</span></div>
|
|
<div class="line"><a name="l01398"></a><span class="lineno"> 1398</span> <span class="comment"> Channel::setSpeakerLevels</span></div>
|
|
<div class="line"><a name="l01399"></a><span class="lineno"> 1399</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01400"></a><span class="lineno"> 1400</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01401"></a><span class="lineno"> 1401</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01402"></a><span class="lineno"> 1402</span> {</div>
|
|
<div class="line"><a name="l01403"></a><span class="lineno"> 1403</span>  FMOD_SPEAKERMAPTYPE_DEFAULT, <span class="comment">/* This is the default, and just means FMOD decides which speakers it puts the source channels. */</span></div>
|
|
<div class="line"><a name="l01404"></a><span class="lineno"> 1404</span>  FMOD_SPEAKERMAPTYPE_ALLMONO, <span class="comment">/* This means the sound is made up of all mono sounds. All voices will be panned to the front center by default in this case. */</span></div>
|
|
<div class="line"><a name="l01405"></a><span class="lineno"> 1405</span>  FMOD_SPEAKERMAPTYPE_ALLSTEREO, <span class="comment">/* This means the sound is made up of all stereo sounds. All voices will be panned to front left and front right alternating every second channel. */</span></div>
|
|
<div class="line"><a name="l01406"></a><span class="lineno"> 1406</span>  FMOD_SPEAKERMAPTYPE_51_PROTOOLS <span class="comment">/* Map a 5.1 sound to use protools L C R Ls Rs LFE mapping. Will return an error if not a 6 channel sound. */</span></div>
|
|
<div class="line"><a name="l01407"></a><span class="lineno"> 1407</span> } FMOD_SPEAKERMAPTYPE;</div>
|
|
<div class="line"><a name="l01408"></a><span class="lineno"> 1408</span> </div>
|
|
<div class="line"><a name="l01409"></a><span class="lineno"> 1409</span> </div>
|
|
<div class="line"><a name="l01410"></a><span class="lineno"> 1410</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01411"></a><span class="lineno"> 1411</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l01412"></a><span class="lineno"> 1412</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01413"></a><span class="lineno"> 1413</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01414"></a><span class="lineno"> 1414</span> <span class="comment"> Use this structure with System::createSound when more control is needed over loading.<br></span></div>
|
|
<div class="line"><a name="l01415"></a><span class="lineno"> 1415</span> <span class="comment"> The possible reasons to use this with System::createSound are:<br></span></div>
|
|
<div class="line"><a name="l01416"></a><span class="lineno"> 1416</span> <span class="comment"> <li>Loading a file from memory.</span></div>
|
|
<div class="line"><a name="l01417"></a><span class="lineno"> 1417</span> <span class="comment"> <li>Loading a file from within another larger (possibly wad/pak) file, by giving the loader an offset and length.</span></div>
|
|
<div class="line"><a name="l01418"></a><span class="lineno"> 1418</span> <span class="comment"> <li>To create a user created / non file based sound.</span></div>
|
|
<div class="line"><a name="l01419"></a><span class="lineno"> 1419</span> <span class="comment"> <li>To specify a starting subsound to seek to within a multi-sample sounds (ie FSB/DLS/SF2) when created as a stream.</span></div>
|
|
<div class="line"><a name="l01420"></a><span class="lineno"> 1420</span> <span class="comment"> <li>To specify which subsounds to load for multi-sample sounds (ie FSB/DLS/SF2) so that memory is saved and only a subset is actually loaded/read from disk.</span></div>
|
|
<div class="line"><a name="l01421"></a><span class="lineno"> 1421</span> <span class="comment"> <li>To specify 'piggyback' read and seek callbacks for capture of sound data as fmod reads and decodes it. Useful for ripping decoded PCM data from sounds as they are loaded / played.</span></div>
|
|
<div class="line"><a name="l01422"></a><span class="lineno"> 1422</span> <span class="comment"> <li>To specify a MIDI DLS/SF2 sample set file to load when opening a MIDI file.</span></div>
|
|
<div class="line"><a name="l01423"></a><span class="lineno"> 1423</span> <span class="comment"> See below on what members to fill for each of the above types of sound you want to create.</span></div>
|
|
<div class="line"><a name="l01424"></a><span class="lineno"> 1424</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01425"></a><span class="lineno"> 1425</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01426"></a><span class="lineno"> 1426</span> <span class="comment"> This structure is optional! Specify 0 or NULL in System::createSound if you don't need it!<br></span></div>
|
|
<div class="line"><a name="l01427"></a><span class="lineno"> 1427</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01428"></a><span class="lineno"> 1428</span> <span class="comment"> <u>Loading a file from memory.</u><br></span></div>
|
|
<div class="line"><a name="l01429"></a><span class="lineno"> 1429</span> <span class="comment"> <li>Create the sound using the FMOD_OPENMEMORY flag.<br></span></div>
|
|
<div class="line"><a name="l01430"></a><span class="lineno"> 1430</span> <span class="comment"> <li>Mandatory. Specify 'length' for the size of the memory block in bytes.</span></div>
|
|
<div class="line"><a name="l01431"></a><span class="lineno"> 1431</span> <span class="comment"> <li>Other flags are optional.</span></div>
|
|
<div class="line"><a name="l01432"></a><span class="lineno"> 1432</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01433"></a><span class="lineno"> 1433</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01434"></a><span class="lineno"> 1434</span> <span class="comment"> <u>Loading a file from within another larger (possibly wad/pak) file, by giving the loader an offset and length.</u><br></span></div>
|
|
<div class="line"><a name="l01435"></a><span class="lineno"> 1435</span> <span class="comment"> <li>Mandatory. Specify 'fileoffset' and 'length'.</span></div>
|
|
<div class="line"><a name="l01436"></a><span class="lineno"> 1436</span> <span class="comment"> <li>Other flags are optional.</span></div>
|
|
<div class="line"><a name="l01437"></a><span class="lineno"> 1437</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01438"></a><span class="lineno"> 1438</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01439"></a><span class="lineno"> 1439</span> <span class="comment"> <u>To create a user created / non file based sound.</u><br></span></div>
|
|
<div class="line"><a name="l01440"></a><span class="lineno"> 1440</span> <span class="comment"> <li>Create the sound using the FMOD_OPENUSER flag.</span></div>
|
|
<div class="line"><a name="l01441"></a><span class="lineno"> 1441</span> <span class="comment"> <li>Mandatory. Specify 'defaultfrequency, 'numchannels' and 'format'.</span></div>
|
|
<div class="line"><a name="l01442"></a><span class="lineno"> 1442</span> <span class="comment"> <li>Other flags are optional.</span></div>
|
|
<div class="line"><a name="l01443"></a><span class="lineno"> 1443</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01444"></a><span class="lineno"> 1444</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01445"></a><span class="lineno"> 1445</span> <span class="comment"> <u>To specify a starting subsound to seek to and flush with, within a multi-sample stream (ie FSB/DLS/SF2).</u><br></span></div>
|
|
<div class="line"><a name="l01446"></a><span class="lineno"> 1446</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01447"></a><span class="lineno"> 1447</span> <span class="comment"> <li>Mandatory. Specify 'initialsubsound'.</span></div>
|
|
<div class="line"><a name="l01448"></a><span class="lineno"> 1448</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01449"></a><span class="lineno"> 1449</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01450"></a><span class="lineno"> 1450</span> <span class="comment"> <u>To specify which subsounds to load for multi-sample sounds (ie FSB/DLS/SF2) so that memory is saved and only a subset is actually loaded/read from disk.</u><br></span></div>
|
|
<div class="line"><a name="l01451"></a><span class="lineno"> 1451</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01452"></a><span class="lineno"> 1452</span> <span class="comment"> <li>Mandatory. Specify 'inclusionlist' and 'inclusionlistnum'.</span></div>
|
|
<div class="line"><a name="l01453"></a><span class="lineno"> 1453</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01454"></a><span class="lineno"> 1454</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01455"></a><span class="lineno"> 1455</span> <span class="comment"> <u>To specify 'piggyback' read and seek callbacks for capture of sound data as fmod reads and decodes it. Useful for ripping decoded PCM data from sounds as they are loaded / played.</u><br></span></div>
|
|
<div class="line"><a name="l01456"></a><span class="lineno"> 1456</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01457"></a><span class="lineno"> 1457</span> <span class="comment"> <li>Mandatory. Specify 'pcmreadcallback' and 'pcmseekcallback'.</span></div>
|
|
<div class="line"><a name="l01458"></a><span class="lineno"> 1458</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01459"></a><span class="lineno"> 1459</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01460"></a><span class="lineno"> 1460</span> <span class="comment"> <u>To specify a MIDI DLS/SF2 sample set file to load when opening a MIDI file.</u><br></span></div>
|
|
<div class="line"><a name="l01461"></a><span class="lineno"> 1461</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01462"></a><span class="lineno"> 1462</span> <span class="comment"> <li>Mandatory. Specify 'dlsname'.</span></div>
|
|
<div class="line"><a name="l01463"></a><span class="lineno"> 1463</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01464"></a><span class="lineno"> 1464</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01465"></a><span class="lineno"> 1465</span> <span class="comment"> Setting the 'decodebuffersize' is for cpu intensive codecs that may be causing stuttering, not file intensive codecs (ie those from CD or netstreams) which are normally </span></div>
|
|
<div class="line"><a name="l01466"></a><span class="lineno"> 1466</span> <span class="comment"> altered with System::setStreamBufferSize. As an example of cpu intensive codecs, an mp3 file will take more cpu to decode than a PCM wav file.<br></span></div>
|
|
<div class="line"><a name="l01467"></a><span class="lineno"> 1467</span> <span class="comment"> If you have a stuttering effect, then it is using more cpu than the decode buffer playback rate can keep up with. Increasing the decode buffersize will most likely solve this problem.<br></span></div>
|
|
<div class="line"><a name="l01468"></a><span class="lineno"> 1468</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01469"></a><span class="lineno"> 1469</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01470"></a><span class="lineno"> 1470</span> <span class="comment"> FSB codec. If inclusionlist and numsubsounds are used together, this will trigger a special mode where subsounds are shuffled down to save memory. (useful for large FSB </span></div>
|
|
<div class="line"><a name="l01471"></a><span class="lineno"> 1471</span> <span class="comment"> files where you only want to load 1 sound). There will be no gaps, ie no null subsounds. As an example, if there are 10,000 subsounds and there is an inclusionlist with only 1 entry, </span></div>
|
|
<div class="line"><a name="l01472"></a><span class="lineno"> 1472</span> <span class="comment"> and numsubsounds = 1, then subsound 0 will be that entry, and there will only be the memory allocated for 1 subsound. Previously there would still be 10,000 subsound pointers and other</span></div>
|
|
<div class="line"><a name="l01473"></a><span class="lineno"> 1473</span> <span class="comment"> associated codec entries allocated along with it multiplied by 10,000.<br></span></div>
|
|
<div class="line"><a name="l01474"></a><span class="lineno"> 1474</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01475"></a><span class="lineno"> 1475</span> <span class="comment"> Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br></span></div>
|
|
<div class="line"><a name="l01476"></a><span class="lineno"> 1476</span> <span class="comment"> Members marked with [w] mean the variable can be written to. The user can set the value.<br></span></div>
|
|
<div class="line"><a name="l01477"></a><span class="lineno"> 1477</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01478"></a><span class="lineno"> 1478</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01479"></a><span class="lineno"> 1479</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01480"></a><span class="lineno"> 1480</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01481"></a><span class="lineno"> 1481</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01482"></a><span class="lineno"> 1482</span> <span class="comment"> System::createSound</span></div>
|
|
<div class="line"><a name="l01483"></a><span class="lineno"> 1483</span> <span class="comment"> System::setStreamBufferSize</span></div>
|
|
<div class="line"><a name="l01484"></a><span class="lineno"> 1484</span> <span class="comment"> FMOD_MODE</span></div>
|
|
<div class="line"><a name="l01485"></a><span class="lineno"> 1485</span> <span class="comment"> FMOD_SOUND_FORMAT</span></div>
|
|
<div class="line"><a name="l01486"></a><span class="lineno"> 1486</span> <span class="comment"> FMOD_SOUND_TYPE</span></div>
|
|
<div class="line"><a name="l01487"></a><span class="lineno"> 1487</span> <span class="comment"> FMOD_SPEAKERMAPTYPE</span></div>
|
|
<div class="line"><a name="l01488"></a><span class="lineno"> 1488</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01489"></a><span class="lineno"> 1489</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01490"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o.html"> 1490</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o.html">FMOD_CREATESOUNDEXINFO</a></div>
|
|
<div class="line"><a name="l01491"></a><span class="lineno"> 1491</span> {</div>
|
|
<div class="line"><a name="l01492"></a><span class="lineno"> 1492</span>  <span class="keywordtype">int</span> cbsize; <span class="comment">/* [w] Size of this structure. This is used so the structure can be expanded in the future and still work on older versions of FMOD Ex. */</span></div>
|
|
<div class="line"><a name="l01493"></a><span class="lineno"> 1493</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> length; <span class="comment">/* [w] Optional. Specify 0 to ignore. Size in bytes of file to load, or sound to create (in this case only if FMOD_OPENUSER is used). Required if loading from memory. If 0 is specified, then it will use the size of the file (unless loading from memory then an error will be returned). */</span></div>
|
|
<div class="line"><a name="l01494"></a><span class="lineno"> 1494</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> fileoffset; <span class="comment">/* [w] Optional. Specify 0 to ignore. Offset from start of the file to start loading from. This is useful for loading files from inside big data files. */</span></div>
|
|
<div class="line"><a name="l01495"></a><span class="lineno"> 1495</span>  <span class="keywordtype">int</span> numchannels; <span class="comment">/* [w] Optional. Specify 0 to ignore. Number of channels in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. */</span></div>
|
|
<div class="line"><a name="l01496"></a><span class="lineno"> 1496</span>  <span class="keywordtype">int</span> defaultfrequency; <span class="comment">/* [w] Optional. Specify 0 to ignore. Default frequency of sound in a sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the frequency determined by the file format. */</span></div>
|
|
<div class="line"><a name="l01497"></a><span class="lineno"> 1497</span>  FMOD_SOUND_FORMAT format; <span class="comment">/* [w] Optional. Specify 0 or FMOD_SOUND_FORMAT_NONE to ignore. Format of the sound mandatory if FMOD_OPENUSER or FMOD_OPENRAW is used. Other formats use the format determined by the file format. */</span></div>
|
|
<div class="line"><a name="l01498"></a><span class="lineno"> 1498</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> decodebuffersize; <span class="comment">/* [w] Optional. Specify 0 to ignore. For streams. This determines the size of the double buffer (in PCM samples) that a stream uses. Use this for user created streams if you want to determine the size of the callback buffer passed to you. Specify 0 to use FMOD's default size which is currently equivalent to 400ms of the sound format created/loaded. */</span></div>
|
|
<div class="line"><a name="l01499"></a><span class="lineno"> 1499</span>  <span class="keywordtype">int</span> initialsubsound; <span class="comment">/* [w] Optional. Specify 0 to ignore. In a multi-sample file format such as .FSB/.DLS/.SF2, specify the initial subsound to seek to, only if FMOD_CREATESTREAM is used. */</span></div>
|
|
<div class="line"><a name="l01500"></a><span class="lineno"> 1500</span>  <span class="keywordtype">int</span> numsubsounds; <span class="comment">/* [w] Optional. Specify 0 to ignore or have no subsounds. In a sound created with FMOD_OPENUSER, specify the number of subsounds that are accessable with Sound::getSubSound. If not created with FMOD_OPENUSER, this will limit the number of subsounds loaded within a multi-subsound file. If using FSB, then if FMOD_CREATESOUNDEXINFO::inclusionlist is used, this will shuffle subsounds down so that there are not any gaps. It will mean that the indices of the sounds will be different. */</span></div>
|
|
<div class="line"><a name="l01501"></a><span class="lineno"> 1501</span>  <span class="keywordtype">int</span> *inclusionlist; <span class="comment">/* [w] Optional. Specify 0 to ignore. In a multi-sample format such as .FSB/.DLS/.SF2 it may be desirable to specify only a subset of sounds to be loaded out of the whole file. This is an array of subsound indices to load into memory when created. */</span></div>
|
|
<div class="line"><a name="l01502"></a><span class="lineno"> 1502</span>  <span class="keywordtype">int</span> inclusionlistnum; <span class="comment">/* [w] Optional. Specify 0 to ignore. This is the number of integers contained within the inclusionlist array. */</span></div>
|
|
<div class="line"><a name="l01503"></a><span class="lineno"> 1503</span>  FMOD_SOUND_PCMREADCALLBACK pcmreadcallback; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback to 'piggyback' on FMOD's read functions and accept or even write PCM data while FMOD is opening the sound. Used for user sounds created with FMOD_OPENUSER or for capturing decoded data as FMOD reads it. */</span></div>
|
|
<div class="line"><a name="l01504"></a><span class="lineno"> 1504</span>  FMOD_SOUND_PCMSETPOSCALLBACK pcmsetposcallback; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for when the user calls a seeking function such as Channel::setTime or Channel::setPosition within a multi-sample sound, and for when it is opened.*/</span></div>
|
|
<div class="line"><a name="l01505"></a><span class="lineno"> 1505</span>  FMOD_SOUND_NONBLOCKCALLBACK nonblockcallback; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for successful completion, or error while loading a sound that used the FMOD_NONBLOCKING flag. Also called duing seeking, when setPosition is called or a stream is restarted. */</span></div>
|
|
<div class="line"><a name="l01506"></a><span class="lineno"> 1506</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *dlsname; <span class="comment">/* [w] Optional. Specify 0 to ignore. Filename for a DLS or SF2 sample set when loading a MIDI file. If not specified, on Windows it will attempt to open /windows/system32/drivers/gm.dls or /windows/system32/drivers/etc/gm.dls, on Mac it will attempt to load /System/Library/Components/CoreAudio.component/Contents/Resources/gs_instruments.dls, otherwise the MIDI will fail to open. Current DLS support is for level 1 of the specification. */</span></div>
|
|
<div class="line"><a name="l01507"></a><span class="lineno"> 1507</span>  <span class="keyword">const</span> <span class="keywordtype">char</span> *encryptionkey; <span class="comment">/* [w] Optional. Specify 0 to ignore. Key for encrypted FSB file. Without this key an encrypted FSB file will not load. */</span></div>
|
|
<div class="line"><a name="l01508"></a><span class="lineno"> 1508</span>  <span class="keywordtype">int</span> maxpolyphony; <span class="comment">/* [w] Optional. Specify 0 to ignore. For sequenced formats with dynamic channel allocation such as .MID and .IT, this specifies the maximum voice count allowed while playing. .IT defaults to 64. .MID defaults to 32. */</span></div>
|
|
<div class="line"><a name="l01509"></a><span class="lineno"> 1509</span>  <span class="keywordtype">void</span> *userdata; <span class="comment">/* [w] Optional. Specify 0 to ignore. This is user data to be attached to the sound during creation. Access via Sound::getUserData. Note: This is not passed to FMOD_FILE_OPENCALLBACK, that is a different userdata that is file specific. */</span></div>
|
|
<div class="line"><a name="l01510"></a><span class="lineno"> 1510</span>  FMOD_SOUND_TYPE suggestedsoundtype; <span class="comment">/* [w] Optional. Specify 0 or FMOD_SOUND_TYPE_UNKNOWN to ignore. Instead of scanning all codec types, use this to speed up loading by making it jump straight to this codec. */</span></div>
|
|
<div class="line"><a name="l01511"></a><span class="lineno"> 1511</span>  FMOD_FILE_OPENCALLBACK useropen; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for opening this file. */</span></div>
|
|
<div class="line"><a name="l01512"></a><span class="lineno"> 1512</span>  FMOD_FILE_CLOSECALLBACK userclose; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for closing this file. */</span></div>
|
|
<div class="line"><a name="l01513"></a><span class="lineno"> 1513</span>  FMOD_FILE_READCALLBACK userread; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for reading from this file. */</span></div>
|
|
<div class="line"><a name="l01514"></a><span class="lineno"> 1514</span>  FMOD_FILE_SEEKCALLBACK userseek; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for seeking within this file. */</span></div>
|
|
<div class="line"><a name="l01515"></a><span class="lineno"> 1515</span>  FMOD_FILE_ASYNCREADCALLBACK userasyncread; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for seeking within this file. */</span></div>
|
|
<div class="line"><a name="l01516"></a><span class="lineno"> 1516</span>  FMOD_FILE_ASYNCCANCELCALLBACK userasynccancel; <span class="comment">/* [w] Optional. Specify 0 to ignore. Callback for seeking within this file. */</span></div>
|
|
<div class="line"><a name="l01517"></a><span class="lineno"> 1517</span>  FMOD_SPEAKERMAPTYPE speakermap; <span class="comment">/* [w] Optional. Specify 0 to ignore. Use this to differ the way fmod maps multichannel sounds to speakers. See FMOD_SPEAKERMAPTYPE for more. */</span></div>
|
|
<div class="line"><a name="l01518"></a><span class="lineno"> 1518</span>  FMOD_SOUNDGROUP *initialsoundgroup; <span class="comment">/* [w] Optional. Specify 0 to ignore. Specify a sound group if required, to put sound in as it is created. */</span></div>
|
|
<div class="line"><a name="l01519"></a><span class="lineno"> 1519</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> initialseekposition;<span class="comment">/* [w] Optional. Specify 0 to ignore. For streams. Specify an initial position to seek the stream to. */</span></div>
|
|
<div class="line"><a name="l01520"></a><span class="lineno"> 1520</span>  FMOD_TIMEUNIT initialseekpostype; <span class="comment">/* [w] Optional. Specify 0 to ignore. For streams. Specify the time unit for the position set in initialseekposition. */</span></div>
|
|
<div class="line"><a name="l01521"></a><span class="lineno"> 1521</span>  <span class="keywordtype">int</span> ignoresetfilesystem;<span class="comment">/* [w] Optional. Specify 0 to ignore. Set to 1 to use fmod's built in file system. Ignores setFileSystem callbacks and also FMOD_CREATESOUNEXINFO file callbacks. Useful for specific cases where you don't want to use your own file system but want to use fmod's file system (ie net streaming). */</span></div>
|
|
<div class="line"><a name="l01522"></a><span class="lineno"> 1522</span>  <span class="keywordtype">int</span> cddaforceaspi; <span class="comment">/* [w] Optional. Specify 0 to ignore. For CDDA sounds only - if non-zero use ASPI instead of NTSCSI to access the specified CD/DVD device. */</span></div>
|
|
<div class="line"><a name="l01523"></a><span class="lineno"> 1523</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> audioqueuepolicy; <span class="comment">/* [w] Optional. Specify 0 or FMOD_AUDIOQUEUE_CODECPOLICY_DEFAULT to ignore. Policy used to determine whether hardware or software is used for decoding, see FMOD_AUDIOQUEUE_CODECPOLICY for options (iOS >= 3.0 required, otherwise only hardware is available) */</span> </div>
|
|
<div class="line"><a name="l01524"></a><span class="lineno"> 1524</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> minmidigranularity; <span class="comment">/* [w] Optional. Specify 0 to ignore. Allows you to set a minimum desired MIDI mixer granularity. Values smaller than 512 give greater than default accuracy at the cost of more CPU and vice versa. Specify 0 for default (512 samples). */</span></div>
|
|
<div class="line"><a name="l01525"></a><span class="lineno"> 1525</span>  <span class="keywordtype">int</span> nonblockthreadid; <span class="comment">/* [w] Optional. Specify 0 to ignore. Specifies a thread index to execute non blocking load on. Allows for up to 5 threads to be used for loading at once. This is to avoid one load blocking another. Maximum value = 4. */</span></div>
|
|
<div class="line"><a name="l01526"></a><span class="lineno"> 1526</span> } <a class="code" href="struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o.html">FMOD_CREATESOUNDEXINFO</a>;</div>
|
|
<div class="line"><a name="l01527"></a><span class="lineno"> 1527</span> </div>
|
|
<div class="line"><a name="l01528"></a><span class="lineno"> 1528</span> </div>
|
|
<div class="line"><a name="l01529"></a><span class="lineno"> 1529</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01530"></a><span class="lineno"> 1530</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l01531"></a><span class="lineno"> 1531</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01532"></a><span class="lineno"> 1532</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01533"></a><span class="lineno"> 1533</span> <span class="comment"> Structure defining a reverb environment.<br></span></div>
|
|
<div class="line"><a name="l01534"></a><span class="lineno"> 1534</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01535"></a><span class="lineno"> 1535</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01536"></a><span class="lineno"> 1536</span> <span class="comment"> Note the default reverb properties are the same as the FMOD_PRESET_GENERIC preset.<br></span></div>
|
|
<div class="line"><a name="l01537"></a><span class="lineno"> 1537</span> <span class="comment"> Note that integer values that typically range from -10,000 to 1000 are represented in </span></div>
|
|
<div class="line"><a name="l01538"></a><span class="lineno"> 1538</span> <span class="comment"> decibels, and are of a logarithmic scale, not linear, wheras float values are always linear.<br></span></div>
|
|
<div class="line"><a name="l01539"></a><span class="lineno"> 1539</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01540"></a><span class="lineno"> 1540</span> <span class="comment"> The numerical values listed below are the maximum, minimum and default values for each variable respectively.<br></span></div>
|
|
<div class="line"><a name="l01541"></a><span class="lineno"> 1541</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01542"></a><span class="lineno"> 1542</span> <span class="comment"> <b>SUPPORTED</b> next to each parameter means the platform the parameter can be set on. Some platforms support all parameters and some don't.<br></span></div>
|
|
<div class="line"><a name="l01543"></a><span class="lineno"> 1543</span> <span class="comment"> WII means Nintendo Wii hardware reverb (must use FMOD_HARDWARE).<br></span></div>
|
|
<div class="line"><a name="l01544"></a><span class="lineno"> 1544</span> <span class="comment"> PSP means Playstation Portable hardware reverb (must use FMOD_HARDWARE).<br></span></div>
|
|
<div class="line"><a name="l01545"></a><span class="lineno"> 1545</span> <span class="comment"> SFX means FMOD SFX software reverb. This works on any platform that uses FMOD_SOFTWARE for loading sounds.<br></span></div>
|
|
<div class="line"><a name="l01546"></a><span class="lineno"> 1546</span> <span class="comment"> --- means unsupported/deprecated. Will either be removed or supported by SFX in the future.</span></div>
|
|
<div class="line"><a name="l01547"></a><span class="lineno"> 1547</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01548"></a><span class="lineno"> 1548</span> <span class="comment"> Nintendo Wii Notes:<br></span></div>
|
|
<div class="line"><a name="l01549"></a><span class="lineno"> 1549</span> <span class="comment"> This structure supports only limited parameters, and maps them to the Wii hardware reverb as follows.<br></span></div>
|
|
<div class="line"><a name="l01550"></a><span class="lineno"> 1550</span> <span class="comment"> DecayTime = 'time'<br></span></div>
|
|
<div class="line"><a name="l01551"></a><span class="lineno"> 1551</span> <span class="comment"> ReverbDelay = 'predelay'<br></span></div>
|
|
<div class="line"><a name="l01552"></a><span class="lineno"> 1552</span> <span class="comment"> ModulationDepth = 'damping'<br></span></div>
|
|
<div class="line"><a name="l01553"></a><span class="lineno"> 1553</span> <span class="comment"> Reflections = 'coloration'<br></span></div>
|
|
<div class="line"><a name="l01554"></a><span class="lineno"> 1554</span> <span class="comment"> EnvDiffusion = 'crosstalk'<br></span></div>
|
|
<div class="line"><a name="l01555"></a><span class="lineno"> 1555</span> <span class="comment"> Room = 'mix'<br></span></div>
|
|
<div class="line"><a name="l01556"></a><span class="lineno"> 1556</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01557"></a><span class="lineno"> 1557</span> <span class="comment"> Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br></span></div>
|
|
<div class="line"><a name="l01558"></a><span class="lineno"> 1558</span> <span class="comment"> Members marked with [w] mean the variable can be written to. The user can set the value.<br></span></div>
|
|
<div class="line"><a name="l01559"></a><span class="lineno"> 1559</span> <span class="comment"> Members marked with [r/w] are either read or write depending on if you are using System::setReverbProperties (w) or System::getReverbProperties (r).</span></div>
|
|
<div class="line"><a name="l01560"></a><span class="lineno"> 1560</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01561"></a><span class="lineno"> 1561</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01562"></a><span class="lineno"> 1562</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01563"></a><span class="lineno"> 1563</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01564"></a><span class="lineno"> 1564</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01565"></a><span class="lineno"> 1565</span> <span class="comment"> System::setReverbProperties</span></div>
|
|
<div class="line"><a name="l01566"></a><span class="lineno"> 1566</span> <span class="comment"> System::getReverbProperties</span></div>
|
|
<div class="line"><a name="l01567"></a><span class="lineno"> 1567</span> <span class="comment"> FMOD_REVERB_PRESETS</span></div>
|
|
<div class="line"><a name="l01568"></a><span class="lineno"> 1568</span> <span class="comment"> FMOD_REVERB_FLAGS</span></div>
|
|
<div class="line"><a name="l01569"></a><span class="lineno"> 1569</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01570"></a><span class="lineno"> 1570</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01571"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html"> 1571</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a></div>
|
|
<div class="line"><a name="l01572"></a><span class="lineno"> 1572</span> { <span class="comment">/* MIN MAX DEFAULT DESCRIPTION */</span></div>
|
|
<div class="line"><a name="l01573"></a><span class="lineno"> 1573</span>  <span class="keywordtype">int</span> Instance; <span class="comment">/* [w] 0 3 0 Environment Instance. (SUPPORTED:SFX(4 instances) and Wii (3 instances)) */</span></div>
|
|
<div class="line"><a name="l01574"></a><span class="lineno"> 1574</span>  <span class="keywordtype">int</span> Environment; <span class="comment">/* [r/w] -1 25 -1 Sets all listener properties. -1 = OFF. (SUPPORTED:SFX(-1 only)/PSP) */</span></div>
|
|
<div class="line"><a name="l01575"></a><span class="lineno"> 1575</span>  <span class="keywordtype">float</span> EnvDiffusion; <span class="comment">/* [r/w] 0.0 1.0 1.0 Environment diffusion (SUPPORTED:WII) */</span></div>
|
|
<div class="line"><a name="l01576"></a><span class="lineno"> 1576</span>  <span class="keywordtype">int</span> Room; <span class="comment">/* [r/w] -10000 0 -1000 Room effect level (at mid frequencies) (SUPPORTED:SFX/WII/PSP) */</span></div>
|
|
<div class="line"><a name="l01577"></a><span class="lineno"> 1577</span>  <span class="keywordtype">int</span> RoomHF; <span class="comment">/* [r/w] -10000 0 -100 Relative room effect level at high frequencies (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01578"></a><span class="lineno"> 1578</span>  <span class="keywordtype">int</span> RoomLF; <span class="comment">/* [r/w] -10000 0 0 Relative room effect level at low frequencies (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01579"></a><span class="lineno"> 1579</span>  <span class="keywordtype">float</span> DecayTime; <span class="comment">/* [r/w] 0.1 20.0 1.49 Reverberation decay time at mid frequencies (SUPPORTED:SFX/WII) */</span></div>
|
|
<div class="line"><a name="l01580"></a><span class="lineno"> 1580</span>  <span class="keywordtype">float</span> DecayHFRatio; <span class="comment">/* [r/w] 0.1 2.0 0.83 High-frequency to mid-frequency decay time ratio (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01581"></a><span class="lineno"> 1581</span>  <span class="keywordtype">float</span> DecayLFRatio; <span class="comment">/* [r/w] 0.1 2.0 1.0 Low-frequency to mid-frequency decay time ratio (SUPPORTED:---) */</span></div>
|
|
<div class="line"><a name="l01582"></a><span class="lineno"> 1582</span>  <span class="keywordtype">int</span> Reflections; <span class="comment">/* [r/w] -10000 1000 -2602 Early reflections level relative to room effect (SUPPORTED:SFX/WII) */</span></div>
|
|
<div class="line"><a name="l01583"></a><span class="lineno"> 1583</span>  <span class="keywordtype">float</span> ReflectionsDelay; <span class="comment">/* [r/w] 0.0 0.3 0.007 Initial reflection delay time (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01584"></a><span class="lineno"> 1584</span>  <span class="keywordtype">int</span> Reverb; <span class="comment">/* [r/w] -10000 2000 200 Late reverberation level relative to room effect (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01585"></a><span class="lineno"> 1585</span>  <span class="keywordtype">float</span> ReverbDelay; <span class="comment">/* [r/w] 0.0 0.1 0.011 Late reverberation delay time relative to initial reflection (SUPPORTED:SFX/WII) */</span></div>
|
|
<div class="line"><a name="l01586"></a><span class="lineno"> 1586</span>  <span class="keywordtype">float</span> ModulationTime; <span class="comment">/* [r/w] 0.04 4.0 0.25 Modulation time (SUPPORTED:---) */</span></div>
|
|
<div class="line"><a name="l01587"></a><span class="lineno"> 1587</span>  <span class="keywordtype">float</span> ModulationDepth; <span class="comment">/* [r/w] 0.0 1.0 0.0 Modulation depth (SUPPORTED:WII) */</span></div>
|
|
<div class="line"><a name="l01588"></a><span class="lineno"> 1588</span>  <span class="keywordtype">float</span> HFReference; <span class="comment">/* [r/w] 20.0 20000.0 5000.0 Reference high frequency (hz) (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01589"></a><span class="lineno"> 1589</span>  <span class="keywordtype">float</span> LFReference; <span class="comment">/* [r/w] 20.0 1000.0 250.0 Reference low frequency (hz) (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01590"></a><span class="lineno"> 1590</span>  <span class="keywordtype">float</span> Diffusion; <span class="comment">/* [r/w] 0.0 100.0 100.0 Value that controls the echo density in the late reverberation decay. (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01591"></a><span class="lineno"> 1591</span>  <span class="keywordtype">float</span> Density; <span class="comment">/* [r/w] 0.0 100.0 100.0 Value that controls the modal density in the late reverberation decay (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01592"></a><span class="lineno"> 1592</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Flags; <span class="comment">/* [r/w] FMOD_REVERB_FLAGS - modifies the behavior of above properties (SUPPORTED:WII) */</span></div>
|
|
<div class="line"><a name="l01593"></a><span class="lineno"> 1593</span> } <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a>;</div>
|
|
<div class="line"><a name="l01594"></a><span class="lineno"> 1594</span> </div>
|
|
<div class="line"><a name="l01595"></a><span class="lineno"> 1595</span> </div>
|
|
<div class="line"><a name="l01596"></a><span class="lineno"> 1596</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01597"></a><span class="lineno"> 1597</span> <span class="comment">[DEFINE] </span></div>
|
|
<div class="line"><a name="l01598"></a><span class="lineno"> 1598</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01599"></a><span class="lineno"> 1599</span> <span class="comment"> [NAME] </span></div>
|
|
<div class="line"><a name="l01600"></a><span class="lineno"> 1600</span> <span class="comment"> FMOD_REVERB_FLAGS</span></div>
|
|
<div class="line"><a name="l01601"></a><span class="lineno"> 1601</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01602"></a><span class="lineno"> 1602</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01603"></a><span class="lineno"> 1603</span> <span class="comment"> Values for the Flags member of the FMOD_REVERB_PROPERTIES structure.</span></div>
|
|
<div class="line"><a name="l01604"></a><span class="lineno"> 1604</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01605"></a><span class="lineno"> 1605</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01606"></a><span class="lineno"> 1606</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01607"></a><span class="lineno"> 1607</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01608"></a><span class="lineno"> 1608</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01609"></a><span class="lineno"> 1609</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01610"></a><span class="lineno"> 1610</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01611"></a><span class="lineno"> 1611</span> <span class="comment"> FMOD_REVERB_PROPERTIES</span></div>
|
|
<div class="line"><a name="l01612"></a><span class="lineno"> 1612</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01613"></a><span class="lineno"> 1613</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01614"></a><span class="lineno"> 1614</span> <span class="preprocessor">#define FMOD_REVERB_FLAGS_HIGHQUALITYREVERB 0x00000400 </span><span class="comment">/* Wii. Use high quality reverb */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01615"></a><span class="lineno"> 1615</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_REVERB_FLAGS_HIGHQUALITYDPL2REVERB 0x00000800 </span><span class="comment">/* Wii. Use high quality DPL2 reverb */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01616"></a><span class="lineno"> 1616</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_REVERB_FLAGS_HARDWAREONLY 0x00001000 </span><span class="comment">/* Don't create an SFX reverb for FMOD_SOFTWARE channels, hardware reverb only */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01617"></a><span class="lineno"> 1617</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_REVERB_FLAGS_DEFAULT 0x00000000</span></div>
|
|
<div class="line"><a name="l01618"></a><span class="lineno"> 1618</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l01619"></a><span class="lineno"> 1619</span> </div>
|
|
<div class="line"><a name="l01620"></a><span class="lineno"> 1620</span> </div>
|
|
<div class="line"><a name="l01621"></a><span class="lineno"> 1621</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01622"></a><span class="lineno"> 1622</span> <span class="comment">[DEFINE] </span></div>
|
|
<div class="line"><a name="l01623"></a><span class="lineno"> 1623</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01624"></a><span class="lineno"> 1624</span> <span class="comment"> [NAME] </span></div>
|
|
<div class="line"><a name="l01625"></a><span class="lineno"> 1625</span> <span class="comment"> FMOD_REVERB_PRESETS</span></div>
|
|
<div class="line"><a name="l01626"></a><span class="lineno"> 1626</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01627"></a><span class="lineno"> 1627</span> <span class="comment"> [DESCRIPTION] </span></div>
|
|
<div class="line"><a name="l01628"></a><span class="lineno"> 1628</span> <span class="comment"> A set of predefined environment PARAMETERS.<br></span></div>
|
|
<div class="line"><a name="l01629"></a><span class="lineno"> 1629</span> <span class="comment"> These are used to initialize an FMOD_REVERB_PROPERTIES structure statically.<br></span></div>
|
|
<div class="line"><a name="l01630"></a><span class="lineno"> 1630</span> <span class="comment"> i.e.<br></span></div>
|
|
<div class="line"><a name="l01631"></a><span class="lineno"> 1631</span> <span class="comment"> FMOD_REVERB_PROPERTIES prop = FMOD_PRESET_GENERIC;</span></div>
|
|
<div class="line"><a name="l01632"></a><span class="lineno"> 1632</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01633"></a><span class="lineno"> 1633</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01634"></a><span class="lineno"> 1634</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01635"></a><span class="lineno"> 1635</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01636"></a><span class="lineno"> 1636</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01637"></a><span class="lineno"> 1637</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01638"></a><span class="lineno"> 1638</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01639"></a><span class="lineno"> 1639</span> <span class="comment"> System::setReverbProperties</span></div>
|
|
<div class="line"><a name="l01640"></a><span class="lineno"> 1640</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01641"></a><span class="lineno"> 1641</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01642"></a><span class="lineno"> 1642</span> <span class="comment">/* Inst Env Diffus Room RoomHF RmLF DecTm DecHF DecLF Refl RefDel Revb RevDel ModTm ModDp HFRef LFRef Diffus Densty FLAGS */</span></div>
|
|
<div class="line"><a name="l01643"></a><span class="lineno"> 1643</span> <span class="preprocessor">#define FMOD_PRESET_OFF { 0, -1, 1.00f, -10000, -10000, 0, 1.00f, 1.00f, 1.0f, -2602, 0.007f, 200, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 0.0f, 0.0f, 0x33f }</span></div>
|
|
<div class="line"><a name="l01644"></a><span class="lineno"> 1644</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_GENERIC { 0, 0, 1.00f, -1000, -100, 0, 1.49f, 0.83f, 1.0f, -2602, 0.007f, 200, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01645"></a><span class="lineno"> 1645</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PADDEDCELL { 0, 1, 1.00f, -1000, -6000, 0, 0.17f, 0.10f, 1.0f, -1204, 0.001f, 207, 0.002f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01646"></a><span class="lineno"> 1646</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_ROOM { 0, 2, 1.00f, -1000, -454, 0, 0.40f, 0.83f, 1.0f, -1646, 0.002f, 53, 0.003f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01647"></a><span class="lineno"> 1647</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_BATHROOM { 0, 3, 1.00f, -1000, -1200, 0, 1.49f, 0.54f, 1.0f, -370, 0.007f, 1030, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 60.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01648"></a><span class="lineno"> 1648</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_LIVINGROOM { 0, 4, 1.00f, -1000, -6000, 0, 0.50f, 0.10f, 1.0f, -1376, 0.003f, -1104, 0.004f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01649"></a><span class="lineno"> 1649</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_STONEROOM { 0, 5, 1.00f, -1000, -300, 0, 2.31f, 0.64f, 1.0f, -711, 0.012f, 83, 0.017f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01650"></a><span class="lineno"> 1650</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_AUDITORIUM { 0, 6, 1.00f, -1000, -476, 0, 4.32f, 0.59f, 1.0f, -789, 0.020f, -289, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01651"></a><span class="lineno"> 1651</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_CONCERTHALL { 0, 7, 1.00f, -1000, -500, 0, 3.92f, 0.70f, 1.0f, -1230, 0.020f, -2, 0.029f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01652"></a><span class="lineno"> 1652</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_CAVE { 0, 8, 1.00f, -1000, 0, 0, 2.91f, 1.30f, 1.0f, -602, 0.015f, -302, 0.022f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x1f }</span></div>
|
|
<div class="line"><a name="l01653"></a><span class="lineno"> 1653</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_ARENA { 0, 9, 1.00f, -1000, -698, 0, 7.24f, 0.33f, 1.0f, -1166, 0.020f, 16, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01654"></a><span class="lineno"> 1654</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_HANGAR { 0, 10, 1.00f, -1000, -1000, 0, 10.05f, 0.23f, 1.0f, -602, 0.020f, 198, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01655"></a><span class="lineno"> 1655</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_CARPETTEDHALLWAY { 0, 11, 1.00f, -1000, -4000, 0, 0.30f, 0.10f, 1.0f, -1831, 0.002f, -1630, 0.030f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01656"></a><span class="lineno"> 1656</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_HALLWAY { 0, 12, 1.00f, -1000, -300, 0, 1.49f, 0.59f, 1.0f, -1219, 0.007f, 441, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01657"></a><span class="lineno"> 1657</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_STONECORRIDOR { 0, 13, 1.00f, -1000, -237, 0, 2.70f, 0.79f, 1.0f, -1214, 0.013f, 395, 0.020f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01658"></a><span class="lineno"> 1658</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_ALLEY { 0, 14, 0.30f, -1000, -270, 0, 1.49f, 0.86f, 1.0f, -1204, 0.007f, -4, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01659"></a><span class="lineno"> 1659</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_FOREST { 0, 15, 0.30f, -1000, -3300, 0, 1.49f, 0.54f, 1.0f, -2560, 0.162f, -229, 0.088f, 0.25f, 0.000f, 5000.0f, 250.0f, 79.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01660"></a><span class="lineno"> 1660</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_CITY { 0, 16, 0.50f, -1000, -800, 0, 1.49f, 0.67f, 1.0f, -2273, 0.007f, -1691, 0.011f, 0.25f, 0.000f, 5000.0f, 250.0f, 50.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01661"></a><span class="lineno"> 1661</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_MOUNTAINS { 0, 17, 0.27f, -1000, -2500, 0, 1.49f, 0.21f, 1.0f, -2780, 0.300f, -1434, 0.100f, 0.25f, 0.000f, 5000.0f, 250.0f, 27.0f, 100.0f, 0x1f }</span></div>
|
|
<div class="line"><a name="l01662"></a><span class="lineno"> 1662</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_QUARRY { 0, 18, 1.00f, -1000, -1000, 0, 1.49f, 0.83f, 1.0f, -10000, 0.061f, 500, 0.025f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01663"></a><span class="lineno"> 1663</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PLAIN { 0, 19, 0.21f, -1000, -2000, 0, 1.49f, 0.50f, 1.0f, -2466, 0.179f, -1926, 0.100f, 0.25f, 0.000f, 5000.0f, 250.0f, 21.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01664"></a><span class="lineno"> 1664</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PARKINGLOT { 0, 20, 1.00f, -1000, 0, 0, 1.65f, 1.50f, 1.0f, -1363, 0.008f, -1153, 0.012f, 0.25f, 0.000f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x1f }</span></div>
|
|
<div class="line"><a name="l01665"></a><span class="lineno"> 1665</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_SEWERPIPE { 0, 21, 0.80f, -1000, -1000, 0, 2.81f, 0.14f, 1.0f, 429, 0.014f, 1023, 0.021f, 0.25f, 0.000f, 5000.0f, 250.0f, 80.0f, 60.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01666"></a><span class="lineno"> 1666</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_UNDERWATER { 0, 22, 1.00f, -1000, -4000, 0, 1.49f, 0.10f, 1.0f, -449, 0.007f, 1700, 0.011f, 1.18f, 0.348f, 5000.0f, 250.0f, 100.0f, 100.0f, 0x3f }</span></div>
|
|
<div class="line"><a name="l01667"></a><span class="lineno"> 1667</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01668"></a><span class="lineno"> 1668</span> <span class="comment">/* PlayStation Portable Only presets */</span></div>
|
|
<div class="line"><a name="l01669"></a><span class="lineno"> 1669</span> <span class="preprocessor">#define FMOD_PRESET_PSP_ROOM { 0, 1, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01670"></a><span class="lineno"> 1670</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_STUDIO_A { 0, 2, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01671"></a><span class="lineno"> 1671</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_STUDIO_B { 0, 3, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01672"></a><span class="lineno"> 1672</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_STUDIO_C { 0, 4, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01673"></a><span class="lineno"> 1673</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_HALL { 0, 5, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01674"></a><span class="lineno"> 1674</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_SPACE { 0, 6, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01675"></a><span class="lineno"> 1675</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_ECHO { 0, 7, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01676"></a><span class="lineno"> 1676</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_DELAY { 0, 8, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01677"></a><span class="lineno"> 1677</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_PRESET_PSP_PIPE { 0, 9, 0, 0, 0, 0, 0.0f, 0.0f, 0.0f, 0, 0.000f, 0, 0.000f, 0.00f, 0.000f, 0000.0f, 0.0f, 0.0f, 0.0f, 0x31f }</span></div>
|
|
<div class="line"><a name="l01678"></a><span class="lineno"> 1678</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l01679"></a><span class="lineno"> 1679</span> </div>
|
|
<div class="line"><a name="l01680"></a><span class="lineno"> 1680</span> </div>
|
|
<div class="line"><a name="l01681"></a><span class="lineno"> 1681</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01682"></a><span class="lineno"> 1682</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l01683"></a><span class="lineno"> 1683</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01684"></a><span class="lineno"> 1684</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01685"></a><span class="lineno"> 1685</span> <span class="comment"> Structure defining the properties for a reverb source, related to a FMOD channel.<br></span></div>
|
|
<div class="line"><a name="l01686"></a><span class="lineno"> 1686</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01687"></a><span class="lineno"> 1687</span> <span class="comment"> Note the default reverb properties are the same as the FMOD_PRESET_GENERIC preset.<br></span></div>
|
|
<div class="line"><a name="l01688"></a><span class="lineno"> 1688</span> <span class="comment"> Note that integer values that typically range from -10,000 to 1000 are represented in </span></div>
|
|
<div class="line"><a name="l01689"></a><span class="lineno"> 1689</span> <span class="comment"> decibels, and are of a logarithmic scale, not linear, wheras float values are typically linear.<br></span></div>
|
|
<div class="line"><a name="l01690"></a><span class="lineno"> 1690</span> <span class="comment"> PORTABILITY: Each member has the platform it supports in braces ie (win32/wii).<br></span></div>
|
|
<div class="line"><a name="l01691"></a><span class="lineno"> 1691</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01692"></a><span class="lineno"> 1692</span> <span class="comment"> The numerical values listed below are the maximum, minimum and default values for each variable respectively.<br></span></div>
|
|
<div class="line"><a name="l01693"></a><span class="lineno"> 1693</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01694"></a><span class="lineno"> 1694</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01695"></a><span class="lineno"> 1695</span> <span class="comment"> <b>SUPPORTED</b> next to each parameter means the platform the parameter can be set on. Some platforms support all parameters and some don't.<br></span></div>
|
|
<div class="line"><a name="l01696"></a><span class="lineno"> 1696</span> <span class="comment"> WII means Nintendo Wii hardware reverb (must use FMOD_HARDWARE).<br></span></div>
|
|
<div class="line"><a name="l01697"></a><span class="lineno"> 1697</span> <span class="comment"> PSP means Playstation Portable hardware reverb (must use FMOD_HARDWARE).<br></span></div>
|
|
<div class="line"><a name="l01698"></a><span class="lineno"> 1698</span> <span class="comment"> SFX means FMOD SFX software reverb. This works on any platform that uses FMOD_SOFTWARE for loading sounds.<br></span></div>
|
|
<div class="line"><a name="l01699"></a><span class="lineno"> 1699</span> <span class="comment"> --- means unsupported/deprecated. Will either be removed or supported by SFX in the future.</span></div>
|
|
<div class="line"><a name="l01700"></a><span class="lineno"> 1700</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01701"></a><span class="lineno"> 1701</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01702"></a><span class="lineno"> 1702</span> <span class="comment"> <b>'ConnectionPoint' Parameter.</b> This parameter is for the FMOD software reverb only (known as SFX in the list above).<br></span></div>
|
|
<div class="line"><a name="l01703"></a><span class="lineno"> 1703</span> <span class="comment"> By default the dsp network connection for a channel and its reverb is between the 'SFX Reverb' unit, and the channel's wavetable/resampler/dspcodec/oscillator unit (the unit below the channel DSP head). NULL can be used for this parameter to make it use this default behaviour.<br></span></div>
|
|
<div class="line"><a name="l01704"></a><span class="lineno"> 1704</span> <span class="comment"> This parameter allows the user to connect the SFX reverb to somewhere else internally, for example the channel DSP head, or a related channelgroup. The event system uses this so that it can have the output of an event going to the reverb, instead of just the output of the event's channels (thereby ignoring event effects/submixes etc).<br></span></div>
|
|
<div class="line"><a name="l01705"></a><span class="lineno"> 1705</span> <span class="comment"> Do not use if you are unaware of DSP network connection issues. Leave it at the default of NULL instead.<br></span></div>
|
|
<div class="line"><a name="l01706"></a><span class="lineno"> 1706</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01707"></a><span class="lineno"> 1707</span> <span class="comment"> Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br></span></div>
|
|
<div class="line"><a name="l01708"></a><span class="lineno"> 1708</span> <span class="comment"> Members marked with [w] mean the variable can be written to. The user can set the value.<br></span></div>
|
|
<div class="line"><a name="l01709"></a><span class="lineno"> 1709</span> <span class="comment"> Members marked with [r/w] are either read or write depending on if you are using Channel::setReverbProperties (w) or Channel::getReverbProperties (r).</span></div>
|
|
<div class="line"><a name="l01710"></a><span class="lineno"> 1710</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01711"></a><span class="lineno"> 1711</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01712"></a><span class="lineno"> 1712</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01713"></a><span class="lineno"> 1713</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01714"></a><span class="lineno"> 1714</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01715"></a><span class="lineno"> 1715</span> <span class="comment"> Channel::setReverbProperties</span></div>
|
|
<div class="line"><a name="l01716"></a><span class="lineno"> 1716</span> <span class="comment"> Channel::getReverbProperties</span></div>
|
|
<div class="line"><a name="l01717"></a><span class="lineno"> 1717</span> <span class="comment"> FMOD_REVERB_CHANNELFLAGS </span></div>
|
|
<div class="line"><a name="l01718"></a><span class="lineno"> 1718</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01719"></a><span class="lineno"> 1719</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01720"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s.html"> 1720</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_CHANNELPROPERTIES</a></div>
|
|
<div class="line"><a name="l01721"></a><span class="lineno"> 1721</span> { <span class="comment">/* MIN MAX DEFAULT DESCRIPTION */</span></div>
|
|
<div class="line"><a name="l01722"></a><span class="lineno"> 1722</span>  <span class="keywordtype">int</span> Direct; <span class="comment">/* [r/w] -10000 1000 0 Direct path level (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01723"></a><span class="lineno"> 1723</span>  <span class="keywordtype">int</span> Room; <span class="comment">/* [r/w] -10000 1000 0 Room effect level (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01724"></a><span class="lineno"> 1724</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> Flags; <span class="comment">/* [r/w] FMOD_REVERB_CHANNELFLAGS - modifies the behavior of properties (SUPPORTED:SFX) */</span></div>
|
|
<div class="line"><a name="l01725"></a><span class="lineno"> 1725</span>  FMOD_DSP *ConnectionPoint; <span class="comment">/* [r/w] See remarks. DSP network location to connect reverb for this channel. (SUPPORTED:SFX).*/</span></div>
|
|
<div class="line"><a name="l01726"></a><span class="lineno"> 1726</span> } <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_CHANNELPROPERTIES</a>;</div>
|
|
<div class="line"><a name="l01727"></a><span class="lineno"> 1727</span> </div>
|
|
<div class="line"><a name="l01728"></a><span class="lineno"> 1728</span> </div>
|
|
<div class="line"><a name="l01729"></a><span class="lineno"> 1729</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01730"></a><span class="lineno"> 1730</span> <span class="comment">[DEFINE] </span></div>
|
|
<div class="line"><a name="l01731"></a><span class="lineno"> 1731</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01732"></a><span class="lineno"> 1732</span> <span class="comment"> [NAME] </span></div>
|
|
<div class="line"><a name="l01733"></a><span class="lineno"> 1733</span> <span class="comment"> FMOD_REVERB_CHANNELFLAGS</span></div>
|
|
<div class="line"><a name="l01734"></a><span class="lineno"> 1734</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01735"></a><span class="lineno"> 1735</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01736"></a><span class="lineno"> 1736</span> <span class="comment"> Values for the Flags member of the FMOD_REVERB_CHANNELPROPERTIES structure.</span></div>
|
|
<div class="line"><a name="l01737"></a><span class="lineno"> 1737</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01738"></a><span class="lineno"> 1738</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01739"></a><span class="lineno"> 1739</span> <span class="comment"> For SFX Reverb, there is support for multiple reverb environments.<br></span></div>
|
|
<div class="line"><a name="l01740"></a><span class="lineno"> 1740</span> <span class="comment"> Use FMOD_REVERB_CHANNELFLAGS_ENVIRONMENT0 to FMOD_REVERB_CHANNELFLAGS_ENVIRONMENT3 in the flags member </span></div>
|
|
<div class="line"><a name="l01741"></a><span class="lineno"> 1741</span> <span class="comment"> of FMOD_REVERB_CHANNELPROPERTIES to specify which environment instance(s) to target. <br></span></div>
|
|
<div class="line"><a name="l01742"></a><span class="lineno"> 1742</span> <span class="comment"> - If you do not specify any instance the first reverb instance will be used.<br></span></div>
|
|
<div class="line"><a name="l01743"></a><span class="lineno"> 1743</span> <span class="comment"> - If you specify more than one instance with getReverbProperties, the first instance will be used.<br></span></div>
|
|
<div class="line"><a name="l01744"></a><span class="lineno"> 1744</span> <span class="comment"> - If you specify more than one instance with setReverbProperties, it will set more than 1 instance at once.<br></span></div>
|
|
<div class="line"><a name="l01745"></a><span class="lineno"> 1745</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01746"></a><span class="lineno"> 1746</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01747"></a><span class="lineno"> 1747</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01748"></a><span class="lineno"> 1748</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01749"></a><span class="lineno"> 1749</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01750"></a><span class="lineno"> 1750</span> <span class="comment"> FMOD_REVERB_CHANNELPROPERTIES</span></div>
|
|
<div class="line"><a name="l01751"></a><span class="lineno"> 1751</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01752"></a><span class="lineno"> 1752</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01753"></a><span class="lineno"> 1753</span> <span class="preprocessor">#define FMOD_REVERB_CHANNELFLAGS_INSTANCE0 0x00000010 </span><span class="comment">/* SFX/Wii. Specify channel to target reverb instance 0. Default target. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01754"></a><span class="lineno"> 1754</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_REVERB_CHANNELFLAGS_INSTANCE1 0x00000020 </span><span class="comment">/* SFX/Wii. Specify channel to target reverb instance 1. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01755"></a><span class="lineno"> 1755</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_REVERB_CHANNELFLAGS_INSTANCE2 0x00000040 </span><span class="comment">/* SFX/Wii. Specify channel to target reverb instance 2. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01756"></a><span class="lineno"> 1756</span> <span class="preprocessor"></span><span class="preprocessor">#define FMOD_REVERB_CHANNELFLAGS_INSTANCE3 0x00000080 </span><span class="comment">/* SFX. Specify channel to target reverb instance 3. */</span><span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01757"></a><span class="lineno"> 1757</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01758"></a><span class="lineno"> 1758</span> <span class="preprocessor">#define FMOD_REVERB_CHANNELFLAGS_DEFAULT FMOD_REVERB_CHANNELFLAGS_INSTANCE0</span></div>
|
|
<div class="line"><a name="l01759"></a><span class="lineno"> 1759</span> <span class="preprocessor"></span><span class="comment">/* [DEFINE_END] */</span></div>
|
|
<div class="line"><a name="l01760"></a><span class="lineno"> 1760</span> </div>
|
|
<div class="line"><a name="l01761"></a><span class="lineno"> 1761</span> </div>
|
|
<div class="line"><a name="l01762"></a><span class="lineno"> 1762</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01763"></a><span class="lineno"> 1763</span> <span class="comment">[STRUCTURE] </span></div>
|
|
<div class="line"><a name="l01764"></a><span class="lineno"> 1764</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01765"></a><span class="lineno"> 1765</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01766"></a><span class="lineno"> 1766</span> <span class="comment"> Settings for advanced features like configuring memory and cpu usage for the FMOD_CREATECOMPRESSEDSAMPLE feature.</span></div>
|
|
<div class="line"><a name="l01767"></a><span class="lineno"> 1767</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01768"></a><span class="lineno"> 1768</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01769"></a><span class="lineno"> 1769</span> <span class="comment"> maxMPEGcodecs / maxADPCMcodecs / maxXMAcodecs will determine the maximum cpu usage of playing realtime samples. Use this to lower potential excess cpu usage and also control memory usage.<br></span></div>
|
|
<div class="line"><a name="l01770"></a><span class="lineno"> 1770</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01771"></a><span class="lineno"> 1771</span> <span class="comment"> maxPCMcodecs is for use with PS3 only. It will determine the maximum number of PCM voices that can be played at once. This includes streams of any format and all sounds created</span></div>
|
|
<div class="line"><a name="l01772"></a><span class="lineno"> 1772</span> <span class="comment"> *without* the FMOD_CREATECOMPRESSEDSAMPLE flag.</span></div>
|
|
<div class="line"><a name="l01773"></a><span class="lineno"> 1773</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01774"></a><span class="lineno"> 1774</span> <span class="comment"> Memory will be allocated for codecs 'up front' (during System::init) if these values are specified as non zero. If any are zero, it allocates memory for the codec whenever a file of the type in question is loaded. So if maxMPEGcodecs is 0 for example, it will allocate memory for the mpeg codecs the first time an mp3 is loaded or an mp3 based .FSB file is loaded.<br></span></div>
|
|
<div class="line"><a name="l01775"></a><span class="lineno"> 1775</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01776"></a><span class="lineno"> 1776</span> <span class="comment"> Due to inefficient encoding techniques on certain .wav based ADPCM files, FMOD can can need an extra 29720 bytes per codec. This means for lowest memory consumption. Use FSB as it uses an optimal/small ADPCM block size.<br></span></div>
|
|
<div class="line"><a name="l01777"></a><span class="lineno"> 1777</span> <span class="comment"> <br></span></div>
|
|
<div class="line"><a name="l01778"></a><span class="lineno"> 1778</span> <span class="comment"> Members marked with [r] mean the variable is modified by FMOD and is for reading purposes only. Do not change this value.<br></span></div>
|
|
<div class="line"><a name="l01779"></a><span class="lineno"> 1779</span> <span class="comment"> Members marked with [w] mean the variable can be written to. The user can set the value.<br></span></div>
|
|
<div class="line"><a name="l01780"></a><span class="lineno"> 1780</span> <span class="comment"> Members marked with [r/w] are either read or write depending on if you are using System::setAdvancedSettings (w) or System::getAdvancedSettings (r).</span></div>
|
|
<div class="line"><a name="l01781"></a><span class="lineno"> 1781</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01782"></a><span class="lineno"> 1782</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01783"></a><span class="lineno"> 1783</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01784"></a><span class="lineno"> 1784</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01785"></a><span class="lineno"> 1785</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01786"></a><span class="lineno"> 1786</span> <span class="comment"> System::setAdvancedSettings</span></div>
|
|
<div class="line"><a name="l01787"></a><span class="lineno"> 1787</span> <span class="comment"> System::getAdvancedSettings</span></div>
|
|
<div class="line"><a name="l01788"></a><span class="lineno"> 1788</span> <span class="comment"> System::init</span></div>
|
|
<div class="line"><a name="l01789"></a><span class="lineno"> 1789</span> <span class="comment"> FMOD_MODE</span></div>
|
|
<div class="line"><a name="l01790"></a><span class="lineno"> 1790</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01791"></a><span class="lineno"> 1791</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01792"></a><span class="lineno"><a class="line" href="struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s.html"> 1792</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s.html">FMOD_ADVANCEDSETTINGS</a></div>
|
|
<div class="line"><a name="l01793"></a><span class="lineno"> 1793</span> { </div>
|
|
<div class="line"><a name="l01794"></a><span class="lineno"> 1794</span>  <span class="keywordtype">int</span> cbsize; <span class="comment">/* [w] Size of this structure. Use sizeof(FMOD_ADVANCEDSETTINGS) NOTE: This must be set before calling System::getAdvancedSettings! */</span></div>
|
|
<div class="line"><a name="l01795"></a><span class="lineno"> 1795</span>  <span class="keywordtype">int</span> maxMPEGcodecs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. Mpeg codecs consume 21,684 bytes per instance and this number will determine how many mpeg channels can be played simultaneously. Default = 32. */</span></div>
|
|
<div class="line"><a name="l01796"></a><span class="lineno"> 1796</span>  <span class="keywordtype">int</span> maxADPCMcodecs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. ADPCM codecs consume 2,136 bytes per instance and this number will determine how many ADPCM channels can be played simultaneously. Default = 32. */</span></div>
|
|
<div class="line"><a name="l01797"></a><span class="lineno"> 1797</span>  <span class="keywordtype">int</span> maxXMAcodecs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. XMA codecs consume 14,836 bytes per instance and this number will determine how many XMA channels can be played simultaneously. Default = 32. */</span></div>
|
|
<div class="line"><a name="l01798"></a><span class="lineno"> 1798</span>  <span class="keywordtype">int</span> maxCELTcodecs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. CELT codecs consume 11,500 bytes per instance and this number will determine how many CELT channels can be played simultaneously. Default = 32. */</span> </div>
|
|
<div class="line"><a name="l01799"></a><span class="lineno"> 1799</span>  <span class="keywordtype">int</span> maxVORBIScodecs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. Vorbis codecs consume 12,000 bytes per instance and this number will determine how many Vorbis channels can be played simultaneously. Default = 32. */</span> </div>
|
|
<div class="line"><a name="l01800"></a><span class="lineno"> 1800</span>  <span class="keywordtype">int</span> maxAT9Codecs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_CREATECOMPRESSEDSAMPLE only. AT9 codecs consume 8,720 bytes per instance and this number will determine how many AT9 channels can be played simultaneously. Default = 32. */</span> </div>
|
|
<div class="line"><a name="l01801"></a><span class="lineno"> 1801</span>  <span class="keywordtype">int</span> maxPCMcodecs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with PS3 only. PCM codecs consume 12,672 bytes per instance and this number will determine how many streams and PCM voices can be played simultaneously. Default = 16. */</span></div>
|
|
<div class="line"><a name="l01802"></a><span class="lineno"> 1802</span>  <span class="keywordtype">int</span> ASIONumChannels; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Number of channels available on the ASIO device. */</span></div>
|
|
<div class="line"><a name="l01803"></a><span class="lineno"> 1803</span>  <span class="keywordtype">char</span> **ASIOChannelList; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Pointer to an array of strings (number of entries defined by ASIONumChannels) with ASIO channel names. */</span></div>
|
|
<div class="line"><a name="l01804"></a><span class="lineno"> 1804</span>  FMOD_SPEAKER *ASIOSpeakerList; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Pointer to a list of speakers that the ASIO channels map to. This can be called after System::init to remap ASIO output. */</span></div>
|
|
<div class="line"><a name="l01805"></a><span class="lineno"> 1805</span>  <span class="keywordtype">int</span> max3DReverbDSPs; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. The max number of 3d reverb DSP's in the system. (NOTE: CURRENTLY DISABLED / UNUSED) */</span></div>
|
|
<div class="line"><a name="l01806"></a><span class="lineno"> 1806</span>  <span class="keywordtype">float</span> HRTFMinAngle; <span class="comment">/* [r/w] Optional. For use with FMOD_INIT_HRTF_LOWPASS. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function begins to have an effect. 0 = in front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 180.0. */</span></div>
|
|
<div class="line"><a name="l01807"></a><span class="lineno"> 1807</span>  <span class="keywordtype">float</span> HRTFMaxAngle; <span class="comment">/* [r/w] Optional. For use with FMOD_INIT_HRTF_LOWPASS. The angle range (0-360) of a 3D sound in relation to the listener, at which the HRTF function has maximum effect. 0 = front of the listener. 180 = from 90 degrees to the left of the listener to 90 degrees to the right. 360 = behind the listener. Default = 360.0. */</span></div>
|
|
<div class="line"><a name="l01808"></a><span class="lineno"> 1808</span>  <span class="keywordtype">float</span> HRTFFreq; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_HRTF_LOWPASS. The cutoff frequency of the HRTF's lowpass filter function when at maximum effect. (i.e. at HRTFMaxAngle). Default = 4000.0. */</span></div>
|
|
<div class="line"><a name="l01809"></a><span class="lineno"> 1809</span>  <span class="keywordtype">float</span> vol0virtualvol; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_VOL0_BECOMES_VIRTUAL. If this flag is used, and the volume is 0.0, then the sound will become virtual. Use this value to raise the threshold to a different point where a sound goes virtual. */</span></div>
|
|
<div class="line"><a name="l01810"></a><span class="lineno"> 1810</span>  <span class="keywordtype">int</span> eventqueuesize; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD Event system only. Specifies the number of slots available for simultaneous non blocking loads, across all threads. Default = 32. */</span></div>
|
|
<div class="line"><a name="l01811"></a><span class="lineno"> 1811</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> defaultDecodeBufferSize; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For streams. This determines the default size of the double buffer (in milliseconds) that a stream uses. Default = 400ms */</span></div>
|
|
<div class="line"><a name="l01812"></a><span class="lineno"> 1812</span>  <span class="keywordtype">char</span> *debugLogFilename; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Gives fmod's logging system a path/filename. Normally the log is placed in the same directory as the executable and called fmod.log. When using System::getAdvancedSettings, provide at least 256 bytes of memory to copy into. */</span></div>
|
|
<div class="line"><a name="l01813"></a><span class="lineno"> 1813</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> profileport; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_ENABLE_PROFILE. Specify the port to listen on for connections by the profiler application. */</span></div>
|
|
<div class="line"><a name="l01814"></a><span class="lineno"> 1814</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> geometryMaxFadeTime; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. The maximum time in miliseconds it takes for a channel to fade to the new level when its occlusion changes. */</span></div>
|
|
<div class="line"><a name="l01815"></a><span class="lineno"> 1815</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxSpectrumWaveDataBuffers; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Tells System::init to allocate a pool of wavedata/spectrum buffers to prevent memory fragmentation, any additional buffers will be allocated normally. */</span></div>
|
|
<div class="line"><a name="l01816"></a><span class="lineno"> 1816</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> musicSystemCacheDelay; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. The delay the music system should allow for loading a sample from disk (in milliseconds). Default = 400 ms. */</span></div>
|
|
<div class="line"><a name="l01817"></a><span class="lineno"> 1817</span>  <span class="keywordtype">float</span> distanceFilterCenterFreq; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. For use with FMOD_INIT_DISTANCE_FILTERING. The default center frequency in Hz for the distance filtering effect. Default = 1500.0. */</span></div>
|
|
<div class="line"><a name="l01818"></a><span class="lineno"> 1818</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stackSizeStream; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD Stream thread in bytes. Useful for custom codecs that use excess stack. Default 49,152 (48kb) */</span></div>
|
|
<div class="line"><a name="l01819"></a><span class="lineno"> 1819</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stackSizeNonBlocking; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD_NONBLOCKING loading thread. Useful for custom codecs that use excess stack. Default 65,536 (64kb) */</span></div>
|
|
<div class="line"><a name="l01820"></a><span class="lineno"> 1820</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> stackSizeMixer; <span class="comment">/* [r/w] Optional. Specify 0 to ignore. Specify the stack size for the FMOD mixer thread. Useful for custom dsps that use excess stack. Default 49,152 (48kb) */</span></div>
|
|
<div class="line"><a name="l01821"></a><span class="lineno"> 1821</span> } <a class="code" href="struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s.html">FMOD_ADVANCEDSETTINGS</a>;</div>
|
|
<div class="line"><a name="l01822"></a><span class="lineno"> 1822</span> </div>
|
|
<div class="line"><a name="l01823"></a><span class="lineno"> 1823</span> </div>
|
|
<div class="line"><a name="l01824"></a><span class="lineno"> 1824</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01825"></a><span class="lineno"> 1825</span> <span class="comment">[ENUM]</span></div>
|
|
<div class="line"><a name="l01826"></a><span class="lineno"> 1826</span> <span class="comment">[</span></div>
|
|
<div class="line"><a name="l01827"></a><span class="lineno"> 1827</span> <span class="comment"> [DESCRIPTION]</span></div>
|
|
<div class="line"><a name="l01828"></a><span class="lineno"> 1828</span> <span class="comment"> Special channel index values for FMOD functions.</span></div>
|
|
<div class="line"><a name="l01829"></a><span class="lineno"> 1829</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01830"></a><span class="lineno"> 1830</span> <span class="comment"> [REMARKS]</span></div>
|
|
<div class="line"><a name="l01831"></a><span class="lineno"> 1831</span> <span class="comment"> To get 'all' of the channels, use System::getMasterChannelGroup.</span></div>
|
|
<div class="line"><a name="l01832"></a><span class="lineno"> 1832</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01833"></a><span class="lineno"> 1833</span> <span class="comment"> [PLATFORMS]</span></div>
|
|
<div class="line"><a name="l01834"></a><span class="lineno"> 1834</span> <span class="comment"> Win32, Win64, Linux, Linux64, Macintosh, Xbox360, PlayStation Portable, PlayStation 3, Wii, iPhone, 3GS, NGP, Android</span></div>
|
|
<div class="line"><a name="l01835"></a><span class="lineno"> 1835</span> <span class="comment"></span></div>
|
|
<div class="line"><a name="l01836"></a><span class="lineno"> 1836</span> <span class="comment"> [SEE_ALSO]</span></div>
|
|
<div class="line"><a name="l01837"></a><span class="lineno"> 1837</span> <span class="comment"> System::playSound</span></div>
|
|
<div class="line"><a name="l01838"></a><span class="lineno"> 1838</span> <span class="comment"> System::playDSP</span></div>
|
|
<div class="line"><a name="l01839"></a><span class="lineno"> 1839</span> <span class="comment"> System::getChannel</span></div>
|
|
<div class="line"><a name="l01840"></a><span class="lineno"> 1840</span> <span class="comment"> System::getMasterChannelGroup</span></div>
|
|
<div class="line"><a name="l01841"></a><span class="lineno"> 1841</span> <span class="comment">]</span></div>
|
|
<div class="line"><a name="l01842"></a><span class="lineno"> 1842</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01843"></a><span class="lineno"> 1843</span> <span class="keyword">typedef</span> <span class="keyword">enum</span></div>
|
|
<div class="line"><a name="l01844"></a><span class="lineno"> 1844</span> {</div>
|
|
<div class="line"><a name="l01845"></a><span class="lineno"> 1845</span>  FMOD_CHANNEL_FREE = -1, <span class="comment">/* For a channel index, FMOD chooses a free voice using the priority system. */</span></div>
|
|
<div class="line"><a name="l01846"></a><span class="lineno"> 1846</span>  FMOD_CHANNEL_REUSE = -2 <span class="comment">/* For a channel index, re-use the channel handle that was passed in. */</span></div>
|
|
<div class="line"><a name="l01847"></a><span class="lineno"> 1847</span> } FMOD_CHANNELINDEX;</div>
|
|
<div class="line"><a name="l01848"></a><span class="lineno"> 1848</span> </div>
|
|
<div class="line"><a name="l01849"></a><span class="lineno"> 1849</span> <span class="preprocessor">#include "fmod_codec.h"</span></div>
|
|
<div class="line"><a name="l01850"></a><span class="lineno"> 1850</span> <span class="preprocessor">#include "fmod_dsp.h"</span></div>
|
|
<div class="line"><a name="l01851"></a><span class="lineno"> 1851</span> <span class="preprocessor">#include "fmod_memoryinfo.h"</span></div>
|
|
<div class="line"><a name="l01852"></a><span class="lineno"> 1852</span> </div>
|
|
<div class="line"><a name="l01853"></a><span class="lineno"> 1853</span> <span class="comment">/* ========================================================================================== */</span></div>
|
|
<div class="line"><a name="l01854"></a><span class="lineno"> 1854</span> <span class="comment">/* FUNCTION PROTOTYPES */</span></div>
|
|
<div class="line"><a name="l01855"></a><span class="lineno"> 1855</span> <span class="comment">/* ========================================================================================== */</span></div>
|
|
<div class="line"><a name="l01856"></a><span class="lineno"> 1856</span> </div>
|
|
<div class="line"><a name="l01857"></a><span class="lineno"> 1857</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l01858"></a><span class="lineno"> 1858</span> <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> </div>
|
|
<div class="line"><a name="l01859"></a><span class="lineno"> 1859</span> {</div>
|
|
<div class="line"><a name="l01860"></a><span class="lineno"> 1860</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l01861"></a><span class="lineno"> 1861</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l01862"></a><span class="lineno"> 1862</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01863"></a><span class="lineno"> 1863</span> <span class="comment"> FMOD global system functions (optional).</span></div>
|
|
<div class="line"><a name="l01864"></a><span class="lineno"> 1864</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01865"></a><span class="lineno"> 1865</span> </div>
|
|
<div class="line"><a name="l01866"></a><span class="lineno"> 1866</span> FMOD_RESULT F_API FMOD_Memory_Initialize (<span class="keywordtype">void</span> *poolmem, <span class="keywordtype">int</span> poollen, FMOD_MEMORY_ALLOCCALLBACK useralloc, FMOD_MEMORY_REALLOCCALLBACK userrealloc, FMOD_MEMORY_FREECALLBACK userfree, FMOD_MEMORY_TYPE memtypeflags);</div>
|
|
<div class="line"><a name="l01867"></a><span class="lineno"> 1867</span> FMOD_RESULT F_API FMOD_Memory_GetStats (<span class="keywordtype">int</span> *currentalloced, <span class="keywordtype">int</span> *maxalloced, FMOD_BOOL blocking);</div>
|
|
<div class="line"><a name="l01868"></a><span class="lineno"> 1868</span> FMOD_RESULT F_API FMOD_Debug_SetLevel (FMOD_DEBUGLEVEL level);</div>
|
|
<div class="line"><a name="l01869"></a><span class="lineno"> 1869</span> FMOD_RESULT F_API FMOD_Debug_GetLevel (FMOD_DEBUGLEVEL *level);</div>
|
|
<div class="line"><a name="l01870"></a><span class="lineno"> 1870</span> FMOD_RESULT F_API FMOD_File_SetDiskBusy (<span class="keywordtype">int</span> busy);</div>
|
|
<div class="line"><a name="l01871"></a><span class="lineno"> 1871</span> FMOD_RESULT F_API FMOD_File_GetDiskBusy (<span class="keywordtype">int</span> *busy);</div>
|
|
<div class="line"><a name="l01872"></a><span class="lineno"> 1872</span> </div>
|
|
<div class="line"><a name="l01873"></a><span class="lineno"> 1873</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01874"></a><span class="lineno"> 1874</span> <span class="comment"> FMOD System factory functions. Use this to create an FMOD System Instance. below you will see FMOD_System_Init/Close to get started.</span></div>
|
|
<div class="line"><a name="l01875"></a><span class="lineno"> 1875</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01876"></a><span class="lineno"> 1876</span> </div>
|
|
<div class="line"><a name="l01877"></a><span class="lineno"> 1877</span> FMOD_RESULT F_API FMOD_System_Create (FMOD_SYSTEM **system); </div>
|
|
<div class="line"><a name="l01878"></a><span class="lineno"> 1878</span> FMOD_RESULT F_API FMOD_System_Release (FMOD_SYSTEM *system); </div>
|
|
<div class="line"><a name="l01879"></a><span class="lineno"> 1879</span> </div>
|
|
<div class="line"><a name="l01880"></a><span class="lineno"> 1880</span> <span class="comment">/*$ preserve end $*/</span></div>
|
|
<div class="line"><a name="l01881"></a><span class="lineno"> 1881</span> </div>
|
|
<div class="line"><a name="l01882"></a><span class="lineno"> 1882</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01883"></a><span class="lineno"> 1883</span> <span class="comment"> 'System' API</span></div>
|
|
<div class="line"><a name="l01884"></a><span class="lineno"> 1884</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01885"></a><span class="lineno"> 1885</span> </div>
|
|
<div class="line"><a name="l01886"></a><span class="lineno"> 1886</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01887"></a><span class="lineno"> 1887</span> <span class="comment"> Pre-init functions.</span></div>
|
|
<div class="line"><a name="l01888"></a><span class="lineno"> 1888</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01889"></a><span class="lineno"> 1889</span> </div>
|
|
<div class="line"><a name="l01890"></a><span class="lineno"> 1890</span> FMOD_RESULT F_API FMOD_System_SetOutput (FMOD_SYSTEM *system, FMOD_OUTPUTTYPE output);</div>
|
|
<div class="line"><a name="l01891"></a><span class="lineno"> 1891</span> FMOD_RESULT F_API FMOD_System_GetOutput (FMOD_SYSTEM *system, FMOD_OUTPUTTYPE *output);</div>
|
|
<div class="line"><a name="l01892"></a><span class="lineno"> 1892</span> FMOD_RESULT F_API FMOD_System_GetNumDrivers (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *numdrivers);</div>
|
|
<div class="line"><a name="l01893"></a><span class="lineno"> 1893</span> FMOD_RESULT F_API FMOD_System_GetDriverInfo (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> namelen, <a class="code" href="struct_f_m_o_d___g_u_i_d.html">FMOD_GUID</a> *guid);</div>
|
|
<div class="line"><a name="l01894"></a><span class="lineno"> 1894</span> FMOD_RESULT F_API FMOD_System_GetDriverInfoW (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">short</span> *name, <span class="keywordtype">int</span> namelen, <a class="code" href="struct_f_m_o_d___g_u_i_d.html">FMOD_GUID</a> *guid);</div>
|
|
<div class="line"><a name="l01895"></a><span class="lineno"> 1895</span> FMOD_RESULT F_API FMOD_System_GetDriverCaps (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, FMOD_CAPS *caps, <span class="keywordtype">int</span> *controlpaneloutputrate, FMOD_SPEAKERMODE *controlpanelspeakermode);</div>
|
|
<div class="line"><a name="l01896"></a><span class="lineno"> 1896</span> FMOD_RESULT F_API FMOD_System_SetDriver (FMOD_SYSTEM *system, <span class="keywordtype">int</span> driver);</div>
|
|
<div class="line"><a name="l01897"></a><span class="lineno"> 1897</span> FMOD_RESULT F_API FMOD_System_GetDriver (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *driver);</div>
|
|
<div class="line"><a name="l01898"></a><span class="lineno"> 1898</span> FMOD_RESULT F_API FMOD_System_SetHardwareChannels (FMOD_SYSTEM *system, <span class="keywordtype">int</span> numhardwarechannels);</div>
|
|
<div class="line"><a name="l01899"></a><span class="lineno"> 1899</span> FMOD_RESULT F_API FMOD_System_SetSoftwareChannels (FMOD_SYSTEM *system, <span class="keywordtype">int</span> numsoftwarechannels);</div>
|
|
<div class="line"><a name="l01900"></a><span class="lineno"> 1900</span> FMOD_RESULT F_API FMOD_System_GetSoftwareChannels (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *numsoftwarechannels);</div>
|
|
<div class="line"><a name="l01901"></a><span class="lineno"> 1901</span> FMOD_RESULT F_API FMOD_System_SetSoftwareFormat (FMOD_SYSTEM *system, <span class="keywordtype">int</span> samplerate, FMOD_SOUND_FORMAT format, <span class="keywordtype">int</span> numoutputchannels, <span class="keywordtype">int</span> maxinputchannels, FMOD_DSP_RESAMPLER resamplemethod);</div>
|
|
<div class="line"><a name="l01902"></a><span class="lineno"> 1902</span> FMOD_RESULT F_API FMOD_System_GetSoftwareFormat (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *samplerate, FMOD_SOUND_FORMAT *format, <span class="keywordtype">int</span> *numoutputchannels, <span class="keywordtype">int</span> *maxinputchannels, FMOD_DSP_RESAMPLER *resamplemethod, <span class="keywordtype">int</span> *bits);</div>
|
|
<div class="line"><a name="l01903"></a><span class="lineno"> 1903</span> FMOD_RESULT F_API FMOD_System_SetDSPBufferSize (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> bufferlength, <span class="keywordtype">int</span> numbuffers);</div>
|
|
<div class="line"><a name="l01904"></a><span class="lineno"> 1904</span> FMOD_RESULT F_API FMOD_System_GetDSPBufferSize (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *bufferlength, <span class="keywordtype">int</span> *numbuffers);</div>
|
|
<div class="line"><a name="l01905"></a><span class="lineno"> 1905</span> FMOD_RESULT F_API FMOD_System_SetFileSystem (FMOD_SYSTEM *system, FMOD_FILE_OPENCALLBACK useropen, FMOD_FILE_CLOSECALLBACK userclose, FMOD_FILE_READCALLBACK userread, FMOD_FILE_SEEKCALLBACK userseek, FMOD_FILE_ASYNCREADCALLBACK userasyncread, FMOD_FILE_ASYNCCANCELCALLBACK userasynccancel, <span class="keywordtype">int</span> blockalign);</div>
|
|
<div class="line"><a name="l01906"></a><span class="lineno"> 1906</span> FMOD_RESULT F_API FMOD_System_AttachFileSystem (FMOD_SYSTEM *system, FMOD_FILE_OPENCALLBACK useropen, FMOD_FILE_CLOSECALLBACK userclose, FMOD_FILE_READCALLBACK userread, FMOD_FILE_SEEKCALLBACK userseek);</div>
|
|
<div class="line"><a name="l01907"></a><span class="lineno"> 1907</span> FMOD_RESULT F_API FMOD_System_SetAdvancedSettings (FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s.html">FMOD_ADVANCEDSETTINGS</a> *settings);</div>
|
|
<div class="line"><a name="l01908"></a><span class="lineno"> 1908</span> FMOD_RESULT F_API FMOD_System_GetAdvancedSettings (FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s.html">FMOD_ADVANCEDSETTINGS</a> *settings);</div>
|
|
<div class="line"><a name="l01909"></a><span class="lineno"> 1909</span> FMOD_RESULT F_API FMOD_System_SetSpeakerMode (FMOD_SYSTEM *system, FMOD_SPEAKERMODE speakermode);</div>
|
|
<div class="line"><a name="l01910"></a><span class="lineno"> 1910</span> FMOD_RESULT F_API FMOD_System_GetSpeakerMode (FMOD_SYSTEM *system, FMOD_SPEAKERMODE *speakermode);</div>
|
|
<div class="line"><a name="l01911"></a><span class="lineno"> 1911</span> FMOD_RESULT F_API FMOD_System_SetCallback (FMOD_SYSTEM *system, FMOD_SYSTEM_CALLBACK callback);</div>
|
|
<div class="line"><a name="l01912"></a><span class="lineno"> 1912</span> </div>
|
|
<div class="line"><a name="l01913"></a><span class="lineno"> 1913</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01914"></a><span class="lineno"> 1914</span> <span class="comment"> Plug-in support </span></div>
|
|
<div class="line"><a name="l01915"></a><span class="lineno"> 1915</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01916"></a><span class="lineno"> 1916</span> </div>
|
|
<div class="line"><a name="l01917"></a><span class="lineno"> 1917</span> FMOD_RESULT F_API FMOD_System_SetPluginPath (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div>
|
|
<div class="line"><a name="l01918"></a><span class="lineno"> 1918</span> FMOD_RESULT F_API FMOD_System_LoadPlugin (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">char</span> *filename, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *handle, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> priority);</div>
|
|
<div class="line"><a name="l01919"></a><span class="lineno"> 1919</span> FMOD_RESULT F_API FMOD_System_UnloadPlugin (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> handle);</div>
|
|
<div class="line"><a name="l01920"></a><span class="lineno"> 1920</span> FMOD_RESULT F_API FMOD_System_GetNumPlugins (FMOD_SYSTEM *system, FMOD_PLUGINTYPE plugintype, <span class="keywordtype">int</span> *numplugins);</div>
|
|
<div class="line"><a name="l01921"></a><span class="lineno"> 1921</span> FMOD_RESULT F_API FMOD_System_GetPluginHandle (FMOD_SYSTEM *system, FMOD_PLUGINTYPE plugintype, <span class="keywordtype">int</span> index, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *handle);</div>
|
|
<div class="line"><a name="l01922"></a><span class="lineno"> 1922</span> FMOD_RESULT F_API FMOD_System_GetPluginInfo (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> handle, FMOD_PLUGINTYPE *plugintype, <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> namelen, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *version);</div>
|
|
<div class="line"><a name="l01923"></a><span class="lineno"> 1923</span> FMOD_RESULT F_API FMOD_System_SetOutputByPlugin (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> handle);</div>
|
|
<div class="line"><a name="l01924"></a><span class="lineno"> 1924</span> FMOD_RESULT F_API FMOD_System_GetOutputByPlugin (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *handle);</div>
|
|
<div class="line"><a name="l01925"></a><span class="lineno"> 1925</span> FMOD_RESULT F_API FMOD_System_CreateDSPByPlugin (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> handle, FMOD_DSP **dsp);</div>
|
|
<div class="line"><a name="l01926"></a><span class="lineno"> 1926</span> FMOD_RESULT F_API FMOD_System_RegisterCodec (FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___c_o_d_e_c___d_e_s_c_r_i_p_t_i_o_n.html">FMOD_CODEC_DESCRIPTION</a> *description, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *handle, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> priority);</div>
|
|
<div class="line"><a name="l01927"></a><span class="lineno"> 1927</span> FMOD_RESULT F_API FMOD_System_RegisterDSP (FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___d_s_p___d_e_s_c_r_i_p_t_i_o_n.html">FMOD_DSP_DESCRIPTION</a> *description, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *handle);</div>
|
|
<div class="line"><a name="l01928"></a><span class="lineno"> 1928</span> </div>
|
|
<div class="line"><a name="l01929"></a><span class="lineno"> 1929</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01930"></a><span class="lineno"> 1930</span> <span class="comment"> Init/Close </span></div>
|
|
<div class="line"><a name="l01931"></a><span class="lineno"> 1931</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01932"></a><span class="lineno"> 1932</span> </div>
|
|
<div class="line"><a name="l01933"></a><span class="lineno"> 1933</span> FMOD_RESULT F_API FMOD_System_Init (FMOD_SYSTEM *system, <span class="keywordtype">int</span> maxchannels, FMOD_INITFLAGS flags, <span class="keywordtype">void</span> *extradriverdata);</div>
|
|
<div class="line"><a name="l01934"></a><span class="lineno"> 1934</span> FMOD_RESULT F_API FMOD_System_Close (FMOD_SYSTEM *system);</div>
|
|
<div class="line"><a name="l01935"></a><span class="lineno"> 1935</span> </div>
|
|
<div class="line"><a name="l01936"></a><span class="lineno"> 1936</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01937"></a><span class="lineno"> 1937</span> <span class="comment"> General post-init system functions </span></div>
|
|
<div class="line"><a name="l01938"></a><span class="lineno"> 1938</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01939"></a><span class="lineno"> 1939</span> </div>
|
|
<div class="line"><a name="l01940"></a><span class="lineno"> 1940</span> FMOD_RESULT F_API FMOD_System_Update (FMOD_SYSTEM *system);</div>
|
|
<div class="line"><a name="l01941"></a><span class="lineno"> 1941</span> </div>
|
|
<div class="line"><a name="l01942"></a><span class="lineno"> 1942</span> FMOD_RESULT F_API FMOD_System_Set3DSettings (FMOD_SYSTEM *system, <span class="keywordtype">float</span> dopplerscale, <span class="keywordtype">float</span> distancefactor, <span class="keywordtype">float</span> rolloffscale);</div>
|
|
<div class="line"><a name="l01943"></a><span class="lineno"> 1943</span> FMOD_RESULT F_API FMOD_System_Get3DSettings (FMOD_SYSTEM *system, <span class="keywordtype">float</span> *dopplerscale, <span class="keywordtype">float</span> *distancefactor, <span class="keywordtype">float</span> *rolloffscale);</div>
|
|
<div class="line"><a name="l01944"></a><span class="lineno"> 1944</span> FMOD_RESULT F_API FMOD_System_Set3DNumListeners (FMOD_SYSTEM *system, <span class="keywordtype">int</span> numlisteners);</div>
|
|
<div class="line"><a name="l01945"></a><span class="lineno"> 1945</span> FMOD_RESULT F_API FMOD_System_Get3DNumListeners (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *numlisteners);</div>
|
|
<div class="line"><a name="l01946"></a><span class="lineno"> 1946</span> FMOD_RESULT F_API FMOD_System_Set3DListenerAttributes(FMOD_SYSTEM *system, <span class="keywordtype">int</span> listener, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *pos, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vel, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *forward, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *up);</div>
|
|
<div class="line"><a name="l01947"></a><span class="lineno"> 1947</span> FMOD_RESULT F_API FMOD_System_Get3DListenerAttributes(FMOD_SYSTEM *system, <span class="keywordtype">int</span> listener, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *pos, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vel, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *forward, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *up);</div>
|
|
<div class="line"><a name="l01948"></a><span class="lineno"> 1948</span> FMOD_RESULT F_API FMOD_System_Set3DRolloffCallback (FMOD_SYSTEM *system, FMOD_3D_ROLLOFFCALLBACK callback);</div>
|
|
<div class="line"><a name="l01949"></a><span class="lineno"> 1949</span> FMOD_RESULT F_API FMOD_System_Set3DSpeakerPosition (FMOD_SYSTEM *system, FMOD_SPEAKER speaker, <span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y, FMOD_BOOL active);</div>
|
|
<div class="line"><a name="l01950"></a><span class="lineno"> 1950</span> FMOD_RESULT F_API FMOD_System_Get3DSpeakerPosition (FMOD_SYSTEM *system, FMOD_SPEAKER speaker, <span class="keywordtype">float</span> *x, <span class="keywordtype">float</span> *y, FMOD_BOOL *active);</div>
|
|
<div class="line"><a name="l01951"></a><span class="lineno"> 1951</span> </div>
|
|
<div class="line"><a name="l01952"></a><span class="lineno"> 1952</span> FMOD_RESULT F_API FMOD_System_SetStreamBufferSize (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> filebuffersize, FMOD_TIMEUNIT filebuffersizetype);</div>
|
|
<div class="line"><a name="l01953"></a><span class="lineno"> 1953</span> FMOD_RESULT F_API FMOD_System_GetStreamBufferSize (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *filebuffersize, FMOD_TIMEUNIT *filebuffersizetype);</div>
|
|
<div class="line"><a name="l01954"></a><span class="lineno"> 1954</span> </div>
|
|
<div class="line"><a name="l01955"></a><span class="lineno"> 1955</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01956"></a><span class="lineno"> 1956</span> <span class="comment"> System information functions. </span></div>
|
|
<div class="line"><a name="l01957"></a><span class="lineno"> 1957</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01958"></a><span class="lineno"> 1958</span> </div>
|
|
<div class="line"><a name="l01959"></a><span class="lineno"> 1959</span> FMOD_RESULT F_API FMOD_System_GetVersion (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *version);</div>
|
|
<div class="line"><a name="l01960"></a><span class="lineno"> 1960</span> FMOD_RESULT F_API FMOD_System_GetOutputHandle (FMOD_SYSTEM *system, <span class="keywordtype">void</span> **handle);</div>
|
|
<div class="line"><a name="l01961"></a><span class="lineno"> 1961</span> FMOD_RESULT F_API FMOD_System_GetChannelsPlaying (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *channels);</div>
|
|
<div class="line"><a name="l01962"></a><span class="lineno"> 1962</span> FMOD_RESULT F_API FMOD_System_GetHardwareChannels (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *numhardwarechannels);</div>
|
|
<div class="line"><a name="l01963"></a><span class="lineno"> 1963</span> FMOD_RESULT F_API FMOD_System_GetCPUUsage (FMOD_SYSTEM *system, <span class="keywordtype">float</span> *dsp, <span class="keywordtype">float</span> *stream, <span class="keywordtype">float</span> *geometry, <span class="keywordtype">float</span> *update, <span class="keywordtype">float</span> *total);</div>
|
|
<div class="line"><a name="l01964"></a><span class="lineno"> 1964</span> FMOD_RESULT F_API FMOD_System_GetSoundRAM (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *currentalloced, <span class="keywordtype">int</span> *maxalloced, <span class="keywordtype">int</span> *total);</div>
|
|
<div class="line"><a name="l01965"></a><span class="lineno"> 1965</span> FMOD_RESULT F_API FMOD_System_GetNumCDROMDrives (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *numdrives);</div>
|
|
<div class="line"><a name="l01966"></a><span class="lineno"> 1966</span> FMOD_RESULT F_API FMOD_System_GetCDROMDriveName (FMOD_SYSTEM *system, <span class="keywordtype">int</span> drive, <span class="keywordtype">char</span> *drivename, <span class="keywordtype">int</span> drivenamelen, <span class="keywordtype">char</span> *scsiname, <span class="keywordtype">int</span> scsinamelen, <span class="keywordtype">char</span> *devicename, <span class="keywordtype">int</span> devicenamelen);</div>
|
|
<div class="line"><a name="l01967"></a><span class="lineno"> 1967</span> FMOD_RESULT F_API FMOD_System_GetSpectrum (FMOD_SYSTEM *system, <span class="keywordtype">float</span> *spectrumarray, <span class="keywordtype">int</span> numvalues, <span class="keywordtype">int</span> channeloffset, FMOD_DSP_FFT_WINDOW windowtype);</div>
|
|
<div class="line"><a name="l01968"></a><span class="lineno"> 1968</span> FMOD_RESULT F_API FMOD_System_GetWaveData (FMOD_SYSTEM *system, <span class="keywordtype">float</span> *wavearray, <span class="keywordtype">int</span> numvalues, <span class="keywordtype">int</span> channeloffset);</div>
|
|
<div class="line"><a name="l01969"></a><span class="lineno"> 1969</span> </div>
|
|
<div class="line"><a name="l01970"></a><span class="lineno"> 1970</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01971"></a><span class="lineno"> 1971</span> <span class="comment"> Sound/DSP/Channel/FX creation and retrieval. </span></div>
|
|
<div class="line"><a name="l01972"></a><span class="lineno"> 1972</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01973"></a><span class="lineno"> 1973</span> </div>
|
|
<div class="line"><a name="l01974"></a><span class="lineno"> 1974</span> FMOD_RESULT F_API FMOD_System_CreateSound (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">char</span> *name_or_data, FMOD_MODE mode, <a class="code" href="struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o.html">FMOD_CREATESOUNDEXINFO</a> *exinfo, FMOD_SOUND **sound);</div>
|
|
<div class="line"><a name="l01975"></a><span class="lineno"> 1975</span> FMOD_RESULT F_API FMOD_System_CreateStream (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">char</span> *name_or_data, FMOD_MODE mode, <a class="code" href="struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o.html">FMOD_CREATESOUNDEXINFO</a> *exinfo, FMOD_SOUND **sound);</div>
|
|
<div class="line"><a name="l01976"></a><span class="lineno"> 1976</span> FMOD_RESULT F_API FMOD_System_CreateDSP (FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___d_s_p___d_e_s_c_r_i_p_t_i_o_n.html">FMOD_DSP_DESCRIPTION</a> *description, FMOD_DSP **dsp);</div>
|
|
<div class="line"><a name="l01977"></a><span class="lineno"> 1977</span> FMOD_RESULT F_API FMOD_System_CreateDSPByType (FMOD_SYSTEM *system, FMOD_DSP_TYPE type, FMOD_DSP **dsp);</div>
|
|
<div class="line"><a name="l01978"></a><span class="lineno"> 1978</span> FMOD_RESULT F_API FMOD_System_CreateChannelGroup (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, FMOD_CHANNELGROUP **channelgroup);</div>
|
|
<div class="line"><a name="l01979"></a><span class="lineno"> 1979</span> FMOD_RESULT F_API FMOD_System_CreateSoundGroup (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, FMOD_SOUNDGROUP **soundgroup);</div>
|
|
<div class="line"><a name="l01980"></a><span class="lineno"> 1980</span> FMOD_RESULT F_API FMOD_System_CreateReverb (FMOD_SYSTEM *system, FMOD_REVERB **reverb);</div>
|
|
<div class="line"><a name="l01981"></a><span class="lineno"> 1981</span> </div>
|
|
<div class="line"><a name="l01982"></a><span class="lineno"> 1982</span> FMOD_RESULT F_API FMOD_System_PlaySound (FMOD_SYSTEM *system, FMOD_CHANNELINDEX channelid, FMOD_SOUND *sound, FMOD_BOOL paused, FMOD_CHANNEL **channel);</div>
|
|
<div class="line"><a name="l01983"></a><span class="lineno"> 1983</span> FMOD_RESULT F_API FMOD_System_PlayDSP (FMOD_SYSTEM *system, FMOD_CHANNELINDEX channelid, FMOD_DSP *dsp, FMOD_BOOL paused, FMOD_CHANNEL **channel);</div>
|
|
<div class="line"><a name="l01984"></a><span class="lineno"> 1984</span> FMOD_RESULT F_API FMOD_System_GetChannel (FMOD_SYSTEM *system, <span class="keywordtype">int</span> channelid, FMOD_CHANNEL **channel);</div>
|
|
<div class="line"><a name="l01985"></a><span class="lineno"> 1985</span> FMOD_RESULT F_API FMOD_System_GetMasterChannelGroup (FMOD_SYSTEM *system, FMOD_CHANNELGROUP **channelgroup);</div>
|
|
<div class="line"><a name="l01986"></a><span class="lineno"> 1986</span> FMOD_RESULT F_API FMOD_System_GetMasterSoundGroup (FMOD_SYSTEM *system, FMOD_SOUNDGROUP **soundgroup);</div>
|
|
<div class="line"><a name="l01987"></a><span class="lineno"> 1987</span> </div>
|
|
<div class="line"><a name="l01988"></a><span class="lineno"> 1988</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01989"></a><span class="lineno"> 1989</span> <span class="comment"> Reverb API </span></div>
|
|
<div class="line"><a name="l01990"></a><span class="lineno"> 1990</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l01991"></a><span class="lineno"> 1991</span> </div>
|
|
<div class="line"><a name="l01992"></a><span class="lineno"> 1992</span> FMOD_RESULT F_API FMOD_System_SetReverbProperties (FMOD_SYSTEM *system, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a> *prop);</div>
|
|
<div class="line"><a name="l01993"></a><span class="lineno"> 1993</span> FMOD_RESULT F_API FMOD_System_GetReverbProperties (FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a> *prop);</div>
|
|
<div class="line"><a name="l01994"></a><span class="lineno"> 1994</span> FMOD_RESULT F_API FMOD_System_SetReverbAmbientProperties(FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a> *prop);</div>
|
|
<div class="line"><a name="l01995"></a><span class="lineno"> 1995</span> FMOD_RESULT F_API FMOD_System_GetReverbAmbientProperties(FMOD_SYSTEM *system, <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a> *prop);</div>
|
|
<div class="line"><a name="l01996"></a><span class="lineno"> 1996</span> </div>
|
|
<div class="line"><a name="l01997"></a><span class="lineno"> 1997</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l01998"></a><span class="lineno"> 1998</span> <span class="comment"> System level DSP access.</span></div>
|
|
<div class="line"><a name="l01999"></a><span class="lineno"> 1999</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02000"></a><span class="lineno"> 2000</span> </div>
|
|
<div class="line"><a name="l02001"></a><span class="lineno"> 2001</span> FMOD_RESULT F_API FMOD_System_GetDSPHead (FMOD_SYSTEM *system, FMOD_DSP **dsp);</div>
|
|
<div class="line"><a name="l02002"></a><span class="lineno"> 2002</span> FMOD_RESULT F_API FMOD_System_AddDSP (FMOD_SYSTEM *system, FMOD_DSP *dsp, FMOD_DSPCONNECTION **connection);</div>
|
|
<div class="line"><a name="l02003"></a><span class="lineno"> 2003</span> FMOD_RESULT F_API FMOD_System_LockDSP (FMOD_SYSTEM *system);</div>
|
|
<div class="line"><a name="l02004"></a><span class="lineno"> 2004</span> FMOD_RESULT F_API FMOD_System_UnlockDSP (FMOD_SYSTEM *system);</div>
|
|
<div class="line"><a name="l02005"></a><span class="lineno"> 2005</span> FMOD_RESULT F_API FMOD_System_GetDSPClock (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *hi, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *lo);</div>
|
|
<div class="line"><a name="l02006"></a><span class="lineno"> 2006</span> </div>
|
|
<div class="line"><a name="l02007"></a><span class="lineno"> 2007</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02008"></a><span class="lineno"> 2008</span> <span class="comment"> Recording API.</span></div>
|
|
<div class="line"><a name="l02009"></a><span class="lineno"> 2009</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02010"></a><span class="lineno"> 2010</span> </div>
|
|
<div class="line"><a name="l02011"></a><span class="lineno"> 2011</span> FMOD_RESULT F_API FMOD_System_GetRecordNumDrivers (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *numdrivers);</div>
|
|
<div class="line"><a name="l02012"></a><span class="lineno"> 2012</span> FMOD_RESULT F_API FMOD_System_GetRecordDriverInfo (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> namelen, <a class="code" href="struct_f_m_o_d___g_u_i_d.html">FMOD_GUID</a> *guid);</div>
|
|
<div class="line"><a name="l02013"></a><span class="lineno"> 2013</span> FMOD_RESULT F_API FMOD_System_GetRecordDriverInfoW (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">short</span> *name, <span class="keywordtype">int</span> namelen, <a class="code" href="struct_f_m_o_d___g_u_i_d.html">FMOD_GUID</a> *guid);</div>
|
|
<div class="line"><a name="l02014"></a><span class="lineno"> 2014</span> FMOD_RESULT F_API FMOD_System_GetRecordDriverCaps (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, FMOD_CAPS *caps, <span class="keywordtype">int</span> *minfrequency, <span class="keywordtype">int</span> *maxfrequency);</div>
|
|
<div class="line"><a name="l02015"></a><span class="lineno"> 2015</span> FMOD_RESULT F_API FMOD_System_GetRecordPosition (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *position);</div>
|
|
<div class="line"><a name="l02016"></a><span class="lineno"> 2016</span> </div>
|
|
<div class="line"><a name="l02017"></a><span class="lineno"> 2017</span> FMOD_RESULT F_API FMOD_System_RecordStart (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, FMOD_SOUND *sound, FMOD_BOOL loop);</div>
|
|
<div class="line"><a name="l02018"></a><span class="lineno"> 2018</span> FMOD_RESULT F_API FMOD_System_RecordStop (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>);</div>
|
|
<div class="line"><a name="l02019"></a><span class="lineno"> 2019</span> FMOD_RESULT F_API FMOD_System_IsRecording (FMOD_SYSTEM *system, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, FMOD_BOOL *recording);</div>
|
|
<div class="line"><a name="l02020"></a><span class="lineno"> 2020</span> </div>
|
|
<div class="line"><a name="l02021"></a><span class="lineno"> 2021</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02022"></a><span class="lineno"> 2022</span> <span class="comment"> Geometry API.</span></div>
|
|
<div class="line"><a name="l02023"></a><span class="lineno"> 2023</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02024"></a><span class="lineno"> 2024</span> </div>
|
|
<div class="line"><a name="l02025"></a><span class="lineno"> 2025</span> FMOD_RESULT F_API FMOD_System_CreateGeometry (FMOD_SYSTEM *system, <span class="keywordtype">int</span> maxpolygons, <span class="keywordtype">int</span> maxvertices, FMOD_GEOMETRY **geometry);</div>
|
|
<div class="line"><a name="l02026"></a><span class="lineno"> 2026</span> FMOD_RESULT F_API FMOD_System_SetGeometrySettings (FMOD_SYSTEM *system, <span class="keywordtype">float</span> maxworldsize);</div>
|
|
<div class="line"><a name="l02027"></a><span class="lineno"> 2027</span> FMOD_RESULT F_API FMOD_System_GetGeometrySettings (FMOD_SYSTEM *system, <span class="keywordtype">float</span> *maxworldsize);</div>
|
|
<div class="line"><a name="l02028"></a><span class="lineno"> 2028</span> FMOD_RESULT F_API FMOD_System_LoadGeometry (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> datasize, FMOD_GEOMETRY **geometry);</div>
|
|
<div class="line"><a name="l02029"></a><span class="lineno"> 2029</span> FMOD_RESULT F_API FMOD_System_GetGeometryOcclusion (FMOD_SYSTEM *system, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *listener, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *source, <span class="keywordtype">float</span> *direct, <span class="keywordtype">float</span> *reverb);</div>
|
|
<div class="line"><a name="l02030"></a><span class="lineno"> 2030</span> </div>
|
|
<div class="line"><a name="l02031"></a><span class="lineno"> 2031</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02032"></a><span class="lineno"> 2032</span> <span class="comment"> Network functions.</span></div>
|
|
<div class="line"><a name="l02033"></a><span class="lineno"> 2033</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02034"></a><span class="lineno"> 2034</span> </div>
|
|
<div class="line"><a name="l02035"></a><span class="lineno"> 2035</span> FMOD_RESULT F_API FMOD_System_SetNetworkProxy (FMOD_SYSTEM *system, <span class="keyword">const</span> <span class="keywordtype">char</span> *proxy);</div>
|
|
<div class="line"><a name="l02036"></a><span class="lineno"> 2036</span> FMOD_RESULT F_API FMOD_System_GetNetworkProxy (FMOD_SYSTEM *system, <span class="keywordtype">char</span> *proxy, <span class="keywordtype">int</span> proxylen);</div>
|
|
<div class="line"><a name="l02037"></a><span class="lineno"> 2037</span> FMOD_RESULT F_API FMOD_System_SetNetworkTimeout (FMOD_SYSTEM *system, <span class="keywordtype">int</span> timeout);</div>
|
|
<div class="line"><a name="l02038"></a><span class="lineno"> 2038</span> FMOD_RESULT F_API FMOD_System_GetNetworkTimeout (FMOD_SYSTEM *system, <span class="keywordtype">int</span> *timeout);</div>
|
|
<div class="line"><a name="l02039"></a><span class="lineno"> 2039</span> </div>
|
|
<div class="line"><a name="l02040"></a><span class="lineno"> 2040</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02041"></a><span class="lineno"> 2041</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02042"></a><span class="lineno"> 2042</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02043"></a><span class="lineno"> 2043</span> </div>
|
|
<div class="line"><a name="l02044"></a><span class="lineno"> 2044</span> FMOD_RESULT F_API FMOD_System_SetUserData (FMOD_SYSTEM *system, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02045"></a><span class="lineno"> 2045</span> FMOD_RESULT F_API FMOD_System_GetUserData (FMOD_SYSTEM *system, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02046"></a><span class="lineno"> 2046</span> </div>
|
|
<div class="line"><a name="l02047"></a><span class="lineno"> 2047</span> FMOD_RESULT F_API FMOD_System_GetMemoryInfo (FMOD_SYSTEM *system, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02048"></a><span class="lineno"> 2048</span> </div>
|
|
<div class="line"><a name="l02049"></a><span class="lineno"> 2049</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02050"></a><span class="lineno"> 2050</span> <span class="comment"> 'Sound' API</span></div>
|
|
<div class="line"><a name="l02051"></a><span class="lineno"> 2051</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02052"></a><span class="lineno"> 2052</span> </div>
|
|
<div class="line"><a name="l02053"></a><span class="lineno"> 2053</span> FMOD_RESULT F_API FMOD_Sound_Release (FMOD_SOUND *sound);</div>
|
|
<div class="line"><a name="l02054"></a><span class="lineno"> 2054</span> FMOD_RESULT F_API FMOD_Sound_GetSystemObject (FMOD_SOUND *sound, FMOD_SYSTEM **system);</div>
|
|
<div class="line"><a name="l02055"></a><span class="lineno"> 2055</span> </div>
|
|
<div class="line"><a name="l02056"></a><span class="lineno"> 2056</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02057"></a><span class="lineno"> 2057</span> <span class="comment"> Standard sound manipulation functions. </span></div>
|
|
<div class="line"><a name="l02058"></a><span class="lineno"> 2058</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02059"></a><span class="lineno"> 2059</span> </div>
|
|
<div class="line"><a name="l02060"></a><span class="lineno"> 2060</span> FMOD_RESULT F_API FMOD_Sound_Lock (FMOD_SOUND *sound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> offset, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> length, <span class="keywordtype">void</span> **ptr1, <span class="keywordtype">void</span> **ptr2, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *len1, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *len2);</div>
|
|
<div class="line"><a name="l02061"></a><span class="lineno"> 2061</span> FMOD_RESULT F_API FMOD_Sound_Unlock (FMOD_SOUND *sound, <span class="keywordtype">void</span> *ptr1, <span class="keywordtype">void</span> *ptr2, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> len1, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> len2);</div>
|
|
<div class="line"><a name="l02062"></a><span class="lineno"> 2062</span> FMOD_RESULT F_API FMOD_Sound_SetDefaults (FMOD_SOUND *sound, <span class="keywordtype">float</span> frequency, <span class="keywordtype">float</span> volume, <span class="keywordtype">float</span> pan, <span class="keywordtype">int</span> priority);</div>
|
|
<div class="line"><a name="l02063"></a><span class="lineno"> 2063</span> FMOD_RESULT F_API FMOD_Sound_GetDefaults (FMOD_SOUND *sound, <span class="keywordtype">float</span> *frequency, <span class="keywordtype">float</span> *volume, <span class="keywordtype">float</span> *pan, <span class="keywordtype">int</span> *priority);</div>
|
|
<div class="line"><a name="l02064"></a><span class="lineno"> 2064</span> FMOD_RESULT F_API FMOD_Sound_SetVariations (FMOD_SOUND *sound, <span class="keywordtype">float</span> frequencyvar, <span class="keywordtype">float</span> volumevar, <span class="keywordtype">float</span> panvar);</div>
|
|
<div class="line"><a name="l02065"></a><span class="lineno"> 2065</span> FMOD_RESULT F_API FMOD_Sound_GetVariations (FMOD_SOUND *sound, <span class="keywordtype">float</span> *frequencyvar, <span class="keywordtype">float</span> *volumevar, <span class="keywordtype">float</span> *panvar);</div>
|
|
<div class="line"><a name="l02066"></a><span class="lineno"> 2066</span> FMOD_RESULT F_API FMOD_Sound_Set3DMinMaxDistance (FMOD_SOUND *sound, <span class="keywordtype">float</span> min, <span class="keywordtype">float</span> max);</div>
|
|
<div class="line"><a name="l02067"></a><span class="lineno"> 2067</span> FMOD_RESULT F_API FMOD_Sound_Get3DMinMaxDistance (FMOD_SOUND *sound, <span class="keywordtype">float</span> *min, <span class="keywordtype">float</span> *max);</div>
|
|
<div class="line"><a name="l02068"></a><span class="lineno"> 2068</span> FMOD_RESULT F_API FMOD_Sound_Set3DConeSettings (FMOD_SOUND *sound, <span class="keywordtype">float</span> insideconeangle, <span class="keywordtype">float</span> outsideconeangle, <span class="keywordtype">float</span> outsidevolume);</div>
|
|
<div class="line"><a name="l02069"></a><span class="lineno"> 2069</span> FMOD_RESULT F_API FMOD_Sound_Get3DConeSettings (FMOD_SOUND *sound, <span class="keywordtype">float</span> *insideconeangle, <span class="keywordtype">float</span> *outsideconeangle, <span class="keywordtype">float</span> *outsidevolume);</div>
|
|
<div class="line"><a name="l02070"></a><span class="lineno"> 2070</span> FMOD_RESULT F_API FMOD_Sound_Set3DCustomRolloff (FMOD_SOUND *sound, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *points, <span class="keywordtype">int</span> numpoints);</div>
|
|
<div class="line"><a name="l02071"></a><span class="lineno"> 2071</span> FMOD_RESULT F_API FMOD_Sound_Get3DCustomRolloff (FMOD_SOUND *sound, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> **points, <span class="keywordtype">int</span> *numpoints);</div>
|
|
<div class="line"><a name="l02072"></a><span class="lineno"> 2072</span> FMOD_RESULT F_API FMOD_Sound_SetSubSound (FMOD_SOUND *sound, <span class="keywordtype">int</span> index, FMOD_SOUND *subsound);</div>
|
|
<div class="line"><a name="l02073"></a><span class="lineno"> 2073</span> FMOD_RESULT F_API FMOD_Sound_GetSubSound (FMOD_SOUND *sound, <span class="keywordtype">int</span> index, FMOD_SOUND **subsound);</div>
|
|
<div class="line"><a name="l02074"></a><span class="lineno"> 2074</span> FMOD_RESULT F_API FMOD_Sound_SetSubSoundSentence (FMOD_SOUND *sound, <span class="keywordtype">int</span> *subsoundlist, <span class="keywordtype">int</span> numsubsounds);</div>
|
|
<div class="line"><a name="l02075"></a><span class="lineno"> 2075</span> FMOD_RESULT F_API FMOD_Sound_GetName (FMOD_SOUND *sound, <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> namelen);</div>
|
|
<div class="line"><a name="l02076"></a><span class="lineno"> 2076</span> FMOD_RESULT F_API FMOD_Sound_GetLength (FMOD_SOUND *sound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *length, FMOD_TIMEUNIT lengthtype);</div>
|
|
<div class="line"><a name="l02077"></a><span class="lineno"> 2077</span> FMOD_RESULT F_API FMOD_Sound_GetFormat (FMOD_SOUND *sound, FMOD_SOUND_TYPE *type, FMOD_SOUND_FORMAT *format, <span class="keywordtype">int</span> *channels, <span class="keywordtype">int</span> *bits);</div>
|
|
<div class="line"><a name="l02078"></a><span class="lineno"> 2078</span> FMOD_RESULT F_API FMOD_Sound_GetNumSubSounds (FMOD_SOUND *sound, <span class="keywordtype">int</span> *numsubsounds);</div>
|
|
<div class="line"><a name="l02079"></a><span class="lineno"> 2079</span> FMOD_RESULT F_API FMOD_Sound_GetNumTags (FMOD_SOUND *sound, <span class="keywordtype">int</span> *numtags, <span class="keywordtype">int</span> *numtagsupdated);</div>
|
|
<div class="line"><a name="l02080"></a><span class="lineno"> 2080</span> FMOD_RESULT F_API FMOD_Sound_GetTag (FMOD_SOUND *sound, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> index, <a class="code" href="struct_f_m_o_d___t_a_g.html">FMOD_TAG</a> *tag);</div>
|
|
<div class="line"><a name="l02081"></a><span class="lineno"> 2081</span> FMOD_RESULT F_API FMOD_Sound_GetOpenState (FMOD_SOUND *sound, FMOD_OPENSTATE *openstate, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *percentbuffered, FMOD_BOOL *starving, FMOD_BOOL *diskbusy);</div>
|
|
<div class="line"><a name="l02082"></a><span class="lineno"> 2082</span> FMOD_RESULT F_API FMOD_Sound_ReadData (FMOD_SOUND *sound, <span class="keywordtype">void</span> *buffer, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> lenbytes, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *read);</div>
|
|
<div class="line"><a name="l02083"></a><span class="lineno"> 2083</span> FMOD_RESULT F_API FMOD_Sound_SeekData (FMOD_SOUND *sound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> pcm);</div>
|
|
<div class="line"><a name="l02084"></a><span class="lineno"> 2084</span> </div>
|
|
<div class="line"><a name="l02085"></a><span class="lineno"> 2085</span> FMOD_RESULT F_API FMOD_Sound_SetSoundGroup (FMOD_SOUND *sound, FMOD_SOUNDGROUP *soundgroup);</div>
|
|
<div class="line"><a name="l02086"></a><span class="lineno"> 2086</span> FMOD_RESULT F_API FMOD_Sound_GetSoundGroup (FMOD_SOUND *sound, FMOD_SOUNDGROUP **soundgroup);</div>
|
|
<div class="line"><a name="l02087"></a><span class="lineno"> 2087</span> </div>
|
|
<div class="line"><a name="l02088"></a><span class="lineno"> 2088</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02089"></a><span class="lineno"> 2089</span> <span class="comment"> Synchronization point API. These points can come from markers embedded in wav files, and can also generate channel callbacks. </span></div>
|
|
<div class="line"><a name="l02090"></a><span class="lineno"> 2090</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02091"></a><span class="lineno"> 2091</span> </div>
|
|
<div class="line"><a name="l02092"></a><span class="lineno"> 2092</span> FMOD_RESULT F_API FMOD_Sound_GetNumSyncPoints (FMOD_SOUND *sound, <span class="keywordtype">int</span> *numsyncpoints);</div>
|
|
<div class="line"><a name="l02093"></a><span class="lineno"> 2093</span> FMOD_RESULT F_API FMOD_Sound_GetSyncPoint (FMOD_SOUND *sound, <span class="keywordtype">int</span> index, FMOD_SYNCPOINT **point);</div>
|
|
<div class="line"><a name="l02094"></a><span class="lineno"> 2094</span> FMOD_RESULT F_API FMOD_Sound_GetSyncPointInfo (FMOD_SOUND *sound, FMOD_SYNCPOINT *point, <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> namelen, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *offset, FMOD_TIMEUNIT offsettype);</div>
|
|
<div class="line"><a name="l02095"></a><span class="lineno"> 2095</span> FMOD_RESULT F_API FMOD_Sound_AddSyncPoint (FMOD_SOUND *sound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> offset, FMOD_TIMEUNIT offsettype, <span class="keyword">const</span> <span class="keywordtype">char</span> *name, FMOD_SYNCPOINT **point);</div>
|
|
<div class="line"><a name="l02096"></a><span class="lineno"> 2096</span> FMOD_RESULT F_API FMOD_Sound_DeleteSyncPoint (FMOD_SOUND *sound, FMOD_SYNCPOINT *point);</div>
|
|
<div class="line"><a name="l02097"></a><span class="lineno"> 2097</span> </div>
|
|
<div class="line"><a name="l02098"></a><span class="lineno"> 2098</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02099"></a><span class="lineno"> 2099</span> <span class="comment"> Functions also in Channel class but here they are the 'default' to save having to change it in Channel all the time.</span></div>
|
|
<div class="line"><a name="l02100"></a><span class="lineno"> 2100</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02101"></a><span class="lineno"> 2101</span> </div>
|
|
<div class="line"><a name="l02102"></a><span class="lineno"> 2102</span> FMOD_RESULT F_API FMOD_Sound_SetMode (FMOD_SOUND *sound, FMOD_MODE mode);</div>
|
|
<div class="line"><a name="l02103"></a><span class="lineno"> 2103</span> FMOD_RESULT F_API FMOD_Sound_GetMode (FMOD_SOUND *sound, FMOD_MODE *mode);</div>
|
|
<div class="line"><a name="l02104"></a><span class="lineno"> 2104</span> FMOD_RESULT F_API FMOD_Sound_SetLoopCount (FMOD_SOUND *sound, <span class="keywordtype">int</span> loopcount);</div>
|
|
<div class="line"><a name="l02105"></a><span class="lineno"> 2105</span> FMOD_RESULT F_API FMOD_Sound_GetLoopCount (FMOD_SOUND *sound, <span class="keywordtype">int</span> *loopcount);</div>
|
|
<div class="line"><a name="l02106"></a><span class="lineno"> 2106</span> FMOD_RESULT F_API FMOD_Sound_SetLoopPoints (FMOD_SOUND *sound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> loopstart, FMOD_TIMEUNIT loopstarttype, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> loopend, FMOD_TIMEUNIT loopendtype);</div>
|
|
<div class="line"><a name="l02107"></a><span class="lineno"> 2107</span> FMOD_RESULT F_API FMOD_Sound_GetLoopPoints (FMOD_SOUND *sound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *loopstart, FMOD_TIMEUNIT loopstarttype, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *loopend, FMOD_TIMEUNIT loopendtype);</div>
|
|
<div class="line"><a name="l02108"></a><span class="lineno"> 2108</span> </div>
|
|
<div class="line"><a name="l02109"></a><span class="lineno"> 2109</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02110"></a><span class="lineno"> 2110</span> <span class="comment"> For MOD/S3M/XM/IT/MID sequenced formats only.</span></div>
|
|
<div class="line"><a name="l02111"></a><span class="lineno"> 2111</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02112"></a><span class="lineno"> 2112</span> </div>
|
|
<div class="line"><a name="l02113"></a><span class="lineno"> 2113</span> FMOD_RESULT F_API FMOD_Sound_GetMusicNumChannels (FMOD_SOUND *sound, <span class="keywordtype">int</span> *numchannels);</div>
|
|
<div class="line"><a name="l02114"></a><span class="lineno"> 2114</span> FMOD_RESULT F_API FMOD_Sound_SetMusicChannelVolume (FMOD_SOUND *sound, <span class="keywordtype">int</span> channel, <span class="keywordtype">float</span> volume);</div>
|
|
<div class="line"><a name="l02115"></a><span class="lineno"> 2115</span> FMOD_RESULT F_API FMOD_Sound_GetMusicChannelVolume (FMOD_SOUND *sound, <span class="keywordtype">int</span> channel, <span class="keywordtype">float</span> *volume);</div>
|
|
<div class="line"><a name="l02116"></a><span class="lineno"> 2116</span> FMOD_RESULT F_API FMOD_Sound_SetMusicSpeed (FMOD_SOUND *sound, <span class="keywordtype">float</span> speed);</div>
|
|
<div class="line"><a name="l02117"></a><span class="lineno"> 2117</span> FMOD_RESULT F_API FMOD_Sound_GetMusicSpeed (FMOD_SOUND *sound, <span class="keywordtype">float</span> *speed);</div>
|
|
<div class="line"><a name="l02118"></a><span class="lineno"> 2118</span> </div>
|
|
<div class="line"><a name="l02119"></a><span class="lineno"> 2119</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02120"></a><span class="lineno"> 2120</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02121"></a><span class="lineno"> 2121</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02122"></a><span class="lineno"> 2122</span> </div>
|
|
<div class="line"><a name="l02123"></a><span class="lineno"> 2123</span> FMOD_RESULT F_API FMOD_Sound_SetUserData (FMOD_SOUND *sound, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02124"></a><span class="lineno"> 2124</span> FMOD_RESULT F_API FMOD_Sound_GetUserData (FMOD_SOUND *sound, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02125"></a><span class="lineno"> 2125</span> </div>
|
|
<div class="line"><a name="l02126"></a><span class="lineno"> 2126</span> FMOD_RESULT F_API FMOD_Sound_GetMemoryInfo (FMOD_SOUND *sound, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02127"></a><span class="lineno"> 2127</span> </div>
|
|
<div class="line"><a name="l02128"></a><span class="lineno"> 2128</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02129"></a><span class="lineno"> 2129</span> <span class="comment"> 'Channel' API</span></div>
|
|
<div class="line"><a name="l02130"></a><span class="lineno"> 2130</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02131"></a><span class="lineno"> 2131</span> </div>
|
|
<div class="line"><a name="l02132"></a><span class="lineno"> 2132</span> FMOD_RESULT F_API FMOD_Channel_GetSystemObject (FMOD_CHANNEL *channel, FMOD_SYSTEM **system);</div>
|
|
<div class="line"><a name="l02133"></a><span class="lineno"> 2133</span> </div>
|
|
<div class="line"><a name="l02134"></a><span class="lineno"> 2134</span> FMOD_RESULT F_API FMOD_Channel_Stop (FMOD_CHANNEL *channel);</div>
|
|
<div class="line"><a name="l02135"></a><span class="lineno"> 2135</span> FMOD_RESULT F_API FMOD_Channel_SetPaused (FMOD_CHANNEL *channel, FMOD_BOOL paused);</div>
|
|
<div class="line"><a name="l02136"></a><span class="lineno"> 2136</span> FMOD_RESULT F_API FMOD_Channel_GetPaused (FMOD_CHANNEL *channel, FMOD_BOOL *paused);</div>
|
|
<div class="line"><a name="l02137"></a><span class="lineno"> 2137</span> FMOD_RESULT F_API FMOD_Channel_SetVolume (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> volume);</div>
|
|
<div class="line"><a name="l02138"></a><span class="lineno"> 2138</span> FMOD_RESULT F_API FMOD_Channel_GetVolume (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *volume);</div>
|
|
<div class="line"><a name="l02139"></a><span class="lineno"> 2139</span> FMOD_RESULT F_API FMOD_Channel_SetFrequency (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> frequency);</div>
|
|
<div class="line"><a name="l02140"></a><span class="lineno"> 2140</span> FMOD_RESULT F_API FMOD_Channel_GetFrequency (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *frequency);</div>
|
|
<div class="line"><a name="l02141"></a><span class="lineno"> 2141</span> FMOD_RESULT F_API FMOD_Channel_SetPan (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> pan);</div>
|
|
<div class="line"><a name="l02142"></a><span class="lineno"> 2142</span> FMOD_RESULT F_API FMOD_Channel_GetPan (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *pan);</div>
|
|
<div class="line"><a name="l02143"></a><span class="lineno"> 2143</span> FMOD_RESULT F_API FMOD_Channel_SetDelay (FMOD_CHANNEL *channel, FMOD_DELAYTYPE delaytype, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> delayhi, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> delaylo);</div>
|
|
<div class="line"><a name="l02144"></a><span class="lineno"> 2144</span> FMOD_RESULT F_API FMOD_Channel_GetDelay (FMOD_CHANNEL *channel, FMOD_DELAYTYPE delaytype, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *delayhi, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *delaylo);</div>
|
|
<div class="line"><a name="l02145"></a><span class="lineno"> 2145</span> FMOD_RESULT F_API FMOD_Channel_SetSpeakerMix (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> frontleft, <span class="keywordtype">float</span> frontright, <span class="keywordtype">float</span> center, <span class="keywordtype">float</span> lfe, <span class="keywordtype">float</span> backleft, <span class="keywordtype">float</span> backright, <span class="keywordtype">float</span> sideleft, <span class="keywordtype">float</span> sideright);</div>
|
|
<div class="line"><a name="l02146"></a><span class="lineno"> 2146</span> FMOD_RESULT F_API FMOD_Channel_GetSpeakerMix (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *frontleft, <span class="keywordtype">float</span> *frontright, <span class="keywordtype">float</span> *center, <span class="keywordtype">float</span> *lfe, <span class="keywordtype">float</span> *backleft, <span class="keywordtype">float</span> *backright, <span class="keywordtype">float</span> *sideleft, <span class="keywordtype">float</span> *sideright);</div>
|
|
<div class="line"><a name="l02147"></a><span class="lineno"> 2147</span> FMOD_RESULT F_API FMOD_Channel_SetSpeakerLevels (FMOD_CHANNEL *channel, FMOD_SPEAKER speaker, <span class="keywordtype">float</span> *levels, <span class="keywordtype">int</span> numlevels);</div>
|
|
<div class="line"><a name="l02148"></a><span class="lineno"> 2148</span> FMOD_RESULT F_API FMOD_Channel_GetSpeakerLevels (FMOD_CHANNEL *channel, FMOD_SPEAKER speaker, <span class="keywordtype">float</span> *levels, <span class="keywordtype">int</span> numlevels);</div>
|
|
<div class="line"><a name="l02149"></a><span class="lineno"> 2149</span> FMOD_RESULT F_API FMOD_Channel_SetInputChannelMix (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *levels, <span class="keywordtype">int</span> numlevels);</div>
|
|
<div class="line"><a name="l02150"></a><span class="lineno"> 2150</span> FMOD_RESULT F_API FMOD_Channel_GetInputChannelMix (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *levels, <span class="keywordtype">int</span> numlevels);</div>
|
|
<div class="line"><a name="l02151"></a><span class="lineno"> 2151</span> FMOD_RESULT F_API FMOD_Channel_SetMute (FMOD_CHANNEL *channel, FMOD_BOOL mute);</div>
|
|
<div class="line"><a name="l02152"></a><span class="lineno"> 2152</span> FMOD_RESULT F_API FMOD_Channel_GetMute (FMOD_CHANNEL *channel, FMOD_BOOL *mute);</div>
|
|
<div class="line"><a name="l02153"></a><span class="lineno"> 2153</span> FMOD_RESULT F_API FMOD_Channel_SetPriority (FMOD_CHANNEL *channel, <span class="keywordtype">int</span> priority);</div>
|
|
<div class="line"><a name="l02154"></a><span class="lineno"> 2154</span> FMOD_RESULT F_API FMOD_Channel_GetPriority (FMOD_CHANNEL *channel, <span class="keywordtype">int</span> *priority);</div>
|
|
<div class="line"><a name="l02155"></a><span class="lineno"> 2155</span> FMOD_RESULT F_API FMOD_Channel_SetPosition (FMOD_CHANNEL *channel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> position, FMOD_TIMEUNIT postype);</div>
|
|
<div class="line"><a name="l02156"></a><span class="lineno"> 2156</span> FMOD_RESULT F_API FMOD_Channel_GetPosition (FMOD_CHANNEL *channel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *position, FMOD_TIMEUNIT postype);</div>
|
|
<div class="line"><a name="l02157"></a><span class="lineno"> 2157</span> FMOD_RESULT F_API FMOD_Channel_SetReverbProperties (FMOD_CHANNEL *channel, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_CHANNELPROPERTIES</a> *prop);</div>
|
|
<div class="line"><a name="l02158"></a><span class="lineno"> 2158</span> FMOD_RESULT F_API FMOD_Channel_GetReverbProperties (FMOD_CHANNEL *channel, <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_CHANNELPROPERTIES</a> *prop);</div>
|
|
<div class="line"><a name="l02159"></a><span class="lineno"> 2159</span> FMOD_RESULT F_API FMOD_Channel_SetLowPassGain (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> gain);</div>
|
|
<div class="line"><a name="l02160"></a><span class="lineno"> 2160</span> FMOD_RESULT F_API FMOD_Channel_GetLowPassGain (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *gain);</div>
|
|
<div class="line"><a name="l02161"></a><span class="lineno"> 2161</span> </div>
|
|
<div class="line"><a name="l02162"></a><span class="lineno"> 2162</span> FMOD_RESULT F_API FMOD_Channel_SetChannelGroup (FMOD_CHANNEL *channel, FMOD_CHANNELGROUP *channelgroup);</div>
|
|
<div class="line"><a name="l02163"></a><span class="lineno"> 2163</span> FMOD_RESULT F_API FMOD_Channel_GetChannelGroup (FMOD_CHANNEL *channel, FMOD_CHANNELGROUP **channelgroup);</div>
|
|
<div class="line"><a name="l02164"></a><span class="lineno"> 2164</span> FMOD_RESULT F_API FMOD_Channel_SetCallback (FMOD_CHANNEL *channel, FMOD_CHANNEL_CALLBACK callback);</div>
|
|
<div class="line"><a name="l02165"></a><span class="lineno"> 2165</span> </div>
|
|
<div class="line"><a name="l02166"></a><span class="lineno"> 2166</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02167"></a><span class="lineno"> 2167</span> <span class="comment"> 3D functionality.</span></div>
|
|
<div class="line"><a name="l02168"></a><span class="lineno"> 2168</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02169"></a><span class="lineno"> 2169</span> </div>
|
|
<div class="line"><a name="l02170"></a><span class="lineno"> 2170</span> FMOD_RESULT F_API FMOD_Channel_Set3DAttributes (FMOD_CHANNEL *channel, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *pos, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vel);</div>
|
|
<div class="line"><a name="l02171"></a><span class="lineno"> 2171</span> FMOD_RESULT F_API FMOD_Channel_Get3DAttributes (FMOD_CHANNEL *channel, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *pos, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vel);</div>
|
|
<div class="line"><a name="l02172"></a><span class="lineno"> 2172</span> FMOD_RESULT F_API FMOD_Channel_Set3DMinMaxDistance (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> mindistance, <span class="keywordtype">float</span> maxdistance);</div>
|
|
<div class="line"><a name="l02173"></a><span class="lineno"> 2173</span> FMOD_RESULT F_API FMOD_Channel_Get3DMinMaxDistance (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *mindistance, <span class="keywordtype">float</span> *maxdistance);</div>
|
|
<div class="line"><a name="l02174"></a><span class="lineno"> 2174</span> FMOD_RESULT F_API FMOD_Channel_Set3DConeSettings (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> insideconeangle, <span class="keywordtype">float</span> outsideconeangle, <span class="keywordtype">float</span> outsidevolume);</div>
|
|
<div class="line"><a name="l02175"></a><span class="lineno"> 2175</span> FMOD_RESULT F_API FMOD_Channel_Get3DConeSettings (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *insideconeangle, <span class="keywordtype">float</span> *outsideconeangle, <span class="keywordtype">float</span> *outsidevolume);</div>
|
|
<div class="line"><a name="l02176"></a><span class="lineno"> 2176</span> FMOD_RESULT F_API FMOD_Channel_Set3DConeOrientation (FMOD_CHANNEL *channel, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *orientation);</div>
|
|
<div class="line"><a name="l02177"></a><span class="lineno"> 2177</span> FMOD_RESULT F_API FMOD_Channel_Get3DConeOrientation (FMOD_CHANNEL *channel, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *orientation);</div>
|
|
<div class="line"><a name="l02178"></a><span class="lineno"> 2178</span> FMOD_RESULT F_API FMOD_Channel_Set3DCustomRolloff (FMOD_CHANNEL *channel, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *points, <span class="keywordtype">int</span> numpoints);</div>
|
|
<div class="line"><a name="l02179"></a><span class="lineno"> 2179</span> FMOD_RESULT F_API FMOD_Channel_Get3DCustomRolloff (FMOD_CHANNEL *channel, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> **points, <span class="keywordtype">int</span> *numpoints);</div>
|
|
<div class="line"><a name="l02180"></a><span class="lineno"> 2180</span> FMOD_RESULT F_API FMOD_Channel_Set3DOcclusion (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> directocclusion, <span class="keywordtype">float</span> reverbocclusion);</div>
|
|
<div class="line"><a name="l02181"></a><span class="lineno"> 2181</span> FMOD_RESULT F_API FMOD_Channel_Get3DOcclusion (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *directocclusion, <span class="keywordtype">float</span> *reverbocclusion);</div>
|
|
<div class="line"><a name="l02182"></a><span class="lineno"> 2182</span> FMOD_RESULT F_API FMOD_Channel_Set3DSpread (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> angle);</div>
|
|
<div class="line"><a name="l02183"></a><span class="lineno"> 2183</span> FMOD_RESULT F_API FMOD_Channel_Get3DSpread (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *angle);</div>
|
|
<div class="line"><a name="l02184"></a><span class="lineno"> 2184</span> FMOD_RESULT F_API FMOD_Channel_Set3DPanLevel (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> level);</div>
|
|
<div class="line"><a name="l02185"></a><span class="lineno"> 2185</span> FMOD_RESULT F_API FMOD_Channel_Get3DPanLevel (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *level);</div>
|
|
<div class="line"><a name="l02186"></a><span class="lineno"> 2186</span> FMOD_RESULT F_API FMOD_Channel_Set3DDopplerLevel (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> level);</div>
|
|
<div class="line"><a name="l02187"></a><span class="lineno"> 2187</span> FMOD_RESULT F_API FMOD_Channel_Get3DDopplerLevel (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *level);</div>
|
|
<div class="line"><a name="l02188"></a><span class="lineno"> 2188</span> FMOD_RESULT F_API FMOD_Channel_Set3DDistanceFilter (FMOD_CHANNEL *channel, FMOD_BOOL custom, <span class="keywordtype">float</span> customLevel, <span class="keywordtype">float</span> centerFreq);</div>
|
|
<div class="line"><a name="l02189"></a><span class="lineno"> 2189</span> FMOD_RESULT F_API FMOD_Channel_Get3DDistanceFilter (FMOD_CHANNEL *channel, FMOD_BOOL *custom, <span class="keywordtype">float</span> *customLevel, <span class="keywordtype">float</span> *centerFreq);</div>
|
|
<div class="line"><a name="l02190"></a><span class="lineno"> 2190</span> </div>
|
|
<div class="line"><a name="l02191"></a><span class="lineno"> 2191</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02192"></a><span class="lineno"> 2192</span> <span class="comment"> DSP functionality only for channels playing sounds created with FMOD_SOFTWARE.</span></div>
|
|
<div class="line"><a name="l02193"></a><span class="lineno"> 2193</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02194"></a><span class="lineno"> 2194</span> </div>
|
|
<div class="line"><a name="l02195"></a><span class="lineno"> 2195</span> FMOD_RESULT F_API FMOD_Channel_GetDSPHead (FMOD_CHANNEL *channel, FMOD_DSP **dsp);</div>
|
|
<div class="line"><a name="l02196"></a><span class="lineno"> 2196</span> FMOD_RESULT F_API FMOD_Channel_AddDSP (FMOD_CHANNEL *channel, FMOD_DSP *dsp, FMOD_DSPCONNECTION **connection);</div>
|
|
<div class="line"><a name="l02197"></a><span class="lineno"> 2197</span> </div>
|
|
<div class="line"><a name="l02198"></a><span class="lineno"> 2198</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02199"></a><span class="lineno"> 2199</span> <span class="comment"> Information only functions.</span></div>
|
|
<div class="line"><a name="l02200"></a><span class="lineno"> 2200</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02201"></a><span class="lineno"> 2201</span> </div>
|
|
<div class="line"><a name="l02202"></a><span class="lineno"> 2202</span> FMOD_RESULT F_API FMOD_Channel_IsPlaying (FMOD_CHANNEL *channel, FMOD_BOOL *isplaying);</div>
|
|
<div class="line"><a name="l02203"></a><span class="lineno"> 2203</span> FMOD_RESULT F_API FMOD_Channel_IsVirtual (FMOD_CHANNEL *channel, FMOD_BOOL *isvirtual);</div>
|
|
<div class="line"><a name="l02204"></a><span class="lineno"> 2204</span> FMOD_RESULT F_API FMOD_Channel_GetAudibility (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *audibility);</div>
|
|
<div class="line"><a name="l02205"></a><span class="lineno"> 2205</span> FMOD_RESULT F_API FMOD_Channel_GetCurrentSound (FMOD_CHANNEL *channel, FMOD_SOUND **sound);</div>
|
|
<div class="line"><a name="l02206"></a><span class="lineno"> 2206</span> FMOD_RESULT F_API FMOD_Channel_GetSpectrum (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *spectrumarray, <span class="keywordtype">int</span> numvalues, <span class="keywordtype">int</span> channeloffset, FMOD_DSP_FFT_WINDOW windowtype);</div>
|
|
<div class="line"><a name="l02207"></a><span class="lineno"> 2207</span> FMOD_RESULT F_API FMOD_Channel_GetWaveData (FMOD_CHANNEL *channel, <span class="keywordtype">float</span> *wavearray, <span class="keywordtype">int</span> numvalues, <span class="keywordtype">int</span> channeloffset);</div>
|
|
<div class="line"><a name="l02208"></a><span class="lineno"> 2208</span> FMOD_RESULT F_API FMOD_Channel_GetIndex (FMOD_CHANNEL *channel, <span class="keywordtype">int</span> *index);</div>
|
|
<div class="line"><a name="l02209"></a><span class="lineno"> 2209</span> </div>
|
|
<div class="line"><a name="l02210"></a><span class="lineno"> 2210</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02211"></a><span class="lineno"> 2211</span> <span class="comment"> Functions also found in Sound class but here they can be set per channel.</span></div>
|
|
<div class="line"><a name="l02212"></a><span class="lineno"> 2212</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02213"></a><span class="lineno"> 2213</span> </div>
|
|
<div class="line"><a name="l02214"></a><span class="lineno"> 2214</span> FMOD_RESULT F_API FMOD_Channel_SetMode (FMOD_CHANNEL *channel, FMOD_MODE mode);</div>
|
|
<div class="line"><a name="l02215"></a><span class="lineno"> 2215</span> FMOD_RESULT F_API FMOD_Channel_GetMode (FMOD_CHANNEL *channel, FMOD_MODE *mode);</div>
|
|
<div class="line"><a name="l02216"></a><span class="lineno"> 2216</span> FMOD_RESULT F_API FMOD_Channel_SetLoopCount (FMOD_CHANNEL *channel, <span class="keywordtype">int</span> loopcount);</div>
|
|
<div class="line"><a name="l02217"></a><span class="lineno"> 2217</span> FMOD_RESULT F_API FMOD_Channel_GetLoopCount (FMOD_CHANNEL *channel, <span class="keywordtype">int</span> *loopcount);</div>
|
|
<div class="line"><a name="l02218"></a><span class="lineno"> 2218</span> FMOD_RESULT F_API FMOD_Channel_SetLoopPoints (FMOD_CHANNEL *channel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> loopstart, FMOD_TIMEUNIT loopstarttype, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> loopend, FMOD_TIMEUNIT loopendtype);</div>
|
|
<div class="line"><a name="l02219"></a><span class="lineno"> 2219</span> FMOD_RESULT F_API FMOD_Channel_GetLoopPoints (FMOD_CHANNEL *channel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *loopstart, FMOD_TIMEUNIT loopstarttype, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *loopend, FMOD_TIMEUNIT loopendtype);</div>
|
|
<div class="line"><a name="l02220"></a><span class="lineno"> 2220</span> </div>
|
|
<div class="line"><a name="l02221"></a><span class="lineno"> 2221</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02222"></a><span class="lineno"> 2222</span> <span class="comment"> Userdata set/get. </span></div>
|
|
<div class="line"><a name="l02223"></a><span class="lineno"> 2223</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02224"></a><span class="lineno"> 2224</span> </div>
|
|
<div class="line"><a name="l02225"></a><span class="lineno"> 2225</span> FMOD_RESULT F_API FMOD_Channel_SetUserData (FMOD_CHANNEL *channel, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02226"></a><span class="lineno"> 2226</span> FMOD_RESULT F_API FMOD_Channel_GetUserData (FMOD_CHANNEL *channel, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02227"></a><span class="lineno"> 2227</span> </div>
|
|
<div class="line"><a name="l02228"></a><span class="lineno"> 2228</span> FMOD_RESULT F_API FMOD_Channel_GetMemoryInfo (FMOD_CHANNEL *channel, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02229"></a><span class="lineno"> 2229</span> </div>
|
|
<div class="line"><a name="l02230"></a><span class="lineno"> 2230</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02231"></a><span class="lineno"> 2231</span> <span class="comment"> 'ChannelGroup' API</span></div>
|
|
<div class="line"><a name="l02232"></a><span class="lineno"> 2232</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02233"></a><span class="lineno"> 2233</span> </div>
|
|
<div class="line"><a name="l02234"></a><span class="lineno"> 2234</span> FMOD_RESULT F_API FMOD_ChannelGroup_Release (FMOD_CHANNELGROUP *channelgroup);</div>
|
|
<div class="line"><a name="l02235"></a><span class="lineno"> 2235</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetSystemObject (FMOD_CHANNELGROUP *channelgroup, FMOD_SYSTEM **system);</div>
|
|
<div class="line"><a name="l02236"></a><span class="lineno"> 2236</span> </div>
|
|
<div class="line"><a name="l02237"></a><span class="lineno"> 2237</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02238"></a><span class="lineno"> 2238</span> <span class="comment"> Channelgroup scale values. (changes attributes relative to the channels, doesn't overwrite them)</span></div>
|
|
<div class="line"><a name="l02239"></a><span class="lineno"> 2239</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02240"></a><span class="lineno"> 2240</span> </div>
|
|
<div class="line"><a name="l02241"></a><span class="lineno"> 2241</span> FMOD_RESULT F_API FMOD_ChannelGroup_SetVolume (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> volume);</div>
|
|
<div class="line"><a name="l02242"></a><span class="lineno"> 2242</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetVolume (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> *volume);</div>
|
|
<div class="line"><a name="l02243"></a><span class="lineno"> 2243</span> FMOD_RESULT F_API FMOD_ChannelGroup_SetPitch (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> pitch);</div>
|
|
<div class="line"><a name="l02244"></a><span class="lineno"> 2244</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetPitch (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> *pitch);</div>
|
|
<div class="line"><a name="l02245"></a><span class="lineno"> 2245</span> FMOD_RESULT F_API FMOD_ChannelGroup_Set3DOcclusion (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> directocclusion, <span class="keywordtype">float</span> reverbocclusion);</div>
|
|
<div class="line"><a name="l02246"></a><span class="lineno"> 2246</span> FMOD_RESULT F_API FMOD_ChannelGroup_Get3DOcclusion (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> *directocclusion, <span class="keywordtype">float</span> *reverbocclusion);</div>
|
|
<div class="line"><a name="l02247"></a><span class="lineno"> 2247</span> FMOD_RESULT F_API FMOD_ChannelGroup_SetPaused (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL paused);</div>
|
|
<div class="line"><a name="l02248"></a><span class="lineno"> 2248</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetPaused (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *paused);</div>
|
|
<div class="line"><a name="l02249"></a><span class="lineno"> 2249</span> FMOD_RESULT F_API FMOD_ChannelGroup_SetMute (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL mute);</div>
|
|
<div class="line"><a name="l02250"></a><span class="lineno"> 2250</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetMute (FMOD_CHANNELGROUP *channelgroup, FMOD_BOOL *mute);</div>
|
|
<div class="line"><a name="l02251"></a><span class="lineno"> 2251</span> </div>
|
|
<div class="line"><a name="l02252"></a><span class="lineno"> 2252</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02253"></a><span class="lineno"> 2253</span> <span class="comment"> Channelgroup override values. (recursively overwrites whatever settings the channels had)</span></div>
|
|
<div class="line"><a name="l02254"></a><span class="lineno"> 2254</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02255"></a><span class="lineno"> 2255</span> </div>
|
|
<div class="line"><a name="l02256"></a><span class="lineno"> 2256</span> FMOD_RESULT F_API FMOD_ChannelGroup_Stop (FMOD_CHANNELGROUP *channelgroup);</div>
|
|
<div class="line"><a name="l02257"></a><span class="lineno"> 2257</span> FMOD_RESULT F_API FMOD_ChannelGroup_OverrideVolume (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> volume);</div>
|
|
<div class="line"><a name="l02258"></a><span class="lineno"> 2258</span> FMOD_RESULT F_API FMOD_ChannelGroup_OverrideFrequency(FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> frequency);</div>
|
|
<div class="line"><a name="l02259"></a><span class="lineno"> 2259</span> FMOD_RESULT F_API FMOD_ChannelGroup_OverridePan (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> pan);</div>
|
|
<div class="line"><a name="l02260"></a><span class="lineno"> 2260</span> FMOD_RESULT F_API FMOD_ChannelGroup_OverrideReverbProperties(FMOD_CHANNELGROUP *channelgroup, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_CHANNELPROPERTIES</a> *prop);</div>
|
|
<div class="line"><a name="l02261"></a><span class="lineno"> 2261</span> FMOD_RESULT F_API FMOD_ChannelGroup_Override3DAttributes(FMOD_CHANNELGROUP *channelgroup, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *pos, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vel);</div>
|
|
<div class="line"><a name="l02262"></a><span class="lineno"> 2262</span> FMOD_RESULT F_API FMOD_ChannelGroup_OverrideSpeakerMix(FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> frontleft, <span class="keywordtype">float</span> frontright, <span class="keywordtype">float</span> center, <span class="keywordtype">float</span> lfe, <span class="keywordtype">float</span> backleft, <span class="keywordtype">float</span> backright, <span class="keywordtype">float</span> sideleft, <span class="keywordtype">float</span> sideright);</div>
|
|
<div class="line"><a name="l02263"></a><span class="lineno"> 2263</span> </div>
|
|
<div class="line"><a name="l02264"></a><span class="lineno"> 2264</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02265"></a><span class="lineno"> 2265</span> <span class="comment"> Nested channel groups.</span></div>
|
|
<div class="line"><a name="l02266"></a><span class="lineno"> 2266</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02267"></a><span class="lineno"> 2267</span> </div>
|
|
<div class="line"><a name="l02268"></a><span class="lineno"> 2268</span> FMOD_RESULT F_API FMOD_ChannelGroup_AddGroup (FMOD_CHANNELGROUP *channelgroup, FMOD_CHANNELGROUP *group);</div>
|
|
<div class="line"><a name="l02269"></a><span class="lineno"> 2269</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetNumGroups (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">int</span> *numgroups);</div>
|
|
<div class="line"><a name="l02270"></a><span class="lineno"> 2270</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetGroup (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">int</span> index, FMOD_CHANNELGROUP **group);</div>
|
|
<div class="line"><a name="l02271"></a><span class="lineno"> 2271</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetParentGroup (FMOD_CHANNELGROUP *channelgroup, FMOD_CHANNELGROUP **group);</div>
|
|
<div class="line"><a name="l02272"></a><span class="lineno"> 2272</span> </div>
|
|
<div class="line"><a name="l02273"></a><span class="lineno"> 2273</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02274"></a><span class="lineno"> 2274</span> <span class="comment"> DSP functionality only for channel groups playing sounds created with FMOD_SOFTWARE.</span></div>
|
|
<div class="line"><a name="l02275"></a><span class="lineno"> 2275</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02276"></a><span class="lineno"> 2276</span> </div>
|
|
<div class="line"><a name="l02277"></a><span class="lineno"> 2277</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetDSPHead (FMOD_CHANNELGROUP *channelgroup, FMOD_DSP **dsp);</div>
|
|
<div class="line"><a name="l02278"></a><span class="lineno"> 2278</span> FMOD_RESULT F_API FMOD_ChannelGroup_AddDSP (FMOD_CHANNELGROUP *channelgroup, FMOD_DSP *dsp, FMOD_DSPCONNECTION **connection);</div>
|
|
<div class="line"><a name="l02279"></a><span class="lineno"> 2279</span> </div>
|
|
<div class="line"><a name="l02280"></a><span class="lineno"> 2280</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02281"></a><span class="lineno"> 2281</span> <span class="comment"> Information only functions.</span></div>
|
|
<div class="line"><a name="l02282"></a><span class="lineno"> 2282</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02283"></a><span class="lineno"> 2283</span> </div>
|
|
<div class="line"><a name="l02284"></a><span class="lineno"> 2284</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetName (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> namelen);</div>
|
|
<div class="line"><a name="l02285"></a><span class="lineno"> 2285</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetNumChannels (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">int</span> *numchannels);</div>
|
|
<div class="line"><a name="l02286"></a><span class="lineno"> 2286</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetChannel (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">int</span> index, FMOD_CHANNEL **channel);</div>
|
|
<div class="line"><a name="l02287"></a><span class="lineno"> 2287</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetSpectrum (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> *spectrumarray, <span class="keywordtype">int</span> numvalues, <span class="keywordtype">int</span> channeloffset, FMOD_DSP_FFT_WINDOW windowtype);</div>
|
|
<div class="line"><a name="l02288"></a><span class="lineno"> 2288</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetWaveData (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">float</span> *wavearray, <span class="keywordtype">int</span> numvalues, <span class="keywordtype">int</span> channeloffset);</div>
|
|
<div class="line"><a name="l02289"></a><span class="lineno"> 2289</span> </div>
|
|
<div class="line"><a name="l02290"></a><span class="lineno"> 2290</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02291"></a><span class="lineno"> 2291</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02292"></a><span class="lineno"> 2292</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02293"></a><span class="lineno"> 2293</span> </div>
|
|
<div class="line"><a name="l02294"></a><span class="lineno"> 2294</span> FMOD_RESULT F_API FMOD_ChannelGroup_SetUserData (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02295"></a><span class="lineno"> 2295</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetUserData (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02296"></a><span class="lineno"> 2296</span> </div>
|
|
<div class="line"><a name="l02297"></a><span class="lineno"> 2297</span> FMOD_RESULT F_API FMOD_ChannelGroup_GetMemoryInfo (FMOD_CHANNELGROUP *channelgroup, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02298"></a><span class="lineno"> 2298</span> </div>
|
|
<div class="line"><a name="l02299"></a><span class="lineno"> 2299</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02300"></a><span class="lineno"> 2300</span> <span class="comment"> 'SoundGroup' API</span></div>
|
|
<div class="line"><a name="l02301"></a><span class="lineno"> 2301</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02302"></a><span class="lineno"> 2302</span> </div>
|
|
<div class="line"><a name="l02303"></a><span class="lineno"> 2303</span> FMOD_RESULT F_API FMOD_SoundGroup_Release (FMOD_SOUNDGROUP *soundgroup);</div>
|
|
<div class="line"><a name="l02304"></a><span class="lineno"> 2304</span> FMOD_RESULT F_API FMOD_SoundGroup_GetSystemObject (FMOD_SOUNDGROUP *soundgroup, FMOD_SYSTEM **system);</div>
|
|
<div class="line"><a name="l02305"></a><span class="lineno"> 2305</span> </div>
|
|
<div class="line"><a name="l02306"></a><span class="lineno"> 2306</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02307"></a><span class="lineno"> 2307</span> <span class="comment"> SoundGroup control functions.</span></div>
|
|
<div class="line"><a name="l02308"></a><span class="lineno"> 2308</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02309"></a><span class="lineno"> 2309</span> </div>
|
|
<div class="line"><a name="l02310"></a><span class="lineno"> 2310</span> FMOD_RESULT F_API FMOD_SoundGroup_SetMaxAudible (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">int</span> maxaudible);</div>
|
|
<div class="line"><a name="l02311"></a><span class="lineno"> 2311</span> FMOD_RESULT F_API FMOD_SoundGroup_GetMaxAudible (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">int</span> *maxaudible);</div>
|
|
<div class="line"><a name="l02312"></a><span class="lineno"> 2312</span> FMOD_RESULT F_API FMOD_SoundGroup_SetMaxAudibleBehavior(FMOD_SOUNDGROUP *soundgroup, FMOD_SOUNDGROUP_BEHAVIOR behavior);</div>
|
|
<div class="line"><a name="l02313"></a><span class="lineno"> 2313</span> FMOD_RESULT F_API FMOD_SoundGroup_GetMaxAudibleBehavior(FMOD_SOUNDGROUP *soundgroup, FMOD_SOUNDGROUP_BEHAVIOR *behavior);</div>
|
|
<div class="line"><a name="l02314"></a><span class="lineno"> 2314</span> FMOD_RESULT F_API FMOD_SoundGroup_SetMuteFadeSpeed (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">float</span> speed);</div>
|
|
<div class="line"><a name="l02315"></a><span class="lineno"> 2315</span> FMOD_RESULT F_API FMOD_SoundGroup_GetMuteFadeSpeed (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">float</span> *speed);</div>
|
|
<div class="line"><a name="l02316"></a><span class="lineno"> 2316</span> FMOD_RESULT F_API FMOD_SoundGroup_SetVolume (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">float</span> volume);</div>
|
|
<div class="line"><a name="l02317"></a><span class="lineno"> 2317</span> FMOD_RESULT F_API FMOD_SoundGroup_GetVolume (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">float</span> *volume);</div>
|
|
<div class="line"><a name="l02318"></a><span class="lineno"> 2318</span> FMOD_RESULT F_API FMOD_SoundGroup_Stop (FMOD_SOUNDGROUP *soundgroup);</div>
|
|
<div class="line"><a name="l02319"></a><span class="lineno"> 2319</span> </div>
|
|
<div class="line"><a name="l02320"></a><span class="lineno"> 2320</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02321"></a><span class="lineno"> 2321</span> <span class="comment"> Information only functions.</span></div>
|
|
<div class="line"><a name="l02322"></a><span class="lineno"> 2322</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02323"></a><span class="lineno"> 2323</span> </div>
|
|
<div class="line"><a name="l02324"></a><span class="lineno"> 2324</span> FMOD_RESULT F_API FMOD_SoundGroup_GetName (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">char</span> *name, <span class="keywordtype">int</span> namelen);</div>
|
|
<div class="line"><a name="l02325"></a><span class="lineno"> 2325</span> FMOD_RESULT F_API FMOD_SoundGroup_GetNumSounds (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">int</span> *numsounds);</div>
|
|
<div class="line"><a name="l02326"></a><span class="lineno"> 2326</span> FMOD_RESULT F_API FMOD_SoundGroup_GetSound (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">int</span> index, FMOD_SOUND **sound);</div>
|
|
<div class="line"><a name="l02327"></a><span class="lineno"> 2327</span> FMOD_RESULT F_API FMOD_SoundGroup_GetNumPlaying (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">int</span> *numplaying);</div>
|
|
<div class="line"><a name="l02328"></a><span class="lineno"> 2328</span> </div>
|
|
<div class="line"><a name="l02329"></a><span class="lineno"> 2329</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02330"></a><span class="lineno"> 2330</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02331"></a><span class="lineno"> 2331</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02332"></a><span class="lineno"> 2332</span> </div>
|
|
<div class="line"><a name="l02333"></a><span class="lineno"> 2333</span> FMOD_RESULT F_API FMOD_SoundGroup_SetUserData (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02334"></a><span class="lineno"> 2334</span> FMOD_RESULT F_API FMOD_SoundGroup_GetUserData (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02335"></a><span class="lineno"> 2335</span> </div>
|
|
<div class="line"><a name="l02336"></a><span class="lineno"> 2336</span> FMOD_RESULT F_API FMOD_SoundGroup_GetMemoryInfo (FMOD_SOUNDGROUP *soundgroup, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02337"></a><span class="lineno"> 2337</span> </div>
|
|
<div class="line"><a name="l02338"></a><span class="lineno"> 2338</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02339"></a><span class="lineno"> 2339</span> <span class="comment"> 'DSP' API</span></div>
|
|
<div class="line"><a name="l02340"></a><span class="lineno"> 2340</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02341"></a><span class="lineno"> 2341</span> </div>
|
|
<div class="line"><a name="l02342"></a><span class="lineno"> 2342</span> FMOD_RESULT F_API FMOD_DSP_Release (FMOD_DSP *dsp);</div>
|
|
<div class="line"><a name="l02343"></a><span class="lineno"> 2343</span> FMOD_RESULT F_API FMOD_DSP_GetSystemObject (FMOD_DSP *dsp, FMOD_SYSTEM **system);</div>
|
|
<div class="line"><a name="l02344"></a><span class="lineno"> 2344</span> </div>
|
|
<div class="line"><a name="l02345"></a><span class="lineno"> 2345</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02346"></a><span class="lineno"> 2346</span> <span class="comment"> Connection / disconnection / input and output enumeration.</span></div>
|
|
<div class="line"><a name="l02347"></a><span class="lineno"> 2347</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02348"></a><span class="lineno"> 2348</span> </div>
|
|
<div class="line"><a name="l02349"></a><span class="lineno"> 2349</span> FMOD_RESULT F_API FMOD_DSP_AddInput (FMOD_DSP *dsp, FMOD_DSP *target, FMOD_DSPCONNECTION **connection);</div>
|
|
<div class="line"><a name="l02350"></a><span class="lineno"> 2350</span> FMOD_RESULT F_API FMOD_DSP_DisconnectFrom (FMOD_DSP *dsp, FMOD_DSP *target);</div>
|
|
<div class="line"><a name="l02351"></a><span class="lineno"> 2351</span> FMOD_RESULT F_API FMOD_DSP_DisconnectAll (FMOD_DSP *dsp, FMOD_BOOL inputs, FMOD_BOOL outputs);</div>
|
|
<div class="line"><a name="l02352"></a><span class="lineno"> 2352</span> FMOD_RESULT F_API FMOD_DSP_Remove (FMOD_DSP *dsp);</div>
|
|
<div class="line"><a name="l02353"></a><span class="lineno"> 2353</span> FMOD_RESULT F_API FMOD_DSP_GetNumInputs (FMOD_DSP *dsp, <span class="keywordtype">int</span> *numinputs);</div>
|
|
<div class="line"><a name="l02354"></a><span class="lineno"> 2354</span> FMOD_RESULT F_API FMOD_DSP_GetNumOutputs (FMOD_DSP *dsp, <span class="keywordtype">int</span> *numoutputs);</div>
|
|
<div class="line"><a name="l02355"></a><span class="lineno"> 2355</span> FMOD_RESULT F_API FMOD_DSP_GetInput (FMOD_DSP *dsp, <span class="keywordtype">int</span> index, FMOD_DSP **input, FMOD_DSPCONNECTION **inputconnection);</div>
|
|
<div class="line"><a name="l02356"></a><span class="lineno"> 2356</span> FMOD_RESULT F_API FMOD_DSP_GetOutput (FMOD_DSP *dsp, <span class="keywordtype">int</span> index, FMOD_DSP **output, FMOD_DSPCONNECTION **outputconnection);</div>
|
|
<div class="line"><a name="l02357"></a><span class="lineno"> 2357</span> </div>
|
|
<div class="line"><a name="l02358"></a><span class="lineno"> 2358</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02359"></a><span class="lineno"> 2359</span> <span class="comment"> DSP unit control.</span></div>
|
|
<div class="line"><a name="l02360"></a><span class="lineno"> 2360</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02361"></a><span class="lineno"> 2361</span> </div>
|
|
<div class="line"><a name="l02362"></a><span class="lineno"> 2362</span> FMOD_RESULT F_API FMOD_DSP_SetActive (FMOD_DSP *dsp, FMOD_BOOL active);</div>
|
|
<div class="line"><a name="l02363"></a><span class="lineno"> 2363</span> FMOD_RESULT F_API FMOD_DSP_GetActive (FMOD_DSP *dsp, FMOD_BOOL *active);</div>
|
|
<div class="line"><a name="l02364"></a><span class="lineno"> 2364</span> FMOD_RESULT F_API FMOD_DSP_SetBypass (FMOD_DSP *dsp, FMOD_BOOL bypass);</div>
|
|
<div class="line"><a name="l02365"></a><span class="lineno"> 2365</span> FMOD_RESULT F_API FMOD_DSP_GetBypass (FMOD_DSP *dsp, FMOD_BOOL *bypass);</div>
|
|
<div class="line"><a name="l02366"></a><span class="lineno"> 2366</span> FMOD_RESULT F_API FMOD_DSP_SetSpeakerActive (FMOD_DSP *dsp, FMOD_SPEAKER speaker, FMOD_BOOL active);</div>
|
|
<div class="line"><a name="l02367"></a><span class="lineno"> 2367</span> FMOD_RESULT F_API FMOD_DSP_GetSpeakerActive (FMOD_DSP *dsp, FMOD_SPEAKER speaker, FMOD_BOOL *active);</div>
|
|
<div class="line"><a name="l02368"></a><span class="lineno"> 2368</span> FMOD_RESULT F_API FMOD_DSP_Reset (FMOD_DSP *dsp);</div>
|
|
<div class="line"><a name="l02369"></a><span class="lineno"> 2369</span> </div>
|
|
<div class="line"><a name="l02370"></a><span class="lineno"> 2370</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02371"></a><span class="lineno"> 2371</span> <span class="comment"> DSP parameter control.</span></div>
|
|
<div class="line"><a name="l02372"></a><span class="lineno"> 2372</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02373"></a><span class="lineno"> 2373</span> </div>
|
|
<div class="line"><a name="l02374"></a><span class="lineno"> 2374</span> FMOD_RESULT F_API FMOD_DSP_SetParameter (FMOD_DSP *dsp, <span class="keywordtype">int</span> index, <span class="keywordtype">float</span> value);</div>
|
|
<div class="line"><a name="l02375"></a><span class="lineno"> 2375</span> FMOD_RESULT F_API FMOD_DSP_GetParameter (FMOD_DSP *dsp, <span class="keywordtype">int</span> index, <span class="keywordtype">float</span> *value, <span class="keywordtype">char</span> *valuestr, <span class="keywordtype">int</span> valuestrlen);</div>
|
|
<div class="line"><a name="l02376"></a><span class="lineno"> 2376</span> FMOD_RESULT F_API FMOD_DSP_GetNumParameters (FMOD_DSP *dsp, <span class="keywordtype">int</span> *numparams);</div>
|
|
<div class="line"><a name="l02377"></a><span class="lineno"> 2377</span> FMOD_RESULT F_API FMOD_DSP_GetParameterInfo (FMOD_DSP *dsp, <span class="keywordtype">int</span> index, <span class="keywordtype">char</span> *name, <span class="keywordtype">char</span> *label, <span class="keywordtype">char</span> *description, <span class="keywordtype">int</span> descriptionlen, <span class="keywordtype">float</span> *min, <span class="keywordtype">float</span> *max);</div>
|
|
<div class="line"><a name="l02378"></a><span class="lineno"> 2378</span> FMOD_RESULT F_API FMOD_DSP_ShowConfigDialog (FMOD_DSP *dsp, <span class="keywordtype">void</span> *hwnd, FMOD_BOOL show);</div>
|
|
<div class="line"><a name="l02379"></a><span class="lineno"> 2379</span> </div>
|
|
<div class="line"><a name="l02380"></a><span class="lineno"> 2380</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02381"></a><span class="lineno"> 2381</span> <span class="comment"> DSP attributes. </span></div>
|
|
<div class="line"><a name="l02382"></a><span class="lineno"> 2382</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02383"></a><span class="lineno"> 2383</span> </div>
|
|
<div class="line"><a name="l02384"></a><span class="lineno"> 2384</span> FMOD_RESULT F_API FMOD_DSP_GetInfo (FMOD_DSP *dsp, <span class="keywordtype">char</span> *name, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *version, <span class="keywordtype">int</span> *channels, <span class="keywordtype">int</span> *configwidth, <span class="keywordtype">int</span> *configheight);</div>
|
|
<div class="line"><a name="l02385"></a><span class="lineno"> 2385</span> FMOD_RESULT F_API FMOD_DSP_GetType (FMOD_DSP *dsp, FMOD_DSP_TYPE *type);</div>
|
|
<div class="line"><a name="l02386"></a><span class="lineno"> 2386</span> FMOD_RESULT F_API FMOD_DSP_SetDefaults (FMOD_DSP *dsp, <span class="keywordtype">float</span> frequency, <span class="keywordtype">float</span> volume, <span class="keywordtype">float</span> pan, <span class="keywordtype">int</span> priority);</div>
|
|
<div class="line"><a name="l02387"></a><span class="lineno"> 2387</span> FMOD_RESULT F_API FMOD_DSP_GetDefaults (FMOD_DSP *dsp, <span class="keywordtype">float</span> *frequency, <span class="keywordtype">float</span> *volume, <span class="keywordtype">float</span> *pan, <span class="keywordtype">int</span> *priority);</div>
|
|
<div class="line"><a name="l02388"></a><span class="lineno"> 2388</span> </div>
|
|
<div class="line"><a name="l02389"></a><span class="lineno"> 2389</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02390"></a><span class="lineno"> 2390</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02391"></a><span class="lineno"> 2391</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02392"></a><span class="lineno"> 2392</span> </div>
|
|
<div class="line"><a name="l02393"></a><span class="lineno"> 2393</span> FMOD_RESULT F_API FMOD_DSP_SetUserData (FMOD_DSP *dsp, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02394"></a><span class="lineno"> 2394</span> FMOD_RESULT F_API FMOD_DSP_GetUserData (FMOD_DSP *dsp, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02395"></a><span class="lineno"> 2395</span> </div>
|
|
<div class="line"><a name="l02396"></a><span class="lineno"> 2396</span> FMOD_RESULT F_API FMOD_DSP_GetMemoryInfo (FMOD_DSP *dsp, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02397"></a><span class="lineno"> 2397</span> </div>
|
|
<div class="line"><a name="l02398"></a><span class="lineno"> 2398</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02399"></a><span class="lineno"> 2399</span> <span class="comment"> 'DSPConnection' API</span></div>
|
|
<div class="line"><a name="l02400"></a><span class="lineno"> 2400</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02401"></a><span class="lineno"> 2401</span> </div>
|
|
<div class="line"><a name="l02402"></a><span class="lineno"> 2402</span> FMOD_RESULT F_API FMOD_DSPConnection_GetInput (FMOD_DSPCONNECTION *dspconnection, FMOD_DSP **input);</div>
|
|
<div class="line"><a name="l02403"></a><span class="lineno"> 2403</span> FMOD_RESULT F_API FMOD_DSPConnection_GetOutput (FMOD_DSPCONNECTION *dspconnection, FMOD_DSP **output);</div>
|
|
<div class="line"><a name="l02404"></a><span class="lineno"> 2404</span> FMOD_RESULT F_API FMOD_DSPConnection_SetMix (FMOD_DSPCONNECTION *dspconnection, <span class="keywordtype">float</span> volume);</div>
|
|
<div class="line"><a name="l02405"></a><span class="lineno"> 2405</span> FMOD_RESULT F_API FMOD_DSPConnection_GetMix (FMOD_DSPCONNECTION *dspconnection, <span class="keywordtype">float</span> *volume);</div>
|
|
<div class="line"><a name="l02406"></a><span class="lineno"> 2406</span> FMOD_RESULT F_API FMOD_DSPConnection_SetLevels (FMOD_DSPCONNECTION *dspconnection, FMOD_SPEAKER speaker, <span class="keywordtype">float</span> *levels, <span class="keywordtype">int</span> numlevels);</div>
|
|
<div class="line"><a name="l02407"></a><span class="lineno"> 2407</span> FMOD_RESULT F_API FMOD_DSPConnection_GetLevels (FMOD_DSPCONNECTION *dspconnection, FMOD_SPEAKER speaker, <span class="keywordtype">float</span> *levels, <span class="keywordtype">int</span> numlevels);</div>
|
|
<div class="line"><a name="l02408"></a><span class="lineno"> 2408</span> </div>
|
|
<div class="line"><a name="l02409"></a><span class="lineno"> 2409</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02410"></a><span class="lineno"> 2410</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02411"></a><span class="lineno"> 2411</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02412"></a><span class="lineno"> 2412</span> </div>
|
|
<div class="line"><a name="l02413"></a><span class="lineno"> 2413</span> FMOD_RESULT F_API FMOD_DSPConnection_SetUserData (FMOD_DSPCONNECTION *dspconnection, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02414"></a><span class="lineno"> 2414</span> FMOD_RESULT F_API FMOD_DSPConnection_GetUserData (FMOD_DSPCONNECTION *dspconnection, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02415"></a><span class="lineno"> 2415</span> </div>
|
|
<div class="line"><a name="l02416"></a><span class="lineno"> 2416</span> FMOD_RESULT F_API FMOD_DSPConnection_GetMemoryInfo (FMOD_DSPCONNECTION *dspconnection, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02417"></a><span class="lineno"> 2417</span> </div>
|
|
<div class="line"><a name="l02418"></a><span class="lineno"> 2418</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02419"></a><span class="lineno"> 2419</span> <span class="comment"> 'Geometry' API</span></div>
|
|
<div class="line"><a name="l02420"></a><span class="lineno"> 2420</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02421"></a><span class="lineno"> 2421</span> </div>
|
|
<div class="line"><a name="l02422"></a><span class="lineno"> 2422</span> FMOD_RESULT F_API FMOD_Geometry_Release (FMOD_GEOMETRY *geometry);</div>
|
|
<div class="line"><a name="l02423"></a><span class="lineno"> 2423</span> </div>
|
|
<div class="line"><a name="l02424"></a><span class="lineno"> 2424</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02425"></a><span class="lineno"> 2425</span> <span class="comment"> Polygon manipulation.</span></div>
|
|
<div class="line"><a name="l02426"></a><span class="lineno"> 2426</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02427"></a><span class="lineno"> 2427</span> </div>
|
|
<div class="line"><a name="l02428"></a><span class="lineno"> 2428</span> FMOD_RESULT F_API FMOD_Geometry_AddPolygon (FMOD_GEOMETRY *geometry, <span class="keywordtype">float</span> directocclusion, <span class="keywordtype">float</span> reverbocclusion, FMOD_BOOL doublesided, <span class="keywordtype">int</span> numvertices, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vertices, <span class="keywordtype">int</span> *polygonindex);</div>
|
|
<div class="line"><a name="l02429"></a><span class="lineno"> 2429</span> FMOD_RESULT F_API FMOD_Geometry_GetNumPolygons (FMOD_GEOMETRY *geometry, <span class="keywordtype">int</span> *numpolygons);</div>
|
|
<div class="line"><a name="l02430"></a><span class="lineno"> 2430</span> FMOD_RESULT F_API FMOD_Geometry_GetMaxPolygons (FMOD_GEOMETRY *geometry, <span class="keywordtype">int</span> *maxpolygons, <span class="keywordtype">int</span> *maxvertices);</div>
|
|
<div class="line"><a name="l02431"></a><span class="lineno"> 2431</span> FMOD_RESULT F_API FMOD_Geometry_GetPolygonNumVertices(FMOD_GEOMETRY *geometry, <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> *numvertices);</div>
|
|
<div class="line"><a name="l02432"></a><span class="lineno"> 2432</span> FMOD_RESULT F_API FMOD_Geometry_SetPolygonVertex (FMOD_GEOMETRY *geometry, <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> vertexindex, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vertex);</div>
|
|
<div class="line"><a name="l02433"></a><span class="lineno"> 2433</span> FMOD_RESULT F_API FMOD_Geometry_GetPolygonVertex (FMOD_GEOMETRY *geometry, <span class="keywordtype">int</span> index, <span class="keywordtype">int</span> vertexindex, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *vertex);</div>
|
|
<div class="line"><a name="l02434"></a><span class="lineno"> 2434</span> FMOD_RESULT F_API FMOD_Geometry_SetPolygonAttributes (FMOD_GEOMETRY *geometry, <span class="keywordtype">int</span> index, <span class="keywordtype">float</span> directocclusion, <span class="keywordtype">float</span> reverbocclusion, FMOD_BOOL doublesided);</div>
|
|
<div class="line"><a name="l02435"></a><span class="lineno"> 2435</span> FMOD_RESULT F_API FMOD_Geometry_GetPolygonAttributes (FMOD_GEOMETRY *geometry, <span class="keywordtype">int</span> index, <span class="keywordtype">float</span> *directocclusion, <span class="keywordtype">float</span> *reverbocclusion, FMOD_BOOL *doublesided);</div>
|
|
<div class="line"><a name="l02436"></a><span class="lineno"> 2436</span> </div>
|
|
<div class="line"><a name="l02437"></a><span class="lineno"> 2437</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02438"></a><span class="lineno"> 2438</span> <span class="comment"> Object manipulation.</span></div>
|
|
<div class="line"><a name="l02439"></a><span class="lineno"> 2439</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02440"></a><span class="lineno"> 2440</span> </div>
|
|
<div class="line"><a name="l02441"></a><span class="lineno"> 2441</span> FMOD_RESULT F_API FMOD_Geometry_SetActive (FMOD_GEOMETRY *geometry, FMOD_BOOL active);</div>
|
|
<div class="line"><a name="l02442"></a><span class="lineno"> 2442</span> FMOD_RESULT F_API FMOD_Geometry_GetActive (FMOD_GEOMETRY *geometry, FMOD_BOOL *active);</div>
|
|
<div class="line"><a name="l02443"></a><span class="lineno"> 2443</span> FMOD_RESULT F_API FMOD_Geometry_SetRotation (FMOD_GEOMETRY *geometry, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *forward, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *up);</div>
|
|
<div class="line"><a name="l02444"></a><span class="lineno"> 2444</span> FMOD_RESULT F_API FMOD_Geometry_GetRotation (FMOD_GEOMETRY *geometry, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *forward, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *up);</div>
|
|
<div class="line"><a name="l02445"></a><span class="lineno"> 2445</span> FMOD_RESULT F_API FMOD_Geometry_SetPosition (FMOD_GEOMETRY *geometry, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *position);</div>
|
|
<div class="line"><a name="l02446"></a><span class="lineno"> 2446</span> FMOD_RESULT F_API FMOD_Geometry_GetPosition (FMOD_GEOMETRY *geometry, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *position);</div>
|
|
<div class="line"><a name="l02447"></a><span class="lineno"> 2447</span> FMOD_RESULT F_API FMOD_Geometry_SetScale (FMOD_GEOMETRY *geometry, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *scale);</div>
|
|
<div class="line"><a name="l02448"></a><span class="lineno"> 2448</span> FMOD_RESULT F_API FMOD_Geometry_GetScale (FMOD_GEOMETRY *geometry, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *scale);</div>
|
|
<div class="line"><a name="l02449"></a><span class="lineno"> 2449</span> FMOD_RESULT F_API FMOD_Geometry_Save (FMOD_GEOMETRY *geometry, <span class="keywordtype">void</span> *data, <span class="keywordtype">int</span> *datasize);</div>
|
|
<div class="line"><a name="l02450"></a><span class="lineno"> 2450</span> </div>
|
|
<div class="line"><a name="l02451"></a><span class="lineno"> 2451</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02452"></a><span class="lineno"> 2452</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02453"></a><span class="lineno"> 2453</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02454"></a><span class="lineno"> 2454</span> </div>
|
|
<div class="line"><a name="l02455"></a><span class="lineno"> 2455</span> FMOD_RESULT F_API FMOD_Geometry_SetUserData (FMOD_GEOMETRY *geometry, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02456"></a><span class="lineno"> 2456</span> FMOD_RESULT F_API FMOD_Geometry_GetUserData (FMOD_GEOMETRY *geometry, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02457"></a><span class="lineno"> 2457</span> </div>
|
|
<div class="line"><a name="l02458"></a><span class="lineno"> 2458</span> FMOD_RESULT F_API FMOD_Geometry_GetMemoryInfo (FMOD_GEOMETRY *geometry, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02459"></a><span class="lineno"> 2459</span> </div>
|
|
<div class="line"><a name="l02460"></a><span class="lineno"> 2460</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02461"></a><span class="lineno"> 2461</span> <span class="comment"> 'Reverb' API</span></div>
|
|
<div class="line"><a name="l02462"></a><span class="lineno"> 2462</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02463"></a><span class="lineno"> 2463</span> </div>
|
|
<div class="line"><a name="l02464"></a><span class="lineno"> 2464</span> FMOD_RESULT F_API FMOD_Reverb_Release (FMOD_REVERB *reverb);</div>
|
|
<div class="line"><a name="l02465"></a><span class="lineno"> 2465</span> </div>
|
|
<div class="line"><a name="l02466"></a><span class="lineno"> 2466</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02467"></a><span class="lineno"> 2467</span> <span class="comment"> Reverb manipulation.</span></div>
|
|
<div class="line"><a name="l02468"></a><span class="lineno"> 2468</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02469"></a><span class="lineno"> 2469</span> </div>
|
|
<div class="line"><a name="l02470"></a><span class="lineno"> 2470</span> FMOD_RESULT F_API FMOD_Reverb_Set3DAttributes (FMOD_REVERB *reverb, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *position, <span class="keywordtype">float</span> mindistance, <span class="keywordtype">float</span> maxdistance);</div>
|
|
<div class="line"><a name="l02471"></a><span class="lineno"> 2471</span> FMOD_RESULT F_API FMOD_Reverb_Get3DAttributes (FMOD_REVERB *reverb, <a class="code" href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a> *position, <span class="keywordtype">float</span> *mindistance, <span class="keywordtype">float</span> *maxdistance);</div>
|
|
<div class="line"><a name="l02472"></a><span class="lineno"> 2472</span> FMOD_RESULT F_API FMOD_Reverb_SetProperties (FMOD_REVERB *reverb, <span class="keyword">const</span> <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a> *properties);</div>
|
|
<div class="line"><a name="l02473"></a><span class="lineno"> 2473</span> FMOD_RESULT F_API FMOD_Reverb_GetProperties (FMOD_REVERB *reverb, <a class="code" href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a> *properties);</div>
|
|
<div class="line"><a name="l02474"></a><span class="lineno"> 2474</span> FMOD_RESULT F_API FMOD_Reverb_SetActive (FMOD_REVERB *reverb, FMOD_BOOL active);</div>
|
|
<div class="line"><a name="l02475"></a><span class="lineno"> 2475</span> FMOD_RESULT F_API FMOD_Reverb_GetActive (FMOD_REVERB *reverb, FMOD_BOOL *active);</div>
|
|
<div class="line"><a name="l02476"></a><span class="lineno"> 2476</span> </div>
|
|
<div class="line"><a name="l02477"></a><span class="lineno"> 2477</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l02478"></a><span class="lineno"> 2478</span> <span class="comment"> Userdata set/get.</span></div>
|
|
<div class="line"><a name="l02479"></a><span class="lineno"> 2479</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l02480"></a><span class="lineno"> 2480</span> </div>
|
|
<div class="line"><a name="l02481"></a><span class="lineno"> 2481</span> FMOD_RESULT F_API FMOD_Reverb_SetUserData (FMOD_REVERB *reverb, <span class="keywordtype">void</span> *userdata);</div>
|
|
<div class="line"><a name="l02482"></a><span class="lineno"> 2482</span> FMOD_RESULT F_API FMOD_Reverb_GetUserData (FMOD_REVERB *reverb, <span class="keywordtype">void</span> **userdata);</div>
|
|
<div class="line"><a name="l02483"></a><span class="lineno"> 2483</span> </div>
|
|
<div class="line"><a name="l02484"></a><span class="lineno"> 2484</span> FMOD_RESULT F_API FMOD_Reverb_GetMemoryInfo (FMOD_REVERB *reverb, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> event_memorybits, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> *memoryused, <a class="code" href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a> *memoryused_details);</div>
|
|
<div class="line"><a name="l02485"></a><span class="lineno"> 2485</span> <span class="comment">/*$ preserve start $*/</span></div>
|
|
<div class="line"><a name="l02486"></a><span class="lineno"> 2486</span> </div>
|
|
<div class="line"><a name="l02487"></a><span class="lineno"> 2487</span> <span class="preprocessor">#ifdef __cplusplus</span></div>
|
|
<div class="line"><a name="l02488"></a><span class="lineno"> 2488</span> <span class="preprocessor"></span>}</div>
|
|
<div class="line"><a name="l02489"></a><span class="lineno"> 2489</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l02490"></a><span class="lineno"> 2490</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l02491"></a><span class="lineno"> 2491</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l02492"></a><span class="lineno"> 2492</span> <span class="preprocessor"></span></div>
|
|
<div class="line"><a name="l02493"></a><span class="lineno"> 2493</span> <span class="comment">/*$ preserve end $*/</span></div>
|
|
<div class="ttc" id="struct_f_m_o_d___c_d_t_o_c_html"><div class="ttname"><a href="struct_f_m_o_d___c_d_t_o_c.html">FMOD_CDTOC</a></div><div class="ttdef"><b>Definition:</b> fmod.h:1333</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___t_a_g_html"><div class="ttname"><a href="struct_f_m_o_d___t_a_g.html">FMOD_TAG</a></div><div class="ttdef"><b>Definition:</b> fmod.h:1305</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___v_e_c_t_o_r_html"><div class="ttname"><a href="struct_f_m_o_d___v_e_c_t_o_r.html">FMOD_VECTOR</a></div><div class="ttdef"><b>Definition:</b> fmod.h:237</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___d_s_p___d_e_s_c_r_i_p_t_i_o_n_html"><div class="ttname"><a href="struct_f_m_o_d___d_s_p___d_e_s_c_r_i_p_t_i_o_n.html">FMOD_DSP_DESCRIPTION</a></div><div class="ttdef"><b>Definition:</b> fmod_dsp.h:130</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s_html"><div class="ttname"><a href="struct_f_m_o_d___a_d_v_a_n_c_e_d_s_e_t_t_i_n_g_s.html">FMOD_ADVANCEDSETTINGS</a></div><div class="ttdef"><b>Definition:</b> fmod.h:1792</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___c_o_d_e_c___d_e_s_c_r_i_p_t_i_o_n_html"><div class="ttname"><a href="struct_f_m_o_d___c_o_d_e_c___d_e_s_c_r_i_p_t_i_o_n.html">FMOD_CODEC_DESCRIPTION</a></div><div class="ttdef"><b>Definition:</b> fmod_codec.h:47</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s_html"><div class="ttname"><a href="struct_f_m_o_d___r_e_v_e_r_b___c_h_a_n_n_e_l_p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_CHANNELPROPERTIES</a></div><div class="ttdef"><b>Definition:</b> fmod.h:1720</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___g_u_i_d_html"><div class="ttname"><a href="struct_f_m_o_d___g_u_i_d.html">FMOD_GUID</a></div><div class="ttdef"><b>Definition:</b> fmod.h:259</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s_html"><div class="ttname"><a href="struct_f_m_o_d___m_e_m_o_r_y___u_s_a_g_e___d_e_t_a_i_l_s.html">FMOD_MEMORY_USAGE_DETAILS</a></div><div class="ttdef"><b>Definition:</b> fmod_memoryinfo.h:36</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s_html"><div class="ttname"><a href="struct_f_m_o_d___r_e_v_e_r_b___p_r_o_p_e_r_t_i_e_s.html">FMOD_REVERB_PROPERTIES</a></div><div class="ttdef"><b>Definition:</b> fmod.h:1571</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o_html"><div class="ttname"><a href="struct_f_m_o_d___c_r_e_a_t_e_s_o_u_n_d_e_x_i_n_f_o.html">FMOD_CREATESOUNDEXINFO</a></div><div class="ttdef"><b>Definition:</b> fmod.h:1490</div></div>
|
|
<div class="ttc" id="struct_f_m_o_d___a_s_y_n_c_r_e_a_d_i_n_f_o_html"><div class="ttname"><a href="struct_f_m_o_d___a_s_y_n_c_r_e_a_d_i_n_f_o.html">FMOD_ASYNCREADINFO</a></div><div class="ttdef"><b>Definition:</b> fmod.h:294</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Généré le Jeudi 15 Mai 2014 16:53:16 pour PonyTracker par  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.6
|
|
</small></address>
|
|
</body>
|
|
</html>
|