TorqueEngine
/
Torque2D
зеркало из https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>TorqueScript Reference: Audio</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">Audio<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga43d6105a6e21ff8967bedd014b8e930d" id="r_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>
<tr class="separator:ga43d6105a6e21ff8967bedd014b8e930d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78c18ab02040f5dab4a77be82b061e58" id="r_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>
<tr class="separator:ga78c18ab02040f5dab4a77be82b061e58"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ab01225dc43b1c2d4046219bdb273a8" id="r_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>
<tr class="separator:ga8ab01225dc43b1c2d4046219bdb273a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga03d40ee9f6218a55f1ba64bf9e7d0812" id="r_ga03d40ee9f6218a55f1ba64bf9e7d0812"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga03d40ee9f6218a55f1ba64bf9e7d0812">alListener3f</a> (ALEnum, x, y, z)</td></tr>
<tr class="separator:ga03d40ee9f6218a55f1ba64bf9e7d0812"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab21e4050844a4850097377ee67daab69" id="r_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>
<tr class="separator:gab21e4050844a4850097377ee67daab69"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga19eabe54ad925905e2043a093b9f1310" id="r_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>
<tr class="separator:ga19eabe54ad925905e2043a093b9f1310"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga64d738b656e182d836adcff6aec393ec" id="r_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>
<tr class="separator:ga64d738b656e182d836adcff6aec393ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga429325515e007ed6e9d68831488f1228" id="r_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>
<tr class="separator:ga429325515e007ed6e9d68831488f1228"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2255a339e637a1a30a98d7271068bd1c" id="r_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>
<tr class="separator:ga2255a339e637a1a30a98d7271068bd1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga11c769f03ac4716657403412b42e7c95" id="r_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>
<tr class="separator:ga11c769f03ac4716657403412b42e7c95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabec54909f5720738c7214ad38d5d802a" id="r_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>
<tr class="separator:gabec54909f5720738c7214ad38d5d802a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadc2f5c22b20c1b3a416037ff009d8893" id="r_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>
<tr class="separator:gadc2f5c22b20c1b3a416037ff009d8893"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc37066e5b13bd139eca13e25ba333a2" id="r_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>
<tr class="separator:gacc37066e5b13bd139eca13e25ba333a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga81bd421ba42941f72b24bbe5aab8c2db" id="r_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>
<tr class="separator:ga81bd421ba42941f72b24bbe5aab8c2db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6e08d09bc2485be930925e7f852a68f6" id="r_ga6e08d09bc2485be930925e7f852a68f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga6e08d09bc2485be930925e7f852a68f6">alxListenerf</a> (AlEnum, value)</td></tr>
<tr class="separator:ga6e08d09bc2485be930925e7f852a68f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga5daf341fad11e122208548b117ffd30b" id="r_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>
<tr class="separator:ga5daf341fad11e122208548b117ffd30b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad23bd3a890035794f16489db6b8dee70" id="r_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>
<tr class="separator:gad23bd3a890035794f16489db6b8dee70"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga680fb631cda7d2fa4ba5e5dd0d261395" id="r_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>
<tr class="separator:ga680fb631cda7d2fa4ba5e5dd0d261395"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga78aac95142f9023146c1cf258825ea35" id="r_ga78aac95142f9023146c1cf258825ea35"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga78aac95142f9023146c1cf258825ea35">alxSource3f</a> (handle, ALEnum, x, y, z)</td></tr>
<tr class="separator:ga78aac95142f9023146c1cf258825ea35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa1da624cc55d5c8125b304d1d67b38c3" id="r_gaa1da624cc55d5c8125b304d1d67b38c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gaa1da624cc55d5c8125b304d1d67b38c3">alxSourcef</a> (handle, ALEnum, value)</td></tr>
<tr class="separator:gaa1da624cc55d5c8125b304d1d67b38c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3cd6878e2e800a74dd1af135181c931d" id="r_ga3cd6878e2e800a74dd1af135181c931d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga3cd6878e2e800a74dd1af135181c931d">alxSourcei</a> (handle, ALEnum, value)</td></tr>
<tr class="separator:ga3cd6878e2e800a74dd1af135181c931d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bc5ad2eec9308586454d26d86c044c7" id="r_ga2bc5ad2eec9308586454d26d86c044c7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga2bc5ad2eec9308586454d26d86c044c7">alxStop</a> (handle)</td></tr>
<tr class="separator:ga2bc5ad2eec9308586454d26d86c044c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4966a7ceda5ff621b7ba6d28242665a3" id="r_ga4966a7ceda5ff621b7ba6d28242665a3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga4966a7ceda5ff621b7ba6d28242665a3">alxStopAll</a> ()</td></tr>
<tr class="separator:ga4966a7ceda5ff621b7ba6d28242665a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2bf0547ff333ca8ee34a2d0dfef0e0cd" id="r_ga2bf0547ff333ca8ee34a2d0dfef0e0cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga2bf0547ff333ca8ee34a2d0dfef0e0cd">alxUnpause</a> (handle)</td></tr>
<tr class="separator:ga2bf0547ff333ca8ee34a2d0dfef0e0cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2fb386a670dd388de4d1f21d67fc11f6" id="r_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>
<tr class="separator:ga2fb386a670dd388de4d1f21d67fc11f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10c63ae60cc0a7884de9f8a803d0d5a6" id="r_ga10c63ae60cc0a7884de9f8a803d0d5a6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#ga10c63ae60cc0a7884de9f8a803d0d5a6">OpenALRegisterExtensions</a> ()</td></tr>
<tr class="separator:ga10c63ae60cc0a7884de9f8a803d0d5a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1fcd2fe4b77f916f76c176fcacb05de" id="r_gac1fcd2fe4b77f916f76c176fcacb05de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AudioFunctions.html#gac1fcd2fe4b77f916f76c176fcacb05de">OpenALShutdownDriver</a> ()</td></tr>
<tr class="separator:gac1fcd2fe4b77f916f76c176fcacb05de"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga43d6105a6e21ff8967bedd014b8e930d" name="ga43d6105a6e21ff8967bedd014b8e930d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga43d6105a6e21ff8967bedd014b8e930d">&#9670;&#160;</a></span>alGetListener3f()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alGetListener3f </td>
          <td>(</td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <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>
  </table>
  </dd>
</dl>
<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>
<dl class="section see"><dt>See also</dt><dd>alxGetSource* </dd></dl>

</div>
</div>
<a id="ga78c18ab02040f5dab4a77be82b061e58" name="ga78c18ab02040f5dab4a77be82b061e58"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga78c18ab02040f5dab4a77be82b061e58">&#9670;&#160;</a></span>alGetListeneri()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alGetListeneri </td>
          <td>(</td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <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>
  </table>
  </dd>
</dl>
<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>
<dl class="section see"><dt>See also</dt><dd>alxGetSource* </dd></dl>

</div>
</div>
<a id="ga8ab01225dc43b1c2d4046219bdb273a8" name="ga8ab01225dc43b1c2d4046219bdb273a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ab01225dc43b1c2d4046219bdb273a8">&#9670;&#160;</a></span>alGetString()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alGetString </td>
          <td>(</td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alGetString function to get the string equivalent to the specified OpenAL enumerated value. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string corresponding to the passed ALEnum </dd></dl>

</div>
</div>
<a id="ga03d40ee9f6218a55f1ba64bf9e7d0812" name="ga03d40ee9f6218a55f1ba64bf9e7d0812"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03d40ee9f6218a55f1ba64bf9e7d0812">&#9670;&#160;</a></span>alListener3f()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alListener3f </td>
          <td>(</td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">x&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">y&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">z&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <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>
    <tr><td class="paramname">x,y,z</td><td>XYZ floating-point coordinates. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>al*GetListener*, alxSource* </dd></dl>

</div>
</div>
<a id="gab21e4050844a4850097377ee67daab69" name="gab21e4050844a4850097377ee67daab69"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab21e4050844a4850097377ee67daab69">&#9670;&#160;</a></span>alxCreateSource()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxCreateSource </td>
          <td>(</td>
          <td class="paramtype">audio-&#160;</td>
          <td class="paramname"><em>assetId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a source from the specified asset Id. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">audio-assetId</td><td>The asset Id to create the source from. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The handle of the created source or 0 on error. </dd></dl>

</div>
</div>
<a id="ga19eabe54ad925905e2043a093b9f1310" name="ga19eabe54ad925905e2043a093b9f1310"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga19eabe54ad925905e2043a093b9f1310">&#9670;&#160;</a></span>alxGetAudioLength()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxGetAudioLength </td>
          <td>(</td>
          <td class="paramtype">audio-&#160;</td>
          <td class="paramname"><em>assetId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxGetAudioLength function to get the play-length of a specified resource sound file in milliseconds. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">audio-assetId</td><td>The asset Id that specifies the audio file to check. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns play-length of the audio file specified by audio-assetId in milliseconds. </dd></dl>
<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>

</div>
</div>
<a id="ga64d738b656e182d836adcff6aec393ec" name="ga64d738b656e182d836adcff6aec393ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga64d738b656e182d836adcff6aec393ec">&#9670;&#160;</a></span>alxGetChannelVolume()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetChannelVolume </td>
          <td>(</td>
          <td class="paramtype">channelID&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxGetChannelVolume function to get the volume setting for a specified channel. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">channelID</td><td>An integer value, equal to or greater than 0, corresponding to a valid audio channel. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns volume [ 0.0, 1.0 ] for channel specified by channelID. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga680fb631cda7d2fa4ba5e5dd0d261395">alxSetChannelVolume</a> </dd></dl>

</div>
</div>
<a id="ga429325515e007ed6e9d68831488f1228" name="ga429325515e007ed6e9d68831488f1228"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga429325515e007ed6e9d68831488f1228">&#9670;&#160;</a></span>alxGetListenerf()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetListenerf </td>
          <td>(</td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the al*GetListener* function to get the current value of a listener parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of al*GetListener*. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <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>
  </table>
  </dd>
</dl>
<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>
<dl class="section see"><dt>See also</dt><dd>alxGetSource* </dd></dl>

</div>
</div>
<a id="ga2255a339e637a1a30a98d7271068bd1c" name="ga2255a339e637a1a30a98d7271068bd1c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2255a339e637a1a30a98d7271068bd1c">&#9670;&#160;</a></span>alxGetSource3f()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> alxGetSource3f </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    <tr><td class="paramname">ALEnum</td><td>A string containing an OpenAL enumerated type name. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>alxSource*, al*GetListener* </dd></dl>

</div>
</div>
<a id="ga11c769f03ac4716657403412b42e7c95" name="ga11c769f03ac4716657403412b42e7c95"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga11c769f03ac4716657403412b42e7c95">&#9670;&#160;</a></span>alxGetSourcef()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetSourcef </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>alxSource*, al*GetListener* </dd></dl>

</div>
</div>
<a id="gabec54909f5720738c7214ad38d5d802a" name="gabec54909f5720738c7214ad38d5d802a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabec54909f5720738c7214ad38d5d802a">&#9670;&#160;</a></span>alxGetSourcei()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxGetSourcei </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxGetSource* function to get the current value of a source parameter, as specified by ALEnum. Depending on the ALEnum you need to acquire, be sure to use the correct version (i.e. correct return type) of alxGetSource*. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns current value of parameter specified by ALEnum for source identified by handle. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>alxSource*, al*GetListener* </dd></dl>

</div>
</div>
<a id="gadc2f5c22b20c1b3a416037ff009d8893" name="gadc2f5c22b20c1b3a416037ff009d8893"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadc2f5c22b20c1b3a416037ff009d8893">&#9670;&#160;</a></span>alxGetStreamDuration()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetStreamDuration </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxGetStreamDuration function to determine the length of a previously set up sound in seconds. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  </table>
  </dd>
</dl>
<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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gacc37066e5b13bd139eca13e25ba333a2">alxGetStreamPosition</a> </dd></dl>

</div>
</div>
<a id="gacc37066e5b13bd139eca13e25ba333a2" name="gacc37066e5b13bd139eca13e25ba333a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacc37066e5b13bd139eca13e25ba333a2">&#9670;&#160;</a></span>alxGetStreamPosition()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> alxGetStreamPosition </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxGetStreamPosition function to get the current play position for a playing sound. Note, this value is a percentage equivalent to the percent of the sound that as already played. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  </table>
  </dd>
</dl>
<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>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gadc2f5c22b20c1b3a416037ff009d8893">alxGetStreamDuration</a> </dd></dl>

</div>
</div>
<a id="ga81bd421ba42941f72b24bbe5aab8c2db" name="ga81bd421ba42941f72b24bbe5aab8c2db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga81bd421ba42941f72b24bbe5aab8c2db">&#9670;&#160;</a></span>alxIsPlaying()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxIsPlaying </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxIsPlaying function to determine if the sound associated with a previously set-up sound handle is playing or not. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if specified handle is being played, 0 otherwise. </dd></dl>
<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>

</div>
</div>
<a id="ga6e08d09bc2485be930925e7f852a68f6" name="ga6e08d09bc2485be930925e7f852a68f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6e08d09bc2485be930925e7f852a68f6">&#9670;&#160;</a></span>alxListenerf()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alxListenerf </td>
          <td>(</td>
          <td class="paramtype">AlEnum&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">value&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the al*Listener* function to set a listener parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <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>
    <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>al*GetListener*, alxSource* </dd></dl>

</div>
</div>
<a id="ga5daf341fad11e122208548b117ffd30b" name="ga5daf341fad11e122208548b117ffd30b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga5daf341fad11e122208548b117ffd30b">&#9670;&#160;</a></span>alxPause()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxPause </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxPause function to pause a currently playing sound as specified by handle. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<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>

</div>
</div>
<a id="gad23bd3a890035794f16489db6b8dee70" name="gad23bd3a890035794f16489db6b8dee70"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad23bd3a890035794f16489db6b8dee70">&#9670;&#160;</a></span>alxPlay()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> alxPlay </td>
          <td>(</td>
          <td class="paramtype">audio-&#160;</td>
          <td class="paramname"><em>assetId</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Play the audio asset Id. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">audio-assetId</td><td>The asset Id to play. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The handle to the playing audio asset Id or 0 on error. </dd></dl>

</div>
</div>
<a id="ga680fb631cda7d2fa4ba5e5dd0d261395" name="ga680fb631cda7d2fa4ba5e5dd0d261395"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga680fb631cda7d2fa4ba5e5dd0d261395">&#9670;&#160;</a></span>alxSetChannelVolume()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> alxSetChannelVolume </td>
          <td>(</td>
          <td class="paramtype">channelD&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">volume&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxSetChannelVolume function to set a volume [ 0.0, 1.0 ] for the channel specified by channelID. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">channelID</td><td>An integer value, equal to or greater than 0, corresponding to a valid audio channel. </td></tr>
    <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>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true on success and false on failure. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga64d738b656e182d836adcff6aec393ec">alxGetChannelVolume</a> </dd></dl>

</div>
</div>
<a id="ga78aac95142f9023146c1cf258825ea35" name="ga78aac95142f9023146c1cf258825ea35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga78aac95142f9023146c1cf258825ea35">&#9670;&#160;</a></span>alxSource3f()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alxSource3f </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">x&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">y&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">z&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    <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>
    <tr><td class="paramname">x,y,z</td><td>XYZ floating-point coordinates. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>alxGetSource*, al*Listener* </dd></dl>

</div>
</div>
<a id="gaa1da624cc55d5c8125b304d1d67b38c3" name="gaa1da624cc55d5c8125b304d1d67b38c3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa1da624cc55d5c8125b304d1d67b38c3">&#9670;&#160;</a></span>alxSourcef()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alxSourcef </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">value&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    <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>
    <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>alxGetSource*, al*Listener* </dd></dl>

</div>
</div>
<a id="ga3cd6878e2e800a74dd1af135181c931d" name="ga3cd6878e2e800a74dd1af135181c931d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3cd6878e2e800a74dd1af135181c931d">&#9670;&#160;</a></span>alxSourcei()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alxSourcei </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">ALEnum&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">value&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxSource* function to set a source parameter(s) as specified by the OpenAL enumerated type ALEnum. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
    <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>
    <tr><td class="paramname">value</td><td>An ALEnum type specific value corresponding to the new value for this enumerated parameters. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>alxGetSource*, al*Listener* </dd></dl>

</div>
</div>
<a id="ga2bc5ad2eec9308586454d26d86c044c7" name="ga2bc5ad2eec9308586454d26d86c044c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bc5ad2eec9308586454d26d86c044c7">&#9670;&#160;</a></span>alxStop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alxStop </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxStop function to stop a currently playing sound as specified by handle. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<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>

</div>
</div>
<a id="ga4966a7ceda5ff621b7ba6d28242665a3" name="ga4966a7ceda5ff621b7ba6d28242665a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4966a7ceda5ff621b7ba6d28242665a3">&#9670;&#160;</a></span>alxStopAll()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alxStopAll </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxStopAll function to stop all currently playing sounds associated with registered handles. </p><dl class="section return"><dt>Returns</dt><dd>No return. </dd></dl>
<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>

</div>
</div>
<a id="ga2bf0547ff333ca8ee34a2d0dfef0e0cd" name="ga2bf0547ff333ca8ee34a2d0dfef0e0cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2bf0547ff333ca8ee34a2d0dfef0e0cd">&#9670;&#160;</a></span>alxUnpause()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> alxUnpause </td>
          <td>(</td>
          <td class="paramtype">handle&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the alxUnpause function to resume playing a currently paused sound as specified by handle. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">handle</td><td>The ID (a non-negative integer) corresponding to a previously set up sound source. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<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>

</div>
</div>
<a id="ga2fb386a670dd388de4d1f21d67fc11f6" name="ga2fb386a670dd388de4d1f21d67fc11f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2fb386a670dd388de4d1f21d67fc11f6">&#9670;&#160;</a></span>OpenALInitDriver()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> OpenALInitDriver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the OpenALInitDriver function to initialize the OpenAL driver. This must be done before all other OpenAL operations. </p><dl class="section return"><dt>Returns</dt><dd>Returns true on successful initialization, false otherwise. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#gac1fcd2fe4b77f916f76c176fcacb05de">OpenALShutdownDriver</a> </dd></dl>

</div>
</div>
<a id="ga10c63ae60cc0a7884de9f8a803d0d5a6" name="ga10c63ae60cc0a7884de9f8a803d0d5a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga10c63ae60cc0a7884de9f8a803d0d5a6">&#9670;&#160;</a></span>OpenALRegisterExtensions()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> OpenALRegisterExtensions </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section note"><dt>Note</dt><dd>Currently does nothing (possibly deprecated) </dd></dl>

</div>
</div>
<a id="gac1fcd2fe4b77f916f76c176fcacb05de" name="gac1fcd2fe4b77f916f76c176fcacb05de"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1fcd2fe4b77f916f76c176fcacb05de">&#9670;&#160;</a></span>OpenALShutdownDriver()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> OpenALShutdownDriver </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the OpenALShutdownDriver function to stop/shut down the OpenAL driver. After this is called, you must restart the driver with OpenALInitDriver to execute any new sound operations. </p><dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__AudioFunctions.html#ga2fb386a670dd388de4d1f21d67fc11f6">OpenALInitDriver</a> </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>