Startseite Erkunden Hilfe
Anmelden
TorqueEngine
/
Torque2D
Mirror von https://github.com/TorqueGameEngines/Torque2D.git
2
0
Fork 0
Dateien Issues 0 Wiki
Struktur: 9aa0867d16
Branches Tags
Torque2D
/
TorqueScriptDocs
/
html
/
group__AudioFunctions.html

group__AudioFunctions.html 47 KB
Verlauf Originalformat

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900 
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
    6. 

  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
    7. 

  7. <title>TorqueScript Reference: Audio</title>
    8. 

  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    9. 

  9. <script type="text/javascript" src="jquery.js"></script>
    10. 

  10. <script type="text/javascript" src="dynsections.js"></script>
    11. 

  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
    12. 

  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
    13. 

  13. </head>
    14. 

  14. <body>
    15. 

  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
    16. 

  16. <div id="titlearea">
    17. 

  17. <table cellspacing="0" cellpadding="0">
    18. 

  18.  <tbody>
    19. 

  19.  <tr style="height: 56px;">
    20. 

  20.   <td style="padding-left: 0.5em;">
    21. 

  21.    <div id="projectname">TorqueScript Reference
    22. 

  22.    </div>
    23. 

  23.   </td>
    24. 

  24.  </tr>
    25. 

  25.  </tbody>
    26. 

  26. </table>
    27. 

  27. </div>
    28. 

  28. <!-- end header part -->
    29. 

  29. <!-- Generated by Doxygen 1.8.3.1 -->
    30. 

  30.   <div id="navrow1" class="tabs">
    31. 

  31.     <ul class="tablist">
    32. 

  32.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    33. 

  33.       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
    34. 

  34.       <li><a href="modules.html"><span>Modules</span></a></li>
    35. 

  35.       <li><a href="annotated.html"><span>Classes</span></a></li>
    36. 

  36.     </ul>
    37. 

  37.   </div>
    38. 

  38. </div><!-- top -->
    39. 

  39. <div class="header">
    40. 

  40.   <div class="summary">
    41. 

  41. <a href="#func-members">Functions</a>  </div>
    42. 

  42.   <div class="headertitle">
    43. 

  43. <div class="title">Audio<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div>  </div>
    44. 

  44. </div><!--header-->
    45. 

  45. <div class="contents">
    46. 

  46. <table class="memberdecls">
    47. 

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

  48. Functions</h2></td></tr>
    49. 

  49. <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>
    50. 

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

  51. <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>
    52. 

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

  53. <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>
    54. 

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

  55. <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>
    56. 

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

  57. <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>
    58. 

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

  59. <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>
    60. 

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

  61. <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>
    62. 

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

  63. <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>
    64. 

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

  65. <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>
    66. 

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

  67. <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>
    68. 

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

  69. <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>
    70. 

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

  71. <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>
    72. 

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

  73. <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>
    74. 

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

  75. <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>
    76. 

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

  77. <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>
    78. 

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

  79. <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>
    80. 

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

  81. <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>
    82. 

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

  83. <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>
    84. 

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

  85. <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>
    86. 

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

  87. <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>
    88. 

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

  89. <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>
    90. 

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

  91. <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>
    92. 

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

  93. <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>
    94. 

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

  95. <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>
    96. 

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

  97. <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>
    98. 

  98. <tr class="separator:ga2fb386a670dd388de4d1f21d67fc11f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
    99. 

  99. <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>
    100. 

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

  101. <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>
    102. 

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

  103. </table>
    104. 

  104. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
    105. 

  105. <h2 class="groupheader">Function Documentation</h2>
    106. 

  106. <a class="anchor" id="ga43d6105a6e21ff8967bedd014b8e930d"></a>
    107. 

  107. <div class="memitem">
    108. 

  108. <div class="memproto">
    109. 

  109.       <table class="memname">
    110. 

  110.         <tr>
    111. 

  111.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alGetListener3f </td>
    112. 

  112.           <td>(</td>
    113. 

  113.           <td class="paramtype">ALEnum&#160;</td>
    114. 

  114.           <td class="paramname"></td><td>)</td>
    115. 

  115.           <td></td>
    116. 

  116.         </tr>
    117. 

  117.       </table>
    118. 

  118. </div><div class="memdoc">
    119. 

  119. <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>
    120. 

  120. <dl class="params"><dt>Parameters</dt><dd>
    121. 

  121.   <table class="params">
    122. 

  122.     <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>
    123. 

  123.   </table>
    124. 

  124.   </dd>
    125. 

  125. </dl>
    126. 

  126. <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>
    127. 

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

  128. 

  129. </div>
    130. 

  130. </div>
    131. 

  131. <a class="anchor" id="ga78c18ab02040f5dab4a77be82b061e58"></a>
    132. 

  132. <div class="memitem">
    133. 

  133. <div class="memproto">
    134. 

  134.       <table class="memname">
    135. 

  135.         <tr>
    136. 

  136.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alGetListeneri </td>
    137. 

  137.           <td>(</td>
    138. 

  138.           <td class="paramtype">ALEnum&#160;</td>
    139. 

  139.           <td class="paramname"></td><td>)</td>
    140. 

  140.           <td></td>
    141. 

  141.         </tr>
    142. 

  142.       </table>
    143. 

  143. </div><div class="memdoc">
    144. 

  144. <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>
    145. 

  145. <dl class="params"><dt>Parameters</dt><dd>
    146. 

  146.   <table class="params">
    147. 

  147.     <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>
    148. 

  148.   </table>
    149. 

  149.   </dd>
    150. 

  150. </dl>
    151. 

  151. <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>
    152. 

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

  153. 

  154. </div>
    155. 

  155. </div>
    156. 

  156. <a class="anchor" id="ga8ab01225dc43b1c2d4046219bdb273a8"></a>
    157. 

  157. <div class="memitem">
    158. 

  158. <div class="memproto">
    159. 

  159.       <table class="memname">
    160. 

  160.         <tr>
    161. 

  161.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alGetString </td>
    162. 

  162.           <td>(</td>
    163. 

  163.           <td class="paramtype">ALEnum&#160;</td>
    164. 

  164.           <td class="paramname"></td><td>)</td>
    165. 

  165.           <td></td>
    166. 

  166.         </tr>
    167. 

  167.       </table>
    168. 

  168. </div><div class="memdoc">
    169. 

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

  170. <dl class="params"><dt>Parameters</dt><dd>
    171. 

  171.   <table class="params">
    172. 

  172.     <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>
    173. 

  173.   </table>
    174. 

  174.   </dd>
    175. 

  175. </dl>
    176. 

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

  177. 

  178. </div>
    179. 

  179. </div>
    180. 

  180. <a class="anchor" id="ga03d40ee9f6218a55f1ba64bf9e7d0812"></a>
    181. 

  181. <div class="memitem">
    182. 

  182. <div class="memproto">
    183. 

  183.       <table class="memname">
    184. 

  184.         <tr>
    185. 

  185.           <td class="memname">void alListener3f </td>
    186. 

  186.           <td>(</td>
    187. 

  187.           <td class="paramtype">ALEnum&#160;</td>
    188. 

  188.           <td class="paramname">, </td>
    189. 

  189.         </tr>
    190. 

  190.         <tr>
    191. 

  191.           <td class="paramkey"></td>
    192. 

  192.           <td></td>
    193. 

  193.           <td class="paramtype">x&#160;</td>
    194. 

  194.           <td class="paramname">, </td>
    195. 

  195.         </tr>
    196. 

  196.         <tr>
    197. 

  197.           <td class="paramkey"></td>
    198. 

  198.           <td></td>
    199. 

  199.           <td class="paramtype">y&#160;</td>
    200. 

  200.           <td class="paramname">, </td>
    201. 

  201.         </tr>
    202. 

  202.         <tr>
    203. 

  203.           <td class="paramkey"></td>
    204. 

  204.           <td></td>
    205. 

  205.           <td class="paramtype">z&#160;</td>
    206. 

  206.           <td class="paramname">&#160;</td>
    207. 

  207.         </tr>
    208. 

  208.         <tr>
    209. 

  209.           <td></td>
    210. 

  210.           <td>)</td>
    211. 

  211.           <td></td><td></td>
    212. 

  212.         </tr>
    213. 

  213.       </table>
    214. 

  214. </div><div class="memdoc">
    215. 

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

  216. <dl class="params"><dt>Parameters</dt><dd>
    217. 

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

  218.     <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>
    219. 

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

  220.   </table>
    221. 

  221.   </dd>
    222. 

  222. </dl>
    223. 

  223. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    224. 

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

  225. 

  226. </div>
    227. 

  227. </div>
    228. 

  228. <a class="anchor" id="gab21e4050844a4850097377ee67daab69"></a>
    229. 

  229. <div class="memitem">
    230. 

  230. <div class="memproto">
    231. 

  231.       <table class="memname">
    232. 

  232.         <tr>
    233. 

  233.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxCreateSource </td>
    234. 

  234.           <td>(</td>
    235. 

  235.           <td class="paramtype">audio-&#160;</td>
    236. 

  236.           <td class="paramname"><em>assetId</em></td><td>)</td>
    237. 

  237.           <td></td>
    238. 

  238.         </tr>
    239. 

  239.       </table>
    240. 

  240. </div><div class="memdoc">
    241. 

  241. <p>Create a source from the specified asset Id. </p>
    242. 

  242. <dl class="params"><dt>Parameters</dt><dd>
    243. 

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

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

  245.   </table>
    246. 

  246.   </dd>
    247. 

  247. </dl>
    248. 

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

  249. 

  250. </div>
    251. 

  251. </div>
    252. 

  252. <a class="anchor" id="ga19eabe54ad925905e2043a093b9f1310"></a>
    253. 

  253. <div class="memitem">
    254. 

  254. <div class="memproto">
    255. 

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

  256.         <tr>
    257. 

  257.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxGetAudioLength </td>
    258. 

  258.           <td>(</td>
    259. 

  259.           <td class="paramtype">audio-&#160;</td>
    260. 

  260.           <td class="paramname"><em>assetId</em></td><td>)</td>
    261. 

  261.           <td></td>
    262. 

  262.         </tr>
    263. 

  263.       </table>
    264. 

  264. </div><div class="memdoc">
    265. 

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

  266. <dl class="params"><dt>Parameters</dt><dd>
    267. 

  267.   <table class="params">
    268. 

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

  269.   </table>
    270. 

  270.   </dd>
    271. 

  271. </dl>
    272. 

  272. <dl class="section return"><dt>Returns</dt><dd>Returns play-length of the audio file specified by audio-assetId in milliseconds. </dd></dl>
    273. 

  273. <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>
    274. 

  274. 

  275. </div>
    276. 

  276. </div>
    277. 

  277. <a class="anchor" id="ga64d738b656e182d836adcff6aec393ec"></a>
    278. 

  278. <div class="memitem">
    279. 

  279. <div class="memproto">
    280. 

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

  281.         <tr>
    282. 

  282.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetChannelVolume </td>
    283. 

  283.           <td>(</td>
    284. 

  284.           <td class="paramtype">channelID&#160;</td>
    285. 

  285.           <td class="paramname"></td><td>)</td>
    286. 

  286.           <td></td>
    287. 

  287.         </tr>
    288. 

  288.       </table>
    289. 

  289. </div><div class="memdoc">
    290. 

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

  291. <dl class="params"><dt>Parameters</dt><dd>
    292. 

  292.   <table class="params">
    293. 

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

  294.   </table>
    295. 

  295.   </dd>
    296. 

  296. </dl>
    297. 

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

  298. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__AudioFunctions.html#ga680fb631cda7d2fa4ba5e5dd0d261395">alxSetChannelVolume</a> </dd></dl>
    299. 

  299. 

  300. </div>
    301. 

  301. </div>
    302. 

  302. <a class="anchor" id="ga429325515e007ed6e9d68831488f1228"></a>
    303. 

  303. <div class="memitem">
    304. 

  304. <div class="memproto">
    305. 

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

  306.         <tr>
    307. 

  307.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetListenerf </td>
    308. 

  308.           <td>(</td>
    309. 

  309.           <td class="paramtype">ALEnum&#160;</td>
    310. 

  310.           <td class="paramname"></td><td>)</td>
    311. 

  311.           <td></td>
    312. 

  312.         </tr>
    313. 

  313.       </table>
    314. 

  314. </div><div class="memdoc">
    315. 

  315. <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>
    316. 

  316. <dl class="params"><dt>Parameters</dt><dd>
    317. 

  317.   <table class="params">
    318. 

  318.     <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>
    319. 

  319.   </table>
    320. 

  320.   </dd>
    321. 

  321. </dl>
    322. 

  322. <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>
    323. 

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

  324. 

  325. </div>
    326. 

  326. </div>
    327. 

  327. <a class="anchor" id="ga2255a339e637a1a30a98d7271068bd1c"></a>
    328. 

  328. <div class="memitem">
    329. 

  329. <div class="memproto">
    330. 

  330.       <table class="memname">
    331. 

  331.         <tr>
    332. 

  332.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alxGetSource3f </td>
    333. 

  333.           <td>(</td>
    334. 

  334.           <td class="paramtype">handle&#160;</td>
    335. 

  335.           <td class="paramname">, </td>
    336. 

  336.         </tr>
    337. 

  337.         <tr>
    338. 

  338.           <td class="paramkey"></td>
    339. 

  339.           <td></td>
    340. 

  340.           <td class="paramtype">ALEnum&#160;</td>
    341. 

  341.           <td class="paramname">&#160;</td>
    342. 

  342.         </tr>
    343. 

  343.         <tr>
    344. 

  344.           <td></td>
    345. 

  345.           <td>)</td>
    346. 

  346.           <td></td><td></td>
    347. 

  347.         </tr>
    348. 

  348.       </table>
    349. 

  349. </div><div class="memdoc">
    350. 

  350. <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>
    351. 

  351. <dl class="params"><dt>Parameters</dt><dd>
    352. 

  352.   <table class="params">
    353. 

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

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

  355.   </table>
    356. 

  356.   </dd>
    357. 

  357. </dl>
    358. 

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

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

  360. 

  361. </div>
    362. 

  362. </div>
    363. 

  363. <a class="anchor" id="ga11c769f03ac4716657403412b42e7c95"></a>
    364. 

  364. <div class="memitem">
    365. 

  365. <div class="memproto">
    366. 

  366.       <table class="memname">
    367. 

  367.         <tr>
    368. 

  368.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetSourcef </td>
    369. 

  369.           <td>(</td>
    370. 

  370.           <td class="paramtype">handle&#160;</td>
    371. 

  371.           <td class="paramname">, </td>
    372. 

  372.         </tr>
    373. 

  373.         <tr>
    374. 

  374.           <td class="paramkey"></td>
    375. 

  375.           <td></td>
    376. 

  376.           <td class="paramtype">ALEnum&#160;</td>
    377. 

  377.           <td class="paramname">&#160;</td>
    378. 

  378.         </tr>
    379. 

  379.         <tr>
    380. 

  380.           <td></td>
    381. 

  381.           <td>)</td>
    382. 

  382.           <td></td><td></td>
    383. 

  383.         </tr>
    384. 

  384.       </table>
    385. 

  385. </div><div class="memdoc">
    386. 

  386. <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>
    387. 

  387. <dl class="params"><dt>Parameters</dt><dd>
    388. 

  388.   <table class="params">
    389. 

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

  390.     <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>
    391. 

  391.   </table>
    392. 

  392.   </dd>
    393. 

  393. </dl>
    394. 

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

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

  396. 

  397. </div>
    398. 

  398. </div>
    399. 

  399. <a class="anchor" id="gabec54909f5720738c7214ad38d5d802a"></a>
    400. 

  400. <div class="memitem">
    401. 

  401. <div class="memproto">
    402. 

  402.       <table class="memname">
    403. 

  403.         <tr>
    404. 

  404.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxGetSourcei </td>
    405. 

  405.           <td>(</td>
    406. 

  406.           <td class="paramtype">handle&#160;</td>
    407. 

  407.           <td class="paramname">, </td>
    408. 

  408.         </tr>
    409. 

  409.         <tr>
    410. 

  410.           <td class="paramkey"></td>
    411. 

  411.           <td></td>
    412. 

  412.           <td class="paramtype">ALEnum&#160;</td>
    413. 

  413.           <td class="paramname">&#160;</td>
    414. 

  414.         </tr>
    415. 

  415.         <tr>
    416. 

  416.           <td></td>
    417. 

  417.           <td>)</td>
    418. 

  418.           <td></td><td></td>
    419. 

  419.         </tr>
    420. 

  420.       </table>
    421. 

  421. </div><div class="memdoc">
    422. 

  422. <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>
    423. 

  423. <dl class="params"><dt>Parameters</dt><dd>
    424. 

  424.   <table class="params">
    425. 

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

  426.     <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>
    427. 

  427.   </table>
    428. 

  428.   </dd>
    429. 

  429. </dl>
    430. 

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

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

  432. 

  433. </div>
    434. 

  434. </div>
    435. 

  435. <a class="anchor" id="gadc2f5c22b20c1b3a416037ff009d8893"></a>
    436. 

  436. <div class="memitem">
    437. 

  437. <div class="memproto">
    438. 

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

  439.         <tr>
    440. 

  440.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetStreamDuration </td>
    441. 

  441.           <td>(</td>
    442. 

  442.           <td class="paramtype">handle&#160;</td>
    443. 

  443.           <td class="paramname"></td><td>)</td>
    444. 

  444.           <td></td>
    445. 

  445.         </tr>
    446. 

  446.       </table>
    447. 

  447. </div><div class="memdoc">
    448. 

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

  449. <dl class="params"><dt>Parameters</dt><dd>
    450. 

  450.   <table class="params">
    451. 

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

  452.   </table>
    453. 

  453.   </dd>
    454. 

  454. </dl>
    455. 

  455. <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>
    456. 

  456. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__AudioFunctions.html#gacc37066e5b13bd139eca13e25ba333a2">alxGetStreamPosition</a> </dd></dl>
    457. 

  457. 

  458. </div>
    459. 

  459. </div>
    460. 

  460. <a class="anchor" id="gacc37066e5b13bd139eca13e25ba333a2"></a>
    461. 

  461. <div class="memitem">
    462. 

  462. <div class="memproto">
    463. 

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

  464.         <tr>
    465. 

  465.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetStreamPosition </td>
    466. 

  466.           <td>(</td>
    467. 

  467.           <td class="paramtype">handle&#160;</td>
    468. 

  468.           <td class="paramname"></td><td>)</td>
    469. 

  469.           <td></td>
    470. 

  470.         </tr>
    471. 

  471.       </table>
    472. 

  472. </div><div class="memdoc">
    473. 

  473. <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>
    474. 

  474. <dl class="params"><dt>Parameters</dt><dd>
    475. 

  475.   <table class="params">
    476. 

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

  477.   </table>
    478. 

  478.   </dd>
    479. 

  479. </dl>
    480. 

  480. <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>
    481. 

  481. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__AudioFunctions.html#gadc2f5c22b20c1b3a416037ff009d8893">alxGetStreamDuration</a> </dd></dl>
    482. 

  482. 

  483. </div>
    484. 

  484. </div>
    485. 

  485. <a class="anchor" id="ga81bd421ba42941f72b24bbe5aab8c2db"></a>
    486. 

  486. <div class="memitem">
    487. 

  487. <div class="memproto">
    488. 

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

  489.         <tr>
    490. 

  490.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxIsPlaying </td>
    491. 

  491.           <td>(</td>
    492. 

  492.           <td class="paramtype">handle&#160;</td>
    493. 

  493.           <td class="paramname"></td><td>)</td>
    494. 

  494.           <td></td>
    495. 

  495.         </tr>
    496. 

  496.       </table>
    497. 

  497. </div><div class="memdoc">
    498. 

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

  499. <dl class="params"><dt>Parameters</dt><dd>
    500. 

  500.   <table class="params">
    501. 

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

  502.   </table>
    503. 

  503.   </dd>
    504. 

  504. </dl>
    505. 

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

  506. <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>
    507. 

  507. 

  508. </div>
    509. 

  509. </div>
    510. 

  510. <a class="anchor" id="ga6e08d09bc2485be930925e7f852a68f6"></a>
    511. 

  511. <div class="memitem">
    512. 

  512. <div class="memproto">
    513. 

  513.       <table class="memname">
    514. 

  514.         <tr>
    515. 

  515.           <td class="memname">void alxListenerf </td>
    516. 

  516.           <td>(</td>
    517. 

  517.           <td class="paramtype">AlEnum&#160;</td>
    518. 

  518.           <td class="paramname">, </td>
    519. 

  519.         </tr>
    520. 

  520.         <tr>
    521. 

  521.           <td class="paramkey"></td>
    522. 

  522.           <td></td>
    523. 

  523.           <td class="paramtype">value&#160;</td>
    524. 

  524.           <td class="paramname">&#160;</td>
    525. 

  525.         </tr>
    526. 

  526.         <tr>
    527. 

  527.           <td></td>
    528. 

  528.           <td>)</td>
    529. 

  529.           <td></td><td></td>
    530. 

  530.         </tr>
    531. 

  531.       </table>
    532. 

  532. </div><div class="memdoc">
    533. 

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

  534. <dl class="params"><dt>Parameters</dt><dd>
    535. 

  535.   <table class="params">
    536. 

  536.     <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>
    537. 

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

  538.   </table>
    539. 

  539.   </dd>
    540. 

  540. </dl>
    541. 

  541. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    542. 

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

  543. 

  544. </div>
    545. 

  545. </div>
    546. 

  546. <a class="anchor" id="ga5daf341fad11e122208548b117ffd30b"></a>
    547. 

  547. <div class="memitem">
    548. 

  548. <div class="memproto">
    549. 

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

  550.         <tr>
    551. 

  551.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxPause </td>
    552. 

  552.           <td>(</td>
    553. 

  553.           <td class="paramtype">handle&#160;</td>
    554. 

  554.           <td class="paramname"></td><td>)</td>
    555. 

  555.           <td></td>
    556. 

  556.         </tr>
    557. 

  557.       </table>
    558. 

  558. </div><div class="memdoc">
    559. 

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

  560. <dl class="params"><dt>Parameters</dt><dd>
    561. 

  561.   <table class="params">
    562. 

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

  563.   </table>
    564. 

  564.   </dd>
    565. 

  565. </dl>
    566. 

  566. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    567. 

  567. <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>
    568. 

  568. 

  569. </div>
    570. 

  570. </div>
    571. 

  571. <a class="anchor" id="gad23bd3a890035794f16489db6b8dee70"></a>
    572. 

  572. <div class="memitem">
    573. 

  573. <div class="memproto">
    574. 

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

  575.         <tr>
    576. 

  576.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxPlay </td>
    577. 

  577.           <td>(</td>
    578. 

  578.           <td class="paramtype">audio-&#160;</td>
    579. 

  579.           <td class="paramname"><em>assetId</em></td><td>)</td>
    580. 

  580.           <td></td>
    581. 

  581.         </tr>
    582. 

  582.       </table>
    583. 

  583. </div><div class="memdoc">
    584. 

  584. <p>Play the audio asset Id. </p>
    585. 

  585. <dl class="params"><dt>Parameters</dt><dd>
    586. 

  586.   <table class="params">
    587. 

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

  588.   </table>
    589. 

  589.   </dd>
    590. 

  590. </dl>
    591. 

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

  592. 

  593. </div>
    594. 

  594. </div>
    595. 

  595. <a class="anchor" id="ga680fb631cda7d2fa4ba5e5dd0d261395"></a>
    596. 

  596. <div class="memitem">
    597. 

  597. <div class="memproto">
    598. 

  598.       <table class="memname">
    599. 

  599.         <tr>
    600. 

  600.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxSetChannelVolume </td>
    601. 

  601.           <td>(</td>
    602. 

  602.           <td class="paramtype">channelD&#160;</td>
    603. 

  603.           <td class="paramname">, </td>
    604. 

  604.         </tr>
    605. 

  605.         <tr>
    606. 

  606.           <td class="paramkey"></td>
    607. 

  607.           <td></td>
    608. 

  608.           <td class="paramtype">volume&#160;</td>
    609. 

  609.           <td class="paramname">&#160;</td>
    610. 

  610.         </tr>
    611. 

  611.         <tr>
    612. 

  612.           <td></td>
    613. 

  613.           <td>)</td>
    614. 

  614.           <td></td><td></td>
    615. 

  615.         </tr>
    616. 

  616.       </table>
    617. 

  617. </div><div class="memdoc">
    618. 

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

  619. <dl class="params"><dt>Parameters</dt><dd>
    620. 

  620.   <table class="params">
    621. 

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

  622.     <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>
    623. 

  623.   </table>
    624. 

  624.   </dd>
    625. 

  625. </dl>
    626. 

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

  627. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__AudioFunctions.html#ga64d738b656e182d836adcff6aec393ec">alxGetChannelVolume</a> </dd></dl>
    628. 

  628. 

  629. </div>
    630. 

  630. </div>
    631. 

  631. <a class="anchor" id="ga78aac95142f9023146c1cf258825ea35"></a>
    632. 

  632. <div class="memitem">
    633. 

  633. <div class="memproto">
    634. 

  634.       <table class="memname">
    635. 

  635.         <tr>
    636. 

  636.           <td class="memname">void alxSource3f </td>
    637. 

  637.           <td>(</td>
    638. 

  638.           <td class="paramtype">handle&#160;</td>
    639. 

  639.           <td class="paramname">, </td>
    640. 

  640.         </tr>
    641. 

  641.         <tr>
    642. 

  642.           <td class="paramkey"></td>
    643. 

  643.           <td></td>
    644. 

  644.           <td class="paramtype">ALEnum&#160;</td>
    645. 

  645.           <td class="paramname">, </td>
    646. 

  646.         </tr>
    647. 

  647.         <tr>
    648. 

  648.           <td class="paramkey"></td>
    649. 

  649.           <td></td>
    650. 

  650.           <td class="paramtype">x&#160;</td>
    651. 

  651.           <td class="paramname">, </td>
    652. 

  652.         </tr>
    653. 

  653.         <tr>
    654. 

  654.           <td class="paramkey"></td>
    655. 

  655.           <td></td>
    656. 

  656.           <td class="paramtype">y&#160;</td>
    657. 

  657.           <td class="paramname">, </td>
    658. 

  658.         </tr>
    659. 

  659.         <tr>
    660. 

  660.           <td class="paramkey"></td>
    661. 

  661.           <td></td>
    662. 

  662.           <td class="paramtype">z&#160;</td>
    663. 

  663.           <td class="paramname">&#160;</td>
    664. 

  664.         </tr>
    665. 

  665.         <tr>
    666. 

  666.           <td></td>
    667. 

  667.           <td>)</td>
    668. 

  668.           <td></td><td></td>
    669. 

  669.         </tr>
    670. 

  670.       </table>
    671. 

  671. </div><div class="memdoc">
    672. 

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

  673. <dl class="params"><dt>Parameters</dt><dd>
    674. 

  674.   <table class="params">
    675. 

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

  676.     <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>
    677. 

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

  678.   </table>
    679. 

  679.   </dd>
    680. 

  680. </dl>
    681. 

  681. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    682. 

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

  683. 

  684. </div>
    685. 

  685. </div>
    686. 

  686. <a class="anchor" id="gaa1da624cc55d5c8125b304d1d67b38c3"></a>
    687. 

  687. <div class="memitem">
    688. 

  688. <div class="memproto">
    689. 

  689.       <table class="memname">
    690. 

  690.         <tr>
    691. 

  691.           <td class="memname">void alxSourcef </td>
    692. 

  692.           <td>(</td>
    693. 

  693.           <td class="paramtype">handle&#160;</td>
    694. 

  694.           <td class="paramname">, </td>
    695. 

  695.         </tr>
    696. 

  696.         <tr>
    697. 

  697.           <td class="paramkey"></td>
    698. 

  698.           <td></td>
    699. 

  699.           <td class="paramtype">ALEnum&#160;</td>
    700. 

  700.           <td class="paramname">, </td>
    701. 

  701.         </tr>
    702. 

  702.         <tr>
    703. 

  703.           <td class="paramkey"></td>
    704. 

  704.           <td></td>
    705. 

  705.           <td class="paramtype">value&#160;</td>
    706. 

  706.           <td class="paramname">&#160;</td>
    707. 

  707.         </tr>
    708. 

  708.         <tr>
    709. 

  709.           <td></td>
    710. 

  710.           <td>)</td>
    711. 

  711.           <td></td><td></td>
    712. 

  712.         </tr>
    713. 

  713.       </table>
    714. 

  714. </div><div class="memdoc">
    715. 

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

  716. <dl class="params"><dt>Parameters</dt><dd>
    717. 

  717.   <table class="params">
    718. 

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

  719.     <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>
    720. 

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

  721.   </table>
    722. 

  722.   </dd>
    723. 

  723. </dl>
    724. 

  724. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    725. 

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

  726. 

  727. </div>
    728. 

  728. </div>
    729. 

  729. <a class="anchor" id="ga3cd6878e2e800a74dd1af135181c931d"></a>
    730. 

  730. <div class="memitem">
    731. 

  731. <div class="memproto">
    732. 

  732.       <table class="memname">
    733. 

  733.         <tr>
    734. 

  734.           <td class="memname">void alxSourcei </td>
    735. 

  735.           <td>(</td>
    736. 

  736.           <td class="paramtype">handle&#160;</td>
    737. 

  737.           <td class="paramname">, </td>
    738. 

  738.         </tr>
    739. 

  739.         <tr>
    740. 

  740.           <td class="paramkey"></td>
    741. 

  741.           <td></td>
    742. 

  742.           <td class="paramtype">ALEnum&#160;</td>
    743. 

  743.           <td class="paramname">, </td>
    744. 

  744.         </tr>
    745. 

  745.         <tr>
    746. 

  746.           <td class="paramkey"></td>
    747. 

  747.           <td></td>
    748. 

  748.           <td class="paramtype">value&#160;</td>
    749. 

  749.           <td class="paramname">&#160;</td>
    750. 

  750.         </tr>
    751. 

  751.         <tr>
    752. 

  752.           <td></td>
    753. 

  753.           <td>)</td>
    754. 

  754.           <td></td><td></td>
    755. 

  755.         </tr>
    756. 

  756.       </table>
    757. 

  757. </div><div class="memdoc">
    758. 

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

  759. <dl class="params"><dt>Parameters</dt><dd>
    760. 

  760.   <table class="params">
    761. 

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

  762.     <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>
    763. 

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

  764.   </table>
    765. 

  765.   </dd>
    766. 

  766. </dl>
    767. 

  767. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    768. 

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

  769. 

  770. </div>
    771. 

  771. </div>
    772. 

  772. <a class="anchor" id="ga2bc5ad2eec9308586454d26d86c044c7"></a>
    773. 

  773. <div class="memitem">
    774. 

  774. <div class="memproto">
    775. 

  775.       <table class="memname">
    776. 

  776.         <tr>
    777. 

  777.           <td class="memname">void alxStop </td>
    778. 

  778.           <td>(</td>
    779. 

  779.           <td class="paramtype">handle&#160;</td>
    780. 

  780.           <td class="paramname"></td><td>)</td>
    781. 

  781.           <td></td>
    782. 

  782.         </tr>
    783. 

  783.       </table>
    784. 

  784. </div><div class="memdoc">
    785. 

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

  786. <dl class="params"><dt>Parameters</dt><dd>
    787. 

  787.   <table class="params">
    788. 

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

  789.   </table>
    790. 

  790.   </dd>
    791. 

  791. </dl>
    792. 

  792. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    793. 

  793. <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>
    794. 

  794. 

  795. </div>
    796. 

  796. </div>
    797. 

  797. <a class="anchor" id="ga4966a7ceda5ff621b7ba6d28242665a3"></a>
    798. 

  798. <div class="memitem">
    799. 

  799. <div class="memproto">
    800. 

  800.       <table class="memname">
    801. 

  801.         <tr>
    802. 

  802.           <td class="memname">void alxStopAll </td>
    803. 

  803.           <td>(</td>
    804. 

  804.           <td class="paramname"></td><td>)</td>
    805. 

  805.           <td></td>
    806. 

  806.         </tr>
    807. 

  807.       </table>
    808. 

  808. </div><div class="memdoc">
    809. 

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

  810. <dl class="section return"><dt>Returns</dt><dd>No return. </dd></dl>
    811. 

  811. <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>
    812. 

  812. 

  813. </div>
    814. 

  814. </div>
    815. 

  815. <a class="anchor" id="ga2bf0547ff333ca8ee34a2d0dfef0e0cd"></a>
    816. 

  816. <div class="memitem">
    817. 

  817. <div class="memproto">
    818. 

  818.       <table class="memname">
    819. 

  819.         <tr>
    820. 

  820.           <td class="memname">void alxUnpause </td>
    821. 

  821.           <td>(</td>
    822. 

  822.           <td class="paramtype">handle&#160;</td>
    823. 

  823.           <td class="paramname"></td><td>)</td>
    824. 

  824.           <td></td>
    825. 

  825.         </tr>
    826. 

  826.       </table>
    827. 

  827. </div><div class="memdoc">
    828. 

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

  829. <dl class="params"><dt>Parameters</dt><dd>
    830. 

  830.   <table class="params">
    831. 

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

  832.   </table>
    833. 

  833.   </dd>
    834. 

  834. </dl>
    835. 

  835. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    836. 

  836. <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>
    837. 

  837. 

  838. </div>
    839. 

  839. </div>
    840. 

  840. <a class="anchor" id="ga2fb386a670dd388de4d1f21d67fc11f6"></a>
    841. 

  841. <div class="memitem">
    842. 

  842. <div class="memproto">
    843. 

  843.       <table class="memname">
    844. 

  844.         <tr>
    845. 

  845.           <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> OpenALInitDriver </td>
    846. 

  846.           <td>(</td>
    847. 

  847.           <td class="paramname"></td><td>)</td>
    848. 

  848.           <td></td>
    849. 

  849.         </tr>
    850. 

  850.       </table>
    851. 

  851. </div><div class="memdoc">
    852. 

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

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

  854. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__AudioFunctions.html#gac1fcd2fe4b77f916f76c176fcacb05de">OpenALShutdownDriver</a> </dd></dl>
    855. 

  855. 

  856. </div>
    857. 

  857. </div>
    858. 

  858. <a class="anchor" id="ga10c63ae60cc0a7884de9f8a803d0d5a6"></a>
    859. 

  859. <div class="memitem">
    860. 

  860. <div class="memproto">
    861. 

  861.       <table class="memname">
    862. 

  862.         <tr>
    863. 

  863.           <td class="memname">void OpenALRegisterExtensions </td>
    864. 

  864.           <td>(</td>
    865. 

  865.           <td class="paramname"></td><td>)</td>
    866. 

  866.           <td></td>
    867. 

  867.         </tr>
    868. 

  868.       </table>
    869. 

  869. </div><div class="memdoc">
    870. 

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

  871. 

  872. </div>
    873. 

  873. </div>
    874. 

  874. <a class="anchor" id="gac1fcd2fe4b77f916f76c176fcacb05de"></a>
    875. 

  875. <div class="memitem">
    876. 

  876. <div class="memproto">
    877. 

  877.       <table class="memname">
    878. 

  878.         <tr>
    879. 

  879.           <td class="memname">void OpenALShutdownDriver </td>
    880. 

  880.           <td>(</td>
    881. 

  881.           <td class="paramname"></td><td>)</td>
    882. 

  882.           <td></td>
    883. 

  883.         </tr>
    884. 

  884.       </table>
    885. 

  885. </div><div class="memdoc">
    886. 

  886. <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>
    887. 

  887. <dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
    888. 

  888. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__AudioFunctions.html#ga2fb386a670dd388de4d1f21d67fc11f6">OpenALInitDriver</a> </dd></dl>
    889. 

  889. 

  890. </div>
    891. 

  891. </div>
    892. 

  892. </div><!-- contents -->
    893. 

  893. <!-- start footer part -->
    894. 

  894. <hr class="footer"/><address class="footer"><small>
    895. 

  895. Generated by &#160;<a href="http://www.doxygen.org/index.html">
    896. 

  896. <img class="footer" src="doxygen.png" alt="doxygen"/>
    897. 

  897. </a> 1.8.3.1
    898. 

  898. </small></address>
    899. 

  899. </body>
    900. 

  900. </html>
    901.