565 lines
22 KiB
HTML
565 lines
22 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="nl">
|
|
<head>
|
|
<!-- Generated by javadoc (version 1.7.0_40) on Tue Oct 15 12:25:30 CEST 2013 -->
|
|
<title>SoundEffectInstance</title>
|
|
<meta name="date" content="2013-10-15">
|
|
<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="SoundEffectInstance";
|
|
}
|
|
//-->
|
|
</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/SoundEffectInstance.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffect.html" title="class in Microsoft.Xna.Framework.Audio"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" target="_top">Frames</a></li>
|
|
<li><a href="SoundEffectInstance.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">Microsoft.Xna.Framework.Audio</div>
|
|
<h2 title="Class SoundEffectInstance" class="title">Class SoundEffectInstance</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>Microsoft.Xna.Framework.Audio.SoundEffectInstance</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>All Implemented Interfaces:</dt>
|
|
<dd><a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a></dd>
|
|
</dl>
|
|
<dl>
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><a href="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">DynamicSoundEffectInstance</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="strong">SoundEffectInstance</span>
|
|
extends java.lang.Object
|
|
implements <a href="../../../../System/IDisposable.html" title="interface in System">IDisposable</a></pre>
|
|
<div class="block">Provides a single playing, paused, or stopped instance of a SoundEffect sound.</div>
|
|
<dl><dt><span class="strong">Author:</span></dt>
|
|
<dd>Halofreak1990</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>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#IsLooped">IsLooped</a></strong></code>
|
|
<div class="block">Gets a value that indicates whether looping is enabled for the SoundEffectInstance.</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>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Apply3D(Microsoft.Xna.Framework.Audio.AudioListener[], Microsoft.Xna.Framework.Audio.AudioEmitter)">Apply3D</a></strong>(<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>
|
|
<div class="block">Applies 3D position to the sound using multiple listeners.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Apply3D(Microsoft.Xna.Framework.Audio.AudioListener, Microsoft.Xna.Framework.Audio.AudioEmitter)">Apply3D</a></strong>(<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>
|
|
<div class="block">Applies 3D positioning to the sound using a single listener.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Dispose()">Dispose</a></strong>()</code>
|
|
<div class="block">Releases unmanaged resources held by this SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Dispose(boolean)">Dispose</a></strong>(boolean disposing)</code>
|
|
<div class="block">Releases the unmanaged resources held by this SoundEffectInstance, and optionally releases the managed resources.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#finalize()">finalize</a></strong>()</code>
|
|
<div class="block">Releases unmanaged resources and performs other cleanup operations before the SoundEffectInstance is reclaimed by garbage collection.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getPan()">getPan</a></strong>()</code>
|
|
<div class="block">Gets the panning for the SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getPitch()">getPitch</a></strong>()</code>
|
|
<div class="block">Gets the pitch adjustment for the SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code><a href="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio">SoundState</a></code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getState()">getState</a></strong>()</code>
|
|
<div class="block">Gets the current state (playing, paused, or stopped) of the SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>float</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getVolume()">getVolume</a></strong>()</code>
|
|
<div class="block">Gets the volume of the SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>boolean</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#IsDisposed()">IsDisposed</a></strong>()</code>
|
|
<div class="block">Gets a value that indicates whether the object is disposed.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Pause()">Pause</a></strong>()</code>
|
|
<div class="block">Pauses a SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Play()">Play</a></strong>()</code>
|
|
<div class="block">Plays or resumes a SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Resume()">Resume</a></strong>()</code>
|
|
<div class="block">Resumes playback for a SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setPan(float)">setPan</a></strong>(float value)</code>
|
|
<div class="block">Sets the panning for the SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setPitch(float)">setPitch</a></strong>(float value)</code>
|
|
<div class="block">Sets the pitch adjustment for the SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setVolume(float)">setVolume</a></strong>(float value)</code>
|
|
<div class="block">Sets the volume of the SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Stop()">Stop</a></strong>()</code>
|
|
<div class="block">Immediately stops playing a SoundEffectInstance.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<td class="colLast"><code><strong><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Stop(boolean)">Stop</a></strong>(boolean immediate)</code>
|
|
<div class="block">Stops playing a SoundEffectInstance, either immediately or as authored.</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, 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="IsLooped">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>IsLooped</h4>
|
|
<pre>public boolean IsLooped</pre>
|
|
<div class="block">Gets a value that indicates whether looping is enabled for the SoundEffectInstance. Reference page contains links to related code samples.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method_detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="IsDisposed()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>IsDisposed</h4>
|
|
<pre>public boolean IsDisposed()</pre>
|
|
<div class="block">Gets a value that indicates whether the object is disposed.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getPan()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPan</h4>
|
|
<pre>public float getPan()</pre>
|
|
<div class="block">Gets the panning for the SoundEffectInstance.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setPan(float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPan</h4>
|
|
<pre>public void setPan(float value)</pre>
|
|
<div class="block">Sets the panning for the SoundEffectInstance.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getPitch()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPitch</h4>
|
|
<pre>public float getPitch()</pre>
|
|
<div class="block">Gets the pitch adjustment for the SoundEffectInstance. Reference page contains links to related code samples.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setPitch(float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPitch</h4>
|
|
<pre>public void setPitch(float value)</pre>
|
|
<div class="block">Sets the pitch adjustment for the SoundEffectInstance. Reference page contains links to related code samples.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getState()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getState</h4>
|
|
<pre>public <a href="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio">SoundState</a> getState()</pre>
|
|
<div class="block">Gets the current state (playing, paused, or stopped) of the SoundEffectInstance.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="getVolume()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getVolume</h4>
|
|
<pre>public float getVolume()</pre>
|
|
<div class="block">Gets the volume of the SoundEffectInstance. Reference page contains links to related code samples.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="setVolume(float)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setVolume</h4>
|
|
<pre>public void setVolume(float value)</pre>
|
|
<div class="block">Sets the volume of the SoundEffectInstance. Reference page contains links to related code samples.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="Apply3D(Microsoft.Xna.Framework.Audio.AudioListener, Microsoft.Xna.Framework.Audio.AudioEmitter)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Apply3D</h4>
|
|
<pre>public void Apply3D(<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>
|
|
<div class="block">Applies 3D positioning to the sound using a single listener. Reference page contains links to related code samples.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listener</code> - Position of the listener.</dd><dd><code>emitter</code> - Position of the emitter.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Apply3D(Microsoft.Xna.Framework.Audio.AudioListener[], Microsoft.Xna.Framework.Audio.AudioEmitter)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Apply3D</h4>
|
|
<pre>public void Apply3D(<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>
|
|
<div class="block">Applies 3D position to the sound using multiple listeners. Reference page contains links to related code samples.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listeners</code> - Positions of each listener.</dd><dd><code>emitter</code> - Position of the emitter.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Dispose()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Dispose</h4>
|
|
<pre>public void Dispose()</pre>
|
|
<div class="block">Releases unmanaged resources held by this SoundEffectInstance.</div>
|
|
<dl>
|
|
<dt><strong>Specified by:</strong></dt>
|
|
<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></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Dispose(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Dispose</h4>
|
|
<pre>protected void Dispose(boolean disposing)</pre>
|
|
<div class="block">Releases the unmanaged resources held by this SoundEffectInstance, and optionally releases the managed resources.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>disposing</code> - Pass true to release both the managed and unmanaged resources for this SoundEffectInstance. Passing false releases only the unmanaged resources.</dd></dl>
|
|
</li>
|
|
</ul>
|
|
<a name="finalize()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>finalize</h4>
|
|
<pre>protected void finalize()</pre>
|
|
<div class="block">Releases unmanaged resources and performs other cleanup operations before the SoundEffectInstance is reclaimed by garbage collection.</div>
|
|
<dl>
|
|
<dt><strong>Overrides:</strong></dt>
|
|
<dd><code>finalize</code> in class <code>java.lang.Object</code></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="Pause()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Pause</h4>
|
|
<pre>public void Pause()</pre>
|
|
<div class="block">Pauses a SoundEffectInstance.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="Play()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Play</h4>
|
|
<pre>public void Play()</pre>
|
|
<div class="block">Plays or resumes a SoundEffectInstance.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="Resume()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Resume</h4>
|
|
<pre>public void Resume()</pre>
|
|
<div class="block">Resumes playback for a SoundEffectInstance.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="Stop()">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>Stop</h4>
|
|
<pre>public void Stop()</pre>
|
|
<div class="block">Immediately stops playing a SoundEffectInstance.</div>
|
|
</li>
|
|
</ul>
|
|
<a name="Stop(boolean)">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Stop</h4>
|
|
<pre>public void Stop(boolean immediate)</pre>
|
|
<div class="block">Stops playing a SoundEffectInstance, either immediately or as authored.</div>
|
|
<dl><dt><span class="strong">Parameters:</span></dt><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).</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/SoundEffectInstance.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-files/index-1.html">Index</a></li>
|
|
<li><a href="../../../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../../../Microsoft/Xna/Framework/Audio/SoundEffect.html" title="class in Microsoft.Xna.Framework.Audio"><span class="strong">Prev Class</span></a></li>
|
|
<li><a href="../../../../Microsoft/Xna/Framework/Audio/SoundState.html" title="enum in Microsoft.Xna.Framework.Audio"><span class="strong">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../../../index.html?Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" target="_top">Frames</a></li>
|
|
<li><a href="SoundEffectInstance.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 ======= -->
|
|
</body>
|
|
</html>
|