689 lines
24 KiB
HTML
689 lines
24 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<!-- Generated by javadoc (build 1.6.0_24) on Sun Apr 15 20:18:19 CEST 2012 -->
|
|
<TITLE>
|
|
SoundEffectInstance
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2012-04-15">
|
|
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
|
|
|
|
<SCRIPT type="text/javascript">
|
|
function windowTitle()
|
|
{
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="SoundEffectInstance";
|
|
}
|
|
}
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
</NOSCRIPT>
|
|
|
|
</HEAD>
|
|
|
|
<BODY BGCOLOR="white" onload="windowTitle();">
|
|
<HR>
|
|
|
|
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<A NAME="navbar_top"><!-- --></A>
|
|
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SoundEffectInstance.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffect.html" title="class in Microsoft.Xna.Framework.Audio"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="SoundEffectInstance.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_top"></A>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
Microsoft.Xna.Framework.Audio</FONT>
|
|
<BR>
|
|
Class SoundEffectInstance</H2>
|
|
<PRE>
|
|
java.lang.Object
|
|
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>Microsoft.Xna.Framework.Audio.SoundEffectInstance</B>
|
|
</PRE>
|
|
<DL>
|
|
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../System/IDisposable.html" title="interface in System">IDisposable</A></DD>
|
|
</DL>
|
|
<DL>
|
|
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">DynamicSoundEffectInstance</A></DD>
|
|
</DL>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE>public class <B>SoundEffectInstance</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../System/IDisposable.html" title="interface in System">IDisposable</A></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
Provides a single playing, paused, or stopped instance of a SoundEffect sound.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Halofreak1990</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#IsLooped">IsLooped</A></B></CODE>
|
|
|
|
<BR>
|
|
Gets a value that indicates whether looping is enabled for the SoundEffectInstance.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Apply3D(Microsoft.Xna.Framework.Audio.AudioListener[], Microsoft.Xna.Framework.Audio.AudioEmitter)">Apply3D</A></B>(<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioListener.html" title="class in Microsoft.Xna.Framework.Audio">AudioListener</A>[] listeners,
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioEmitter.html" title="class in Microsoft.Xna.Framework.Audio">AudioEmitter</A> emitter)</CODE>
|
|
|
|
<BR>
|
|
Applies 3D position to the sound using multiple listeners.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Apply3D(Microsoft.Xna.Framework.Audio.AudioListener, Microsoft.Xna.Framework.Audio.AudioEmitter)">Apply3D</A></B>(<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioListener.html" title="class in Microsoft.Xna.Framework.Audio">AudioListener</A> listener,
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioEmitter.html" title="class in Microsoft.Xna.Framework.Audio">AudioEmitter</A> emitter)</CODE>
|
|
|
|
<BR>
|
|
Applies 3D positioning to the sound using a single listener.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Dispose()">Dispose</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Releases unmanaged resources held by this SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Dispose(boolean)">Dispose</A></B>(boolean disposing)</CODE>
|
|
|
|
<BR>
|
|
Releases the unmanaged resources held by this SoundEffectInstance, and optionally releases the managed resources.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>protected void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#finalize()">finalize</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Releases unmanaged resources and performs other cleanup operations before the SoundEffectInstance is reclaimed by garbage collection.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getPan()">getPan</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the panning for the SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getPitch()">getPitch</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the pitch adjustment for the SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio">SoundState</A></CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getState()">getState</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the current state (playing, paused, or stopped) of the SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> float</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getVolume()">getVolume</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets the volume of the SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#IsDisposed()">IsDisposed</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Gets a value that indicates whether the object is disposed.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Pause()">Pause</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Pauses a SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Play()">Play</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Plays or resumes a SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Resume()">Resume</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Resumes playback for a SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setPan(float)">setPan</A></B>(float value)</CODE>
|
|
|
|
<BR>
|
|
Sets the panning for the SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setPitch(float)">setPitch</A></B>(float value)</CODE>
|
|
|
|
<BR>
|
|
Sets the pitch adjustment for the SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setVolume(float)">setVolume</A></B>(float value)</CODE>
|
|
|
|
<BR>
|
|
Sets the volume of the SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Stop()">Stop</A></B>()</CODE>
|
|
|
|
<BR>
|
|
Immediately stops playing a SoundEffectInstance.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Stop(boolean)">Stop</A></B>(boolean immediate)</CODE>
|
|
|
|
<BR>
|
|
Stops playing a SoundEffectInstance, either immediately or as authored.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
|
|
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
|
|
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
|
<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD><CODE>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<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="IsLooped"><!-- --></A><H3>
|
|
IsLooped</H3>
|
|
<PRE>
|
|
public boolean <B>IsLooped</B></PRE>
|
|
<DL>
|
|
<DD>Gets a value that indicates whether looping is enabled for the SoundEffectInstance. Reference page contains links to related code samples.
|
|
<P>
|
|
<DL>
|
|
</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="IsDisposed()"><!-- --></A><H3>
|
|
IsDisposed</H3>
|
|
<PRE>
|
|
public boolean <B>IsDisposed</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets a value that indicates whether the object is disposed.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPan()"><!-- --></A><H3>
|
|
getPan</H3>
|
|
<PRE>
|
|
public float <B>getPan</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the panning for the SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPan(float)"><!-- --></A><H3>
|
|
setPan</H3>
|
|
<PRE>
|
|
public void <B>setPan</B>(float value)</PRE>
|
|
<DL>
|
|
<DD>Sets the panning for the SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getPitch()"><!-- --></A><H3>
|
|
getPitch</H3>
|
|
<PRE>
|
|
public float <B>getPitch</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the pitch adjustment for the SoundEffectInstance. Reference page contains links to related code samples.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setPitch(float)"><!-- --></A><H3>
|
|
setPitch</H3>
|
|
<PRE>
|
|
public void <B>setPitch</B>(float value)</PRE>
|
|
<DL>
|
|
<DD>Sets the pitch adjustment for the SoundEffectInstance. Reference page contains links to related code samples.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getState()"><!-- --></A><H3>
|
|
getState</H3>
|
|
<PRE>
|
|
public <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio">SoundState</A> <B>getState</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the current state (playing, paused, or stopped) of the SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="getVolume()"><!-- --></A><H3>
|
|
getVolume</H3>
|
|
<PRE>
|
|
public float <B>getVolume</B>()</PRE>
|
|
<DL>
|
|
<DD>Gets the volume of the SoundEffectInstance. Reference page contains links to related code samples.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="setVolume(float)"><!-- --></A><H3>
|
|
setVolume</H3>
|
|
<PRE>
|
|
public void <B>setVolume</B>(float value)</PRE>
|
|
<DL>
|
|
<DD>Sets the volume of the SoundEffectInstance. Reference page contains links to related code samples.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Apply3D(Microsoft.Xna.Framework.Audio.AudioListener, Microsoft.Xna.Framework.Audio.AudioEmitter)"><!-- --></A><H3>
|
|
Apply3D</H3>
|
|
<PRE>
|
|
public void <B>Apply3D</B>(<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioListener.html" title="class in Microsoft.Xna.Framework.Audio">AudioListener</A> listener,
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioEmitter.html" title="class in Microsoft.Xna.Framework.Audio">AudioEmitter</A> emitter)</PRE>
|
|
<DL>
|
|
<DD>Applies 3D positioning to the sound using a single listener. Reference page contains links to related code samples.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>listener</CODE> - Position of the listener.<DD><CODE>emitter</CODE> - Position of the emitter.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Apply3D(Microsoft.Xna.Framework.Audio.AudioListener[], Microsoft.Xna.Framework.Audio.AudioEmitter)"><!-- --></A><H3>
|
|
Apply3D</H3>
|
|
<PRE>
|
|
public void <B>Apply3D</B>(<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioListener.html" title="class in Microsoft.Xna.Framework.Audio">AudioListener</A>[] listeners,
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioEmitter.html" title="class in Microsoft.Xna.Framework.Audio">AudioEmitter</A> emitter)</PRE>
|
|
<DL>
|
|
<DD>Applies 3D position to the sound using multiple listeners. Reference page contains links to related code samples.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>listeners</CODE> - Positions of each listener.<DD><CODE>emitter</CODE> - Position of the emitter.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Dispose()"><!-- --></A><H3>
|
|
Dispose</H3>
|
|
<PRE>
|
|
public void <B>Dispose</B>()</PRE>
|
|
<DL>
|
|
<DD>Releases unmanaged resources held by this SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../System/IDisposable.html#Dispose()">Dispose</A></CODE> in interface <CODE><A HREF="../../../../System/IDisposable.html" title="interface in System">IDisposable</A></CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Dispose(boolean)"><!-- --></A><H3>
|
|
Dispose</H3>
|
|
<PRE>
|
|
protected void <B>Dispose</B>(boolean disposing)</PRE>
|
|
<DL>
|
|
<DD>Releases the unmanaged resources held by this SoundEffectInstance, and optionally releases the managed resources.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>disposing</CODE> - Pass true to release both the managed and unmanaged resources for this SoundEffectInstance. Passing false releases only the unmanaged resources.</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="finalize()"><!-- --></A><H3>
|
|
finalize</H3>
|
|
<PRE>
|
|
protected void <B>finalize</B>()</PRE>
|
|
<DL>
|
|
<DD>Releases unmanaged resources and performs other cleanup operations before the SoundEffectInstance is reclaimed by garbage collection.
|
|
<P>
|
|
<DD><DL>
|
|
<DT><B>Overrides:</B><DD><CODE>finalize</CODE> in class <CODE>java.lang.Object</CODE></DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Pause()"><!-- --></A><H3>
|
|
Pause</H3>
|
|
<PRE>
|
|
public void <B>Pause</B>()</PRE>
|
|
<DL>
|
|
<DD>Pauses a SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Play()"><!-- --></A><H3>
|
|
Play</H3>
|
|
<PRE>
|
|
public void <B>Play</B>()</PRE>
|
|
<DL>
|
|
<DD>Plays or resumes a SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Resume()"><!-- --></A><H3>
|
|
Resume</H3>
|
|
<PRE>
|
|
public void <B>Resume</B>()</PRE>
|
|
<DL>
|
|
<DD>Resumes playback for a SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Stop()"><!-- --></A><H3>
|
|
Stop</H3>
|
|
<PRE>
|
|
public void <B>Stop</B>()</PRE>
|
|
<DL>
|
|
<DD>Immediately stops playing a SoundEffectInstance.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Stop(boolean)"><!-- --></A><H3>
|
|
Stop</H3>
|
|
<PRE>
|
|
public void <B>Stop</B>(boolean immediate)</PRE>
|
|
<DL>
|
|
<DD>Stops playing a SoundEffectInstance, either immediately or as authored.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
<DT><B>Parameters:</B><DD><CODE>immediate</CODE> - Whether to stop playing immediately, or to break out of the loop region and play the release. Specify true to stop playing immediately, or false to break out of the loop region and play the release phase (the remainder of the sound).</DL>
|
|
</DD>
|
|
</DL>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<HR>
|
|
|
|
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SoundEffectInstance.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
</EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffect.html" title="class in Microsoft.Xna.Framework.Audio"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../../index.html?Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="SoundEffectInstance.html" target="_top"><B>NO FRAMES</B></A>
|
|
<SCRIPT type="text/javascript">
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
|
|
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|