mirror of
https://github.com/0ldsk00l/nestopia.git
synced 2025-04-02 10:31:51 -04:00
689 lines
19 KiB
HTML
689 lines
19 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::Nsf</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..Nsf.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <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::Nsf</H2>
|
|
<PRE>
|
|
<code>Base</code>
|
|
|
|
|
+--<B>Nes::Api::Nsf</B>
|
|
|
|
</PRE>
|
|
<HR>
|
|
<DL>
|
|
<DT>class <B><a href="../api/Nes..Api.html">Nes::Api</a>::Nsf</B></DT><dt> extends Base
|
|
</DL>
|
|
|
|
<p>NES Sound Files 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..Nsf..Event.html">Nes::Api::Nsf::Event</a></CODE></B>
|
|
|
|
<BR>
|
|
Event.</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..Nsf..EventCallback.html">Nes::Api::Nsf::EventCallback</a></CODE></B>
|
|
|
|
<BR>
|
|
Event callback prototype.</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..Nsf..TuneMode.html">Nes::Api::Nsf::TuneMode</a></CODE></B>
|
|
|
|
<BR>
|
|
Tune mode.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> static <a href="../api/Nes..Api..Nsf..EventCaller.html">Nes::Api::Nsf::EventCaller</a></CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#eventCallback">eventCallback</a></B></CODE>
|
|
|
|
<BR>
|
|
Event callback manager.</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="#Nsf(T&)">Nsf</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> const char*</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetArtist()">GetArtist</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the name of the artists.</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="#GetChips()">GetChips</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the OR:ed chips in use.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> const char*</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetCopyright()">GetCopyright</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the copyright string.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetCurrentSong()">GetCurrentSong</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the current song index.</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="#GetInitAddress()">GetInitAddress</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the init-address.</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="#GetLoadAddress()">GetLoadAddress</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the load-address.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> <a href="../api/Nes..Api..Nsf..TuneMode.html">Nes::Api::Nsf::TuneMode</a></CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetMode()">GetMode</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Return the tune mode.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> const char*</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetName()">GetName</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the name of the NSF.</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="#GetNumSongs()">GetNumSongs</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the total number of songs.</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="#GetPlayAddress()">GetPlayAddress</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the play-address.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%" NOWRAP><FONT SIZE="-1">
|
|
<CODE> int</CODE></FONT></TD>
|
|
<TD><CODE><B><a href="#GetStartingSong()">GetStartingSong</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Returns the starting song index.</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="#IsPlaying()">IsPlaying</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if a song is currently being played.</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="#PlaySong()">PlaySong</a></B>()</CODE>
|
|
|
|
<BR>
|
|
Plays current selected song.</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="#SelectNextSong()">SelectNextSong</a></B>()</CODE>
|
|
|
|
<BR>
|
|
Selects the next song.</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="#SelectPrevSong()">SelectPrevSong</a></B>()</CODE>
|
|
|
|
<BR>
|
|
Selects the previous song.</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="#SelectSong(uint)">SelectSong</a></B>( uint song )</CODE>
|
|
|
|
<BR>
|
|
Selects a song.</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="#StopSong()">StopSong</a></B>()</CODE>
|
|
|
|
<BR>
|
|
Stops current selected song.</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="#UsesBankSwitching()">UsesBankSwitching</a></B>() const</CODE>
|
|
|
|
<BR>
|
|
Checks if the NSF uses bank-switching.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<BR>
|
|
<BR>
|
|
<!-- ============ Field Detail ========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#ccccff">
|
|
<TD COLSPAN=1><FONT SIZE="+2">
|
|
<B>Field Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="eventCallback"><!-- --></A>
|
|
<A NAME="eventCallback"><!-- --></A>
|
|
<H3>eventCallback</H3>
|
|
<PRE>
|
|
public static <a href="../api/Nes..Api..Nsf..EventCaller.html">Nes::Api::Nsf::EventCaller</a> <B>eventCallback</B>;
|
|
</PRE>
|
|
<DL>
|
|
<DD>Event callback manager.
|
|
Static object used for adding the user defined callback.
|
|
</DD>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<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="Nsf(T&)"><!-- --></A>
|
|
<A NAME="Nsf"><!-- --></A>
|
|
<H3>Nsf</H3>
|
|
<PRE>
|
|
public <B>Nsf</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="GetArtist()"><!-- --></A>
|
|
<A NAME="GetArtist"><!-- --></A>
|
|
<H3>GetArtist</H3>
|
|
<PRE>
|
|
public const char* <B>GetArtist</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the name of the artists.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>artist names or empty string if NSF hasn't been loaded</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetChips()"><!-- --></A>
|
|
<A NAME="GetChips"><!-- --></A>
|
|
<H3>GetChips</H3>
|
|
<PRE>
|
|
public uint <B>GetChips</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the OR:ed chips in use.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>OR:ed chips used</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetCopyright()"><!-- --></A>
|
|
<A NAME="GetCopyright"><!-- --></A>
|
|
<H3>GetCopyright</H3>
|
|
<PRE>
|
|
public const char* <B>GetCopyright</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the copyright string.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>copyright or empty string if NSF hasn't been loaded</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetCurrentSong()"><!-- --></A>
|
|
<A NAME="GetCurrentSong"><!-- --></A>
|
|
<H3>GetCurrentSong</H3>
|
|
<PRE>
|
|
public int <B>GetCurrentSong</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the current song index.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>song index or NO_SONG if NSF hasn't been loaded</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetInitAddress()"><!-- --></A>
|
|
<A NAME="GetInitAddress"><!-- --></A>
|
|
<H3>GetInitAddress</H3>
|
|
<PRE>
|
|
public uint <B>GetInitAddress</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the init-address.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>address</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetLoadAddress()"><!-- --></A>
|
|
<A NAME="GetLoadAddress"><!-- --></A>
|
|
<H3>GetLoadAddress</H3>
|
|
<PRE>
|
|
public uint <B>GetLoadAddress</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the load-address.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>address</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetMode()"><!-- --></A>
|
|
<A NAME="GetMode"><!-- --></A>
|
|
<H3>GetMode</H3>
|
|
<PRE>
|
|
public <a href="../api/Nes..Api..Nsf..TuneMode.html">Nes::Api::Nsf::TuneMode</a> <B>GetMode</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Return the tune mode.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>tune mode</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetName()"><!-- --></A>
|
|
<A NAME="GetName"><!-- --></A>
|
|
<H3>GetName</H3>
|
|
<PRE>
|
|
public const char* <B>GetName</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the name of the NSF.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>name or empty string if NSF hasn't been loaded</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetNumSongs()"><!-- --></A>
|
|
<A NAME="GetNumSongs"><!-- --></A>
|
|
<H3>GetNumSongs</H3>
|
|
<PRE>
|
|
public uint <B>GetNumSongs</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the total number of songs.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>number</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetPlayAddress()"><!-- --></A>
|
|
<A NAME="GetPlayAddress"><!-- --></A>
|
|
<H3>GetPlayAddress</H3>
|
|
<PRE>
|
|
public uint <B>GetPlayAddress</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the play-address.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>address</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="GetStartingSong()"><!-- --></A>
|
|
<A NAME="GetStartingSong"><!-- --></A>
|
|
<H3>GetStartingSong</H3>
|
|
<PRE>
|
|
public int <B>GetStartingSong</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Returns the starting song index.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>song index or NO_SONG if NSF hasn't been loaded</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="IsPlaying()"><!-- --></A>
|
|
<A NAME="IsPlaying"><!-- --></A>
|
|
<H3>IsPlaying</H3>
|
|
<PRE>
|
|
public bool <B>IsPlaying</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if a song is currently being played.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if playing</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="PlaySong()"><!-- --></A>
|
|
<A NAME="PlaySong"><!-- --></A>
|
|
<H3>PlaySong</H3>
|
|
<PRE>
|
|
public Result <B>PlaySong</B>() throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Plays current selected song.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SelectNextSong()"><!-- --></A>
|
|
<A NAME="SelectNextSong"><!-- --></A>
|
|
<H3>SelectNextSong</H3>
|
|
<PRE>
|
|
public Result <B>SelectNextSong</B>() throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Selects the next song.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SelectPrevSong()"><!-- --></A>
|
|
<A NAME="SelectPrevSong"><!-- --></A>
|
|
<H3>SelectPrevSong</H3>
|
|
<PRE>
|
|
public Result <B>SelectPrevSong</B>() throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Selects the previous song.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="SelectSong(uint)"><!-- --></A>
|
|
<A NAME="SelectSong"><!-- --></A>
|
|
<H3>SelectSong</H3>
|
|
<PRE>
|
|
public Result <B>SelectSong</B>( uint song ) throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Selects a song.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Parameters: </B><DD><code>song</code> - index</DD>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="StopSong()"><!-- --></A>
|
|
<A NAME="StopSong"><!-- --></A>
|
|
<H3>StopSong</H3>
|
|
<PRE>
|
|
public Result <B>StopSong</B>() throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Stops current selected song.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>result code</DD>
|
|
|
|
</DL>
|
|
|
|
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="UsesBankSwitching()"><!-- --></A>
|
|
<A NAME="UsesBankSwitching"><!-- --></A>
|
|
<H3>UsesBankSwitching</H3>
|
|
<PRE>
|
|
public bool <B>UsesBankSwitching</B>() const throw();
|
|
</PRE>
|
|
<DL>
|
|
<DD>Checks if the NSF uses bank-switching.
|
|
</DD>
|
|
|
|
<DL>
|
|
|
|
<DT><B>Returns: </B><DD>true if NSF uses bank-switching</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..Nsf.html" target="_top"><B>NO FRAMES</B></a></FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top"><FONT SIZE="-2">
|
|
SUMMARY: INNER | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
|
|
|
|
</BODY>
|
|
|
|
</HTML>
|
|
|