sound.html

java 3d帮助文档

<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_PRIORITY_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_DURATION_READ"><!-- --></A><H3>
ALLOW_DURATION_READ</H3>
<PRE>
public static final int <B>ALLOW_DURATION_READ</B></PRE>
<DL>
<DD>Specifies that this node allows access to its object's sound duration
  information.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_DURATION_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_IS_READY_READ"><!-- --></A><H3>
ALLOW_IS_READY_READ</H3>
<PRE>
public static final int <B>ALLOW_IS_READY_READ</B></PRE>
<DL>
<DD>Specifies that this node allows access to its object's sound status
  denoting if it is ready to be played 'immediately'.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_IS_READY_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_IS_PLAYING_READ"><!-- --></A><H3>
ALLOW_IS_PLAYING_READ</H3>
<PRE>
public static final int <B>ALLOW_IS_PLAYING_READ</B></PRE>
<DL>
<DD>Specifies that this node allows access to its object's sound audibly
  playing or playing silently status.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_IS_PLAYING_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_CHANNELS_USED_READ"><!-- --></A><H3>
ALLOW_CHANNELS_USED_READ</H3>
<PRE>
public static final int <B>ALLOW_CHANNELS_USED_READ</B></PRE>
<DL>
<DD>Specifies that this node allows access to its number of channels
 used by this sound.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_CHANNELS_USED_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_MUTE_READ"><!-- --></A><H3>
ALLOW_MUTE_READ</H3>
<PRE>
public static final int <B>ALLOW_MUTE_READ</B></PRE>
<DL>
<DD>Specifies that this node allows access to its object's mute flag
 information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_MUTE_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_MUTE_WRITE"><!-- --></A><H3>
ALLOW_MUTE_WRITE</H3>
<PRE>
public static final int <B>ALLOW_MUTE_WRITE</B></PRE>
<DL>
<DD>Specifies that this node allows writing to its object's mute flag
 information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_MUTE_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_PAUSE_READ"><!-- --></A><H3>
ALLOW_PAUSE_READ</H3>
<PRE>
public static final int <B>ALLOW_PAUSE_READ</B></PRE>
<DL>
<DD>Specifies that this node allows access to its object's pause flag
  information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_PAUSE_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_PAUSE_WRITE"><!-- --></A><H3>
ALLOW_PAUSE_WRITE</H3>
<PRE>
public static final int <B>ALLOW_PAUSE_WRITE</B></PRE>
<DL>
<DD>Specifies that this node allows writing to its object's pause flag
 information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_PAUSE_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_RATE_SCALE_FACTOR_READ"><!-- --></A><H3>
ALLOW_RATE_SCALE_FACTOR_READ</H3>
<PRE>
public static final int <B>ALLOW_RATE_SCALE_FACTOR_READ</B></PRE>
<DL>
<DD>Specifies that this node allows access to its object's sample rate scale
 factor information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_RATE_SCALE_FACTOR_READ">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="ALLOW_RATE_SCALE_FACTOR_WRITE"><!-- --></A><H3>
ALLOW_RATE_SCALE_FACTOR_WRITE</H3>
<PRE>
public static final int <B>ALLOW_RATE_SCALE_FACTOR_WRITE</B></PRE>
<DL>
<DD>Specifies that this node allows writing to its object's sample rate scale
 factor information.
<P>
<DL>
<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.ALLOW_RATE_SCALE_FACTOR_WRITE">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="NO_FILTER"><!-- --></A><H3>
NO_FILTER</H3>
<PRE>
public static final float <B>NO_FILTER</B></PRE>
<DL>
<DD>Denotes that there is no filter value associated with object's distance
 or angular attenuation array.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.NO_FILTER">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="DURATION_UNKNOWN"><!-- --></A><H3>
DURATION_UNKNOWN</H3>
<PRE>
public static final int <B>DURATION_UNKNOWN</B></PRE>
<DL>
<DD>Denotes that the sound's duration could not be calculated.
 A fall back for getDuration of a non-cached sound.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.DURATION_UNKNOWN">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="INFINITE_LOOPS"><!-- --></A><H3>
INFINITE_LOOPS</H3>
<PRE>
public static final int <B>INFINITE_LOOPS</B></PRE>
<DL>
<DD>When used as a loop count sound will loop an infinite number of time
 until explicitly stopped (setEnabled(false)).
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#javax.media.j3d.Sound.INFINITE_LOOPS">Constant Field Values</A></DL>
</DL>

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

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

<A NAME="Sound()"><!-- --></A><H3>
Sound</H3>
<PRE>
public <B>Sound</B>()</PRE>
<DL>
<DD>Constructs and initializes a new Sound node using default
 parameters.  The following defaults values are used:
 <ul>
 sound data: null<br>
 initial gain: 1.0<br>
 loop: 0<br>
 release flag: false<br>
 continuous flag: false<br>
 enable flag: false<br>
 scheduling bounds : null<br>
 scheduling bounding leaf : null<br>
 priority: 1.0<br>
 rate scale factor: 1.0<br>
 mute state: false<br>
 pause state: false<br>
 </ul>
<P>
</DL>
<HR>

<A NAME="Sound(javax.media.j3d.MediaContainer, float)"><!-- --></A><H3>
Sound</H3>
<PRE>
public <B>Sound</B>(<A HREF="../../../javax/media/j3d/MediaContainer.html">MediaContainer</A>&nbsp;soundData,
             float&nbsp;initialGain)</PRE>
<DL>
<DD>Constructs and initializes a new Sound node object using the provided 
 data and gain parameter values, and defaults for all other fields. This 
 constructor implicitly loads the sound data associated with this node if
 the implementation uses sound caching.
<P>
<DT><B>Parameters:</B><DD><CODE>soundData</CODE> - description of JMF source data used by this sound source<DD><CODE>initialGain</CODE> - overall amplitude scale factor applied to sound source</DL>
<HR>

<A NAME="Sound(javax.media.j3d.MediaContainer, float, int, boolean, boolean, boolean, javax.media.j3d.Bounds, float)"><!-- --></A><H3>
Sound</H3>
<PRE>
public <B>Sound</B>(<A HREF="../../../javax/media/j3d/MediaContainer.html">MediaContainer</A>&nbsp;soundData,
             float&nbsp;initialGain,
             int&nbsp;loopCount,
             boolean&nbsp;release,
             boolean&nbsp;continuous,
             boolean&nbsp;enable,
             <A HREF="../../../javax/media/j3d/Bounds.html">Bounds</A>&nbsp;region,
             float&nbsp;priority)</PRE>
<DL>
<DD>Constructs and initializes a new Sound node using provided parameter
 values.
<P>
<DT><B>Parameters:</B><DD><CODE>soundData</CODE> - description of JMF source data used by this sound source<DD><CODE>initialGain</CODE> - overall amplitude scale factor applied to sound source<DD><CODE>loopCount</CODE> - number of times sound is looped when played<DD><CODE>release</CODE> - flag specifying whether the sound is to be played
 to end when stopped<DD><CODE>continuous</CODE> - flag specifying whether the sound silently plays
 when disabled<DD><CODE>enable</CODE> - flag specifying whether the sound is enabled<DD><CODE>region</CODE> - scheduling bounds<DD><CODE>priority</CODE> - defines playback priority if too many sounds started</DL>
<HR>

<A NAME="Sound(javax.media.j3d.MediaContainer, float, int, boolean, boolean, boolean, javax.media.j3d.Bounds, float, float)"><!-- --></A><H3>
Sound</H3>
<PRE>
public <B>Sound</B>(<A HREF="../../../javax/media/j3d/MediaContainer.html">MediaContainer</A>&nbsp;soundData,
             float&nbsp;initialGain,
             int&nbsp;loopCount,
             boolean&nbsp;release,
             boolean&nbsp;continuous,
             boolean&nbsp;enable,
             <A HREF="../../../javax/media/j3d/Bounds.html">Bounds</A>&nbsp;region,
             float&nbsp;priority,
             float&nbsp;rateFactor)</PRE>
<DL>
<DD>Constructs and initializes a new Sound node using provided parameter
 values.
<P>
<DT><B>Parameters:</B><DD><CODE>soundData</CODE> - description of JMF source data used by this sound source<DD><CODE>initialGain</CODE> - overall amplitude scale factor applied to sound source<DD><CODE>loopCount</CODE> - number of times sound is looped when played<DD><CODE>release</CODE> - flag specifying whether the sound is to be played
 to end when stopped<DD><CODE>continuous</CODE> - flag specifying whether the sound silently plays
 when disabled<DD><CODE>enable</CODE> - flag specifying whether the sound is enabled<DD><CODE>region</CODE> - scheduling bounds<DD><CODE>priority</CODE> - defines playback priority if too many sounds started<DD><CODE>rateFactor</CODE> - defines playback sample rate scale factor<DT><B>Since:</B><DD>Java 3D 1.3</DD>
</DD>
</DL>

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

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

<A NAME="setSoundData(javax.media.j3d.MediaContainer)"><!-- --></A><H3>
setSoundData</H3>
<PRE>
public void <B>setSoundData</B>(<A HREF="../../../javax/media/j3d/MediaCont