mirror of
https://github.com/0ldsk00l/nestopia.git
synced 2025-04-02 10:31:51 -04:00
600 lines
17 KiB
HTML
600 lines
17 KiB
HTML
<HTML>
|
|
|
|
<HEAD>
|
|
<!-- Generated by CppDoc v2.4.1 on June 07, 2008 at 22:48-->
|
|
|
|
<META NAME="GENERATOR" Content="CppDoc">
|
|
<TITLE>Nestopia Core API: Nes::Api::Sound</TITLE>
|
|
|
|
</HEAD>
|
|
|
|
<BODY>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../api/Nes..Api..Sound.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>
|
|
<FONT SIZE="-1">
|
|
api</FONT>
|
|
<BR>
|
|
Class Nes::Api::Sound</H2>
|
|
<PRE>
|
|
<code>Base</code>
|
|
|
|
|
+--<B>Nes::Api::Sound</B>
|
|
|
|
</PRE>
|
|
<HR>
|
|
<DL>
|
|
<DT>class <B><a href="../api/Nes..Api.html">Nes::Api</a>::Sound</B></DT><dt> extends Base
|
|
</DL>
|
|
|
|
<p>Sound interface.
|
|
<p>
|
|
|
|
|
|
<HR>
|
|
|
|
|
|
<!-- =========== INNER CLASSES, TYPEDEFS, ENUMS =========== -->
|
|
|
|
<A NAME="inner_defs_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Inner Classes, Typedefs, and Enums</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>enum</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Sound..Channel.html">Nes::Api::Sound::Channel</a></CODE></B>
|
|
|
|
<BR>
|
|
Sound channel types.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>typedef</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Sound..Output.html">Nes::Api::Sound::Output</a></CODE></B>
|
|
|
|
<BR>
|
|
Sound output context.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE>enum</CODE></FONT></TD>
|
|
<TD><B><CODE><a href="../api/Nes..Api..Sound..Speaker.html">Nes::Api::Sound::Speaker</a></CODE></B>
|
|
|
|
<BR>
|
|
Speaker type.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<!-- =========== CONSTRUCTOR SUMMARY =========== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD><CODE><B><a href="#Sound(T&)">Sound</a></B>( T& instance )</CODE>
|
|
|
|
<BR>
|
|
Interface constructor.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<!-- =========== METHOD SUMMARY =========== -->
|
|
|
|
<A NAME="method_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Method Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#EmptyBuffer()">EmptyBuffer</a></B>()</CODE>
|
|
|
|
<BR>
|
|
Empties the internal sound buffer.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> uint</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetSampleBits()">GetSampleBits</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the sample bits.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> ulong</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetSampleRate()">GetSampleRate</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the sample rate.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> <a href="../api/Nes..Api..Sound..Speaker.html">Nes::Api::Sound::Speaker</a></CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetSpeaker()">GetSpeaker</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the speaker type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> uint</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetSpeed()">GetSpeed</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current speed.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> uint</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetVolume(uint)">GetVolume</a></B>( uint channel ) const</CODE>
|
|
|
|
<BR>
|
|
Returns the volume of a channel.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#IsAudible()">IsAudible</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if sound is audible at all.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#IsAutoTransposing()">IsAutoTransposing</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if automatic transposing is enabled.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> bool</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#IsMuted()">IsMuted</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if sound is muted.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#Mute(bool)">Mute</a></B>( bool mute )</CODE>
|
|
|
|
<BR>
|
|
Mutes all sound.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#SetAutoTranspose(bool)">SetAutoTranspose</a></B>( bool state )</CODE>
|
|
|
|
<BR>
|
|
Enables automatic transposition.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> Result</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#SetSampleBits(uint)">SetSampleBits</a></B>( uint bits )</CODE>
|
|
|
|
<BR>
|
|
Sets the sample bits.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> Result</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#SetSampleRate(ulong)">SetSampleRate</a></B>( ulong rate )</CODE>
|
|
|
|
<BR>
|
|
Sets the sample rate.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> void</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#SetSpeaker(Speaker)">SetSpeaker</a></B>( <a href="../api/Nes..Api..Sound..Speaker.html">Nes::Api::Sound::Speaker</a> speaker )</CODE>
|
|
|
|
<BR>
|
|
Sets the speaker type.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> Result</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#SetSpeed(uint)">SetSpeed</a></B>( uint speed )</CODE>
|
|
|
|
<BR>
|
|
Sets the speed.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> Result</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#SetVolume(uint,uint)">SetVolume</a></B>( uint channels, uint volume )</CODE>
|
|
|
|
<BR>
|
|
Sets one or more channel volumes.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<BR>
|
|
<BR>
|
|
<!-- ============ Constructor Detail ========== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Constructor Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="Sound(T&)"><!-- --></A>
|
|
<A NAME="Sound"><!-- --></A>
|
|
<H3>Sound</H3>
|
|
<PRE>
|
|
public <B>Sound</B>( T& instance );
|
|
</PRE>
|
|
<DL>
|
|
<DD>Interface constructor.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>instance</code> - emulator instance</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<BR>
|
|
<!-- ============ Method Detail ========== -->
|
|
|
|
<A NAME="method_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Method Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="EmptyBuffer()"><!-- --></A>
|
|
<A NAME="EmptyBuffer"><!-- --></A>
|
|
<H3>EmptyBuffer</H3>
|
|
<PRE>
|
|
public void <B>EmptyBuffer</B>() throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Empties the internal sound buffer.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetSampleBits()"><!-- --></A>
|
|
<A NAME="GetSampleBits"><!-- --></A>
|
|
<H3>GetSampleBits</H3>
|
|
<PRE>
|
|
public uint <B>GetSampleBits</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the sample bits.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>number</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetSampleRate()"><!-- --></A>
|
|
<A NAME="GetSampleRate"><!-- --></A>
|
|
<H3>GetSampleRate</H3>
|
|
<PRE>
|
|
public ulong <B>GetSampleRate</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the sample rate.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>sample rate</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetSpeaker()"><!-- --></A>
|
|
<A NAME="GetSpeaker"><!-- --></A>
|
|
<H3>GetSpeaker</H3>
|
|
<PRE>
|
|
public <a href="../api/Nes..Api..Sound..Speaker.html">Nes::Api::Sound::Speaker</a> <B>GetSpeaker</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the speaker type.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>speaker type</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetSpeed()"><!-- --></A>
|
|
<A NAME="GetSpeed"><!-- --></A>
|
|
<H3>GetSpeed</H3>
|
|
<PRE>
|
|
public uint <B>GetSpeed</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current speed.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>speed</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetVolume(uint)"><!-- --></A>
|
|
<A NAME="GetVolume"><!-- --></A>
|
|
<H3>GetVolume</H3>
|
|
<PRE>
|
|
public uint <B>GetVolume</B>( uint channel ) const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the volume of a channel.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>channel</code> - channel</DD>
|
|
|
|
<DT><B>Returns: </B><DD>volume</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsAudible()"><!-- --></A>
|
|
<A NAME="IsAudible"><!-- --></A>
|
|
<H3>IsAudible</H3>
|
|
<PRE>
|
|
public bool <B>IsAudible</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if sound is audible at all.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if audible</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsAutoTransposing()"><!-- --></A>
|
|
<A NAME="IsAutoTransposing"><!-- --></A>
|
|
<H3>IsAutoTransposing</H3>
|
|
<PRE>
|
|
public bool <B>IsAutoTransposing</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if automatic transposing is enabled.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if enabled</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsMuted()"><!-- --></A>
|
|
<A NAME="IsMuted"><!-- --></A>
|
|
<H3>IsMuted</H3>
|
|
<PRE>
|
|
public bool <B>IsMuted</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if sound is muted.
|
|
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if muted</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="Mute(bool)"><!-- --></A>
|
|
<A NAME="Mute"><!-- --></A>
|
|
<H3>Mute</H3>
|
|
<PRE>
|
|
public void <B>Mute</B>( bool mute ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Mutes all sound.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>mute</code> - true to mute sound</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetAutoTranspose(bool)"><!-- --></A>
|
|
<A NAME="SetAutoTranspose"><!-- --></A>
|
|
<H3>SetAutoTranspose</H3>
|
|
<PRE>
|
|
public void <B>SetAutoTranspose</B>( bool state ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Enables automatic transposition.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>state</code> - true to enable</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetSampleBits(uint)"><!-- --></A>
|
|
<A NAME="SetSampleBits"><!-- --></A>
|
|
<H3>SetSampleBits</H3>
|
|
<PRE>
|
|
public Result <B>SetSampleBits</B>( uint bits ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the sample bits.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>bits</code> - value of 8 or 16, default is 16</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetSampleRate(ulong)"><!-- --></A>
|
|
<A NAME="SetSampleRate"><!-- --></A>
|
|
<H3>SetSampleRate</H3>
|
|
<PRE>
|
|
public Result <B>SetSampleRate</B>( ulong rate ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the sample rate.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>rate</code> - value in the range 11025 to 96000, default is 44100</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetSpeaker(Speaker)"><!-- --></A>
|
|
<A NAME="SetSpeaker"><!-- --></A>
|
|
<H3>SetSpeaker</H3>
|
|
<PRE>
|
|
public void <B>SetSpeaker</B>( <a href="../api/Nes..Api..Sound..Speaker.html">Nes::Api::Sound::Speaker</a> speaker ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the speaker type.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>speaker</code> - speaker type, default is SPEAKER_MONO</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetSpeed(uint)"><!-- --></A>
|
|
<A NAME="SetSpeed"><!-- --></A>
|
|
<H3>SetSpeed</H3>
|
|
<PRE>
|
|
public Result <B>SetSpeed</B>( uint speed ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets the speed.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>speed</code> - speed in the range 30 to 240, set to DEFAULT_SPEED for automatic adjustment</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SetVolume(uint,uint)"><!-- --></A>
|
|
<A NAME="SetVolume"><!-- --></A>
|
|
<H3>SetVolume</H3>
|
|
<PRE>
|
|
public Result <B>SetVolume</B>( uint channels, uint volume ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Sets one or more channel volumes.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>channels</code> - OR:ed channels
|
|
|
|
<DD><code>volume</code> - volume in the range 0 to 100, default is 85</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=2 BGCOLOR="#eeeeff">
|
|
<A NAME="navbar_top_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<TR ALIGN="center" VALIGN="top">
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-overview-summary.html"><B>Overview</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-summary.html"><B>Project</B></a> </TD>
|
|
<TD BGCOLOR="navy"> <FONT COLOR="white"> <B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="project-tree.html"><B>Tree</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-deprecated-list.html"><B>Deprecated</B></a> </TD>
|
|
<TD BGCOLOR="#eeeeff"> <a href="../../index-all.html"><B>Index</B></a> </TD>
|
|
</TR>
|
|
</TABLE>
|
|
</TD>
|
|
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
|
<B>Nestopia Core API</B></EM>
|
|
</TD>
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD><FONT SIZE="-2">
|
|
<a href="../../index.html" target="_top"><B>FRAMES</B></a>
|
|
<a href="../api/Nes..Api..Sound.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
|
|
|
|
</BODY>
|
|
|
|
</HTML>
|
|
|