Inicio Explorar Ayuda
Iniciar sesión
TorqueEngine
/
Torque2D
espejo de https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Archivos Incidencias 0 Wiki
Árbol: 889f61e63c
Ramas Etiquetas
Torque2D
/
TorqueScriptDocs
/
html
/
group__Audio.html

group__Audio.html 43 KB
Histórico Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>Audio</title>
    6. 

  6. <link href="torquedoc.css" rel="stylesheet" type="text/css"/>
    7. 

  7. </head>
    8. 

  8. <body>
    9. 

  9. <table width="100%" class="header">
    10. 

  10. <tr>
    11. 

  11. </tr>
    12. 

  12. <tr><td class="headermenu">
    13. 

  13. 	<center>
    14. 

  14. 	<a class="qindex" href="index.html">Main</a> &nbsp; 
    15. 

  15. 	<a class="qindex" target="_blank" href="https://github.com/GarageGames/Torque2D">GitHub</a>
    16. 

  16. 	</center>
    17. 

  17. </td></tr>
    18. 

  18. </table>
    19. 

  19. <br>
    20. 

  20. <!-- END HEADER -->
    21. 

  21. <!-- Generated by Doxygen 1.8.3.1 -->
    22. 

  22. </div><!-- top -->
    23. 

  23. <div class="header">
    24. 

  24.   <div class="summary">
    25. 

  25. <a href="#func-members">Functions</a>  </div>
    26. 

  26.   <div class="headertitle">
    27. 

  27. <div class="title">Audio</div>  </div>
    28. 

  28. </div><!--header-->
    29. 

  29. <div class="contents">
    30. 

  30. <table class="memberdecls">
    31. 

  31. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
    32. 

  32. Functions</h2></td></tr>
    33. 

  33. <tr class="memitem:gab58e6a5a4f3897df9249018a301f7d41"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gab58e6a5a4f3897df9249018a301f7d41">alGetListener3f</a> (ALEnum)</td></tr>
    34. 

  34. <tr class="separator:gab58e6a5a4f3897df9249018a301f7d41"><td class="memSeparator" colspan="2">&#160;</td></tr>
    35. 

  35. <tr class="memitem:ga6ac5581fc13d4ff32738bfe52e6a2e51"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga6ac5581fc13d4ff32738bfe52e6a2e51">alGetListeneri</a> (ALEnum)</td></tr>
    36. 

  36. <tr class="separator:ga6ac5581fc13d4ff32738bfe52e6a2e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
    37. 

  37. <tr class="memitem:ga087414c24ad61273892f9b714396bf11"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga087414c24ad61273892f9b714396bf11">alGetString</a> (ALEnum)</td></tr>
    38. 

  38. <tr class="separator:ga087414c24ad61273892f9b714396bf11"><td class="memSeparator" colspan="2">&#160;</td></tr>
    39. 

  39. <tr class="memitem:ga03d40ee9f6218a55f1ba64bf9e7d0812"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga03d40ee9f6218a55f1ba64bf9e7d0812">alListener3f</a> (ALEnum, x, y, z)</td></tr>
    40. 

  40. <tr class="separator:ga03d40ee9f6218a55f1ba64bf9e7d0812"><td class="memSeparator" colspan="2">&#160;</td></tr>
    41. 

  41. <tr class="memitem:gaa8ef327d69c0f0d3d77edd89318a6685"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gaa8ef327d69c0f0d3d77edd89318a6685">alxCreateSource</a> (audio-assetId)</td></tr>
    42. 

  42. <tr class="separator:gaa8ef327d69c0f0d3d77edd89318a6685"><td class="memSeparator" colspan="2">&#160;</td></tr>
    43. 

  43. <tr class="memitem:ga62fadc30c55113e9190cb17ce7b61cf3"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga62fadc30c55113e9190cb17ce7b61cf3">alxGetAudioLength</a> (audio-assetId)</td></tr>
    44. 

  44. <tr class="separator:ga62fadc30c55113e9190cb17ce7b61cf3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    45. 

  45. <tr class="memitem:ga33a4ff1adfffac760cfc70ecddf979ab"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga33a4ff1adfffac760cfc70ecddf979ab">alxGetChannelVolume</a> (channelID)</td></tr>
    46. 

  46. <tr class="separator:ga33a4ff1adfffac760cfc70ecddf979ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
    47. 

  47. <tr class="memitem:ga17d1ff12ff2903779e86b7174ea17eb5"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga17d1ff12ff2903779e86b7174ea17eb5">alxGetListenerf</a> (ALEnum)</td></tr>
    48. 

  48. <tr class="separator:ga17d1ff12ff2903779e86b7174ea17eb5"><td class="memSeparator" colspan="2">&#160;</td></tr>
    49. 

  49. <tr class="memitem:ga071dc5c140c2d536ea22ebd610a26c68"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga071dc5c140c2d536ea22ebd610a26c68">alxGetSource3f</a> (handle, ALEnum)</td></tr>
    50. 

  50. <tr class="separator:ga071dc5c140c2d536ea22ebd610a26c68"><td class="memSeparator" colspan="2">&#160;</td></tr>
    51. 

  51. <tr class="memitem:ga43c5f6ff31d7234ba93643bb4927120b"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga43c5f6ff31d7234ba93643bb4927120b">alxGetSourcef</a> (handle, ALEnum)</td></tr>
    52. 

  52. <tr class="separator:ga43c5f6ff31d7234ba93643bb4927120b"><td class="memSeparator" colspan="2">&#160;</td></tr>
    53. 

  53. <tr class="memitem:ga9b68f9d589e0b029bc932e2e29d12a7e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga9b68f9d589e0b029bc932e2e29d12a7e">alxGetSourcei</a> (handle, ALEnum)</td></tr>
    54. 

  54. <tr class="separator:ga9b68f9d589e0b029bc932e2e29d12a7e"><td class="memSeparator" colspan="2">&#160;</td></tr>
    55. 

  55. <tr class="memitem:gad9e5d0e0b5a6a4cd7b0d0ecbaffc1716"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gad9e5d0e0b5a6a4cd7b0d0ecbaffc1716">alxGetStreamDuration</a> (handle)</td></tr>
    56. 

  56. <tr class="separator:gad9e5d0e0b5a6a4cd7b0d0ecbaffc1716"><td class="memSeparator" colspan="2">&#160;</td></tr>
    57. 

  57. <tr class="memitem:gabfee0433ee325f237e46fd228c1faa8f"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gabfee0433ee325f237e46fd228c1faa8f">alxGetStreamPosition</a> (handle)</td></tr>
    58. 

  58. <tr class="separator:gabfee0433ee325f237e46fd228c1faa8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    59. 

  59. <tr class="memitem:gaa0351f14b4177cce5d40090409247eec"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gaa0351f14b4177cce5d40090409247eec">alxIsPlaying</a> (handle)</td></tr>
    60. 

  60. <tr class="separator:gaa0351f14b4177cce5d40090409247eec"><td class="memSeparator" colspan="2">&#160;</td></tr>
    61. 

  61. <tr class="memitem:ga6e08d09bc2485be930925e7f852a68f6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga6e08d09bc2485be930925e7f852a68f6">alxListenerf</a> (AlEnum, value)</td></tr>
    62. 

  62. <tr class="separator:ga6e08d09bc2485be930925e7f852a68f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    63. 

  63. <tr class="memitem:ga65156cfde22f21fec690f70a3af7846c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga65156cfde22f21fec690f70a3af7846c">alxPause</a> (handle)</td></tr>
    64. 

  64. <tr class="separator:ga65156cfde22f21fec690f70a3af7846c"><td class="memSeparator" colspan="2">&#160;</td></tr>
    65. 

  65. <tr class="memitem:ga547870a3c5ff2c17110f65b7211c687f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga547870a3c5ff2c17110f65b7211c687f">alxPlay</a> (audio-assetId)</td></tr>
    66. 

  66. <tr class="separator:ga547870a3c5ff2c17110f65b7211c687f"><td class="memSeparator" colspan="2">&#160;</td></tr>
    67. 

  67. <tr class="memitem:gacf0ea2e30b693e6afaae99a2c5c13b73"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gacf0ea2e30b693e6afaae99a2c5c13b73">alxSetChannelVolume</a> (channelD, volume)</td></tr>
    68. 

  68. <tr class="separator:gacf0ea2e30b693e6afaae99a2c5c13b73"><td class="memSeparator" colspan="2">&#160;</td></tr>
    69. 

  69. <tr class="memitem:ga78aac95142f9023146c1cf258825ea35"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga78aac95142f9023146c1cf258825ea35">alxSource3f</a> (handle, ALEnum, x, y, z)</td></tr>
    70. 

  70. <tr class="separator:ga78aac95142f9023146c1cf258825ea35"><td class="memSeparator" colspan="2">&#160;</td></tr>
    71. 

  71. <tr class="memitem:gaa1da624cc55d5c8125b304d1d67b38c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gaa1da624cc55d5c8125b304d1d67b38c3">alxSourcef</a> (handle, ALEnum, value)</td></tr>
    72. 

  72. <tr class="separator:gaa1da624cc55d5c8125b304d1d67b38c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    73. 

  73. <tr class="memitem:ga3cd6878e2e800a74dd1af135181c931d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga3cd6878e2e800a74dd1af135181c931d">alxSourcei</a> (handle, ALEnum, value)</td></tr>
    74. 

  74. <tr class="separator:ga3cd6878e2e800a74dd1af135181c931d"><td class="memSeparator" colspan="2">&#160;</td></tr>
    75. 

  75. <tr class="memitem:ga2bc5ad2eec9308586454d26d86c044c7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga2bc5ad2eec9308586454d26d86c044c7">alxStop</a> (handle)</td></tr>
    76. 

  76. <tr class="separator:ga2bc5ad2eec9308586454d26d86c044c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
    77. 

  77. <tr class="memitem:ga4966a7ceda5ff621b7ba6d28242665a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> ()</td></tr>
    78. 

  78. <tr class="separator:ga4966a7ceda5ff621b7ba6d28242665a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
    79. 

  79. <tr class="memitem:ga2bf0547ff333ca8ee34a2d0dfef0e0cd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga2bf0547ff333ca8ee34a2d0dfef0e0cd">alxUnpause</a> (handle)</td></tr>
    80. 

  80. <tr class="separator:ga2bf0547ff333ca8ee34a2d0dfef0e0cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
    81. 

  81. <tr class="memitem:ga2fc0df4a885e1208251c9e75690b9dae"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga2fc0df4a885e1208251c9e75690b9dae">OpenALInitDriver</a> ()</td></tr>
    82. 

  82. <tr class="separator:ga2fc0df4a885e1208251c9e75690b9dae"><td class="memSeparator" colspan="2">&#160;</td></tr>
    83. 

  83. <tr class="memitem:ga10c63ae60cc0a7884de9f8a803d0d5a6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#ga10c63ae60cc0a7884de9f8a803d0d5a6">OpenALRegisterExtensions</a> ()</td></tr>
    84. 

  84. <tr class="separator:ga10c63ae60cc0a7884de9f8a803d0d5a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    85. 

  85. <tr class="memitem:gac1fcd2fe4b77f916f76c176fcacb05de"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__Audio.html#gac1fcd2fe4b77f916f76c176fcacb05de">OpenALShutdownDriver</a> ()</td></tr>
    86. 

  86. <tr class="separator:gac1fcd2fe4b77f916f76c176fcacb05de"><td class="memSeparator" colspan="2">&#160;</td></tr>
    87. 

  87. </table>
    88. 

  88. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    89. 

  89. <p>Functions dealing with the OpenAL audio layer.</p>
    90. 

  90. <dl class="section see"><dt>See Also</dt><dd>www.OpenAL.org for what these functions do. Variances from posted behaviour is described below. </dd></dl>
    91. 

  91. <h2 class="groupheader">Function Documentation</h2>
    92. 

  92. <a class="anchor" id="gab58e6a5a4f3897df9249018a301f7d41"></a>
    93. 

  93. <div class="memitem">
    94. 

  94. <div class="memproto">
    95. 

  95.       <table class="memname">
    96. 

  96.         <tr>
    97. 

  97.           <td class="memname">string alGetListener3f </td>
    98. 

  98.           <td>(</td>
    99. 

  99.           <td class="paramtype">ALEnum&#160;</td>
    100. 

  100.           <td class="paramname"></td><td>)</td>
    101. 

  101.           <td></td>
    102. 

  102.         </tr>
    103. 

  103.       </table>
    104. 

  104. </div><div class="memdoc">
    105. 

  105. <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>
    106. 

  106. <dl class="params"><dt>Parameters</dt><dd>
    107. 

  107.   <table class="params">
    108. 

  108.     <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>
    109. 

  109.   </table>
    110. 

  110.   </dd>
    111. 

  111. </dl>
    112. 

  112. <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>
    113. 

  113. <dl class="section see"><dt>See Also</dt><dd>alxGetSource* </dd></dl>
    114. 

  114. 

  115. </div>
    116. 

  116. </div>
    117. 

  117. <a class="anchor" id="ga6ac5581fc13d4ff32738bfe52e6a2e51"></a>
    118. 

  118. <div class="memitem">
    119. 

  119. <div class="memproto">
    120. 

  120.       <table class="memname">
    121. 

  121.         <tr>
    122. 

  122.           <td class="memname">int alGetListeneri </td>
    123. 

  123.           <td>(</td>
    124. 

  124.           <td class="paramtype">ALEnum&#160;</td>
    125. 

  125.           <td class="paramname"></td><td>)</td>
    126. 

  126.           <td></td>
    127. 

  127.         </tr>
    128. 

  128.       </table>
    129. 

  129. </div><div class="memdoc">
    130. 

  130. <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>
    131. 

  131. <dl class="params"><dt>Parameters</dt><dd>
    132. 

  132.   <table class="params">
    133. 

  133.     <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>
    134. 

  134.   </table>
    135. 

  135.   </dd>
    136. 

  136. </dl>
    137. 

  137. <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>
    138. 

  138. <dl class="section see"><dt>See Also</dt><dd>alxGetSource* </dd></dl>
    139. 

  139. 

  140. </div>
    141. 

  141. </div>
    142. 

  142. <a class="anchor" id="ga087414c24ad61273892f9b714396bf11"></a>
    143. 

  143. <div class="memitem">
    144. 

  144. <div class="memproto">
    145. 

  145.       <table class="memname">
    146. 

  146.         <tr>
    147. 

  147.           <td class="memname">string alGetString </td>
    148. 

  148.           <td>(</td>
    149. 

  149.           <td class="paramtype">ALEnum&#160;</td>
    150. 

  150.           <td class="paramname"></td><td>)</td>
    151. 

  151.           <td></td>
    152. 

  152.         </tr>
    153. 

  153.       </table>
    154. 

  154. </div><div class="memdoc">
    155. 

  155. <p>Use the alGetString function to get the string equivalent to the specified OpenAL enumerated value. </p>
    156. 

  156. <dl class="params"><dt>Parameters</dt><dd>
    157. 

  157.   <table class="params">
    158. 

  158.     <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>
    159. 

  159.   </table>
    160. 

  160.   </dd>
    161. 

  161. </dl>
    162. 

  162. <dl class="section return"><dt>Returns</dt><dd>Returns a string corresponding to the passed ALEnum </dd></dl>
    163. 

  163. 

  164. </div>
    165. 

  165. </div>
    166. 

  166. <a class="anchor" id="ga03d40ee9f6218a55f1ba64bf9e7d0812"></a>
    167. 

  167. <div class="memitem">
    168. 

  168. <div class="memproto">
    169. 

  169.       <table class="memname">
    170. 

  170.         <tr>
    171. 

  171.           <td class="memname">void alListener3f </td>
    172. 

  172.           <td>(</td>
    173. 

  173.           <td class="paramtype">ALEnum&#160;</td>
    174. 

  174.           <td class="paramname">, </td>
    175. 

  175.         </tr>
    176. 

  176.         <tr>
    177. 

  177.           <td class="paramkey"></td>
    178. 

  178.           <td></td>
    179. 

  179.           <td class="paramtype">x&#160;</td>
    180. 

  180.           <td class="paramname">, </td>
    181. 

  181.         </tr>
    182. 

  182.         <tr>
    183. 

  183.           <td class="paramkey"></td>
    184. 

  184.           <td></td>
    185. 

  185.           <td class="paramtype">y&#160;</td>
    186. 

  186.           <td class="paramname">, </td>
    187. 

  187.         </tr>
    188. 

  188.         <tr>
    189. 

  189.           <td class="paramkey"></td>
    190. 

  190.           <td></td>
    191. 

  191.           <td class="paramtype">z&#160;</td>
    192. 

  192.           <td class="paramname">&#160;</td>
    193. 

  193.         </tr>
    194. 

  194.         <tr>
    195. 

  195.           <td></td>
    196. 

  196.           <td>)</td>
    197. 

  197.           <td></td><td></td>
    198. 

  198.         </tr>
    199. 

  199.       </table>
    200. 

  200. </div><div class="memdoc">
    201. 

  201. <p>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum. </p>
    202. 

  202. <dl class="params"><dt>Parameters</dt><dd>
    203. 

  203.   <table class="params">
    204. 

  204.     <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>
    205. 

  205.     <tr><td class="paramname">x,y,z</td><td>XYZ floating-point coordinates. </td></tr>
    206. 

  206.   </table>
    207. 

  207.   </dd>
    208. 

  208. </dl>
    209. 

  209. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    210. 

  210. <dl class="section see"><dt>See Also</dt><dd>al*GetListener*, alxSource* </dd></dl>
    211. 

  211. 

  212. </div>
    213. 

  213. </div>
    214. 

  214. <a class="anchor" id="gaa8ef327d69c0f0d3d77edd89318a6685"></a>
    215. 

  215. <div class="memitem">
    216. 

  216. <div class="memproto">
    217. 

  217.       <table class="memname">
    218. 

  218.         <tr>
    219. 

  219.           <td class="memname">int alxCreateSource </td>
    220. 

  220.           <td>(</td>
    221. 

  221.           <td class="paramtype">audio-&#160;</td>
    222. 

  222.           <td class="paramname"><em>assetId</em></td><td>)</td>
    223. 

  223.           <td></td>
    224. 

  224.         </tr>
    225. 

  225.       </table>
    226. 

  226. </div><div class="memdoc">
    227. 

  227. <ul>
    228. 

  228. <li>Create a source from the specified asset Id. <dl class="params"><dt>Parameters</dt><dd>
    229. 

  229.   <table class="params">
    230. 

  230.     <tr><td class="paramname">audio-assetId</td><td>The asset Id to create the source from. </td></tr>
    231. 

  231.   </table>
    232. 

  232.   </dd>
    233. 

  233. </dl>
    234. 

  234. <dl class="section return"><dt>Returns</dt><dd>The handle of the created source or 0 on error. </dd></dl>
    235. 

  235. </li>
    236. 

  236. </ul>
    237. 

  237. 

  238. </div>
    239. 

  239. </div>
    240. 

  240. <a class="anchor" id="ga62fadc30c55113e9190cb17ce7b61cf3"></a>
    241. 

  241. <div class="memitem">
    242. 

  242. <div class="memproto">
    243. 

  243.       <table class="memname">
    244. 

  244.         <tr>
    245. 

  245.           <td class="memname">int alxGetAudioLength </td>
    246. 

  246.           <td>(</td>
    247. 

  247.           <td class="paramtype">audio-&#160;</td>
    248. 

  248.           <td class="paramname"><em>assetId</em></td><td>)</td>
    249. 

  249.           <td></td>
    250. 

  250.         </tr>
    251. 

  251.       </table>
    252. 

  252. </div><div class="memdoc">
    253. 

  253. <p>Use the alxGetAudioLength function to get the play-length of a specified resource sound file in milliseconds. </p>
    254. 

  254. <dl class="params"><dt>Parameters</dt><dd>
    255. 

  255.   <table class="params">
    256. 

  256.     <tr><td class="paramname">audio-assetId</td><td>The asset Id that specifies the audio file to check. </td></tr>
    257. 

  257.   </table>
    258. 

  258.   </dd>
    259. 

  259. </dl>
    260. 

  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. 

  261. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gad9e5d0e0b5a6a4cd7b0d0ecbaffc1716">alxGetStreamDuration</a>, <a class="el" href="group__Audio.html#gabfee0433ee325f237e46fd228c1faa8f">alxGetStreamPosition</a> </dd></dl>
    262. 

  262. 

  263. </div>
    264. 

  264. </div>
    265. 

  265. <a class="anchor" id="ga33a4ff1adfffac760cfc70ecddf979ab"></a>
    266. 

  266. <div class="memitem">
    267. 

  267. <div class="memproto">
    268. 

  268.       <table class="memname">
    269. 

  269.         <tr>
    270. 

  270.           <td class="memname">float alxGetChannelVolume </td>
    271. 

  271.           <td>(</td>
    272. 

  272.           <td class="paramtype">channelID&#160;</td>
    273. 

  273.           <td class="paramname"></td><td>)</td>
    274. 

  274.           <td></td>
    275. 

  275.         </tr>
    276. 

  276.       </table>
    277. 

  277. </div><div class="memdoc">
    278. 

  278. <p>Use the alxGetChannelVolume function to get the volume setting for a specified channel. </p>
    279. 

  279. <dl class="params"><dt>Parameters</dt><dd>
    280. 

  280.   <table class="params">
    281. 

  281.     <tr><td class="paramname">channelID</td><td>An integer value, equal to or greater than 0, corresponding to a valid audio channel. </td></tr>
    282. 

  282.   </table>
    283. 

  283.   </dd>
    284. 

  284. </dl>
    285. 

  285. <dl class="section return"><dt>Returns</dt><dd>Returns volume [ 0.0, 1.0 ] for channel specified by channelID. </dd></dl>
    286. 

  286. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gacf0ea2e30b693e6afaae99a2c5c13b73">alxSetChannelVolume</a> </dd></dl>
    287. 

  287. 

  288. </div>
    289. 

  289. </div>
    290. 

  290. <a class="anchor" id="ga17d1ff12ff2903779e86b7174ea17eb5"></a>
    291. 

  291. <div class="memitem">
    292. 

  292. <div class="memproto">
    293. 

  293.       <table class="memname">
    294. 

  294.         <tr>
    295. 

  295.           <td class="memname">float alxGetListenerf </td>
    296. 

  296.           <td>(</td>
    297. 

  297.           <td class="paramtype">ALEnum&#160;</td>
    298. 

  298.           <td class="paramname"></td><td>)</td>
    299. 

  299.           <td></td>
    300. 

  300.         </tr>
    301. 

  301.       </table>
    302. 

  302. </div><div class="memdoc">
    303. 

  303. <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>
    304. 

  304. <dl class="params"><dt>Parameters</dt><dd>
    305. 

  305.   <table class="params">
    306. 

  306.     <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>
    307. 

  307.   </table>
    308. 

  308.   </dd>
    309. 

  309. </dl>
    310. 

  310. <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>
    311. 

  311. <dl class="section see"><dt>See Also</dt><dd>alxGetSource* </dd></dl>
    312. 

  312. 

  313. </div>
    314. 

  314. </div>
    315. 

  315. <a class="anchor" id="ga071dc5c140c2d536ea22ebd610a26c68"></a>
    316. 

  316. <div class="memitem">
    317. 

  317. <div class="memproto">
    318. 

  318.       <table class="memname">
    319. 

  319.         <tr>
    320. 

  320.           <td class="memname">string alxGetSource3f </td>
    321. 

  321.           <td>(</td>
    322. 

  322.           <td class="paramtype">handle&#160;</td>
    323. 

  323.           <td class="paramname">, </td>
    324. 

  324.         </tr>
    325. 

  325.         <tr>
    326. 

  326.           <td class="paramkey"></td>
    327. 

  327.           <td></td>
    328. 

  328.           <td class="paramtype">ALEnum&#160;</td>
    329. 

  329.           <td class="paramname">&#160;</td>
    330. 

  330.         </tr>
    331. 

  331.         <tr>
    332. 

  332.           <td></td>
    333. 

  333.           <td>)</td>
    334. 

  334.           <td></td><td></td>
    335. 

  335.         </tr>
    336. 

  336.       </table>
    337. 

  337. </div><div class="memdoc">
    338. 

  338. <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>
    339. 

  339. <dl class="params"><dt>Parameters</dt><dd>
    340. 

  340.   <table class="params">
    341. 

  341.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    342. 

  342.     <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. </td></tr>
    343. 

  343.   </table>
    344. 

  344.   </dd>
    345. 

  345. </dl>
    346. 

  346. <dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
    347. 

  347. <dl class="section see"><dt>See Also</dt><dd>alxSource*, al*GetListener* </dd></dl>
    348. 

  348. 

  349. </div>
    350. 

  350. </div>
    351. 

  351. <a class="anchor" id="ga43c5f6ff31d7234ba93643bb4927120b"></a>
    352. 

  352. <div class="memitem">
    353. 

  353. <div class="memproto">
    354. 

  354.       <table class="memname">
    355. 

  355.         <tr>
    356. 

  356.           <td class="memname">float alxGetSourcef </td>
    357. 

  357.           <td>(</td>
    358. 

  358.           <td class="paramtype">handle&#160;</td>
    359. 

  359.           <td class="paramname">, </td>
    360. 

  360.         </tr>
    361. 

  361.         <tr>
    362. 

  362.           <td class="paramkey"></td>
    363. 

  363.           <td></td>
    364. 

  364.           <td class="paramtype">ALEnum&#160;</td>
    365. 

  365.           <td class="paramname">&#160;</td>
    366. 

  366.         </tr>
    367. 

  367.         <tr>
    368. 

  368.           <td></td>
    369. 

  369.           <td>)</td>
    370. 

  370.           <td></td><td></td>
    371. 

  371.         </tr>
    372. 

  372.       </table>
    373. 

  373. </div><div class="memdoc">
    374. 

  374. <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>
    375. 

  375. <dl class="params"><dt>Parameters</dt><dd>
    376. 

  376.   <table class="params">
    377. 

  377.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    378. 

  378.     <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>
    379. 

  379.   </table>
    380. 

  380.   </dd>
    381. 

  381. </dl>
    382. 

  382. <dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
    383. 

  383. <dl class="section see"><dt>See Also</dt><dd>alxSource*, al*GetListener* </dd></dl>
    384. 

  384. 

  385. </div>
    386. 

  386. </div>
    387. 

  387. <a class="anchor" id="ga9b68f9d589e0b029bc932e2e29d12a7e"></a>
    388. 

  388. <div class="memitem">
    389. 

  389. <div class="memproto">
    390. 

  390.       <table class="memname">
    391. 

  391.         <tr>
    392. 

  392.           <td class="memname">int alxGetSourcei </td>
    393. 

  393.           <td>(</td>
    394. 

  394.           <td class="paramtype">handle&#160;</td>
    395. 

  395.           <td class="paramname">, </td>
    396. 

  396.         </tr>
    397. 

  397.         <tr>
    398. 

  398.           <td class="paramkey"></td>
    399. 

  399.           <td></td>
    400. 

  400.           <td class="paramtype">ALEnum&#160;</td>
    401. 

  401.           <td class="paramname">&#160;</td>
    402. 

  402.         </tr>
    403. 

  403.         <tr>
    404. 

  404.           <td></td>
    405. 

  405.           <td>)</td>
    406. 

  406.           <td></td><td></td>
    407. 

  407.         </tr>
    408. 

  408.       </table>
    409. 

  409. </div><div class="memdoc">
    410. 

  410. <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>
    411. 

  411. <dl class="params"><dt>Parameters</dt><dd>
    412. 

  412.   <table class="params">
    413. 

  413.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    414. 

  414.     <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>
    415. 

  415.   </table>
    416. 

  416.   </dd>
    417. 

  417. </dl>
    418. 

  418. <dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
    419. 

  419. <dl class="section see"><dt>See Also</dt><dd>alxSource*, al*GetListener* </dd></dl>
    420. 

  420. 

  421. </div>
    422. 

  422. </div>
    423. 

  423. <a class="anchor" id="gad9e5d0e0b5a6a4cd7b0d0ecbaffc1716"></a>
    424. 

  424. <div class="memitem">
    425. 

  425. <div class="memproto">
    426. 

  426.       <table class="memname">
    427. 

  427.         <tr>
    428. 

  428.           <td class="memname">float alxGetStreamDuration </td>
    429. 

  429.           <td>(</td>
    430. 

  430.           <td class="paramtype">handle&#160;</td>
    431. 

  431.           <td class="paramname"></td><td>)</td>
    432. 

  432.           <td></td>
    433. 

  433.         </tr>
    434. 

  434.       </table>
    435. 

  435. </div><div class="memdoc">
    436. 

  436. <p>Use the alxGetStreamDuration function to determine the length of a previously set up sound in seconds. </p>
    437. 

  437. <dl class="params"><dt>Parameters</dt><dd>
    438. 

  438.   <table class="params">
    439. 

  439.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    440. 

  440.   </table>
    441. 

  441.   </dd>
    442. 

  442. </dl>
    443. 

  443. <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>
    444. 

  444. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gabfee0433ee325f237e46fd228c1faa8f">alxGetStreamPosition</a> </dd></dl>
    445. 

  445. 

  446. </div>
    447. 

  447. </div>
    448. 

  448. <a class="anchor" id="gabfee0433ee325f237e46fd228c1faa8f"></a>
    449. 

  449. <div class="memitem">
    450. 

  450. <div class="memproto">
    451. 

  451.       <table class="memname">
    452. 

  452.         <tr>
    453. 

  453.           <td class="memname">float alxGetStreamPosition </td>
    454. 

  454.           <td>(</td>
    455. 

  455.           <td class="paramtype">handle&#160;</td>
    456. 

  456.           <td class="paramname"></td><td>)</td>
    457. 

  457.           <td></td>
    458. 

  458.         </tr>
    459. 

  459.       </table>
    460. 

  460. </div><div class="memdoc">
    461. 

  461. <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>
    462. 

  462. <dl class="params"><dt>Parameters</dt><dd>
    463. 

  463.   <table class="params">
    464. 

  464.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    465. 

  465.   </table>
    466. 

  466.   </dd>
    467. 

  467. </dl>
    468. 

  468. <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>
    469. 

  469. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gad9e5d0e0b5a6a4cd7b0d0ecbaffc1716">alxGetStreamDuration</a> </dd></dl>
    470. 

  470. 

  471. </div>
    472. 

  472. </div>
    473. 

  473. <a class="anchor" id="gaa0351f14b4177cce5d40090409247eec"></a>
    474. 

  474. <div class="memitem">
    475. 

  475. <div class="memproto">
    476. 

  476.       <table class="memname">
    477. 

  477.         <tr>
    478. 

  478.           <td class="memname">bool alxIsPlaying </td>
    479. 

  479.           <td>(</td>
    480. 

  480.           <td class="paramtype">handle&#160;</td>
    481. 

  481.           <td class="paramname"></td><td>)</td>
    482. 

  482.           <td></td>
    483. 

  483.         </tr>
    484. 

  484.       </table>
    485. 

  485. </div><div class="memdoc">
    486. 

  486. <p>Use the alxIsPlaying function to determine if the sound associated with a previously set-up sound handle is playing or not. </p>
    487. 

  487. <dl class="params"><dt>Parameters</dt><dd>
    488. 

  488.   <table class="params">
    489. 

  489.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    490. 

  490.   </table>
    491. 

  491.   </dd>
    492. 

  492. </dl>
    493. 

  493. <dl class="section return"><dt>Returns</dt><dd>Returns 1 if specified handle is being played, 0 otherwise. </dd></dl>
    494. 

  494. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#ga547870a3c5ff2c17110f65b7211c687f">alxPlay</a>, <a class="el" href="group__Audio.html#ga2bc5ad2eec9308586454d26d86c044c7">alxStop</a>, <a class="el" href="group__Audio.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
    495. 

  495. 

  496. </div>
    497. 

  497. </div>
    498. 

  498. <a class="anchor" id="ga6e08d09bc2485be930925e7f852a68f6"></a>
    499. 

  499. <div class="memitem">
    500. 

  500. <div class="memproto">
    501. 

  501.       <table class="memname">
    502. 

  502.         <tr>
    503. 

  503.           <td class="memname">void alxListenerf </td>
    504. 

  504.           <td>(</td>
    505. 

  505.           <td class="paramtype">AlEnum&#160;</td>
    506. 

  506.           <td class="paramname">, </td>
    507. 

  507.         </tr>
    508. 

  508.         <tr>
    509. 

  509.           <td class="paramkey"></td>
    510. 

  510.           <td></td>
    511. 

  511.           <td class="paramtype">value&#160;</td>
    512. 

  512.           <td class="paramname">&#160;</td>
    513. 

  513.         </tr>
    514. 

  514.         <tr>
    515. 

  515.           <td></td>
    516. 

  516.           <td>)</td>
    517. 

  517.           <td></td><td></td>
    518. 

  518.         </tr>
    519. 

  519.       </table>
    520. 

  520. </div><div class="memdoc">
    521. 

  521. <p>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum. </p>
    522. 

  522. <dl class="params"><dt>Parameters</dt><dd>
    523. 

  523.   <table class="params">
    524. 

  524.     <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>
    525. 

  525.     <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
    526. 

  526.   </table>
    527. 

  527.   </dd>
    528. 

  528. </dl>
    529. 

  529. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    530. 

  530. <dl class="section see"><dt>See Also</dt><dd>al*GetListener*, alxSource* </dd></dl>
    531. 

  531. 

  532. </div>
    533. 

  533. </div>
    534. 

  534. <a class="anchor" id="ga65156cfde22f21fec690f70a3af7846c"></a>
    535. 

  535. <div class="memitem">
    536. 

  536. <div class="memproto">
    537. 

  537.       <table class="memname">
    538. 

  538.         <tr>
    539. 

  539.           <td class="memname">bool alxPause </td>
    540. 

  540.           <td>(</td>
    541. 

  541.           <td class="paramtype">handle&#160;</td>
    542. 

  542.           <td class="paramname"></td><td>)</td>
    543. 

  543.           <td></td>
    544. 

  544.         </tr>
    545. 

  545.       </table>
    546. 

  546. </div><div class="memdoc">
    547. 

  547. <p>Use the alxPause function to pause a currently playing sound as specified by handle. </p>
    548. 

  548. <dl class="params"><dt>Parameters</dt><dd>
    549. 

  549.   <table class="params">
    550. 

  550.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    551. 

  551.   </table>
    552. 

  552.   </dd>
    553. 

  553. </dl>
    554. 

  554. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    555. 

  555. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gaa0351f14b4177cce5d40090409247eec">alxIsPlaying</a>, <a class="el" href="group__Audio.html#ga547870a3c5ff2c17110f65b7211c687f">alxPlay</a>, <a class="el" href="group__Audio.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
    556. 

  556. 

  557. </div>
    558. 

  558. </div>
    559. 

  559. <a class="anchor" id="ga547870a3c5ff2c17110f65b7211c687f"></a>
    560. 

  560. <div class="memitem">
    561. 

  561. <div class="memproto">
    562. 

  562.       <table class="memname">
    563. 

  563.         <tr>
    564. 

  564.           <td class="memname">int alxPlay </td>
    565. 

  565.           <td>(</td>
    566. 

  566.           <td class="paramtype">audio-&#160;</td>
    567. 

  567.           <td class="paramname"><em>assetId</em></td><td>)</td>
    568. 

  568.           <td></td>
    569. 

  569.         </tr>
    570. 

  570.       </table>
    571. 

  571. </div><div class="memdoc">
    572. 

  572. <ul>
    573. 

  573. <li>Play the audio asset Id. <dl class="params"><dt>Parameters</dt><dd>
    574. 

  574.   <table class="params">
    575. 

  575.     <tr><td class="paramname">audio-assetId</td><td>The asset Id to play. </td></tr>
    576. 

  576.   </table>
    577. 

  577.   </dd>
    578. 

  578. </dl>
    579. 

  579. <dl class="section return"><dt>Returns</dt><dd>The handle to the playing audio asset Id or 0 on error. </dd></dl>
    580. 

  580. </li>
    581. 

  581. </ul>
    582. 

  582. 

  583. </div>
    584. 

  584. </div>
    585. 

  585. <a class="anchor" id="gacf0ea2e30b693e6afaae99a2c5c13b73"></a>
    586. 

  586. <div class="memitem">
    587. 

  587. <div class="memproto">
    588. 

  588.       <table class="memname">
    589. 

  589.         <tr>
    590. 

  590.           <td class="memname">bool alxSetChannelVolume </td>
    591. 

  591.           <td>(</td>
    592. 

  592.           <td class="paramtype">channelD&#160;</td>
    593. 

  593.           <td class="paramname">, </td>
    594. 

  594.         </tr>
    595. 

  595.         <tr>
    596. 

  596.           <td class="paramkey"></td>
    597. 

  597.           <td></td>
    598. 

  598.           <td class="paramtype">volume&#160;</td>
    599. 

  599.           <td class="paramname">&#160;</td>
    600. 

  600.         </tr>
    601. 

  601.         <tr>
    602. 

  602.           <td></td>
    603. 

  603.           <td>)</td>
    604. 

  604.           <td></td><td></td>
    605. 

  605.         </tr>
    606. 

  606.       </table>
    607. 

  607. </div><div class="memdoc">
    608. 

  608. <p>Use the alxSetChannelVolume function to set a volume [ 0.0, 1.0 ] for the channel specified by channelID. </p>
    609. 

  609. <dl class="params"><dt>Parameters</dt><dd>
    610. 

  610.   <table class="params">
    611. 

  611.     <tr><td class="paramname">channelID</td><td>An integer value, equal to or greater than 0, corresponding to a valid audio channel. </td></tr>
    612. 

  612.     <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>
    613. 

  613.   </table>
    614. 

  614.   </dd>
    615. 

  615. </dl>
    616. 

  616. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure. </dd></dl>
    617. 

  617. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#ga33a4ff1adfffac760cfc70ecddf979ab">alxGetChannelVolume</a> </dd></dl>
    618. 

  618. 

  619. </div>
    620. 

  620. </div>
    621. 

  621. <a class="anchor" id="ga78aac95142f9023146c1cf258825ea35"></a>
    622. 

  622. <div class="memitem">
    623. 

  623. <div class="memproto">
    624. 

  624.       <table class="memname">
    625. 

  625.         <tr>
    626. 

  626.           <td class="memname">void alxSource3f </td>
    627. 

  627.           <td>(</td>
    628. 

  628.           <td class="paramtype">handle&#160;</td>
    629. 

  629.           <td class="paramname">, </td>
    630. 

  630.         </tr>
    631. 

  631.         <tr>
    632. 

  632.           <td class="paramkey"></td>
    633. 

  633.           <td></td>
    634. 

  634.           <td class="paramtype">ALEnum&#160;</td>
    635. 

  635.           <td class="paramname">, </td>
    636. 

  636.         </tr>
    637. 

  637.         <tr>
    638. 

  638.           <td class="paramkey"></td>
    639. 

  639.           <td></td>
    640. 

  640.           <td class="paramtype">x&#160;</td>
    641. 

  641.           <td class="paramname">, </td>
    642. 

  642.         </tr>
    643. 

  643.         <tr>
    644. 

  644.           <td class="paramkey"></td>
    645. 

  645.           <td></td>
    646. 

  646.           <td class="paramtype">y&#160;</td>
    647. 

  647.           <td class="paramname">, </td>
    648. 

  648.         </tr>
    649. 

  649.         <tr>
    650. 

  650.           <td class="paramkey"></td>
    651. 

  651.           <td></td>
    652. 

  652.           <td class="paramtype">z&#160;</td>
    653. 

  653.           <td class="paramname">&#160;</td>
    654. 

  654.         </tr>
    655. 

  655.         <tr>
    656. 

  656.           <td></td>
    657. 

  657.           <td>)</td>
    658. 

  658.           <td></td><td></td>
    659. 

  659.         </tr>
    660. 

  660.       </table>
    661. 

  661. </div><div class="memdoc">
    662. 

  662. <p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p>
    663. 

  663. <dl class="params"><dt>Parameters</dt><dd>
    664. 

  664.   <table class="params">
    665. 

  665.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    666. 

  666.     <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>
    667. 

  667.     <tr><td class="paramname">x,y,z</td><td>XYZ floating-point coordinates. </td></tr>
    668. 

  668.   </table>
    669. 

  669.   </dd>
    670. 

  670. </dl>
    671. 

  671. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    672. 

  672. <dl class="section see"><dt>See Also</dt><dd>alxGetSource*, al*Listener* </dd></dl>
    673. 

  673. 

  674. </div>
    675. 

  675. </div>
    676. 

  676. <a class="anchor" id="gaa1da624cc55d5c8125b304d1d67b38c3"></a>
    677. 

  677. <div class="memitem">
    678. 

  678. <div class="memproto">
    679. 

  679.       <table class="memname">
    680. 

  680.         <tr>
    681. 

  681.           <td class="memname">void alxSourcef </td>
    682. 

  682.           <td>(</td>
    683. 

  683.           <td class="paramtype">handle&#160;</td>
    684. 

  684.           <td class="paramname">, </td>
    685. 

  685.         </tr>
    686. 

  686.         <tr>
    687. 

  687.           <td class="paramkey"></td>
    688. 

  688.           <td></td>
    689. 

  689.           <td class="paramtype">ALEnum&#160;</td>
    690. 

  690.           <td class="paramname">, </td>
    691. 

  691.         </tr>
    692. 

  692.         <tr>
    693. 

  693.           <td class="paramkey"></td>
    694. 

  694.           <td></td>
    695. 

  695.           <td class="paramtype">value&#160;</td>
    696. 

  696.           <td class="paramname">&#160;</td>
    697. 

  697.         </tr>
    698. 

  698.         <tr>
    699. 

  699.           <td></td>
    700. 

  700.           <td>)</td>
    701. 

  701.           <td></td><td></td>
    702. 

  702.         </tr>
    703. 

  703.       </table>
    704. 

  704. </div><div class="memdoc">
    705. 

  705. <p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p>
    706. 

  706. <dl class="params"><dt>Parameters</dt><dd>
    707. 

  707.   <table class="params">
    708. 

  708.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    709. 

  709.     <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>
    710. 

  710.     <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
    711. 

  711.   </table>
    712. 

  712.   </dd>
    713. 

  713. </dl>
    714. 

  714. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    715. 

  715. <dl class="section see"><dt>See Also</dt><dd>alxGetSource*, al*Listener* </dd></dl>
    716. 

  716. 

  717. </div>
    718. 

  718. </div>
    719. 

  719. <a class="anchor" id="ga3cd6878e2e800a74dd1af135181c931d"></a>
    720. 

  720. <div class="memitem">
    721. 

  721. <div class="memproto">
    722. 

  722.       <table class="memname">
    723. 

  723.         <tr>
    724. 

  724.           <td class="memname">void alxSourcei </td>
    725. 

  725.           <td>(</td>
    726. 

  726.           <td class="paramtype">handle&#160;</td>
    727. 

  727.           <td class="paramname">, </td>
    728. 

  728.         </tr>
    729. 

  729.         <tr>
    730. 

  730.           <td class="paramkey"></td>
    731. 

  731.           <td></td>
    732. 

  732.           <td class="paramtype">ALEnum&#160;</td>
    733. 

  733.           <td class="paramname">, </td>
    734. 

  734.         </tr>
    735. 

  735.         <tr>
    736. 

  736.           <td class="paramkey"></td>
    737. 

  737.           <td></td>
    738. 

  738.           <td class="paramtype">value&#160;</td>
    739. 

  739.           <td class="paramname">&#160;</td>
    740. 

  740.         </tr>
    741. 

  741.         <tr>
    742. 

  742.           <td></td>
    743. 

  743.           <td>)</td>
    744. 

  744.           <td></td><td></td>
    745. 

  745.         </tr>
    746. 

  746.       </table>
    747. 

  747. </div><div class="memdoc">
    748. 

  748. <p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p>
    749. 

  749. <dl class="params"><dt>Parameters</dt><dd>
    750. 

  750.   <table class="params">
    751. 

  751.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    752. 

  752.     <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>
    753. 

  753.     <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
    754. 

  754.   </table>
    755. 

  755.   </dd>
    756. 

  756. </dl>
    757. 

  757. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    758. 

  758. <dl class="section see"><dt>See Also</dt><dd>alxGetSource*, al*Listener* </dd></dl>
    759. 

  759. 

  760. </div>
    761. 

  761. </div>
    762. 

  762. <a class="anchor" id="ga2bc5ad2eec9308586454d26d86c044c7"></a>
    763. 

  763. <div class="memitem">
    764. 

  764. <div class="memproto">
    765. 

  765.       <table class="memname">
    766. 

  766.         <tr>
    767. 

  767.           <td class="memname">void alxStop </td>
    768. 

  768.           <td>(</td>
    769. 

  769.           <td class="paramtype">handle&#160;</td>
    770. 

  770.           <td class="paramname"></td><td>)</td>
    771. 

  771.           <td></td>
    772. 

  772.         </tr>
    773. 

  773.       </table>
    774. 

  774. </div><div class="memdoc">
    775. 

  775. <p>Use the alxStop function to stop a currently playing sound as specified by handle. </p>
    776. 

  776. <dl class="params"><dt>Parameters</dt><dd>
    777. 

  777.   <table class="params">
    778. 

  778.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    779. 

  779.   </table>
    780. 

  780.   </dd>
    781. 

  781. </dl>
    782. 

  782. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    783. 

  783. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gaa0351f14b4177cce5d40090409247eec">alxIsPlaying</a>, <a class="el" href="group__Audio.html#ga547870a3c5ff2c17110f65b7211c687f">alxPlay</a>, <a class="el" href="group__Audio.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
    784. 

  784. 

  785. </div>
    786. 

  786. </div>
    787. 

  787. <a class="anchor" id="ga4966a7ceda5ff621b7ba6d28242665a3"></a>
    788. 

  788. <div class="memitem">
    789. 

  789. <div class="memproto">
    790. 

  790.       <table class="memname">
    791. 

  791.         <tr>
    792. 

  792.           <td class="memname">void alxStopAll </td>
    793. 

  793.           <td>(</td>
    794. 

  794.           <td class="paramname"></td><td>)</td>
    795. 

  795.           <td></td>
    796. 

  796.         </tr>
    797. 

  797.       </table>
    798. 

  798. </div><div class="memdoc">
    799. 

  799. <p>Use the alxStopAll function to stop all currently playing sounds associated with registered handles. </p>
    800. 

  800. <dl class="section return"><dt>Returns</dt><dd>No return. </dd></dl>
    801. 

  801. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gaa0351f14b4177cce5d40090409247eec">alxIsPlaying</a>, <a class="el" href="group__Audio.html#ga547870a3c5ff2c17110f65b7211c687f">alxPlay</a>, <a class="el" href="group__Audio.html#ga2bc5ad2eec9308586454d26d86c044c7">alxStop</a> </dd></dl>
    802. 

  802. 

  803. </div>
    804. 

  804. </div>
    805. 

  805. <a class="anchor" id="ga2bf0547ff333ca8ee34a2d0dfef0e0cd"></a>
    806. 

  806. <div class="memitem">
    807. 

  807. <div class="memproto">
    808. 

  808.       <table class="memname">
    809. 

  809.         <tr>
    810. 

  810.           <td class="memname">void alxUnpause </td>
    811. 

  811.           <td>(</td>
    812. 

  812.           <td class="paramtype">handle&#160;</td>
    813. 

  813.           <td class="paramname"></td><td>)</td>
    814. 

  814.           <td></td>
    815. 

  815.         </tr>
    816. 

  816.       </table>
    817. 

  817. </div><div class="memdoc">
    818. 

  818. <p>Use the alxUnpause function to resume playing a currently paused sound as specified by handle. </p>
    819. 

  819. <dl class="params"><dt>Parameters</dt><dd>
    820. 

  820.   <table class="params">
    821. 

  821.     <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    822. 

  822.   </table>
    823. 

  823.   </dd>
    824. 

  824. </dl>
    825. 

  825. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    826. 

  826. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gaa0351f14b4177cce5d40090409247eec">alxIsPlaying</a>, <a class="el" href="group__Audio.html#ga547870a3c5ff2c17110f65b7211c687f">alxPlay</a>, <a class="el" href="group__Audio.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> </dd></dl>
    827. 

  827. 

  828. </div>
    829. 

  829. </div>
    830. 

  830. <a class="anchor" id="ga2fc0df4a885e1208251c9e75690b9dae"></a>
    831. 

  831. <div class="memitem">
    832. 

  832. <div class="memproto">
    833. 

  833.       <table class="memname">
    834. 

  834.         <tr>
    835. 

  835.           <td class="memname">bool OpenALInitDriver </td>
    836. 

  836.           <td>(</td>
    837. 

  837.           <td class="paramname"></td><td>)</td>
    838. 

  838.           <td></td>
    839. 

  839.         </tr>
    840. 

  840.       </table>
    841. 

  841. </div><div class="memdoc">
    842. 

  842. <p>Use the OpenALInitDriver function to initialize the OpenAL driver. This must be done before all other OpenAL operations. </p>
    843. 

  843. <dl class="section return"><dt>Returns</dt><dd>Returns true on successful initialization, false otherwise. </dd></dl>
    844. 

  844. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#gac1fcd2fe4b77f916f76c176fcacb05de">OpenALShutdownDriver</a> </dd></dl>
    845. 

  845. 

  846. </div>
    847. 

  847. </div>
    848. 

  848. <a class="anchor" id="ga10c63ae60cc0a7884de9f8a803d0d5a6"></a>
    849. 

  849. <div class="memitem">
    850. 

  850. <div class="memproto">
    851. 

  851.       <table class="memname">
    852. 

  852.         <tr>
    853. 

  853.           <td class="memname">void OpenALRegisterExtensions </td>
    854. 

  854.           <td>(</td>
    855. 

  855.           <td class="paramname"></td><td>)</td>
    856. 

  856.           <td></td>
    857. 

  857.         </tr>
    858. 

  858.       </table>
    859. 

  859. </div><div class="memdoc">
    860. 

  860. <dl class="section note"><dt>Note</dt><dd>Currently does nothing (possibly deprecated) </dd></dl>
    861. 

  861. 

  862. </div>
    863. 

  863. </div>
    864. 

  864. <a class="anchor" id="gac1fcd2fe4b77f916f76c176fcacb05de"></a>
    865. 

  865. <div class="memitem">
    866. 

  866. <div class="memproto">
    867. 

  867.       <table class="memname">
    868. 

  868.         <tr>
    869. 

  869.           <td class="memname">void OpenALShutdownDriver </td>
    870. 

  870.           <td>(</td>
    871. 

  871.           <td class="paramname"></td><td>)</td>
    872. 

  872.           <td></td>
    873. 

  873.         </tr>
    874. 

  874.       </table>
    875. 

  875. </div><div class="memdoc">
    876. 

  876. <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>
    877. 

  877. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    878. 

  878. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__Audio.html#ga2fc0df4a885e1208251c9e75690b9dae">OpenALInitDriver</a> </dd></dl>
    879. 

  879. 

  880. </div>
    881. 

  881. </div>
    882. 

  882. </div><!-- contents -->
    883. 

  883. <!-- START FOOTER -->
    884. 

  884. <br>
    885. 

  885. <br>
    886. 

  886. <center>
    887. 

  887. 	<div style="color: #777777;">
    888. 

  888. 	Copyright &copy; 2013 <a style="color: #777777;" target="_blank" href="http://www.garagegames.com">GarageGames, LLC</a>. All Rights Reserved.
    889. 

  889. 	</div>
    890. 

  890. </center>
    891. 

  891. </body>
    892. 

  892. </html>
    893.