2928 lines
120 KiB
HTML
2928 lines
120 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_17) on Mon Dec 02 20:33:02 CET 2013 -->
|
|
<title>AL10 (LWJGL API)</title>
|
|
<meta name="date" content="2013-12-02">
|
|
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="AL10 (LWJGL API)";
|
|
}
|
|
//-->
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar_top">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/AL10.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../org/lwjgl/openal/AL.html" title="class in org.lwjgl.openal"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../org/lwjgl/openal/AL11.html" title="class in org.lwjgl.openal"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?org/lwjgl/openal/AL10.html" target="_top">Frames</a></li>
|
|
<li><a href="AL10.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field_summary">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field_detail">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.lwjgl.openal</div>
|
|
<h2 title="Class AL10" class="title">Class AL10</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.lwjgl.openal.AL10</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<hr>
|
|
<br>
|
|
<pre>public final class <span class="strong">AL10</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block"><br>
|
|
This is the core OpenAL class. This class implements
|
|
AL.h version 1.0
|
|
<p></div>
|
|
<dl><dt><span class="strong">Version:</span></dt>
|
|
<dd>$Revision$
|
|
$Id$</dd>
|
|
<dt><span class="strong">Author:</span></dt>
|
|
<dd>Brian Matzon <brian@matzon.dk></dd></dl>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Field and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_BITS">AL_BITS</a></strong></code>
|
|
<div class="block">Sound buffers: The number of bits per sample for the
|
|
data contained in the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_BUFFER">AL_BUFFER</a></strong></code>
|
|
<div class="block">Indicate the buffer to provide sound samples.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_BUFFERS_PROCESSED">AL_BUFFERS_PROCESSED</a></strong></code>
|
|
<div class="block">Buffer Queue params</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_BUFFERS_QUEUED">AL_BUFFERS_QUEUED</a></strong></code>
|
|
<div class="block">Buffer Queue params</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_CHANNEL_MASK">AL_CHANNEL_MASK</a></strong></code>
|
|
<div class="block">Specify the channel mask.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_CHANNELS">AL_CHANNELS</a></strong></code>
|
|
<div class="block">Sound buffers: The number of channels for the data
|
|
contained in the buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_CONE_INNER_ANGLE">AL_CONE_INNER_ANGLE</a></strong></code>
|
|
<div class="block">Directional source, inner cone angle, in degrees
|
|
Range: [0-360]
|
|
Default: 360</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_CONE_OUTER_ANGLE">AL_CONE_OUTER_ANGLE</a></strong></code>
|
|
<div class="block">Directional source, outer cone angle, in degrees.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_CONE_OUTER_GAIN">AL_CONE_OUTER_GAIN</a></strong></code>
|
|
<div class="block">Indicate the gain (volume amplification) applied.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_DATA">AL_DATA</a></strong></code>
|
|
<div class="block"><strong>Deprecated.</strong>
|
|
<div class="block"><i>This token is a relict of the early OpenAL days and is
|
|
no longer supported. Neither the OpenAL spec nor OpenAL Soft define
|
|
it.</i></div>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_DIRECTION">AL_DIRECTION</a></strong></code>
|
|
<div class="block">Specify the current direction as forward vector.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_DISTANCE_MODEL">AL_DISTANCE_MODEL</a></strong></code>
|
|
<div class="block">Distance model.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_DOPPLER_FACTOR">AL_DOPPLER_FACTOR</a></strong></code>
|
|
<div class="block">Doppler scale.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_DOPPLER_VELOCITY">AL_DOPPLER_VELOCITY</a></strong></code>
|
|
<div class="block">Doppler velocity.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_EXTENSIONS">AL_EXTENSIONS</a></strong></code>
|
|
<div class="block">Context strings: Extensions</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_FALSE">AL_FALSE</a></strong></code>
|
|
<div class="block">Boolean False</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_FORMAT_MONO16">AL_FORMAT_MONO16</a></strong></code>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_FORMAT_MONO8">AL_FORMAT_MONO8</a></strong></code>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_FORMAT_STEREO16">AL_FORMAT_STEREO16</a></strong></code>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_FORMAT_STEREO8">AL_FORMAT_STEREO8</a></strong></code>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_FORMAT_VORBIS_EXT">AL_FORMAT_VORBIS_EXT</a></strong></code>
|
|
<div class="block">Ogg Vorbis format specifier.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_FREQUENCY">AL_FREQUENCY</a></strong></code>
|
|
<div class="block">Sound buffers: frequency, in units of Hertz [Hz].</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_GAIN">AL_GAIN</a></strong></code>
|
|
<div class="block">Indicate the gain (volume amplification) applied.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INITIAL">AL_INITIAL</a></strong></code>
|
|
<div class="block">Source state information</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INVALID">AL_INVALID</a></strong></code>
|
|
<div class="block">Bad value</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INVALID_ENUM">AL_INVALID_ENUM</a></strong></code>
|
|
<div class="block">Illegal enum passed as an argument to an AL call.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INVALID_NAME">AL_INVALID_NAME</a></strong></code>
|
|
<div class="block">Illegal name passed as an argument to an AL call.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INVALID_OPERATION">AL_INVALID_OPERATION</a></strong></code>
|
|
<div class="block">A function was called at inappropriate time,
|
|
or in an inappropriate way, causing an illegal state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INVALID_VALUE">AL_INVALID_VALUE</a></strong></code>
|
|
<div class="block">Illegal value passed as an argument to an AL call.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INVERSE_DISTANCE">AL_INVERSE_DISTANCE</a></strong></code>
|
|
<div class="block">Distance model</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_INVERSE_DISTANCE_CLAMPED">AL_INVERSE_DISTANCE_CLAMPED</a></strong></code>
|
|
<div class="block">Distance model</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_LOOPING">AL_LOOPING</a></strong></code>
|
|
<div class="block">Indicate whether source has to loop infinite.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_MAX_DISTANCE">AL_MAX_DISTANCE</a></strong></code>
|
|
<div class="block">Specify the maximum distance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_MAX_GAIN">AL_MAX_GAIN</a></strong></code>
|
|
<div class="block">Indicate maximum source attenuation.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_MIN_GAIN">AL_MIN_GAIN</a></strong></code>
|
|
<div class="block">Indicate minimum source attenuation.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_NO_ERROR">AL_NO_ERROR</a></strong></code>
|
|
<div class="block">Errors: No Error.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_NONE">AL_NONE</a></strong></code>
|
|
<div class="block">Disable value</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_ORIENTATION">AL_ORIENTATION</a></strong></code>
|
|
<div class="block">Specify the current orientation.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_OUT_OF_MEMORY">AL_OUT_OF_MEMORY</a></strong></code>
|
|
<div class="block">A function could not be completed,
|
|
because there is not enough memory available.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_PAUSED">AL_PAUSED</a></strong></code>
|
|
<div class="block">Source state information</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_PENDING">AL_PENDING</a></strong></code>
|
|
<div class="block">Buffer state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_PITCH">AL_PITCH</a></strong></code>
|
|
<div class="block">Specify the pitch to be applied, either at source,
|
|
or on mixer results, at listener.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_PLAYING">AL_PLAYING</a></strong></code>
|
|
<div class="block">Source state information</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_POSITION">AL_POSITION</a></strong></code>
|
|
<div class="block">Specify the current location in three dimensional space.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_PROCESSED">AL_PROCESSED</a></strong></code>
|
|
<div class="block">Buffer state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_REFERENCE_DISTANCE">AL_REFERENCE_DISTANCE</a></strong></code>
|
|
<div class="block">Specify the current orientation.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_RENDERER">AL_RENDERER</a></strong></code>
|
|
<div class="block">Context strings: Renderer</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_ROLLOFF_FACTOR">AL_ROLLOFF_FACTOR</a></strong></code>
|
|
<div class="block">Indicate the rolloff factor for the source.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_SIZE">AL_SIZE</a></strong></code>
|
|
<div class="block">Sound buffers: Size in bytes of the buffer data.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_SOURCE_ABSOLUTE">AL_SOURCE_ABSOLUTE</a></strong></code>
|
|
<div class="block">Indicate source has absolute coordinates</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_SOURCE_RELATIVE">AL_SOURCE_RELATIVE</a></strong></code>
|
|
<div class="block">Indicate Source has listener relative coordinates</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_SOURCE_STATE">AL_SOURCE_STATE</a></strong></code>
|
|
<div class="block">Source state information</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_SOURCE_TYPE">AL_SOURCE_TYPE</a></strong></code>
|
|
<div class="block">Indicate the type of SOURCE.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_STOPPED">AL_STOPPED</a></strong></code>
|
|
<div class="block">Source state information</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_TRUE">AL_TRUE</a></strong></code>
|
|
<div class="block">Boolean True</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_UNUSED">AL_UNUSED</a></strong></code>
|
|
<div class="block">Buffer state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_VELOCITY">AL_VELOCITY</a></strong></code>
|
|
<div class="block">Specify the current velocity in three dimensional space.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_VENDOR">AL_VENDOR</a></strong></code>
|
|
<div class="block">Context strings: Vendor</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#AL_VERSION">AL_VERSION</a></strong></code>
|
|
<div class="block">Context strings: Version</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alBufferData(int, int, java.nio.ByteBuffer, int)">alBufferData</a></strong>(int buffer,
|
|
int format,
|
|
java.nio.ByteBuffer data,
|
|
int freq)</code>
|
|
<div class="block">
|
|
A special case of Buffer state is the actual sound sample data stored in asociation
|
|
with the Buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alBufferData(int, int, java.nio.IntBuffer, int)">alBufferData</a></strong>(int buffer,
|
|
int format,
|
|
java.nio.IntBuffer data,
|
|
int freq)</code>
|
|
<div class="block">
|
|
A special case of Buffer state is the actual sound sample data stored in asociation
|
|
with the Buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alBufferData(int, int, java.nio.ShortBuffer, int)">alBufferData</a></strong>(int buffer,
|
|
int format,
|
|
java.nio.ShortBuffer data,
|
|
int freq)</code>
|
|
<div class="block">
|
|
A special case of Buffer state is the actual sound sample data stored in asociation
|
|
with the Buffer.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDeleteBuffers(int)">alDeleteBuffers</a></strong>(int buffer)</code>
|
|
<div class="block">Overloads alDeleteBuffers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDeleteBuffers(java.nio.IntBuffer)">alDeleteBuffers</a></strong>(java.nio.IntBuffer buffers)</code>
|
|
<div class="block">
|
|
The application requests deletion of a number of Buffers by calling DeleteBuffers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDeleteSources(int)">alDeleteSources</a></strong>(int source)</code>
|
|
<div class="block">Overloads alDeleteSources.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDeleteSources(java.nio.IntBuffer)">alDeleteSources</a></strong>(java.nio.IntBuffer sources)</code>
|
|
<div class="block">The application requests deletion of a number of Sources by DeleteSources.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDisable(int)">alDisable</a></strong>(int capability)</code>
|
|
<div class="block">The application can temporarily disable certain AL capabilities on a per Context
|
|
basis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDistanceModel(int)">alDistanceModel</a></strong>(int value)</code>
|
|
<div class="block">
|
|
Samples usually use the entire dynamic range of the chosen format/encoding,
|
|
independent of their real world intensity.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDopplerFactor(float)">alDopplerFactor</a></strong>(float value)</code>
|
|
<div class="block">The Doppler Effect depends on the velocities of Source and Listener relative to the
|
|
medium, and the propagation speed of sound in that medium.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alDopplerVelocity(float)">alDopplerVelocity</a></strong>(float value)</code>
|
|
<div class="block">The Doppler Effect depends on the velocities of Source and Listener relative to the
|
|
medium, and the propagation speed of sound in that medium.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alEnable(int)">alEnable</a></strong>(int capability)</code>
|
|
<div class="block">The application can temporarily disable certain AL capabilities on a per Context
|
|
basis.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGenBuffers()">alGenBuffers</a></strong>()</code>
|
|
<div class="block">Overloads alGenBuffers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGenBuffers(java.nio.IntBuffer)">alGenBuffers</a></strong>(java.nio.IntBuffer buffers)</code>
|
|
<div class="block">The application requests a number of Buffers using GenBuffers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGenSources()">alGenSources</a></strong>()</code>
|
|
<div class="block">Overloads alGenSources.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGenSources(java.nio.IntBuffer)">alGenSources</a></strong>(java.nio.IntBuffer sources)</code>
|
|
<div class="block">The application requests a number of Sources using GenSources.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetBoolean(int)">alGetBoolean</a></strong>(int pname)</code>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static float</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetBufferf(int, int)">alGetBufferf</a></strong>(int buffer,
|
|
int pname)</code>
|
|
<div class="block">Buffer state is maintained inside the AL implementation and can be queried in full.<br>
|
|
ALC_FREQUENCY - specified in samples per second, i.e.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetBufferi(int, int)">alGetBufferi</a></strong>(int buffer,
|
|
int pname)</code>
|
|
<div class="block">Buffer state is maintained inside the AL implementation and can be queried in full.<br>
|
|
ALC_FREQUENCY - specified in samples per second, i.e.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static double</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetDouble(int)">alGetDouble</a></strong>(int pname)</code>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetDouble(int, java.nio.DoubleBuffer)">alGetDouble</a></strong>(int pname,
|
|
java.nio.DoubleBuffer data)</code>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetEnumValue(java.lang.String)">alGetEnumValue</a></strong>(java.lang.String ename)</code>
|
|
<div class="block">
|
|
To obtain enumeration values for extensions, the application has to use
|
|
GetEnumValue of an extension token.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetError()">alGetError</a></strong>()</code>
|
|
<div class="block">The AL detects only a subset of those conditions that could be considered errors.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static float</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetFloat(int)">alGetFloat</a></strong>(int pname)</code>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetFloat(int, java.nio.FloatBuffer)">alGetFloat</a></strong>(int pname,
|
|
java.nio.FloatBuffer data)</code>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetInteger(int)">alGetInteger</a></strong>(int pname)</code>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetInteger(int, java.nio.IntBuffer)">alGetInteger</a></strong>(int pname,
|
|
java.nio.IntBuffer data)</code>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetListener(int, java.nio.FloatBuffer)">alGetListener</a></strong>(int pname,
|
|
java.nio.FloatBuffer floatdata)</code>
|
|
<div class="block">Listener state is maintained inside the AL implementation and can be queried in
|
|
full.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static float</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetListenerf(int)">alGetListenerf</a></strong>(int pname)</code>
|
|
<div class="block">Listener state is maintained inside the AL implementation and can be queried in
|
|
full.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetListeneri(int)">alGetListeneri</a></strong>(int pname)</code>
|
|
<div class="block">Listener state is maintained inside the AL implementation and can be queried in
|
|
full.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetSource(int, int, java.nio.FloatBuffer)">alGetSource</a></strong>(int source,
|
|
int pname,
|
|
java.nio.FloatBuffer floatdata)</code>
|
|
<div class="block">Source state is maintained inside the AL implementation, and the current attributes
|
|
can be queried.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static float</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetSourcef(int, int)">alGetSourcef</a></strong>(int source,
|
|
int pname)</code>
|
|
<div class="block">Source state is maintained inside the AL implementation, and the current attributes
|
|
can be queried.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetSourcei(int, int)">alGetSourcei</a></strong>(int source,
|
|
int pname)</code>
|
|
<div class="block">Source state is maintained inside the AL implementation, and the current attributes
|
|
can be queried.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static java.lang.String</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alGetString(int)">alGetString</a></strong>(int pname)</code>
|
|
<div class="block">The application can retrieve state information global to the current AL Context.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alIsBuffer(int)">alIsBuffer</a></strong>(int buffer)</code>
|
|
<div class="block">The application can verify whether a buffer Name is valid using the IsBuffer query.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alIsEnabled(int)">alIsEnabled</a></strong>(int capability)</code>
|
|
<div class="block">The application can also query whether a given capability is currently enabled or
|
|
not.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alIsExtensionPresent(java.lang.String)">alIsExtensionPresent</a></strong>(java.lang.String fname)</code>
|
|
<div class="block">To verify that a given extension is available for the current context and the device it
|
|
is associated with, use this method.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alIsSource(int)">alIsSource</a></strong>(int id)</code>
|
|
<div class="block">The application can verify whether a source name is valid using the IsSource query.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alListener(int, java.nio.FloatBuffer)">alListener</a></strong>(int pname,
|
|
java.nio.FloatBuffer value)</code>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alListener3f(int, float, float, float)">alListener3f</a></strong>(int pname,
|
|
float v1,
|
|
float v2,
|
|
float v3)</code>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alListenerf(int, float)">alListenerf</a></strong>(int pname,
|
|
float value)</code>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alListeneri(int, int)">alListeneri</a></strong>(int pname,
|
|
int value)</code>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSource(int, int, java.nio.FloatBuffer)">alSource</a></strong>(int source,
|
|
int pname,
|
|
java.nio.FloatBuffer value)</code>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSource3f(int, int, float, float, float)">alSource3f</a></strong>(int source,
|
|
int pname,
|
|
float v1,
|
|
float v2,
|
|
float v3)</code>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourcef(int, int, float)">alSourcef</a></strong>(int source,
|
|
int pname,
|
|
float value)</code>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourcei(int, int, int)">alSourcei</a></strong>(int source,
|
|
int pname,
|
|
int value)</code>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourcePause(int)">alSourcePause</a></strong>(int source)</code>
|
|
<div class="block">Pause() applied to an AL_INITIAL Source is a legal NOP.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourcePause(java.nio.IntBuffer)">alSourcePause</a></strong>(java.nio.IntBuffer sources)</code>
|
|
<div class="block">Pause() applied to an AL_INITIAL Source is a legal NOP.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourcePlay(int)">alSourcePlay</a></strong>(int source)</code>
|
|
<div class="block">Play() applied to an AL_INITIAL Source will promote the Source to AL_PLAYING, thus
|
|
the data found in the Buffer will be fed into the processing, starting at the
|
|
beginning.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourcePlay(java.nio.IntBuffer)">alSourcePlay</a></strong>(java.nio.IntBuffer sources)</code>
|
|
<div class="block">Play() applied to an AL_INITIAL Source will promote the Source to AL_PLAYING, thus
|
|
the data found in the Buffer will be fed into the processing, starting at the
|
|
beginning.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceQueueBuffers(int, int)">alSourceQueueBuffers</a></strong>(int source,
|
|
int buffer)</code>
|
|
<div class="block">Overloads alSourceQueueBuffers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceQueueBuffers(int, java.nio.IntBuffer)">alSourceQueueBuffers</a></strong>(int source,
|
|
java.nio.IntBuffer buffers)</code>
|
|
<div class="block">
|
|
The application can queue up one or multiple buffer names using
|
|
SourceQueueBuffers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceRewind(int)">alSourceRewind</a></strong>(int source)</code>
|
|
<div class="block">Rewind() applied to an AL_INITIAL Source is a legal NOP.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceRewind(java.nio.IntBuffer)">alSourceRewind</a></strong>(java.nio.IntBuffer sources)</code>
|
|
<div class="block">Rewind() applied to an AL_INITIAL Source is a legal NOP.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceStop(int)">alSourceStop</a></strong>(int source)</code>
|
|
<div class="block">Stop() applied to an AL_INITIAL Source is a legal NOP.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceStop(java.nio.IntBuffer)">alSourceStop</a></strong>(java.nio.IntBuffer sources)</code>
|
|
<div class="block">Stop() applied to an AL_INITIAL Source is a legal NOP.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>static int</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceUnqueueBuffers(int)">alSourceUnqueueBuffers</a></strong>(int source)</code>
|
|
<div class="block">Overloads alSourceUnqueueBuffers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>static void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../org/lwjgl/openal/AL10.html#alSourceUnqueueBuffers(int, java.nio.IntBuffer)">alSourceUnqueueBuffers</a></strong>(int source,
|
|
java.nio.IntBuffer buffers)</code>
|
|
<div class="block">
|
|
Once a queue entry for a buffer has been appended to a queue and is pending
|
|
processing, it should not be changed.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.Object</h3>
|
|
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a name="AL_INVALID">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_INVALID</h4>
|
|
<pre>public static final int AL_INVALID</pre>
|
|
<div class="block">Bad value</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INVALID">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_NONE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_NONE</h4>
|
|
<pre>public static final int AL_NONE</pre>
|
|
<div class="block">Disable value</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_NONE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_FALSE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_FALSE</h4>
|
|
<pre>public static final int AL_FALSE</pre>
|
|
<div class="block">Boolean False</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_FALSE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_TRUE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_TRUE</h4>
|
|
<pre>public static final int AL_TRUE</pre>
|
|
<div class="block">Boolean True</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_TRUE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_SOURCE_TYPE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_SOURCE_TYPE</h4>
|
|
<pre>public static final int AL_SOURCE_TYPE</pre>
|
|
<div class="block">Indicate the type of SOURCE.
|
|
Sources can be spatialized</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_SOURCE_TYPE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_SOURCE_ABSOLUTE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_SOURCE_ABSOLUTE</h4>
|
|
<pre>public static final int AL_SOURCE_ABSOLUTE</pre>
|
|
<div class="block">Indicate source has absolute coordinates</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_SOURCE_ABSOLUTE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_SOURCE_RELATIVE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_SOURCE_RELATIVE</h4>
|
|
<pre>public static final int AL_SOURCE_RELATIVE</pre>
|
|
<div class="block">Indicate Source has listener relative coordinates</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_SOURCE_RELATIVE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_CONE_INNER_ANGLE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_CONE_INNER_ANGLE</h4>
|
|
<pre>public static final int AL_CONE_INNER_ANGLE</pre>
|
|
<div class="block">Directional source, inner cone angle, in degrees
|
|
Range: [0-360]
|
|
Default: 360</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_CONE_INNER_ANGLE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_CONE_OUTER_ANGLE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_CONE_OUTER_ANGLE</h4>
|
|
<pre>public static final int AL_CONE_OUTER_ANGLE</pre>
|
|
<div class="block">Directional source, outer cone angle, in degrees.
|
|
Range: [0-360]
|
|
Default: 360</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_CONE_OUTER_ANGLE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_PITCH">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_PITCH</h4>
|
|
<pre>public static final int AL_PITCH</pre>
|
|
<div class="block">Specify the pitch to be applied, either at source,
|
|
or on mixer results, at listener.
|
|
Range: [0.5-2.0]
|
|
Default: 1.0</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_PITCH">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_POSITION">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_POSITION</h4>
|
|
<pre>public static final int AL_POSITION</pre>
|
|
<div class="block">Specify the current location in three dimensional space.
|
|
OpenAL, like OpenGL, uses a right handed coordinate system,
|
|
where in a frontal default view X (thumb) points right,
|
|
Y points up (index finger), and Z points towards the
|
|
viewer/camera (middle finger).
|
|
To switch from a left handed coordinate system, flip the
|
|
sign on the Z coordinate.
|
|
Listener position is always in the world coordinate system.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_POSITION">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_DIRECTION">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_DIRECTION</h4>
|
|
<pre>public static final int AL_DIRECTION</pre>
|
|
<div class="block">Specify the current direction as forward vector.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_DIRECTION">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_VELOCITY">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_VELOCITY</h4>
|
|
<pre>public static final int AL_VELOCITY</pre>
|
|
<div class="block">Specify the current velocity in three dimensional space.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_VELOCITY">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_LOOPING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_LOOPING</h4>
|
|
<pre>public static final int AL_LOOPING</pre>
|
|
<div class="block">Indicate whether source has to loop infinite.
|
|
Type: ALboolean
|
|
Range: [TRUE, FALSE]
|
|
Default: FALSE</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_LOOPING">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_BUFFER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_BUFFER</h4>
|
|
<pre>public static final int AL_BUFFER</pre>
|
|
<div class="block">Indicate the buffer to provide sound samples.
|
|
Type: ALuint.
|
|
Range: any valid Buffer id.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_BUFFER">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_GAIN">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_GAIN</h4>
|
|
<pre>public static final int AL_GAIN</pre>
|
|
<div class="block">Indicate the gain (volume amplification) applied.
|
|
Type: ALfloat.
|
|
Range: ]0.0- ]
|
|
A value of 1.0 means un-attenuated/unchanged.
|
|
Each division by 2 equals an attenuation of -6dB.
|
|
Each multiplicaton with 2 equals an amplification of +6dB.
|
|
A value of 0.0 is meaningless with respect to a logarithmic
|
|
scale; it is interpreted as zero volume - the channel
|
|
is effectively disabled.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_GAIN">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_MIN_GAIN">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_MIN_GAIN</h4>
|
|
<pre>public static final int AL_MIN_GAIN</pre>
|
|
<div class="block">Indicate minimum source attenuation.
|
|
Type: ALfloat
|
|
Range: [0.0 - 1.0]</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_MIN_GAIN">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_MAX_GAIN">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_MAX_GAIN</h4>
|
|
<pre>public static final int AL_MAX_GAIN</pre>
|
|
<div class="block">Indicate maximum source attenuation.
|
|
Type: ALfloat
|
|
Range: [0.0 - 1.0]</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_MAX_GAIN">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_ORIENTATION">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_ORIENTATION</h4>
|
|
<pre>public static final int AL_ORIENTATION</pre>
|
|
<div class="block">Specify the current orientation.
|
|
Type: ALfv6 (at/up)
|
|
Range: N/A</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_ORIENTATION">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_REFERENCE_DISTANCE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_REFERENCE_DISTANCE</h4>
|
|
<pre>public static final int AL_REFERENCE_DISTANCE</pre>
|
|
<div class="block">Specify the current orientation.
|
|
Type: ALfv6 (at/up)
|
|
Range: N/A</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_REFERENCE_DISTANCE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_ROLLOFF_FACTOR">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_ROLLOFF_FACTOR</h4>
|
|
<pre>public static final int AL_ROLLOFF_FACTOR</pre>
|
|
<div class="block">Indicate the rolloff factor for the source.
|
|
Type: ALfloat
|
|
Range: [0.0 - ]
|
|
Default: 1.0</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_ROLLOFF_FACTOR">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_CONE_OUTER_GAIN">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_CONE_OUTER_GAIN</h4>
|
|
<pre>public static final int AL_CONE_OUTER_GAIN</pre>
|
|
<div class="block">Indicate the gain (volume amplification) applied.
|
|
Type: ALfloat.
|
|
Range: ]0.0- ]
|
|
A value of 1.0 means un-attenuated/unchanged.
|
|
Each division by 2 equals an attenuation of -6dB.
|
|
Each multiplicaton with 2 equals an amplification of +6dB.
|
|
A value of 0.0 is meaningless with respect to a logarithmic
|
|
scale; it is interpreted as zero volume - the channel
|
|
is effectively disabled.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_CONE_OUTER_GAIN">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_MAX_DISTANCE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_MAX_DISTANCE</h4>
|
|
<pre>public static final int AL_MAX_DISTANCE</pre>
|
|
<div class="block">Specify the maximum distance.
|
|
Type: ALfloat
|
|
Range: [0.0 - ]</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_MAX_DISTANCE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_CHANNEL_MASK">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_CHANNEL_MASK</h4>
|
|
<pre>public static final int AL_CHANNEL_MASK</pre>
|
|
<div class="block">Specify the channel mask. (Creative)
|
|
Type: ALuint
|
|
Range: [0 - 255]</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_CHANNEL_MASK">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_SOURCE_STATE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_SOURCE_STATE</h4>
|
|
<pre>public static final int AL_SOURCE_STATE</pre>
|
|
<div class="block">Source state information</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_SOURCE_STATE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_INITIAL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_INITIAL</h4>
|
|
<pre>public static final int AL_INITIAL</pre>
|
|
<div class="block">Source state information</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INITIAL">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_PLAYING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_PLAYING</h4>
|
|
<pre>public static final int AL_PLAYING</pre>
|
|
<div class="block">Source state information</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_PLAYING">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_PAUSED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_PAUSED</h4>
|
|
<pre>public static final int AL_PAUSED</pre>
|
|
<div class="block">Source state information</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_PAUSED">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_STOPPED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_STOPPED</h4>
|
|
<pre>public static final int AL_STOPPED</pre>
|
|
<div class="block">Source state information</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_STOPPED">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_BUFFERS_QUEUED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_BUFFERS_QUEUED</h4>
|
|
<pre>public static final int AL_BUFFERS_QUEUED</pre>
|
|
<div class="block">Buffer Queue params</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_BUFFERS_QUEUED">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_BUFFERS_PROCESSED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_BUFFERS_PROCESSED</h4>
|
|
<pre>public static final int AL_BUFFERS_PROCESSED</pre>
|
|
<div class="block">Buffer Queue params</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_BUFFERS_PROCESSED">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_FORMAT_MONO8">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_FORMAT_MONO8</h4>
|
|
<pre>public static final int AL_FORMAT_MONO8</pre>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_FORMAT_MONO8">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_FORMAT_MONO16">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_FORMAT_MONO16</h4>
|
|
<pre>public static final int AL_FORMAT_MONO16</pre>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_FORMAT_MONO16">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_FORMAT_STEREO8">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_FORMAT_STEREO8</h4>
|
|
<pre>public static final int AL_FORMAT_STEREO8</pre>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_FORMAT_STEREO8">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_FORMAT_STEREO16">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_FORMAT_STEREO16</h4>
|
|
<pre>public static final int AL_FORMAT_STEREO16</pre>
|
|
<div class="block">Sound buffers: format specifier.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_FORMAT_STEREO16">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_FORMAT_VORBIS_EXT">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_FORMAT_VORBIS_EXT</h4>
|
|
<pre>public static final int AL_FORMAT_VORBIS_EXT</pre>
|
|
<div class="block">Ogg Vorbis format specifier.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_FORMAT_VORBIS_EXT">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_FREQUENCY">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_FREQUENCY</h4>
|
|
<pre>public static final int AL_FREQUENCY</pre>
|
|
<div class="block">Sound buffers: frequency, in units of Hertz [Hz].
|
|
This is the number of samples per second. Half of the
|
|
sample frequency marks the maximum significant
|
|
frequency component.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_FREQUENCY">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_BITS">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_BITS</h4>
|
|
<pre>public static final int AL_BITS</pre>
|
|
<div class="block">Sound buffers: The number of bits per sample for the
|
|
data contained in the buffer.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_BITS">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_CHANNELS">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_CHANNELS</h4>
|
|
<pre>public static final int AL_CHANNELS</pre>
|
|
<div class="block">Sound buffers: The number of channels for the data
|
|
contained in the buffer.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_CHANNELS">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_SIZE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_SIZE</h4>
|
|
<pre>public static final int AL_SIZE</pre>
|
|
<div class="block">Sound buffers: Size in bytes of the buffer data.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_SIZE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_DATA">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_DATA</h4>
|
|
<pre>public static final int AL_DATA</pre>
|
|
<div class="block"><span class="strong">Deprecated.</span> <i>This token is a relict of the early OpenAL days and is
|
|
no longer supported. Neither the OpenAL spec nor OpenAL Soft define
|
|
it.</i></div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_DATA">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_UNUSED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_UNUSED</h4>
|
|
<pre>public static final int AL_UNUSED</pre>
|
|
<div class="block">Buffer state.
|
|
<p>
|
|
Not supported for public use (yet).</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_UNUSED">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_PENDING">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_PENDING</h4>
|
|
<pre>public static final int AL_PENDING</pre>
|
|
<div class="block">Buffer state.
|
|
<p>
|
|
Not supported for public use (yet).</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_PENDING">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_PROCESSED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_PROCESSED</h4>
|
|
<pre>public static final int AL_PROCESSED</pre>
|
|
<div class="block">Buffer state.
|
|
<p>
|
|
Not supported for public use (yet).</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_PROCESSED">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_NO_ERROR">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_NO_ERROR</h4>
|
|
<pre>public static final int AL_NO_ERROR</pre>
|
|
<div class="block">Errors: No Error.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_NO_ERROR">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_INVALID_NAME">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_INVALID_NAME</h4>
|
|
<pre>public static final int AL_INVALID_NAME</pre>
|
|
<div class="block">Illegal name passed as an argument to an AL call.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INVALID_NAME">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_INVALID_ENUM">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_INVALID_ENUM</h4>
|
|
<pre>public static final int AL_INVALID_ENUM</pre>
|
|
<div class="block">Illegal enum passed as an argument to an AL call.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INVALID_ENUM">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_INVALID_VALUE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_INVALID_VALUE</h4>
|
|
<pre>public static final int AL_INVALID_VALUE</pre>
|
|
<div class="block">Illegal value passed as an argument to an AL call.
|
|
Applies to parameter values, but not to enumerations.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INVALID_VALUE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_INVALID_OPERATION">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_INVALID_OPERATION</h4>
|
|
<pre>public static final int AL_INVALID_OPERATION</pre>
|
|
<div class="block">A function was called at inappropriate time,
|
|
or in an inappropriate way, causing an illegal state.
|
|
This can be an incompatible ALenum, object ID,
|
|
and/or function.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INVALID_OPERATION">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_OUT_OF_MEMORY">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_OUT_OF_MEMORY</h4>
|
|
<pre>public static final int AL_OUT_OF_MEMORY</pre>
|
|
<div class="block">A function could not be completed,
|
|
because there is not enough memory available.</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_OUT_OF_MEMORY">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_VENDOR">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_VENDOR</h4>
|
|
<pre>public static final int AL_VENDOR</pre>
|
|
<div class="block">Context strings: Vendor</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_VENDOR">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_VERSION">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_VERSION</h4>
|
|
<pre>public static final int AL_VERSION</pre>
|
|
<div class="block">Context strings: Version</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_VERSION">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_RENDERER">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_RENDERER</h4>
|
|
<pre>public static final int AL_RENDERER</pre>
|
|
<div class="block">Context strings: Renderer</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_RENDERER">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_EXTENSIONS">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_EXTENSIONS</h4>
|
|
<pre>public static final int AL_EXTENSIONS</pre>
|
|
<div class="block">Context strings: Extensions</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_EXTENSIONS">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_DOPPLER_FACTOR">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_DOPPLER_FACTOR</h4>
|
|
<pre>public static final int AL_DOPPLER_FACTOR</pre>
|
|
<div class="block">Doppler scale. Default 1.0</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_DOPPLER_FACTOR">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_DOPPLER_VELOCITY">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_DOPPLER_VELOCITY</h4>
|
|
<pre>public static final int AL_DOPPLER_VELOCITY</pre>
|
|
<div class="block">Doppler velocity. Default 1.0</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_DOPPLER_VELOCITY">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_DISTANCE_MODEL">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_DISTANCE_MODEL</h4>
|
|
<pre>public static final int AL_DISTANCE_MODEL</pre>
|
|
<div class="block">Distance model. Default INVERSE_DISTANCE_CLAMPED</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_DISTANCE_MODEL">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_INVERSE_DISTANCE">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>AL_INVERSE_DISTANCE</h4>
|
|
<pre>public static final int AL_INVERSE_DISTANCE</pre>
|
|
<div class="block">Distance model</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INVERSE_DISTANCE">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="AL_INVERSE_DISTANCE_CLAMPED">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>AL_INVERSE_DISTANCE_CLAMPED</h4>
|
|
<pre>public static final int AL_INVERSE_DISTANCE_CLAMPED</pre>
|
|
<div class="block">Distance model</div>
|
|
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.lwjgl.openal.AL10.AL_INVERSE_DISTANCE_CLAMPED">Constant Field Values</a></dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="alEnable(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alEnable</h4>
|
|
<pre>public static void alEnable(int capability)</pre>
|
|
<div class="block">The application can temporarily disable certain AL capabilities on a per Context
|
|
basis. This allows the driver implementation to optimize for certain subsets of
|
|
operations. Enabling and disabling capabilities is handled using a function pair.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capability</code> - name of a capability to enable</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alDisable(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alDisable</h4>
|
|
<pre>public static void alDisable(int capability)</pre>
|
|
<div class="block">The application can temporarily disable certain AL capabilities on a per Context
|
|
basis. This allows the driver implementation to optimize for certain subsets of
|
|
operations. Enabling and disabling capabilities is handled using a function pair.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capability</code> - name of a capability to disable</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alIsEnabled(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alIsEnabled</h4>
|
|
<pre>public static boolean alIsEnabled(int capability)</pre>
|
|
<div class="block">The application can also query whether a given capability is currently enabled or
|
|
not.
|
|
<p>
|
|
If the token used to specify target is not legal, an AL_INVALID_ENUM error will be
|
|
generated.
|
|
</p>
|
|
<p>
|
|
At this time, this mechanism is not used. There are no valid targets.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>capability</code> - name of a capability to check</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>true if named feature is enabled</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetBoolean(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetBoolean</h4>
|
|
<pre>public static boolean alGetBoolean(int pname)</pre>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.
|
|
<p>
|
|
Legal values are e.g. AL_DOPPLER_FACTOR, AL_DOPPLER_VELOCITY,
|
|
AL_DISTANCE_MODEL.
|
|
<p>
|
|
<code>null</code> destinations are quietly ignored. AL_INVALID_ENUM is the response to errors
|
|
in specifying pName. The amount of memory required in the destination
|
|
depends on the actual state requested.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>boolean state described by pname will be returned.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetInteger(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetInteger</h4>
|
|
<pre>public static int alGetInteger(int pname)</pre>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.
|
|
<p>
|
|
Legal values are e.g. AL_DOPPLER_FACTOR, AL_DOPPLER_VELOCITY,
|
|
AL_DISTANCE_MODEL.
|
|
<p>
|
|
<code>null</code> destinations are quietly ignored. AL_INVALID_ENUM is the response to errors
|
|
in specifying pName. The amount of memory required in the destination
|
|
depends on the actual state requested.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>int state described by pname will be returned.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetFloat(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetFloat</h4>
|
|
<pre>public static float alGetFloat(int pname)</pre>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.
|
|
<p>
|
|
Legal values are e.g. AL_DOPPLER_FACTOR, AL_DOPPLER_VELOCITY,
|
|
AL_DISTANCE_MODEL.
|
|
<p>
|
|
<code>null</code> destinations are quietly ignored. AL_INVALID_ENUM is the response to errors
|
|
in specifying pName. The amount of memory required in the destination
|
|
depends on the actual state requested.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>float state described by pname will be returned.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetDouble(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetDouble</h4>
|
|
<pre>public static double alGetDouble(int pname)</pre>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.
|
|
<p>
|
|
Legal values are e.g. AL_DOPPLER_FACTOR, AL_DOPPLER_VELOCITY,
|
|
AL_DISTANCE_MODEL.
|
|
<p>
|
|
<code>null</code> destinations are quietly ignored. AL_INVALID_ENUM is the response to errors
|
|
in specifying pName. The amount of memory required in the destination
|
|
depends on the actual state requested.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>double state described by pname will be returned.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetInteger(int, java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetInteger</h4>
|
|
<pre>public static void alGetInteger(int pname,
|
|
java.nio.IntBuffer data)</pre>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.
|
|
<p>
|
|
Legal values are e.g. AL_DOPPLER_FACTOR, AL_DOPPLER_VELOCITY,
|
|
AL_DISTANCE_MODEL.
|
|
<p>
|
|
<code>null</code> destinations are quietly ignored. AL_INVALID_ENUM is the response to errors
|
|
in specifying pName. The amount of memory required in the destination
|
|
depends on the actual state requested.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - state to be queried</dd><dd><code>data</code> - Buffer to place the integers in</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetFloat(int, java.nio.FloatBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetFloat</h4>
|
|
<pre>public static void alGetFloat(int pname,
|
|
java.nio.FloatBuffer data)</pre>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.
|
|
<p>
|
|
Legal values are e.g. AL_DOPPLER_FACTOR, AL_DOPPLER_VELOCITY,
|
|
AL_DISTANCE_MODEL.
|
|
<p>
|
|
<code>null</code> destinations are quietly ignored. AL_INVALID_ENUM is the response to errors
|
|
in specifying pName. The amount of memory required in the destination
|
|
depends on the actual state requested.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - state to be queried</dd><dd><code>data</code> - Buffer to place the floats in</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetDouble(int, java.nio.DoubleBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetDouble</h4>
|
|
<pre>public static void alGetDouble(int pname,
|
|
java.nio.DoubleBuffer data)</pre>
|
|
<div class="block">Like OpenGL, AL uses a simplified interface for querying global state.
|
|
<p>
|
|
Legal values are e.g. AL_DOPPLER_FACTOR, AL_DOPPLER_VELOCITY,
|
|
AL_DISTANCE_MODEL.
|
|
<p>
|
|
<code>null</code> destinations are quietly ignored. AL_INVALID_ENUM is the response to errors
|
|
in specifying pName. The amount of memory required in the destination
|
|
depends on the actual state requested.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - state to be queried</dd><dd><code>data</code> - Buffer to place the doubles in</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetString(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetString</h4>
|
|
<pre>public static java.lang.String alGetString(int pname)</pre>
|
|
<div class="block">The application can retrieve state information global to the current AL Context.
|
|
GetString will return a pointer to a constant string. Valid values for param are
|
|
VERSION, RENDERER, VENDOR, and EXTENSIONS, as well as the error codes
|
|
defined by AL. The application can use GetString to retrieve a string for an error
|
|
code.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - The property to be returned</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>OpenAL String property</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetError()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetError</h4>
|
|
<pre>public static int alGetError()</pre>
|
|
<div class="block">The AL detects only a subset of those conditions that could be considered errors.
|
|
This is because in many cases error checking would adversely impact the
|
|
performance of an error-free program.
|
|
<p>
|
|
Each detectable error is assigned a numeric
|
|
code. When an error is detected by AL, a flag is set and the error code is recorded.
|
|
Further errors, if they occur, do not affect this recorded code. When GetError is
|
|
called, the code is returned and the flag is cleared, so that a further error will again
|
|
record its code. If a call to GetError returns AL_NO_ERROR then there has been no
|
|
detectable error since the last call to GetError (or since the AL was initialized).
|
|
</p>
|
|
<p>
|
|
Error codes can be mapped to strings. The GetString function returns a pointer to a
|
|
constant (literal) string that is identical to the identifier used for the enumeration
|
|
value, as defined in the specification.
|
|
</p>
|
|
<p>
|
|
AL_NO_ERROR - "No Error" token.<br>
|
|
AL_INVALID_NAME - Invalid Name parameter.<br>
|
|
AL_INVALID_ENUM - Invalid parameter.<br>
|
|
AL_INVALID_VALUE - Invalid enum parameter value.<br>
|
|
AL_INVALID_OPERATION - Illegal call.<br>
|
|
AL_OUT_OF_MEMORY - Unable to allocate memory.<br>
|
|
</p>
|
|
<p>
|
|
The table summarizes the AL errors. Currently, when an error flag is set, results of
|
|
AL operations are undefined only if AL_OUT_OF_MEMORY has occured. In other
|
|
cases, the command generating the error is ignored so that it has no effect on AL
|
|
state or output buffer contents. If the error generating command returns a value, it
|
|
returns zero. If the generating command modifies values through a pointer
|
|
argument, no change is made to these values. These error semantics apply only to
|
|
AL errors, not to system errors such as memory access errors.
|
|
</p>
|
|
<p>
|
|
Several error generation conditions are implicit in the description of the various AL
|
|
commands. First, if a command that requires an enumerated value is passed a value
|
|
that is not one of those specified as allowable for that command, the error
|
|
AL_INVALID_ENUM results. This is the case even if the argument is a pointer to a
|
|
symbolic constant if that value is not allowable for the given command. This will
|
|
occur whether the value is allowable for other functions, or an invalid integer value.
|
|
</p>
|
|
<p>
|
|
Integer parameters that are used as names for AL objects such as Buffers and
|
|
Sources are checked for validity. If an invalid name parameter is specified in an AL
|
|
command, an AL_INVALID_NAME error will be generated, and the command is
|
|
ignored.
|
|
</p>
|
|
<p>
|
|
If a negative integer is provided where an argument of type sizei is specified, the
|
|
error AL_INVALID_VALUE results. The same error will result from attempts to set
|
|
integral and floating point values for attributes exceeding the legal range for these.
|
|
The specification does not guarantee that the implementation emits
|
|
AL_INVALID_VALUE if a NaN or Infinity value is passed in for a float or double
|
|
argument (as the specification does not enforce possibly expensive testing of
|
|
floating point values).
|
|
</p>
|
|
<p>
|
|
Commands can be invalid. For example, certain commands might not be applicable
|
|
to a given object. There are also illegal combinations of tokens and values as
|
|
arguments to a command. AL responds to any such illegal command with an
|
|
AL_INVALID_OPERATION error.
|
|
</p>
|
|
<p>
|
|
If memory is exhausted as a side effect of the execution of an AL command, either
|
|
on system level or by exhausting the allocated resources at AL's internal disposal,
|
|
the error AL_OUT_OF_MEMORY may be generated. This can also happen independent
|
|
of recent commands if AL has to request memory for an internal task and fails to
|
|
allocate the required memory from the operating system.
|
|
</p>
|
|
<p>
|
|
Otherwise errors are generated only for conditions that are explicitely described in
|
|
this specification.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Returns:</span></dt><dd>current error state</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alIsExtensionPresent(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alIsExtensionPresent</h4>
|
|
<pre>public static boolean alIsExtensionPresent(java.lang.String fname)</pre>
|
|
<div class="block">To verify that a given extension is available for the current context and the device it
|
|
is associated with, use this method.
|
|
<p>
|
|
A <code>null</code> name argument returns AL_FALSE, as do invalid and unsupported string
|
|
tokens. A <code>null</code> deviceHandle will result in an INVALID_DEVICE error.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fname</code> - String describing the desired extension</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>true if extension is available, false if not</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetEnumValue(java.lang.String)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetEnumValue</h4>
|
|
<pre>public static int alGetEnumValue(java.lang.String ename)</pre>
|
|
<div class="block"><p>
|
|
To obtain enumeration values for extensions, the application has to use
|
|
GetEnumValue of an extension token. Enumeration values are defined within the
|
|
AL namespace and allocated according to specification of the core API and the
|
|
extensions, thus they are context-independent.
|
|
</p>
|
|
<p>
|
|
Returns 0 if the enumeration can not be found. The presence of an enum value does
|
|
not guarantee the applicability of an extension to the current context. A non-zero
|
|
return indicates merely that the implementation is aware of the existence of this
|
|
extension. Implementations should not attempt to return 0 to indicate that the
|
|
extensions is not supported for the current context.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ename</code> - String describing an OpenAL enum</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>Actual int for the described enumeration name</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alListeneri(int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alListeneri</h4>
|
|
<pre>public static void alListeneri(int pname,
|
|
int value)</pre>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - name of the attribute to be set</dd><dd><code>value</code> - value to set the attribute to</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alListenerf(int, float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alListenerf</h4>
|
|
<pre>public static void alListenerf(int pname,
|
|
float value)</pre>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - name of the attribute to be set</dd><dd><code>value</code> - floating point value to set the attribute to</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alListener(int, java.nio.FloatBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alListener</h4>
|
|
<pre>public static void alListener(int pname,
|
|
java.nio.FloatBuffer value)</pre>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - name of the attribute to be set</dd><dd><code>value</code> - FloatBuffer containing value to set the attribute to</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alListener3f(int, float, float, float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alListener3f</h4>
|
|
<pre>public static void alListener3f(int pname,
|
|
float v1,
|
|
float v2,
|
|
float v3)</pre>
|
|
<div class="block">Listener attributes are changed using the Listener group of commands.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - name of the attribute to be set</dd><dd><code>v1</code> - value value 1</dd><dd><code>v2</code> - value value 2</dd><dd><code>v3</code> - float value 3</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetListeneri(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetListeneri</h4>
|
|
<pre>public static int alGetListeneri(int pname)</pre>
|
|
<div class="block">Listener state is maintained inside the AL implementation and can be queried in
|
|
full.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - name of the attribute to be retrieved</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>int</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetListenerf(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetListenerf</h4>
|
|
<pre>public static float alGetListenerf(int pname)</pre>
|
|
<div class="block">Listener state is maintained inside the AL implementation and can be queried in
|
|
full.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - name of the attribute to be retrieved</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>float</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetListener(int, java.nio.FloatBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetListener</h4>
|
|
<pre>public static void alGetListener(int pname,
|
|
java.nio.FloatBuffer floatdata)</pre>
|
|
<div class="block">Listener state is maintained inside the AL implementation and can be queried in
|
|
full.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pname</code> - name of the attribute to be retrieved</dd><dd><code>floatdata</code> - Buffer to write floats to</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGenSources(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGenSources</h4>
|
|
<pre>public static void alGenSources(java.nio.IntBuffer sources)</pre>
|
|
<div class="block">The application requests a number of Sources using GenSources.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sources</code> - array holding sources</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGenSources()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGenSources</h4>
|
|
<pre>public static int alGenSources()</pre>
|
|
<div class="block">Overloads alGenSources.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="alDeleteSources(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alDeleteSources</h4>
|
|
<pre>public static void alDeleteSources(java.nio.IntBuffer sources)</pre>
|
|
<div class="block">The application requests deletion of a number of Sources by DeleteSources.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sources</code> - Source array to delete from</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alDeleteSources(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alDeleteSources</h4>
|
|
<pre>public static void alDeleteSources(int source)</pre>
|
|
<div class="block">Overloads alDeleteSources.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="alIsSource(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alIsSource</h4>
|
|
<pre>public static boolean alIsSource(int id)</pre>
|
|
<div class="block">The application can verify whether a source name is valid using the IsSource query.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - id of source to be testes for validity</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>true if id is valid, false if not</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourcei(int, int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourcei</h4>
|
|
<pre>public static void alSourcei(int source,
|
|
int pname,
|
|
int value)</pre>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to det property on</dd><dd><code>pname</code> - property to set</dd><dd><code>value</code> - value of property</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourcef(int, int, float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourcef</h4>
|
|
<pre>public static void alSourcef(int source,
|
|
int pname,
|
|
float value)</pre>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to det property on</dd><dd><code>pname</code> - property to set</dd><dd><code>value</code> - value of property</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSource(int, int, java.nio.FloatBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSource</h4>
|
|
<pre>public static void alSource(int source,
|
|
int pname,
|
|
java.nio.FloatBuffer value)</pre>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to set property on</dd><dd><code>pname</code> - property to set</dd><dd><code>value</code> - FloatBuffer containing value of property</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSource3f(int, int, float, float, float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSource3f</h4>
|
|
<pre>public static void alSource3f(int source,
|
|
int pname,
|
|
float v1,
|
|
float v2,
|
|
float v3)</pre>
|
|
<div class="block">Specifies the position and other properties as taken into account during
|
|
sound processing.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to set property on</dd><dd><code>pname</code> - property to set</dd><dd><code>v1</code> - value 1 of property</dd><dd><code>v2</code> - value 2 of property</dd><dd><code>v3</code> - value 3 of property</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetSourcei(int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetSourcei</h4>
|
|
<pre>public static int alGetSourcei(int source,
|
|
int pname)</pre>
|
|
<div class="block">Source state is maintained inside the AL implementation, and the current attributes
|
|
can be queried. The performance of such queries is implementation dependent, no
|
|
performance guarantees are made.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - source to get property from</dd><dd><code>pname</code> - name of property</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>int</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetSourcef(int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetSourcef</h4>
|
|
<pre>public static float alGetSourcef(int source,
|
|
int pname)</pre>
|
|
<div class="block">Source state is maintained inside the AL implementation, and the current attributes
|
|
can be queried. The performance of such queries is implementation dependent, no
|
|
performance guarantees are made.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - source to get property from</dd><dd><code>pname</code> - name of property</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>float</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetSource(int, int, java.nio.FloatBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetSource</h4>
|
|
<pre>public static void alGetSource(int source,
|
|
int pname,
|
|
java.nio.FloatBuffer floatdata)</pre>
|
|
<div class="block">Source state is maintained inside the AL implementation, and the current attributes
|
|
can be queried. The performance of such queries is implementation dependent, no
|
|
performance guarantees are made.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to get property from</dd><dd><code>pname</code> - property to get</dd><dd><code>floatdata</code> - Buffer to write floats to</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourcePlay(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourcePlay</h4>
|
|
<pre>public static void alSourcePlay(java.nio.IntBuffer sources)</pre>
|
|
<div class="block">Play() applied to an AL_INITIAL Source will promote the Source to AL_PLAYING, thus
|
|
the data found in the Buffer will be fed into the processing, starting at the
|
|
beginning. Play() applied to a AL_PLAYING Source will restart the Source from the
|
|
beginning. It will not affect the configuration, and will leave the Source in
|
|
AL_PLAYING state, but reset the sampling offset to the beginning. Play() applied to a
|
|
AL_PAUSED Source will resume processing using the Source state as preserved at the
|
|
Pause() operation. Play() applied to a AL_STOPPED Source will propagate it to
|
|
AL_INITIAL then to AL_PLAYING immediately.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sources</code> - array of sources to play</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourcePause(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourcePause</h4>
|
|
<pre>public static void alSourcePause(java.nio.IntBuffer sources)</pre>
|
|
<div class="block">Pause() applied to an AL_INITIAL Source is a legal NOP. Pause() applied to a
|
|
AL_PLAYING Source will change its state to AL_PAUSED. The Source is exempt from
|
|
processing, its current state is preserved. Pause() applied to a AL_PAUSED Source is a
|
|
legal NOP. Pause() applied to a AL_STOPPED Source is a legal NOP.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sources</code> - array of sources to pause</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceStop(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceStop</h4>
|
|
<pre>public static void alSourceStop(java.nio.IntBuffer sources)</pre>
|
|
<div class="block">Stop() applied to an AL_INITIAL Source is a legal NOP. Stop() applied to a AL_PLAYING
|
|
Source will change its state to AL_STOPPED. The Source is exempt from processing,
|
|
its current state is preserved. Stop() applied to a AL_PAUSED Source will change its
|
|
state to AL_STOPPED, with the same consequences as on a AL_PLAYING Source. Stop()
|
|
applied to a AL_STOPPED Source is a legal NOP.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sources</code> - array of sources to stop</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceRewind(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceRewind</h4>
|
|
<pre>public static void alSourceRewind(java.nio.IntBuffer sources)</pre>
|
|
<div class="block">Rewind() applied to an AL_INITIAL Source is a legal NOP. Rewind() applied to a
|
|
AL_PLAYING Source will change its state to AL_STOPPED then AL_INITIAL. The Source is
|
|
exempt from processing, its current state is preserved, with the exception of the
|
|
sampling offset which is reset to the beginning. Rewind() applied to a AL_PAUSED
|
|
Source will change its state to AL_INITIAL, with the same consequences as on a
|
|
AL_PLAYING Source. Rewind() applied to a AL_STOPPED Source promotes the Source to
|
|
AL_INITIAL, resetting the sampling offset to the beginning.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sources</code> - array of sources to rewind</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourcePlay(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourcePlay</h4>
|
|
<pre>public static void alSourcePlay(int source)</pre>
|
|
<div class="block">Play() applied to an AL_INITIAL Source will promote the Source to AL_PLAYING, thus
|
|
the data found in the Buffer will be fed into the processing, starting at the
|
|
beginning. Play() applied to a AL_PLAYING Source will restart the Source from the
|
|
beginning. It will not affect the configuration, and will leave the Source in
|
|
AL_PLAYING state, but reset the sampling offset to the beginning. Play() applied to a
|
|
AL_PAUSED Source will resume processing using the Source state as preserved at the
|
|
Pause() operation. Play() applied to a AL_STOPPED Source will propagate it to
|
|
AL_INITIAL then to AL_PLAYING immediately.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to play</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourcePause(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourcePause</h4>
|
|
<pre>public static void alSourcePause(int source)</pre>
|
|
<div class="block">Pause() applied to an AL_INITIAL Source is a legal NOP. Pause() applied to a
|
|
AL_PLAYING Source will change its state to AL_PAUSED. The Source is exempt from
|
|
processing, its current state is preserved. Pause() applied to a AL_PAUSED Source is a
|
|
legal NOP. Pause() applied to a AL_STOPPED Source is a legal NOP.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to pause</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceStop(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceStop</h4>
|
|
<pre>public static void alSourceStop(int source)</pre>
|
|
<div class="block">Stop() applied to an AL_INITIAL Source is a legal NOP. Stop() applied to a AL_PLAYING
|
|
Source will change its state to AL_STOPPED. The Source is exempt from processing,
|
|
its current state is preserved. Stop() applied to a AL_PAUSED Source will change its
|
|
state to AL_STOPPED, with the same consequences as on a AL_PLAYING Source. Stop()
|
|
applied to a AL_STOPPED Source is a legal NOP.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to stop</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceRewind(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceRewind</h4>
|
|
<pre>public static void alSourceRewind(int source)</pre>
|
|
<div class="block">Rewind() applied to an AL_INITIAL Source is a legal NOP. Rewind() applied to a
|
|
AL_PLAYING Source will change its state to AL_STOPPED then AL_INITIAL. The Source is
|
|
exempt from processing, its current state is preserved, with the exception of the
|
|
sampling offset which is reset to the beginning. Rewind() applied to a AL_PAUSED
|
|
Source will change its state to AL_INITIAL, with the same consequences as on a
|
|
AL_PLAYING Source. Rewind() applied to a AL_STOPPED Source promotes the Source to
|
|
AL_INITIAL, resetting the sampling offset to the beginning.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - Source to rewind</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGenBuffers(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGenBuffers</h4>
|
|
<pre>public static void alGenBuffers(java.nio.IntBuffer buffers)</pre>
|
|
<div class="block">The application requests a number of Buffers using GenBuffers.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffers</code> - holding buffers</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGenBuffers()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGenBuffers</h4>
|
|
<pre>public static int alGenBuffers()</pre>
|
|
<div class="block">Overloads alGenBuffers.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="alDeleteBuffers(java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alDeleteBuffers</h4>
|
|
<pre>public static void alDeleteBuffers(java.nio.IntBuffer buffers)</pre>
|
|
<div class="block"><p>
|
|
The application requests deletion of a number of Buffers by calling DeleteBuffers.
|
|
</p>
|
|
<p>
|
|
Once deleted, Names are no longer valid for use with AL function calls. Any such
|
|
use will cause an AL_INVALID_NAME error. The implementation is free to defer actual
|
|
release of resources.
|
|
</p>
|
|
<p>
|
|
IsBuffer(bname) can be used to verify deletion of a buffer. Deleting bufferName 0 is
|
|
a legal NOP in both scalar and vector forms of the command. The same is true for
|
|
unused buffer names, e.g. such as not allocated yet, or as released already.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffers</code> - Buffer to delete from</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alDeleteBuffers(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alDeleteBuffers</h4>
|
|
<pre>public static void alDeleteBuffers(int buffer)</pre>
|
|
<div class="block">Overloads alDeleteBuffers.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="alIsBuffer(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alIsBuffer</h4>
|
|
<pre>public static boolean alIsBuffer(int buffer)</pre>
|
|
<div class="block">The application can verify whether a buffer Name is valid using the IsBuffer query.
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - buffer to be tested for validity</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>true if supplied buffer is valid, false if not</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alBufferData(int, int, java.nio.ByteBuffer, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alBufferData</h4>
|
|
<pre>public static void alBufferData(int buffer,
|
|
int format,
|
|
java.nio.ByteBuffer data,
|
|
int freq)</pre>
|
|
<div class="block"><p>
|
|
A special case of Buffer state is the actual sound sample data stored in asociation
|
|
with the Buffer. Applications can specify sample data using BufferData.
|
|
</p>
|
|
<p>
|
|
The data specified is copied to an internal software, or if possible, hardware buffer.
|
|
The implementation is free to apply decompression, conversion, resampling, and
|
|
filtering as needed. The internal format of the Buffer is not exposed to the
|
|
application, and not accessible. Valid formats are AL_FORMAT_MONO8,
|
|
AL_FORMAT_MONO16, AL_FORMAT_STEREO8, and AL_FORMAT_STEREO16. An
|
|
implementation may expose other formats, see the chapter on Extensions for
|
|
information on determining if additional formats are supported.
|
|
</p>
|
|
<p>
|
|
Applications should always check for an error condition after attempting to specify
|
|
buffer data in case an implementation has to generate an AL_OUT_OF_MEMORY or
|
|
conversion related AL_INVALID_VALUE error. The application is free to reuse the
|
|
memory specified by the data pointer once the call to BufferData returns. The
|
|
implementation has to dereference, e.g. copy, the data during BufferData execution.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - Buffer to fill</dd><dd><code>format</code> - format sound data is in</dd><dd><code>data</code> - location of data</dd><dd><code>freq</code> - frequency of data</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alBufferData(int, int, java.nio.IntBuffer, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alBufferData</h4>
|
|
<pre>public static void alBufferData(int buffer,
|
|
int format,
|
|
java.nio.IntBuffer data,
|
|
int freq)</pre>
|
|
<div class="block"><p>
|
|
A special case of Buffer state is the actual sound sample data stored in asociation
|
|
with the Buffer. Applications can specify sample data using BufferData.
|
|
</p>
|
|
<p>
|
|
The data specified is copied to an internal software, or if possible, hardware buffer.
|
|
The implementation is free to apply decompression, conversion, resampling, and
|
|
filtering as needed. The internal format of the Buffer is not exposed to the
|
|
application, and not accessible. Valid formats are AL_FORMAT_MONO8,
|
|
AL_FORMAT_MONO16, AL_FORMAT_STEREO8, and AL_FORMAT_STEREO16. An
|
|
implementation may expose other formats, see the chapter on Extensions for
|
|
information on determining if additional formats are supported.
|
|
</p>
|
|
<p>
|
|
Applications should always check for an error condition after attempting to specify
|
|
buffer data in case an implementation has to generate an AL_OUT_OF_MEMORY or
|
|
conversion related AL_INVALID_VALUE error. The application is free to reuse the
|
|
memory specified by the data pointer once the call to BufferData returns. The
|
|
implementation has to dereference, e.g. copy, the data during BufferData execution.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - Buffer to fill</dd><dd><code>format</code> - format sound data is in</dd><dd><code>data</code> - location of data</dd><dd><code>freq</code> - frequency of data</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alBufferData(int, int, java.nio.ShortBuffer, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alBufferData</h4>
|
|
<pre>public static void alBufferData(int buffer,
|
|
int format,
|
|
java.nio.ShortBuffer data,
|
|
int freq)</pre>
|
|
<div class="block"><p>
|
|
A special case of Buffer state is the actual sound sample data stored in asociation
|
|
with the Buffer. Applications can specify sample data using BufferData.
|
|
</p>
|
|
<p>
|
|
The data specified is copied to an internal software, or if possible, hardware buffer.
|
|
The implementation is free to apply decompression, conversion, resampling, and
|
|
filtering as needed. The internal format of the Buffer is not exposed to the
|
|
application, and not accessible. Valid formats are AL_FORMAT_MONO8,
|
|
AL_FORMAT_MONO16, AL_FORMAT_STEREO8, and AL_FORMAT_STEREO16. An
|
|
implementation may expose other formats, see the chapter on Extensions for
|
|
information on determining if additional formats are supported.
|
|
</p>
|
|
<p>
|
|
Applications should always check for an error condition after attempting to specify
|
|
buffer data in case an implementation has to generate an AL_OUT_OF_MEMORY or
|
|
conversion related AL_INVALID_VALUE error. The application is free to reuse the
|
|
memory specified by the data pointer once the call to BufferData returns. The
|
|
implementation has to dereference, e.g. copy, the data during BufferData execution.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - Buffer to fill</dd><dd><code>format</code> - format sound data is in</dd><dd><code>data</code> - location of data</dd><dd><code>freq</code> - frequency of data</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetBufferi(int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetBufferi</h4>
|
|
<pre>public static int alGetBufferi(int buffer,
|
|
int pname)</pre>
|
|
<div class="block">Buffer state is maintained inside the AL implementation and can be queried in full.<br>
|
|
ALC_FREQUENCY - specified in samples per second, i.e. units of Hertz [Hz].<br>
|
|
ALC_SIZE - Size in bytes of the buffer data.<br>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - buffer to get property from</dd><dd><code>pname</code> - name of property to retrieve</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alGetBufferf(int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alGetBufferf</h4>
|
|
<pre>public static float alGetBufferf(int buffer,
|
|
int pname)</pre>
|
|
<div class="block">Buffer state is maintained inside the AL implementation and can be queried in full.<br>
|
|
ALC_FREQUENCY - specified in samples per second, i.e. units of Hertz [Hz].<br>
|
|
ALC_SIZE - Size in bytes of the buffer data.<br>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>buffer</code> - buffer to get property from</dd><dd><code>pname</code> - name of property to retrieve</dd>
|
|
<dt><span class="strong">Returns:</span></dt><dd>float</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceQueueBuffers(int, java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceQueueBuffers</h4>
|
|
<pre>public static void alSourceQueueBuffers(int source,
|
|
java.nio.IntBuffer buffers)</pre>
|
|
<div class="block"><p>
|
|
The application can queue up one or multiple buffer names using
|
|
SourceQueueBuffers. The buffers will be queued in the sequence in which they
|
|
appear in the array.
|
|
</p>
|
|
<p>
|
|
This command is legal on a Source in any state (to allow for streaming, queueing
|
|
has to be possible on a AL_PLAYING Source). Queues are read-only with exception of
|
|
the unqueue operation. The Buffer Name AL_NONE (i.e. 0) can be queued.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - source to queue buffers onto</dd><dd><code>buffers</code> - buffers to be queued</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceQueueBuffers(int, int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceQueueBuffers</h4>
|
|
<pre>public static void alSourceQueueBuffers(int source,
|
|
int buffer)</pre>
|
|
<div class="block">Overloads alSourceQueueBuffers.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceUnqueueBuffers(int, java.nio.IntBuffer)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceUnqueueBuffers</h4>
|
|
<pre>public static void alSourceUnqueueBuffers(int source,
|
|
java.nio.IntBuffer buffers)</pre>
|
|
<div class="block"><p>
|
|
Once a queue entry for a buffer has been appended to a queue and is pending
|
|
processing, it should not be changed. Removal of a given queue entry is not possible
|
|
unless either the Source is AL_STOPPED (in which case then entire queue is considered
|
|
processed), or if the queue entry has already been processed (AL_PLAYING or AL_PAUSED
|
|
Source).
|
|
</p>
|
|
<p>
|
|
The Unqueue command removes a number of buffers entries that have finished
|
|
processing, in the order of appearance, from the queue. The operation will fail if
|
|
more buffers are requested than available, leaving the destination arguments
|
|
unchanged. An AL_INVALID_VALUE error will be thrown. If no error, the destination
|
|
argument will have been updated accordingly.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>source</code> - source to unqueue buffers from</dd><dd><code>buffers</code> - IntBuffer containing list of names that were unqueued</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alSourceUnqueueBuffers(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alSourceUnqueueBuffers</h4>
|
|
<pre>public static int alSourceUnqueueBuffers(int source)</pre>
|
|
<div class="block">Overloads alSourceUnqueueBuffers.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="alDistanceModel(int)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alDistanceModel</h4>
|
|
<pre>public static void alDistanceModel(int value)</pre>
|
|
<div class="block"><p>
|
|
Samples usually use the entire dynamic range of the chosen format/encoding,
|
|
independent of their real world intensity. In other words, a jet engine and a
|
|
clockwork both will have samples with full amplitude. The application will then
|
|
have to adjust Source AL_GAIN accordingly to account for relative differences.
|
|
</p>
|
|
<p>
|
|
Source AL_GAIN is then attenuated by distance. The effective attenuation of a Source
|
|
depends on many factors, among which distance attenuation and source and
|
|
Listener AL_GAIN are only some of the contributing factors. Even if the source and
|
|
Listener AL_GAIN exceed 1.0 (amplification beyond the guaranteed dynamic range),
|
|
distance and other attenuation might ultimately limit the overall AL_GAIN to a value
|
|
below 1.0.
|
|
</p>
|
|
<p>
|
|
AL currently supports three modes of operation with respect to distance
|
|
attenuation. It supports two distance-dependent attenuation models, one which is
|
|
similar to the IASIG I3DL2 (and DS3D) model. The application choses one of these
|
|
two models (or can chose to disable distance-dependent attenuation effects model)
|
|
on a per-context basis.
|
|
</p>
|
|
<p>
|
|
Legal arguments are AL_NONE, AL_INVERSE_DISTANCE, and
|
|
AL_INVERSE_DISTANCE_CLAMPED.
|
|
<br>
|
|
<br>
|
|
AL_NONE bypasses all distance attenuation
|
|
calculation for all Sources. The implementation is expected to optimize this
|
|
situation.
|
|
<br>
|
|
<br>
|
|
AL_INVERSE_DISTANCE_CLAMPED is the DS3D model, with
|
|
AL_REFERENCE_DISTANCE indicating both the reference distance and the distance
|
|
below which gain will be clamped.
|
|
<br>
|
|
<br>
|
|
AL_INVERSE_DISTANCE is equivalent to the DS3D
|
|
model with the exception that AL_REFERENCE_DISTANCE does not imply any
|
|
clamping.
|
|
<br>
|
|
<br>
|
|
The AL implementation is still free to apply any range clamping as
|
|
necessary. The current distance model chosen can be queried using GetIntegerv and
|
|
AL_DISTANCE_MODEL.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - distance model to be set</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alDopplerFactor(float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>alDopplerFactor</h4>
|
|
<pre>public static void alDopplerFactor(float value)</pre>
|
|
<div class="block">The Doppler Effect depends on the velocities of Source and Listener relative to the
|
|
medium, and the propagation speed of sound in that medium. The application
|
|
might want to emphasize or de-emphasize the Doppler Effect as physically accurate
|
|
calculation might not give the desired results. The amount of frequency shift (pitch
|
|
change) is proportional to the speed of listener and source along their line of sight.
|
|
The application can increase or decrease that frequency shift by specifying the
|
|
scaling factor AL should apply to the result of the calculation.
|
|
<br>
|
|
<br>
|
|
The Doppler Effect as implemented by AL is described by the formula below. Effects
|
|
of the medium (air, water) moving with respect to listener and source are ignored.
|
|
AL_DOPPLER_VELOCITY is the propagation speed relative to which the Source
|
|
velocities are interpreted.
|
|
<p>
|
|
<p>
|
|
<pre>
|
|
VD: AL_DOPPLER_VELOCITY
|
|
DF: AL_DOPPLER_FACTOR
|
|
vl: Listener velocity (scalar, projected on source-listener vector)
|
|
vs: Source verlocity (scalar, projected on source-listener vector)
|
|
f: Frequency in sample
|
|
f': effective Doppler shifted frequency
|
|
<p>
|
|
f' = DF * f * (VD-vl)/(VD+vs)
|
|
<p>
|
|
vl<0, vs>0 : source and listener approaching each other
|
|
vl>0, vs<0 : source and listener moving away from each other
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
The implementation has to clamp the projected Listener velocity vl, if abs(vl) is
|
|
greater or equal VD. It similarly has to clamp the projected Source velocity vs if
|
|
abs(vs) is greater or equal VD.
|
|
</p>
|
|
<p>
|
|
There are two API calls global to the current context that provide control of the two
|
|
related parameters.
|
|
</p>
|
|
<p>
|
|
AL_DOPPLER_FACTOR is a simple scaling to exaggerate or
|
|
deemphasize the Doppler (pitch) shift resulting from the calculation.
|
|
</p>
|
|
<p>
|
|
A negative value will result in an AL_INVALID_VALUE error, the command is then
|
|
ignored. The default value is 1. The current setting can be queried using GetFloatv
|
|
and AL_DOPPLER_FACTOR. The implementation is free to optimize the case of
|
|
AL_DOPPLER_FACTOR being set to zero, as this effectively disables the effect.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Doppler scale value to set</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="alDopplerVelocity(float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>alDopplerVelocity</h4>
|
|
<pre>public static void alDopplerVelocity(float value)</pre>
|
|
<div class="block">The Doppler Effect depends on the velocities of Source and Listener relative to the
|
|
medium, and the propagation speed of sound in that medium. The application
|
|
might want to emphasize or de-emphasize the Doppler Effect as physically accurate
|
|
calculation might not give the desired results. The amount of frequency shift (pitch
|
|
change) is proportional to the speed of listener and source along their line of sight.
|
|
The application can increase or decrease that frequency shift by specifying the
|
|
scaling factor AL should apply to the result of the calculation.
|
|
<br>
|
|
<br>
|
|
The Doppler Effect as implemented by AL is described by the formula below. Effects
|
|
of the medium (air, water) moving with respect to listener and source are ignored.
|
|
AL_DOPPLER_VELOCITY is the propagation speed relative to which the Source
|
|
velocities are interpreted.
|
|
<p>
|
|
<p>
|
|
<pre>
|
|
VD: AL_DOPPLER_VELOCITY
|
|
DF: AL_DOPPLER_FACTOR
|
|
vl: Listener velocity (scalar, projected on source-listener vector)
|
|
vs: Source verlocity (scalar, projected on source-listener vector)
|
|
f: Frequency in sample
|
|
f': effective Doppler shifted frequency
|
|
<p>
|
|
f' = DF * f * (VD-vl)/(VD+vs)
|
|
<p>
|
|
vl<0, vs>0 : source and listener approaching each other
|
|
vl>0, vs<0 : source and listener moving away from each other
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
The implementation has to clamp the projected Listener velocity vl, if abs(vl) is
|
|
greater or equal VD. It similarly has to clamp the projected Source velocity vs if
|
|
abs(vs) is greater or equal VD.
|
|
</p>
|
|
<p>
|
|
There are two API calls global to the current context that provide control of the two
|
|
related parameters.
|
|
</p>
|
|
<p>
|
|
AL_DOPPLER_VELOCITY allows the application to change the reference (propagation)
|
|
velocity used in the Doppler Effect calculation. This permits the application to use a
|
|
velocity scale appropriate to its purposes.
|
|
</p>
|
|
<p>
|
|
A negative or zero value will result in an AL_INVALID_VALUE error, the command is
|
|
then ignored. The default value is 1. The current setting can be queried using
|
|
GetFloatv and AL_DOPPLER_VELOCITY.
|
|
</p>
|
|
<p></div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - Doppler velocity value to set</dd></dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar_bottom">
|
|
<!-- -->
|
|
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../../overview-summary.html">Overview</a></li>
|
|
<li><a href="package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="class-use/AL10.html">Use</a></li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../../index-all.html">Index</a></li>
|
|
<li><a href="../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../org/lwjgl/openal/AL.html" title="class in org.lwjgl.openal"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../org/lwjgl/openal/AL11.html" title="class in org.lwjgl.openal"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../index.html?org/lwjgl/openal/AL10.html" target="_top">Frames</a></li>
|
|
<li><a href="AL10.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field_summary">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field_detail">Field</a> | </li>
|
|
<li>Constr | </li>
|
|
<li><a href="#method_detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip-navbar_bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
<p class="legalCopy"><small><i>Copyright © 2002-2009 lwjgl.org. All Rights Reserved.</i></small></p>
|
|
</body>
|
|
</html>
|