audioengine3d.html

JAVA多媒体开发类库说明

<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_javax.media.j3d.AudioDevice"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.media.j3d.<A HREF="../../../../javax/media/j3d/AudioDevice.html" title="interface in javax.media.j3d">AudioDevice</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice.html#close()">close</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#getAngleOffsetToSpeaker()">getAngleOffsetToSpeaker</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#getAudioPlaybackType()">getAudioPlaybackType</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#getCenterEarToSpeaker()">getCenterEarToSpeaker</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#getChannelsAvailable()">getChannelsAvailable</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#getChannelsUsedForSound(javax.media.j3d.Sound)">getChannelsUsedForSound</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#getTotalChannels()">getTotalChannels</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#initialize()">initialize</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#setAngleOffsetToSpeaker(float)">setAngleOffsetToSpeaker</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#setAudioPlaybackType(int)">setAudioPlaybackType</A>, <A HREF="../../../../javax/media/j3d/AudioDevice.html#setCenterEarToSpeaker(float)">setCenterEarToSpeaker</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="samples"><!-- --></A><H3>
samples</H3>
<PRE>
protected java.util.ArrayList <B>samples</B></PRE>
<DL>
<DL>
</DL>
</DL>
<HR>

<A NAME="currentView"><!-- --></A><H3>
currentView</H3>
<PRE>
protected <A HREF="../../../../javax/media/j3d/View.html" title="class in javax.media.j3d">View</A> <B>currentView</B></PRE>
<DL>
<DD>Current View sound is being rendered
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="attribs"><!-- --></A><H3>
attribs</H3>
<PRE>
protected <A HREF="../../../../com/sun/j3d/audioengines/AuralParameters.html" title="class in com.sun.j3d.audioengines">AuralParameters</A> <B>attribs</B></PRE>
<DL>
<DL>
</DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="AudioEngine3D(javax.media.j3d.PhysicalEnvironment)"><!-- --></A><H3>
AudioEngine3D</H3>
<PRE>
public <B>AudioEngine3D</B>(<A HREF="../../../../javax/media/j3d/PhysicalEnvironment.html" title="class in javax.media.j3d">PhysicalEnvironment</A>&nbsp;physicalEnvironment)</PRE>
<DL>
<DD>Construct a new AudioEngine with the specified PhysicalEnvironment.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>physicalEnvironment</CODE> - the physical environment object where we
 want access to this device.</DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>

<A NAME="setView(javax.media.j3d.View)"><!-- --></A><H3>
setView</H3>
<PRE>
public void <B>setView</B>(<A HREF="../../../../javax/media/j3d/View.html" title="class in javax.media.j3d">View</A>&nbsp;reference)</PRE>
<DL>
<DD>Save a reference to the current View object.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#setView(javax.media.j3d.View)">setView</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>reference</CODE> - to current view object</DL>
</DD>
</DL>
<HR>

<A NAME="getView()"><!-- --></A><H3>
getView</H3>
<PRE>
public <A HREF="../../../../javax/media/j3d/View.html" title="class in javax.media.j3d">View</A> <B>getView</B>()</PRE>
<DL>
<DD>Get reference to the current View object.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>reference to current view object</DL>
</DD>
</DL>
<HR>

<A NAME="prepareSound(int, javax.media.j3d.MediaContainer)"><!-- --></A><H3>
prepareSound</H3>
<PRE>
public int <B>prepareSound</B>(int&nbsp;soundType,
                        <A HREF="../../../../javax/media/j3d/MediaContainer.html" title="class in javax.media.j3d">MediaContainer</A>&nbsp;soundData)</PRE>
<DL>
<DD>Prepare Sound in device.
 Makes sound assessible to device - in this case attempts to load sound
 Stores sound type and data.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#prepareSound(int, javax.media.j3d.MediaContainer)">prepareSound</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>soundType</CODE> - denotes type of sound: Background, Point or Cone<DD><CODE>soundData</CODE> - descrition of sound source data
<DT><B>Returns:</B><DD>index into sample vector of Sample object for sound</DL>
</DD>
</DL>
<HR>

<A NAME="clearSound(int)"><!-- --></A><H3>
clearSound</H3>
<PRE>
public abstract void <B>clearSound</B>(int&nbsp;index)</PRE>
<DL>
<DD>Clear Sound.
 Removes/clears associated sound data with this sound source node
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#clearSound(int)">clearSound</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - device specific reference number to device driver sample</DL>
</DD>
</DL>
<HR>

<A NAME="setVworldXfrm(int, javax.media.j3d.Transform3D)"><!-- --></A><H3>
setVworldXfrm</H3>
<PRE>
public void <B>setVworldXfrm</B>(int&nbsp;index,
                          <A HREF="../../../../javax/media/j3d/Transform3D.html" title="class in javax.media.j3d">Transform3D</A>&nbsp;trans)</PRE>
<DL>
<DD>Set the transform for local to virtual world coordinate space
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#setVworldXfrm(int, javax.media.j3d.Transform3D)">setVworldXfrm</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - device specific reference number to device driver sample<DD><CODE>trans</CODE> - is a reference to virtual world composite transform</DL>
</DD>
</DL>
<HR>

<A NAME="startSample(int)"><!-- --></A><H3>
startSample</H3>
<PRE>
public abstract int <B>startSample</B>(int&nbsp;index)</PRE>
<DL>
<DD>Start sample playing on audio device
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#startSample(int)">startSample</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - device specific reference number to device driver sample
<DT><B>Returns:</B><DD>status: < 0 denotes an error</DL>
</DD>
</DL>
<HR>

<A NAME="stopSample(int)"><!-- --></A><H3>
stopSample</H3>
<PRE>
public abstract int <B>stopSample</B>(int&nbsp;index)</PRE>
<DL>
<DD>Stop sample playing on audio device
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#stopSample(int)">stopSample</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - device specific reference number to device driver sample
<DT><B>Returns:</B><DD>status: < 0 denotes an error</DL>
</DD>
</DL>
<HR>

<A NAME="updateSample(int)"><!-- --></A><H3>
updateSample</H3>
<PRE>
public abstract void <B>updateSample</B>(int&nbsp;index)</PRE>
<DL>
<DD>Update sample. 
 Implies that some parameters affecting rendering have been modified.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#updateSample(int)">updateSample</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - device specific reference number to device driver sample</DL>
</DD>
</DL>
<HR>

<A NAME="muteSample(int)"><!-- --></A><H3>
muteSample</H3>
<PRE>
public abstract void <B>muteSample</B>(int&nbsp;index)</PRE>
<DL>
<DD>Mute sample.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#muteSample(int)">muteSample</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>index</CODE> - device specific reference number to device driver sample</DL>
</DD>
</DL>
<HR>

<A NAME="unmuteSample(int)"><!-- --></A><H3>
unmuteSample</H3>
<PRE>
public abstract void <B>unmuteSample</B>(int&nbsp;index)</PRE>
<DL>
<DD>Unmute sample.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html#unmuteSample(int)">unmuteSample</A></CODE> in interface <CODE><A HREF="../../../../javax/media/j3d/AudioDevice3D.html" title="interface in javax.media.j3d">AudioDevice3D</A></CODE></DL>
</DD>