backup/JavaXNA
1
0
Fork 0
Code Issues Pull Requests Projects Releases Activity
JavaXNA/Microsoft.Xna.Framework/doc/Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html
Tom Lint 0c477bd97a First commit of existing code to GitHub
2013-06-13 19:57:30 +02:00

445 lines
22 KiB
HTML
Raw Blame History

<!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:18 CEST 2012 -->
<TITLE>
DynamicSoundEffectInstance
</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="DynamicSoundEffectInstance";
}
}
</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DynamicSoundEffectInstance.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioListener.html" title="class in Microsoft.Xna.Framework.Audio"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Audio/NoAudioHardwareException.html" title="class 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/DynamicSoundEffectInstance.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DynamicSoundEffectInstance.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<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 DynamicSoundEffectInstance</H2>
<PRE>
java.lang.Object
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">Microsoft.Xna.Framework.Audio.SoundEffectInstance</A>
<IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>Microsoft.Xna.Framework.Audio.DynamicSoundEffectInstance</B>
</PRE>
<DL>
<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../System/IDisposable.html" title="interface in System">IDisposable</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public final class <B>DynamicSoundEffectInstance</B><DT>extends <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">SoundEffectInstance</A></DL>
</PRE>
<P>
Provides properties, methods, and events for play back of the audio buffer.
<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>&nbsp;<A HREF="../../../../System/Event.html" title="class in System">Event</A>&lt;<A HREF="../../../../System/EventArgs.html" title="class in System">EventArgs</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#BufferNeeded">BufferNeeded</A></B></CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Event that occurs when the number of audio capture buffers awaiting playback is less than or equal to two.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="fields_inherited_from_class_Microsoft.Xna.Framework.Audio.SoundEffectInstance"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Fields inherited from class Microsoft.Xna.Framework.Audio.<A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">SoundEffectInstance</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#IsLooped">IsLooped</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_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>Constructor Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#DynamicSoundEffectInstance(int, Microsoft.Xna.Framework.Audio.AudioChannels)">DynamicSoundEffectInstance</A></B>(int&nbsp;sampleRate,
<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioChannels.html" title="enum in Microsoft.Xna.Framework.Audio">AudioChannels</A>&nbsp;channels)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes a new instance of this class, which creates a dynamic sound effect based on the specified sample rate and audio channel.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== 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>protected &nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#Dispose(boolean)">Dispose</A></B>(boolean&nbsp;disposing)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;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>&nbsp;<A HREF="../../../../System/TimeSpan.html" title="class in System">TimeSpan</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#GetSampleDuration(int)">GetSampleDuration</A></B>(int&nbsp;sizeInBytes)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the sample duration based on the specified size of the audio buffer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#GetSampleSizeInBytes(System.TimeSpan)">GetSampleSizeInBytes</A></B>(<A HREF="../../../../System/TimeSpan.html" title="class in System">TimeSpan</A>&nbsp;duration)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the size of the audio buffer required to contain audio samples based on the specified duration.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#Play()">Play</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Begins or resumes audio playback.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#SubmitBuffer(byte[])">SubmitBuffer</A></B>(byte[]&nbsp;buffer)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Submits an audio buffer for playback.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../Microsoft/Xna/Framework/Audio/DynamicSoundEffectInstance.html#SubmitBuffer(byte[], int, int)">SubmitBuffer</A></B>(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;count)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Submits an audio buffer for playback.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_Microsoft.Xna.Framework.Audio.SoundEffectInstance"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from class Microsoft.Xna.Framework.Audio.<A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">SoundEffectInstance</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Apply3D(Microsoft.Xna.Framework.Audio.AudioListener[], Microsoft.Xna.Framework.Audio.AudioEmitter)">Apply3D</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Apply3D(Microsoft.Xna.Framework.Audio.AudioListener, Microsoft.Xna.Framework.Audio.AudioEmitter)">Apply3D</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Dispose()">Dispose</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#finalize()">finalize</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getPan()">getPan</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getPitch()">getPitch</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getState()">getState</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#getVolume()">getVolume</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#IsDisposed()">IsDisposed</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Pause()">Pause</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Resume()">Resume</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setPan(float)">setPan</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setPitch(float)">setPitch</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#setVolume(float)">setVolume</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Stop()">Stop</A>, <A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Stop(boolean)">Stop</A></CODE></TD>
</TR>
</TABLE>
&nbsp;<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>
&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="BufferNeeded"><!-- --></A><H3>
BufferNeeded</H3>
<PRE>
public <A HREF="../../../../System/Event.html" title="class in System">Event</A>&lt;<A HREF="../../../../System/EventArgs.html" title="class in System">EventArgs</A>&gt; <B>BufferNeeded</B></PRE>
<DL>
<DD>Event that occurs when the number of audio capture buffers awaiting playback is less than or equal to two.
<P>
<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="DynamicSoundEffectInstance(int, Microsoft.Xna.Framework.Audio.AudioChannels)"><!-- --></A><H3>
DynamicSoundEffectInstance</H3>
<PRE>
public <B>DynamicSoundEffectInstance</B>(int&nbsp;sampleRate,
<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioChannels.html" title="enum in Microsoft.Xna.Framework.Audio">AudioChannels</A>&nbsp;channels)</PRE>
<DL>
<DD>Initializes a new instance of this class, which creates a dynamic sound effect based on the specified sample rate and audio channel.
<P>
<DL>
<DT><B>Parameters:</B><DD><CODE>sampleRate</CODE> - Sample rate, in Hertz (Hz), of audio content.<DD><CODE>channels</CODE> - Number of channels in the audio data.</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="Dispose(boolean)"><!-- --></A><H3>
Dispose</H3>
<PRE>
protected void <B>Dispose</B>(boolean&nbsp;disposing)</PRE>
<DL>
<DD><B>Description copied from class: <CODE><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Dispose(boolean)">SoundEffectInstance</A></CODE></B></DD>
<DD>Releases the unmanaged resources held by this SoundEffectInstance, and optionally releases the managed resources.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Dispose(boolean)">Dispose</A></CODE> in class <CODE><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">SoundEffectInstance</A></CODE></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="GetSampleDuration(int)"><!-- --></A><H3>
GetSampleDuration</H3>
<PRE>
public <A HREF="../../../../System/TimeSpan.html" title="class in System">TimeSpan</A> <B>GetSampleDuration</B>(int&nbsp;sizeInBytes)</PRE>
<DL>
<DD>Returns the sample duration based on the specified size of the audio buffer.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>sizeInBytes</CODE> - Size, in bytes, of the audio data.</DL>
</DD>
</DL>
<HR>
<A NAME="GetSampleSizeInBytes(System.TimeSpan)"><!-- --></A><H3>
GetSampleSizeInBytes</H3>
<PRE>
public int <B>GetSampleSizeInBytes</B>(<A HREF="../../../../System/TimeSpan.html" title="class in System">TimeSpan</A>&nbsp;duration)</PRE>
<DL>
<DD>Returns the size of the audio buffer required to contain audio samples based on the specified duration.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>duration</CODE> - TimeSpan object that contains the duration of the audio sample.</DL>
</DD>
</DL>
<HR>
<A NAME="Play()"><!-- --></A><H3>
Play</H3>
<PRE>
public void <B>Play</B>()</PRE>
<DL>
<DD>Begins or resumes audio playback.
<P>
<DD><DL>
<DT><B>Overrides:</B><DD><CODE><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html#Play()">Play</A></CODE> in class <CODE><A HREF="../../../../Microsoft/Xna/Framework/Audio/SoundEffectInstance.html" title="class in Microsoft.Xna.Framework.Audio">SoundEffectInstance</A></CODE></DL>
</DD>
<DD><DL>
</DL>
</DD>
</DL>
<HR>
<A NAME="SubmitBuffer(byte[])"><!-- --></A><H3>
SubmitBuffer</H3>
<PRE>
public void <B>SubmitBuffer</B>(byte[]&nbsp;buffer)</PRE>
<DL>
<DD>Submits an audio buffer for playback. Playback starts at the beginning, and the buffer is played in its entirety.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - Buffer that contains the audio data. The audio format must be PCM wave data.</DL>
</DD>
</DL>
<HR>
<A NAME="SubmitBuffer(byte[], int, int)"><!-- --></A><H3>
SubmitBuffer</H3>
<PRE>
public void <B>SubmitBuffer</B>(byte[]&nbsp;buffer,
int&nbsp;offset,
int&nbsp;count)</PRE>
<DL>
<DD>Submits an audio buffer for playback. Playback begins at the specifed offset, and the byte count determines the size of the sample played.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>buffer</CODE> - Buffer that contains the audio data. The audio format must be PCM wave data.<DD><CODE>offset</CODE> - Offset, in bytes, to the starting position of the data.<DD><CODE>count</CODE> - Amount, in bytes, of data sent.</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>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DynamicSoundEffectInstance.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Audio/AudioListener.html" title="class in Microsoft.Xna.Framework.Audio"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../Microsoft/Xna/Framework/Audio/NoAudioHardwareException.html" title="class 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/DynamicSoundEffectInstance.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="DynamicSoundEffectInstance.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
Reference in New Issue View Git Blame Copy Permalink