first commit
This commit is contained in:
Jose Caban
370
trunk/bin/Release/SoundEngine.xml
Normal file
370
trunk/bin/Release/SoundEngine.xml
Normal file
@@ -0,0 +1,370 @@
|
||||
<?xml version="1.0"?>
|
||||
<doc>
|
||||
<assembly>
|
||||
<name>Icarus.SoundEngine</name>
|
||||
</assembly>
|
||||
<members>
|
||||
<member name="T:Icarus.SoundEngine.MusicStream">
|
||||
<summary>
|
||||
Manages and plays an audio file
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.MusicStream.settings">
|
||||
<summary>
|
||||
Reference to singleton SoundSettings class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.MusicStream.mp3Player">
|
||||
<summary>
|
||||
Responsible for MP3 music playback.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.MusicStream.musicLoopThread">
|
||||
<summary>
|
||||
Thread that sleeps the duration a song plays, and replays the music file.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.MusicStream.musicFilename">
|
||||
<summary>
|
||||
Music filename to be replayed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.MusicStream.duration">
|
||||
<summary>
|
||||
Duration a music file has left to play.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.MusicStream.looping">
|
||||
<summary>
|
||||
Whether or not the music file being played should loop.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.SetVolume(System.Int32)">
|
||||
<summary>
|
||||
Sets the volume this music stream should play at.
|
||||
</summary>
|
||||
<param name="vol">Volume to play at.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.Loop(System.Boolean)">
|
||||
<summary>
|
||||
Sets whether or not this music stream should loop.
|
||||
</summary>
|
||||
<param name="loop">Whether or not this music stream should loop.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.#ctor">
|
||||
<summary>
|
||||
Generate a new Music Stream
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.WaitAndLoop">
|
||||
<summary>
|
||||
Used by a newly created thread to loop music.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.PlayMusic(System.String)">
|
||||
<summary>
|
||||
Plays the music file looping at the established volume.
|
||||
</summary>
|
||||
<param name="filename">Music file to be played.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.PlayMusic(System.String,System.Boolean)">
|
||||
<summary>
|
||||
Plays the music file at the established volume.
|
||||
</summary>
|
||||
<param name="filename">Music file to be played.</param>
|
||||
<param name="loop">Whether or not the file will be played looping.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.PlayMusic">
|
||||
<summary>
|
||||
Plays the established music file at the established music volume.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.StopMusic">
|
||||
<summary>
|
||||
Stops any currently playing music.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.MusicStream.PauseMusic">
|
||||
<summary>
|
||||
Pauses music when music is currently playing.
|
||||
Resumes music when music is paused.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.SoundEngine.MusicStream.gs_musicFilename">
|
||||
<summary>
|
||||
This sets and accesses the filename for this music stream.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Icarus.SoundEngine.SoundEngine">
|
||||
<summary>
|
||||
The SoundEngine of Icarus Game Engine.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundEngine.settings">
|
||||
<summary>
|
||||
Reference to singleton SoundSettings class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundEngine.currentFreeBuffer">
|
||||
<summary>
|
||||
Reference to next available SoundBuffer.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundEngine.engineDevice">
|
||||
<summary>
|
||||
The device for the SoundEngine.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundEngine.overlay">
|
||||
<summary>
|
||||
Overlays that plays music.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundEngine.mSoundCache">
|
||||
<summary>
|
||||
The cache of sounds to keep loaded.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundEngine.instance">
|
||||
<summary>
|
||||
The singleton class instance of this class.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.#ctor">
|
||||
<summary>
|
||||
Private singleton constructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.Initialize(System.Windows.Forms.Control)">
|
||||
<summary>
|
||||
Initializes the Device for the SoundEngine.
|
||||
</summary>
|
||||
<returns>Returns true if successful, false if failed.</returns>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.SetSoundVolume(System.Int32)">
|
||||
<summary>
|
||||
Sets the volume for game sounds.
|
||||
</summary>
|
||||
<param name="vol">Volume for sounds.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.GetSoundVolume">
|
||||
<summary>
|
||||
Accessor for the current volume for sounds.
|
||||
</summary>
|
||||
<returns>Volume for sounds.</returns>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.SetMusicVolume(System.Int32)">
|
||||
<summary>
|
||||
Sets the volume for game music.
|
||||
</summary>
|
||||
<param name="vol">Volume for music.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.GetMusicVolume">
|
||||
<summary>
|
||||
Accessor for the current volume for music.
|
||||
</summary>
|
||||
<returns>Volume for music.</returns>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.PlayRandomSoundFrom(System.String)">
|
||||
<summary>
|
||||
Plays a random sound from the directory specified.
|
||||
</summary>
|
||||
<param name="dirId"></param>
|
||||
<returns></returns>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.PlaySound(System.String)">
|
||||
<summary>
|
||||
Plays the sound file at the established sound volume.
|
||||
</summary>
|
||||
<param name="sndFile">File to be played.</param>
|
||||
<returns> true if successful, false if failed.</returns>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.PlayMusic">
|
||||
<summary>
|
||||
Plays all streams currently loaded with music.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.SetMusicFromId(System.String)">
|
||||
<summary>
|
||||
Sets the music to be played from the id of the music file. Note that all other music will be stopped and cleared. This music will be set up, but playing won't be started yet.
|
||||
</summary>
|
||||
<param name="id"></param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.PlayMusic(System.String,System.Int32)">
|
||||
<summary>
|
||||
Plays the music file on the specified MusicStream overlay.
|
||||
</summary>
|
||||
<param name="filename">File to be played.</param>
|
||||
<param name="stream">Stream to be played on.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.StopMusic">
|
||||
<summary>
|
||||
Stops all currently playing music.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.StopMusic(System.Int32)">
|
||||
<summary>
|
||||
Stops currently playing music on the specified MusicStream overlay.
|
||||
</summary>
|
||||
<param name="stream">Stream to be played on.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.PauseMusic">
|
||||
<summary>
|
||||
Pauses all currently playing music. DOES NOT RESUME.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.PauseMusic(System.Int32)">
|
||||
<summary>
|
||||
Pauses music when music is currently playing and resumes music when music
|
||||
is paused on the specified MusicStream overlay.
|
||||
</summary>
|
||||
<param name="stream">Stream to be paused on.</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.ClearMusic">
|
||||
<summary>
|
||||
Stops and clears out all music buffers.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.getStreamFilename(System.Int32)">
|
||||
<summary>
|
||||
Gets the filename of the specified music stream.
|
||||
</summary>
|
||||
<param name="stream">Stream to be requested.</param>
|
||||
<returns>Music file name of the stream.</returns>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.SetNextFileOnStream(System.String,System.Int32)">
|
||||
<summary>
|
||||
Set the next file to stream
|
||||
</summary>
|
||||
<param name="filename">fileName of the next file</param>
|
||||
<param name="stream">stream to play on</param>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundEngine.RemoveStream(System.Int32)">
|
||||
<summary>
|
||||
Cleans out and removes a single music stream.
|
||||
</summary>
|
||||
<param name="stream">Stream to be removed.</param>
|
||||
</member>
|
||||
<member name="P:Icarus.SoundEngine.SoundEngine.Instance">
|
||||
<summary>
|
||||
Accessor/Modifier for the singleton class instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Icarus.SoundEngine.SoundSettings">
|
||||
<summary>
|
||||
I am a singleton which can be used to retrieve Sound Engine settings.
|
||||
Members are straightforward to access.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundSettings.instance">
|
||||
<summary>
|
||||
Singleton instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundSettings.n_soundEffects">
|
||||
<summary>
|
||||
Maximum number of sound effects that can be simultaneously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundSettings.n_bgMusic">
|
||||
<summary>
|
||||
Maximum number of background music files that can be played simultaneously.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundSettings.soundVolume">
|
||||
<summary>
|
||||
Volume for sound, ranging from 0 to 100.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundSettings.musicVolume">
|
||||
<summary>
|
||||
Volume for music, ranging from 0 to 100.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundSettings.#ctor">
|
||||
<summary>
|
||||
Initializes the Sound Settings to the default values for the Game Engine.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundSettings.#ctor(System.String)">
|
||||
<summary>
|
||||
Load the Sound Settings from fileName.
|
||||
Loads defaults then overwrites them with values in File.
|
||||
</summary>
|
||||
<param name="fileName">Name of File to load</param>
|
||||
</member>
|
||||
<member name="P:Icarus.SoundEngine.SoundSettings.Instance">
|
||||
<summary>
|
||||
Accessor/Modifier for singleton instance.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.SoundEngine.SoundSettings.gs_n_soundEffects">
|
||||
<summary>
|
||||
This sets and accesses the GLOBAL maximum number of
|
||||
sound effects that can be played.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.SoundEngine.SoundSettings.gs_n_bgMusic">
|
||||
<summary>
|
||||
This sets and accesses the GLOBAL maximum number of
|
||||
background music files that can be played.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.SoundEngine.SoundSettings.gs_soundVolume">
|
||||
<summary>
|
||||
This sets and accesses the GLOBAL value of volume for sound effects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:Icarus.SoundEngine.SoundSettings.gs_musicVolume">
|
||||
<summary>
|
||||
This sets and accesses the GLOBAL value of volume for background music.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:Icarus.SoundEngine.SoundTester">
|
||||
<summary>
|
||||
Summary description for SoundTester.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundTester.PathSoundFile">
|
||||
<summary>
|
||||
Generic file path name holder for loading music and sound effects.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundTester.engine">
|
||||
<summary>
|
||||
The reference to the singleton SoundEngine.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundTester.selectedOverlay">
|
||||
<summary>
|
||||
Currently selected overlay stream being manipulated.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:Icarus.SoundEngine.SoundTester.components">
|
||||
<summary>
|
||||
Required designer variable.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundTester.Main">
|
||||
<summary>
|
||||
Display the Sound Tester Form
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundTester.#ctor">
|
||||
<summary>
|
||||
Initialize the SoundTester form
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundTester.Dispose(System.Boolean)">
|
||||
<summary>
|
||||
Clean up any resources being used.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:Icarus.SoundEngine.SoundTester.InitializeComponent">
|
||||
<summary>
|
||||
Required method for Designer support - do not modify
|
||||
the contents of this method with the code editor.
|
||||
</summary>
|
||||
</member>
|
||||
</members>
|
||||
</doc>
|
||||
Reference in New Issue
Block a user