2
0

group__AudioFunctions.html 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.10"/>
  7. <title>TorqueScript Reference: Audio</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td id="projectalign" style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.10 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="annotated.html"><span>Classes</span></a></li>
  35. </ul>
  36. </div>
  37. </div><!-- top -->
  38. <div class="header">
  39. <div class="summary">
  40. <a href="#func-members">Functions</a> </div>
  41. <div class="headertitle">
  42. <div class="title">Audio<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  43. </div><!--header-->
  44. <div class="contents">
  45. <table class="memberdecls">
  46. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  47. Functions</h2></td></tr>
  48. <tr class="memitem:ga43d6105a6e21ff8967bedd014b8e930d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga43d6105a6e21ff8967bedd014b8e930d">alGetListener3f</a> (ALEnum)</td></tr>
  49. <tr class="separator:ga43d6105a6e21ff8967bedd014b8e930d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  50. <tr class="memitem:ga78c18ab02040f5dab4a77be82b061e58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga78c18ab02040f5dab4a77be82b061e58">alGetListeneri</a> (ALEnum)</td></tr>
  51. <tr class="separator:ga78c18ab02040f5dab4a77be82b061e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
  52. <tr class="memitem:ga8ab01225dc43b1c2d4046219bdb273a8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga8ab01225dc43b1c2d4046219bdb273a8">alGetString</a> (ALEnum)</td></tr>
  53. <tr class="separator:ga8ab01225dc43b1c2d4046219bdb273a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  54. <tr class="memitem:ga03d40ee9f6218a55f1ba64bf9e7d0812"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga03d40ee9f6218a55f1ba64bf9e7d0812">alListener3f</a> (ALEnum, x, y, z)</td></tr>
  55. <tr class="separator:ga03d40ee9f6218a55f1ba64bf9e7d0812"><td class="memSeparator" colspan="2">&#160;</td></tr>
  56. <tr class="memitem:gab21e4050844a4850097377ee67daab69"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gab21e4050844a4850097377ee67daab69">alxCreateSource</a> (audio-assetId)</td></tr>
  57. <tr class="separator:gab21e4050844a4850097377ee67daab69"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58. <tr class="memitem:ga19eabe54ad925905e2043a093b9f1310"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga19eabe54ad925905e2043a093b9f1310">alxGetAudioLength</a> (audio-assetId)</td></tr>
  59. <tr class="separator:ga19eabe54ad925905e2043a093b9f1310"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:ga64d738b656e182d836adcff6aec393ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga64d738b656e182d836adcff6aec393ec">alxGetChannelVolume</a> (channelID)</td></tr>
  61. <tr class="separator:ga64d738b656e182d836adcff6aec393ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62. <tr class="memitem:ga429325515e007ed6e9d68831488f1228"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga429325515e007ed6e9d68831488f1228">alxGetListenerf</a> (ALEnum)</td></tr>
  63. <tr class="separator:ga429325515e007ed6e9d68831488f1228"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64. <tr class="memitem:ga2255a339e637a1a30a98d7271068bd1c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga2255a339e637a1a30a98d7271068bd1c">alxGetSource3f</a> (handle, ALEnum)</td></tr>
  65. <tr class="separator:ga2255a339e637a1a30a98d7271068bd1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. <tr class="memitem:ga11c769f03ac4716657403412b42e7c95"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga11c769f03ac4716657403412b42e7c95">alxGetSourcef</a> (handle, ALEnum)</td></tr>
  67. <tr class="separator:ga11c769f03ac4716657403412b42e7c95"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68. <tr class="memitem:gabec54909f5720738c7214ad38d5d802a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gabec54909f5720738c7214ad38d5d802a">alxGetSourcei</a> (handle, ALEnum)</td></tr>
  69. <tr class="separator:gabec54909f5720738c7214ad38d5d802a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:gadc2f5c22b20c1b3a416037ff009d8893"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gadc2f5c22b20c1b3a416037ff009d8893">alxGetStreamDuration</a> (handle)</td></tr>
  71. <tr class="separator:gadc2f5c22b20c1b3a416037ff009d8893"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:gacc37066e5b13bd139eca13e25ba333a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gacc37066e5b13bd139eca13e25ba333a2">alxGetStreamPosition</a> (handle)</td></tr>
  73. <tr class="separator:gacc37066e5b13bd139eca13e25ba333a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:ga81bd421ba42941f72b24bbe5aab8c2db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga81bd421ba42941f72b24bbe5aab8c2db">alxIsPlaying</a> (handle)</td></tr>
  75. <tr class="separator:ga81bd421ba42941f72b24bbe5aab8c2db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:ga6e08d09bc2485be930925e7f852a68f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga6e08d09bc2485be930925e7f852a68f6">alxListenerf</a> (AlEnum, value)</td></tr>
  77. <tr class="separator:ga6e08d09bc2485be930925e7f852a68f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:ga5daf341fad11e122208548b117ffd30b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga5daf341fad11e122208548b117ffd30b">alxPause</a> (handle)</td></tr>
  79. <tr class="separator:ga5daf341fad11e122208548b117ffd30b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:gad23bd3a890035794f16489db6b8dee70"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gad23bd3a890035794f16489db6b8dee70">alxPlay</a> (audio-assetId)</td></tr>
  81. <tr class="separator:gad23bd3a890035794f16489db6b8dee70"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:ga680fb631cda7d2fa4ba5e5dd0d261395"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga680fb631cda7d2fa4ba5e5dd0d261395">alxSetChannelVolume</a> (channelD, volume)</td></tr>
  83. <tr class="separator:ga680fb631cda7d2fa4ba5e5dd0d261395"><td class="memSeparator" colspan="2">&#160;</td></tr>
  84. <tr class="memitem:ga78aac95142f9023146c1cf258825ea35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga78aac95142f9023146c1cf258825ea35">alxSource3f</a> (handle, ALEnum, x, y, z)</td></tr>
  85. <tr class="separator:ga78aac95142f9023146c1cf258825ea35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:gaa1da624cc55d5c8125b304d1d67b38c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gaa1da624cc55d5c8125b304d1d67b38c3">alxSourcef</a> (handle, ALEnum, value)</td></tr>
  87. <tr class="separator:gaa1da624cc55d5c8125b304d1d67b38c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88. <tr class="memitem:ga3cd6878e2e800a74dd1af135181c931d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga3cd6878e2e800a74dd1af135181c931d">alxSourcei</a> (handle, ALEnum, value)</td></tr>
  89. <tr class="separator:ga3cd6878e2e800a74dd1af135181c931d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:ga2bc5ad2eec9308586454d26d86c044c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga2bc5ad2eec9308586454d26d86c044c7">alxStop</a> (handle)</td></tr>
  91. <tr class="separator:ga2bc5ad2eec9308586454d26d86c044c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:ga4966a7ceda5ff621b7ba6d28242665a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> ()</td></tr>
  93. <tr class="separator:ga4966a7ceda5ff621b7ba6d28242665a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  94. <tr class="memitem:ga2bf0547ff333ca8ee34a2d0dfef0e0cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga2bf0547ff333ca8ee34a2d0dfef0e0cd">alxUnpause</a> (handle)</td></tr>
  95. <tr class="separator:ga2bf0547ff333ca8ee34a2d0dfef0e0cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:ga2fb386a670dd388de4d1f21d67fc11f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga2fb386a670dd388de4d1f21d67fc11f6">OpenALInitDriver</a> ()</td></tr>
  97. <tr class="separator:ga2fb386a670dd388de4d1f21d67fc11f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:ga10c63ae60cc0a7884de9f8a803d0d5a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga10c63ae60cc0a7884de9f8a803d0d5a6">OpenALRegisterExtensions</a> ()</td></tr>
  99. <tr class="separator:ga10c63ae60cc0a7884de9f8a803d0d5a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  100. <tr class="memitem:gac1fcd2fe4b77f916f76c176fcacb05de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gac1fcd2fe4b77f916f76c176fcacb05de">OpenALShutdownDriver</a> ()</td></tr>
  101. <tr class="separator:gac1fcd2fe4b77f916f76c176fcacb05de"><td class="memSeparator" colspan="2">&#160;</td></tr>
  102. </table>
  103. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  104. <h2 class="groupheader">Function Documentation</h2>
  105. <a class="anchor" id="ga43d6105a6e21ff8967bedd014b8e930d"></a>
  106. <div class="memitem">
  107. <div class="memproto">
  108. <table class="memname">
  109. <tr>
  110. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alGetListener3f </td>
  111. <td>(</td>
  112. <td class="paramtype">ALEnum&#160;</td>
  113. <td class="paramname"></td><td>)</td>
  114. <td></td>
  115. </tr>
  116. </table>
  117. </div><div class="memdoc">
  118. <p>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*. </p><dl class="params"><dt>Parameters</dt><dd>
  119. <table class="params">
  120. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  121. </table>
  122. </dd>
  123. </dl>
  124. <dl class="section return"><dt>Returns</dt><dd>Returns a float (alxGetListenerf), a vector of three floats (alGetListener3f), or an integer value respectively (alGetListeneri). </dd></dl>
  125. <dl class="section see"><dt>See also</dt><dd>alxGetSource* </dd></dl>
  126. </div>
  127. </div>
  128. <a class="anchor" id="ga78c18ab02040f5dab4a77be82b061e58"></a>
  129. <div class="memitem">
  130. <div class="memproto">
  131. <table class="memname">
  132. <tr>
  133. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alGetListeneri </td>
  134. <td>(</td>
  135. <td class="paramtype">ALEnum&#160;</td>
  136. <td class="paramname"></td><td>)</td>
  137. <td></td>
  138. </tr>
  139. </table>
  140. </div><div class="memdoc">
  141. <p>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*. </p><dl class="params"><dt>Parameters</dt><dd>
  142. <table class="params">
  143. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  144. </table>
  145. </dd>
  146. </dl>
  147. <dl class="section return"><dt>Returns</dt><dd>Returns a float (alxGetListenerf), a vector of three floats (alGetListener3f), or an integer value respectively (alGetListeneri). </dd></dl>
  148. <dl class="section see"><dt>See also</dt><dd>alxGetSource* </dd></dl>
  149. </div>
  150. </div>
  151. <a class="anchor" id="ga8ab01225dc43b1c2d4046219bdb273a8"></a>
  152. <div class="memitem">
  153. <div class="memproto">
  154. <table class="memname">
  155. <tr>
  156. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alGetString </td>
  157. <td>(</td>
  158. <td class="paramtype">ALEnum&#160;</td>
  159. <td class="paramname"></td><td>)</td>
  160. <td></td>
  161. </tr>
  162. </table>
  163. </div><div class="memdoc">
  164. <p>Use the alGetString function to get the string equivalent to the specified OpenAL enumerated value. </p><dl class="params"><dt>Parameters</dt><dd>
  165. <table class="params">
  166. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  167. </table>
  168. </dd>
  169. </dl>
  170. <dl class="section return"><dt>Returns</dt><dd>Returns a string corresponding to the passed ALEnum </dd></dl>
  171. </div>
  172. </div>
  173. <a class="anchor" id="ga03d40ee9f6218a55f1ba64bf9e7d0812"></a>
  174. <div class="memitem">
  175. <div class="memproto">
  176. <table class="memname">
  177. <tr>
  178. <td class="memname">void alListener3f </td>
  179. <td>(</td>
  180. <td class="paramtype">ALEnum&#160;</td>
  181. <td class="paramname">, </td>
  182. </tr>
  183. <tr>
  184. <td class="paramkey"></td>
  185. <td></td>
  186. <td class="paramtype">x&#160;</td>
  187. <td class="paramname">, </td>
  188. </tr>
  189. <tr>
  190. <td class="paramkey"></td>
  191. <td></td>
  192. <td class="paramtype">y&#160;</td>
  193. <td class="paramname">, </td>
  194. </tr>
  195. <tr>
  196. <td class="paramkey"></td>
  197. <td></td>
  198. <td class="paramtype">z&#160;</td>
  199. <td class="paramname">&#160;</td>
  200. </tr>
  201. <tr>
  202. <td></td>
  203. <td>)</td>
  204. <td></td><td></td>
  205. </tr>
  206. </table>
  207. </div><div class="memdoc">
  208. <p>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  209. <table class="params">
  210. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  211. <tr><td class="paramname">x,y,z</td><td>XYZ floating-point coordinates. </td></tr>
  212. </table>
  213. </dd>
  214. </dl>
  215. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  216. <dl class="section see"><dt>See also</dt><dd>al*GetListener*, alxSource* </dd></dl>
  217. </div>
  218. </div>
  219. <a class="anchor" id="gab21e4050844a4850097377ee67daab69"></a>
  220. <div class="memitem">
  221. <div class="memproto">
  222. <table class="memname">
  223. <tr>
  224. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxCreateSource </td>
  225. <td>(</td>
  226. <td class="paramtype">audio-&#160;</td>
  227. <td class="paramname"><em>assetId</em></td><td>)</td>
  228. <td></td>
  229. </tr>
  230. </table>
  231. </div><div class="memdoc">
  232. <p>Create a source from the specified asset Id. </p><dl class="params"><dt>Parameters</dt><dd>
  233. <table class="params">
  234. <tr><td class="paramname">audio-assetId</td><td>The asset Id to create the source from. </td></tr>
  235. </table>
  236. </dd>
  237. </dl>
  238. <dl class="section return"><dt>Returns</dt><dd>The handle of the created source or 0 on error. </dd></dl>
  239. </div>
  240. </div>
  241. <a class="anchor" id="ga19eabe54ad925905e2043a093b9f1310"></a>
  242. <div class="memitem">
  243. <div class="memproto">
  244. <table class="memname">
  245. <tr>
  246. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxGetAudioLength </td>
  247. <td>(</td>
  248. <td class="paramtype">audio-&#160;</td>
  249. <td class="paramname"><em>assetId</em></td><td>)</td>
  250. <td></td>
  251. </tr>
  252. </table>
  253. </div><div class="memdoc">
  254. <p>Use the alxGetAudioLength function to get the play-length of a specified resource sound file in milliseconds. </p><dl class="params"><dt>Parameters</dt><dd>
  255. <table class="params">
  256. <tr><td class="paramname">audio-assetId</td><td>The asset Id that specifies the audio file to check. </td></tr>
  257. </table>
  258. </dd>
  259. </dl>
  260. <dl class="section return"><dt>Returns</dt><dd>Returns play-length of the audio file specified by audio-assetId in milliseconds. </dd></dl>
  261. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gadc2f5c22b20c1b3a416037ff009d8893">alxGetStreamDuration</a>, <a class="el" href="group__AudioFunctions.html#gacc37066e5b13bd139eca13e25ba333a2">alxGetStreamPosition</a> </dd></dl>
  262. </div>
  263. </div>
  264. <a class="anchor" id="ga64d738b656e182d836adcff6aec393ec"></a>
  265. <div class="memitem">
  266. <div class="memproto">
  267. <table class="memname">
  268. <tr>
  269. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetChannelVolume </td>
  270. <td>(</td>
  271. <td class="paramtype">channelID&#160;</td>
  272. <td class="paramname"></td><td>)</td>
  273. <td></td>
  274. </tr>
  275. </table>
  276. </div><div class="memdoc">
  277. <p>Use the alxGetChannelVolume function to get the volume setting for a specified channel. </p><dl class="params"><dt>Parameters</dt><dd>
  278. <table class="params">
  279. <tr><td class="paramname">channelID</td><td>An integer value, equal to or greater than 0, corresponding to a valid audio channel. </td></tr>
  280. </table>
  281. </dd>
  282. </dl>
  283. <dl class="section return"><dt>Returns</dt><dd>Returns volume [ 0.0, 1.0 ] for channel specified by channelID. </dd></dl>
  284. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga680fb631cda7d2fa4ba5e5dd0d261395">alxSetChannelVolume</a> </dd></dl>
  285. </div>
  286. </div>
  287. <a class="anchor" id="ga429325515e007ed6e9d68831488f1228"></a>
  288. <div class="memitem">
  289. <div class="memproto">
  290. <table class="memname">
  291. <tr>
  292. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetListenerf </td>
  293. <td>(</td>
  294. <td class="paramtype">ALEnum&#160;</td>
  295. <td class="paramname"></td><td>)</td>
  296. <td></td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*. </p><dl class="params"><dt>Parameters</dt><dd>
  301. <table class="params">
  302. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  303. </table>
  304. </dd>
  305. </dl>
  306. <dl class="section return"><dt>Returns</dt><dd>Returns a float (alxGetListenerf), a vector of three floats (alGetListener3f), or an integer value respectively (alGetListeneri). </dd></dl>
  307. <dl class="section see"><dt>See also</dt><dd>alxGetSource* </dd></dl>
  308. </div>
  309. </div>
  310. <a class="anchor" id="ga2255a339e637a1a30a98d7271068bd1c"></a>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <table class="memname">
  314. <tr>
  315. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alxGetSource3f </td>
  316. <td>(</td>
  317. <td class="paramtype">handle&#160;</td>
  318. <td class="paramname">, </td>
  319. </tr>
  320. <tr>
  321. <td class="paramkey"></td>
  322. <td></td>
  323. <td class="paramtype">ALEnum&#160;</td>
  324. <td class="paramname">&#160;</td>
  325. </tr>
  326. <tr>
  327. <td></td>
  328. <td>)</td>
  329. <td></td><td></td>
  330. </tr>
  331. </table>
  332. </div><div class="memdoc">
  333. <p>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*. </p><dl class="params"><dt>Parameters</dt><dd>
  334. <table class="params">
  335. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  336. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. </td></tr>
  337. </table>
  338. </dd>
  339. </dl>
  340. <dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
  341. <dl class="section see"><dt>See also</dt><dd>alxSource*, al*GetListener* </dd></dl>
  342. </div>
  343. </div>
  344. <a class="anchor" id="ga11c769f03ac4716657403412b42e7c95"></a>
  345. <div class="memitem">
  346. <div class="memproto">
  347. <table class="memname">
  348. <tr>
  349. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetSourcef </td>
  350. <td>(</td>
  351. <td class="paramtype">handle&#160;</td>
  352. <td class="paramname">, </td>
  353. </tr>
  354. <tr>
  355. <td class="paramkey"></td>
  356. <td></td>
  357. <td class="paramtype">ALEnum&#160;</td>
  358. <td class="paramname">&#160;</td>
  359. </tr>
  360. <tr>
  361. <td></td>
  362. <td>)</td>
  363. <td></td><td></td>
  364. </tr>
  365. </table>
  366. </div><div class="memdoc">
  367. <p>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*. </p><dl class="params"><dt>Parameters</dt><dd>
  368. <table class="params">
  369. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  370. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  371. </table>
  372. </dd>
  373. </dl>
  374. <dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
  375. <dl class="section see"><dt>See also</dt><dd>alxSource*, al*GetListener* </dd></dl>
  376. </div>
  377. </div>
  378. <a class="anchor" id="gabec54909f5720738c7214ad38d5d802a"></a>
  379. <div class="memitem">
  380. <div class="memproto">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxGetSourcei </td>
  384. <td>(</td>
  385. <td class="paramtype">handle&#160;</td>
  386. <td class="paramname">, </td>
  387. </tr>
  388. <tr>
  389. <td class="paramkey"></td>
  390. <td></td>
  391. <td class="paramtype">ALEnum&#160;</td>
  392. <td class="paramname">&#160;</td>
  393. </tr>
  394. <tr>
  395. <td></td>
  396. <td>)</td>
  397. <td></td><td></td>
  398. </tr>
  399. </table>
  400. </div><div class="memdoc">
  401. <p>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*. </p><dl class="params"><dt>Parameters</dt><dd>
  402. <table class="params">
  403. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  404. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  405. </table>
  406. </dd>
  407. </dl>
  408. <dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
  409. <dl class="section see"><dt>See also</dt><dd>alxSource*, al*GetListener* </dd></dl>
  410. </div>
  411. </div>
  412. <a class="anchor" id="gadc2f5c22b20c1b3a416037ff009d8893"></a>
  413. <div class="memitem">
  414. <div class="memproto">
  415. <table class="memname">
  416. <tr>
  417. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetStreamDuration </td>
  418. <td>(</td>
  419. <td class="paramtype">handle&#160;</td>
  420. <td class="paramname"></td><td>)</td>
  421. <td></td>
  422. </tr>
  423. </table>
  424. </div><div class="memdoc">
  425. <p>Use the alxGetStreamDuration function to determine the length of a previously set up sound in seconds. </p><dl class="params"><dt>Parameters</dt><dd>
  426. <table class="params">
  427. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  428. </table>
  429. </dd>
  430. </dl>
  431. <dl class="section return"><dt>Returns</dt><dd>Returns -1 for invalid handle, and 0.0 to N.M for valid handle indicating length of scheduled sound in seconds. </dd></dl>
  432. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gacc37066e5b13bd139eca13e25ba333a2">alxGetStreamPosition</a> </dd></dl>
  433. </div>
  434. </div>
  435. <a class="anchor" id="gacc37066e5b13bd139eca13e25ba333a2"></a>
  436. <div class="memitem">
  437. <div class="memproto">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetStreamPosition </td>
  441. <td>(</td>
  442. <td class="paramtype">handle&#160;</td>
  443. <td class="paramname"></td><td>)</td>
  444. <td></td>
  445. </tr>
  446. </table>
  447. </div><div class="memdoc">
  448. <p>Use the alxGetStreamPosition function to get the current play position for a playing sound. Note, this value is a percentage equivalent to the percent of the sound that as already played. </p><dl class="params"><dt>Parameters</dt><dd>
  449. <table class="params">
  450. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  451. </table>
  452. </dd>
  453. </dl>
  454. <dl class="section return"><dt>Returns</dt><dd>Returns -1 for invalid handle, and 0.0 to 1.0 for valid handle indicating what percentage of the sound file has been played. </dd></dl>
  455. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gadc2f5c22b20c1b3a416037ff009d8893">alxGetStreamDuration</a> </dd></dl>
  456. </div>
  457. </div>
  458. <a class="anchor" id="ga81bd421ba42941f72b24bbe5aab8c2db"></a>
  459. <div class="memitem">
  460. <div class="memproto">
  461. <table class="memname">
  462. <tr>
  463. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxIsPlaying </td>
  464. <td>(</td>
  465. <td class="paramtype">handle&#160;</td>
  466. <td class="paramname"></td><td>)</td>
  467. <td></td>
  468. </tr>
  469. </table>
  470. </div><div class="memdoc">
  471. <p>Use the alxIsPlaying function to determine if the sound associated with a previously set-up sound handle is playing or not. </p><dl class="params"><dt>Parameters</dt><dd>
  472. <table class="params">
  473. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  474. </table>
  475. </dd>
  476. </dl>
  477. <dl class="section return"><dt>Returns</dt><dd>Returns 1 if specified handle is being played, 0 otherwise. </dd></dl>
  478. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gad23bd3a890035794f16489db6b8dee70">alxPlay</a>, <a class="el" href="group__AudioFunctions.html#ga2bc5ad2eec9308586454d26d86c044c7">alxStop</a>, <a class="el" href="group__AudioFunctions.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
  479. </div>
  480. </div>
  481. <a class="anchor" id="ga6e08d09bc2485be930925e7f852a68f6"></a>
  482. <div class="memitem">
  483. <div class="memproto">
  484. <table class="memname">
  485. <tr>
  486. <td class="memname">void alxListenerf </td>
  487. <td>(</td>
  488. <td class="paramtype">AlEnum&#160;</td>
  489. <td class="paramname">, </td>
  490. </tr>
  491. <tr>
  492. <td class="paramkey"></td>
  493. <td></td>
  494. <td class="paramtype">value&#160;</td>
  495. <td class="paramname">&#160;</td>
  496. </tr>
  497. <tr>
  498. <td></td>
  499. <td>)</td>
  500. <td></td><td></td>
  501. </tr>
  502. </table>
  503. </div><div class="memdoc">
  504. <p>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  505. <table class="params">
  506. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  507. <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
  508. </table>
  509. </dd>
  510. </dl>
  511. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  512. <dl class="section see"><dt>See also</dt><dd>al*GetListener*, alxSource* </dd></dl>
  513. </div>
  514. </div>
  515. <a class="anchor" id="ga5daf341fad11e122208548b117ffd30b"></a>
  516. <div class="memitem">
  517. <div class="memproto">
  518. <table class="memname">
  519. <tr>
  520. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxPause </td>
  521. <td>(</td>
  522. <td class="paramtype">handle&#160;</td>
  523. <td class="paramname"></td><td>)</td>
  524. <td></td>
  525. </tr>
  526. </table>
  527. </div><div class="memdoc">
  528. <p>Use the alxPause function to pause a currently playing sound as specified by handle. </p><dl class="params"><dt>Parameters</dt><dd>
  529. <table class="params">
  530. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  531. </table>
  532. </dd>
  533. </dl>
  534. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  535. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga81bd421ba42941f72b24bbe5aab8c2db">alxIsPlaying</a>, <a class="el" href="group__AudioFunctions.html#gad23bd3a890035794f16489db6b8dee70">alxPlay</a>, <a class="el" href="group__AudioFunctions.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
  536. </div>
  537. </div>
  538. <a class="anchor" id="gad23bd3a890035794f16489db6b8dee70"></a>
  539. <div class="memitem">
  540. <div class="memproto">
  541. <table class="memname">
  542. <tr>
  543. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxPlay </td>
  544. <td>(</td>
  545. <td class="paramtype">audio-&#160;</td>
  546. <td class="paramname"><em>assetId</em></td><td>)</td>
  547. <td></td>
  548. </tr>
  549. </table>
  550. </div><div class="memdoc">
  551. <p>Play the audio asset Id. </p><dl class="params"><dt>Parameters</dt><dd>
  552. <table class="params">
  553. <tr><td class="paramname">audio-assetId</td><td>The asset Id to play. </td></tr>
  554. </table>
  555. </dd>
  556. </dl>
  557. <dl class="section return"><dt>Returns</dt><dd>The handle to the playing audio asset Id or 0 on error. </dd></dl>
  558. </div>
  559. </div>
  560. <a class="anchor" id="ga680fb631cda7d2fa4ba5e5dd0d261395"></a>
  561. <div class="memitem">
  562. <div class="memproto">
  563. <table class="memname">
  564. <tr>
  565. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxSetChannelVolume </td>
  566. <td>(</td>
  567. <td class="paramtype">channelD&#160;</td>
  568. <td class="paramname">, </td>
  569. </tr>
  570. <tr>
  571. <td class="paramkey"></td>
  572. <td></td>
  573. <td class="paramtype">volume&#160;</td>
  574. <td class="paramname">&#160;</td>
  575. </tr>
  576. <tr>
  577. <td></td>
  578. <td>)</td>
  579. <td></td><td></td>
  580. </tr>
  581. </table>
  582. </div><div class="memdoc">
  583. <p>Use the alxSetChannelVolume function to set a volume [ 0.0, 1.0 ] for the channel specified by channelID. </p><dl class="params"><dt>Parameters</dt><dd>
  584. <table class="params">
  585. <tr><td class="paramname">channelID</td><td>An integer value, equal to or greater than 0, corresponding to a valid audio channel. </td></tr>
  586. <tr><td class="paramname">volume</td><td>A value between 0.0 and 1.0 specifying the new volume for the specified channel. </td></tr>
  587. </table>
  588. </dd>
  589. </dl>
  590. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure. </dd></dl>
  591. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga64d738b656e182d836adcff6aec393ec">alxGetChannelVolume</a> </dd></dl>
  592. </div>
  593. </div>
  594. <a class="anchor" id="ga78aac95142f9023146c1cf258825ea35"></a>
  595. <div class="memitem">
  596. <div class="memproto">
  597. <table class="memname">
  598. <tr>
  599. <td class="memname">void alxSource3f </td>
  600. <td>(</td>
  601. <td class="paramtype">handle&#160;</td>
  602. <td class="paramname">, </td>
  603. </tr>
  604. <tr>
  605. <td class="paramkey"></td>
  606. <td></td>
  607. <td class="paramtype">ALEnum&#160;</td>
  608. <td class="paramname">, </td>
  609. </tr>
  610. <tr>
  611. <td class="paramkey"></td>
  612. <td></td>
  613. <td class="paramtype">x&#160;</td>
  614. <td class="paramname">, </td>
  615. </tr>
  616. <tr>
  617. <td class="paramkey"></td>
  618. <td></td>
  619. <td class="paramtype">y&#160;</td>
  620. <td class="paramname">, </td>
  621. </tr>
  622. <tr>
  623. <td class="paramkey"></td>
  624. <td></td>
  625. <td class="paramtype">z&#160;</td>
  626. <td class="paramname">&#160;</td>
  627. </tr>
  628. <tr>
  629. <td></td>
  630. <td>)</td>
  631. <td></td><td></td>
  632. </tr>
  633. </table>
  634. </div><div class="memdoc">
  635. <p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  636. <table class="params">
  637. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  638. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  639. <tr><td class="paramname">x,y,z</td><td>XYZ floating-point coordinates. </td></tr>
  640. </table>
  641. </dd>
  642. </dl>
  643. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  644. <dl class="section see"><dt>See also</dt><dd>alxGetSource*, al*Listener* </dd></dl>
  645. </div>
  646. </div>
  647. <a class="anchor" id="gaa1da624cc55d5c8125b304d1d67b38c3"></a>
  648. <div class="memitem">
  649. <div class="memproto">
  650. <table class="memname">
  651. <tr>
  652. <td class="memname">void alxSourcef </td>
  653. <td>(</td>
  654. <td class="paramtype">handle&#160;</td>
  655. <td class="paramname">, </td>
  656. </tr>
  657. <tr>
  658. <td class="paramkey"></td>
  659. <td></td>
  660. <td class="paramtype">ALEnum&#160;</td>
  661. <td class="paramname">, </td>
  662. </tr>
  663. <tr>
  664. <td class="paramkey"></td>
  665. <td></td>
  666. <td class="paramtype">value&#160;</td>
  667. <td class="paramname">&#160;</td>
  668. </tr>
  669. <tr>
  670. <td></td>
  671. <td>)</td>
  672. <td></td><td></td>
  673. </tr>
  674. </table>
  675. </div><div class="memdoc">
  676. <p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  677. <table class="params">
  678. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  679. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  680. <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
  681. </table>
  682. </dd>
  683. </dl>
  684. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  685. <dl class="section see"><dt>See also</dt><dd>alxGetSource*, al*Listener* </dd></dl>
  686. </div>
  687. </div>
  688. <a class="anchor" id="ga3cd6878e2e800a74dd1af135181c931d"></a>
  689. <div class="memitem">
  690. <div class="memproto">
  691. <table class="memname">
  692. <tr>
  693. <td class="memname">void alxSourcei </td>
  694. <td>(</td>
  695. <td class="paramtype">handle&#160;</td>
  696. <td class="paramname">, </td>
  697. </tr>
  698. <tr>
  699. <td class="paramkey"></td>
  700. <td></td>
  701. <td class="paramtype">ALEnum&#160;</td>
  702. <td class="paramname">, </td>
  703. </tr>
  704. <tr>
  705. <td class="paramkey"></td>
  706. <td></td>
  707. <td class="paramtype">value&#160;</td>
  708. <td class="paramname">&#160;</td>
  709. </tr>
  710. <tr>
  711. <td></td>
  712. <td>)</td>
  713. <td></td><td></td>
  714. </tr>
  715. </table>
  716. </div><div class="memdoc">
  717. <p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  718. <table class="params">
  719. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  720. <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. See (above) table of ALEnum values for legal values. </td></tr>
  721. <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
  722. </table>
  723. </dd>
  724. </dl>
  725. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  726. <dl class="section see"><dt>See also</dt><dd>alxGetSource*, al*Listener* </dd></dl>
  727. </div>
  728. </div>
  729. <a class="anchor" id="ga2bc5ad2eec9308586454d26d86c044c7"></a>
  730. <div class="memitem">
  731. <div class="memproto">
  732. <table class="memname">
  733. <tr>
  734. <td class="memname">void alxStop </td>
  735. <td>(</td>
  736. <td class="paramtype">handle&#160;</td>
  737. <td class="paramname"></td><td>)</td>
  738. <td></td>
  739. </tr>
  740. </table>
  741. </div><div class="memdoc">
  742. <p>Use the alxStop function to stop a currently playing sound as specified by handle. </p><dl class="params"><dt>Parameters</dt><dd>
  743. <table class="params">
  744. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  745. </table>
  746. </dd>
  747. </dl>
  748. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  749. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga81bd421ba42941f72b24bbe5aab8c2db">alxIsPlaying</a>, <a class="el" href="group__AudioFunctions.html#gad23bd3a890035794f16489db6b8dee70">alxPlay</a>, <a class="el" href="group__AudioFunctions.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
  750. </div>
  751. </div>
  752. <a class="anchor" id="ga4966a7ceda5ff621b7ba6d28242665a3"></a>
  753. <div class="memitem">
  754. <div class="memproto">
  755. <table class="memname">
  756. <tr>
  757. <td class="memname">void alxStopAll </td>
  758. <td>(</td>
  759. <td class="paramname"></td><td>)</td>
  760. <td></td>
  761. </tr>
  762. </table>
  763. </div><div class="memdoc">
  764. <p>Use the alxStopAll function to stop all currently playing sounds associated with registered handles. </p><dl class="section return"><dt>Returns</dt><dd>No return. </dd></dl>
  765. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga81bd421ba42941f72b24bbe5aab8c2db">alxIsPlaying</a>, <a class="el" href="group__AudioFunctions.html#gad23bd3a890035794f16489db6b8dee70">alxPlay</a>, <a class="el" href="group__AudioFunctions.html#ga2bc5ad2eec9308586454d26d86c044c7">alxStop</a> </dd></dl>
  766. </div>
  767. </div>
  768. <a class="anchor" id="ga2bf0547ff333ca8ee34a2d0dfef0e0cd"></a>
  769. <div class="memitem">
  770. <div class="memproto">
  771. <table class="memname">
  772. <tr>
  773. <td class="memname">void alxUnpause </td>
  774. <td>(</td>
  775. <td class="paramtype">handle&#160;</td>
  776. <td class="paramname"></td><td>)</td>
  777. <td></td>
  778. </tr>
  779. </table>
  780. </div><div class="memdoc">
  781. <p>Use the alxUnpause function to resume playing a currently paused sound as specified by handle. </p><dl class="params"><dt>Parameters</dt><dd>
  782. <table class="params">
  783. <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  784. </table>
  785. </dd>
  786. </dl>
  787. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  788. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga81bd421ba42941f72b24bbe5aab8c2db">alxIsPlaying</a>, <a class="el" href="group__AudioFunctions.html#gad23bd3a890035794f16489db6b8dee70">alxPlay</a>, <a class="el" href="group__AudioFunctions.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
  789. </div>
  790. </div>
  791. <a class="anchor" id="ga2fb386a670dd388de4d1f21d67fc11f6"></a>
  792. <div class="memitem">
  793. <div class="memproto">
  794. <table class="memname">
  795. <tr>
  796. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> OpenALInitDriver </td>
  797. <td>(</td>
  798. <td class="paramname"></td><td>)</td>
  799. <td></td>
  800. </tr>
  801. </table>
  802. </div><div class="memdoc">
  803. <p>Use the OpenALInitDriver function to initialize the OpenAL driver. This must be done before all other OpenAL operations. </p><dl class="section return"><dt>Returns</dt><dd>Returns true on successful initialization, false otherwise. </dd></dl>
  804. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gac1fcd2fe4b77f916f76c176fcacb05de">OpenALShutdownDriver</a> </dd></dl>
  805. </div>
  806. </div>
  807. <a class="anchor" id="ga10c63ae60cc0a7884de9f8a803d0d5a6"></a>
  808. <div class="memitem">
  809. <div class="memproto">
  810. <table class="memname">
  811. <tr>
  812. <td class="memname">void OpenALRegisterExtensions </td>
  813. <td>(</td>
  814. <td class="paramname"></td><td>)</td>
  815. <td></td>
  816. </tr>
  817. </table>
  818. </div><div class="memdoc">
  819. <dl class="section note"><dt>Note</dt><dd>Currently does nothing (possibly deprecated) </dd></dl>
  820. </div>
  821. </div>
  822. <a class="anchor" id="gac1fcd2fe4b77f916f76c176fcacb05de"></a>
  823. <div class="memitem">
  824. <div class="memproto">
  825. <table class="memname">
  826. <tr>
  827. <td class="memname">void OpenALShutdownDriver </td>
  828. <td>(</td>
  829. <td class="paramname"></td><td>)</td>
  830. <td></td>
  831. </tr>
  832. </table>
  833. </div><div class="memdoc">
  834. <p>Use the OpenALShutdownDriver function to stop/shut down the OpenAL driver. After this is called, you must restart the driver with OpenALInitDriver to execute any new sound operations. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
  835. <dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga2fb386a670dd388de4d1f21d67fc11f6">OpenALInitDriver</a> </dd></dl>
  836. </div>
  837. </div>
  838. </div><!-- contents -->
  839. <!-- start footer part -->
  840. <hr class="footer"/><address class="footer"><small>
  841. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  842. <img class="footer" src="doxygen.png" alt="doxygen"/>
  843. </a> 1.8.10
  844. </small></address>
  845. </body>
  846. </html>