C# Class SphereStudio.Plugins.SoundPicker

Inheritance: System.Windows.Forms.UserControl, IDockPane, IFileOpener, IStyleable
Exibir arquivo Open project: Radnen/spherestudio Class Usage Examples

Public Methods

Method Description
ForcePause ( ) : void

Forces pause on songs.

Open ( string fileName ) : DocumentView
PlayFile ( string path ) : void

Plays the song or sound located at the path's location.

PlayOrPauseMusic ( ) : void

Toggles between the playing and pausing of the current music file.

Refresh ( ) : void

Overrides the refresh method to re-add the music and sounds found in your project.

Reset ( ) : void

Resets the sound engine and clears the playlist.

SoundPicker ( IPluginMain plugin ) : System
StopMusic ( ) : void

Stops any currently playing music

UpdateStyle ( ) : void
WatchProject ( IProject game ) : void

Used by filesystem watcher to attempt to automatically add new additions to the sound list.

Protected Methods

Method Description
OnLoad ( EventArgs e ) : void
OnPaint ( PaintEventArgs e ) : void

Private Methods

Method Description
UpdateTrackList ( ) : void

Fills out the list with the music and sound files in your game path.

fileWatcher_Changed ( object sender, IEnumerable eAll ) : void
pauseTool_Click ( object sender, EventArgs e ) : void
playTimer_Tick ( object sender, EventArgs e ) : void
stopTool_Click ( object sender, EventArgs e ) : void
trackList_Click ( object sender, EventArgs e ) : void
trackList_DoubleClick ( object sender, EventArgs e ) : void
trackNameLabel_MouseClick ( object sender, MouseEventArgs e ) : void
trackNameLabel_Paint ( object sender, PaintEventArgs e ) : void

Method Details

ForcePause() public method

Forces pause on songs.
public ForcePause ( ) : void
return void

OnLoad() protected method

protected OnLoad ( EventArgs e ) : void
e System.EventArgs
return void

OnPaint() protected method

protected OnPaint ( PaintEventArgs e ) : void
e PaintEventArgs
return void

Open() public method

public Open ( string fileName ) : DocumentView
fileName string
return Sphere.Plugins.Views.DocumentView

PlayFile() public method

Plays the song or sound located at the path's location.
public PlayFile ( string path ) : void
path string The full path of the file to play.
return void

PlayOrPauseMusic() public method

Toggles between the playing and pausing of the current music file.
public PlayOrPauseMusic ( ) : void
return void

Refresh() public method

Overrides the refresh method to re-add the music and sounds found in your project.
public Refresh ( ) : void
return void

Reset() public method

Resets the sound engine and clears the playlist.
public Reset ( ) : void
return void

SoundPicker() public method

public SoundPicker ( IPluginMain plugin ) : System
plugin IPluginMain
return System

StopMusic() public method

Stops any currently playing music
public StopMusic ( ) : void
return void

UpdateStyle() public method

public UpdateStyle ( ) : void
return void

WatchProject() public method

Used by filesystem watcher to attempt to automatically add new additions to the sound list.
public WatchProject ( IProject game ) : void
game IProject
return void