SoundLoader Class

Provides implementation for the loading of sounds.

Definition

public class SoundLoader: Object

Members Table

The following table lists the members exposed by the SoundLoader object. Click a tab on the left to choose the type of member you want to view.

Methods

Method	Description
Abort	Cancels the loading of a sound.
Equals	Overloaded. Compares two objects to determine if they are equal. (Inherited from Object)
GetHashCode	Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
Load	Loads a sound at a specified url.
OnStateChanged	Raises the StateChanged event.
PlayStream	Plays the sound stream located at the specified url.
ReferenceEquals	Determines whether the specified Object instances are the same instance. (Inherited from Object)
SoundLoader	Initializes a new instance of SoundLoader.
ToString	Returns a String that represents the current Object. (Inherited from Object)

Properties

Property	Description
BufferingDelay	Gets or sets the delay of buffering of the SoundLoader.
ContentLength	Gets the total size of the sound to load.
LoadedPercentage	Gets the loaded percentage of the sound.
LoadedSize	Gets the size of the sound already loaded.
Sound	Gets the Sound object to load.
State	Gets the state of the SoundLoader instance.

Events

Event	Description
StateChanged	Handles the changes of state of the SoundLoader instance.

Inheritance Hierarchy

Object

SoundLoader

Examples

Copy Code to Clipboard

// This sample shows how to create and use a SoundLoader instance.

 

using System;

using System.Audio;

using System.Drawing;

using System.Windows.Forms;

using System.Diagnostics;

 

namespace SampleSoundLoader

{

     public class Form1 : System.Windows.Forms.Form

     {

          private TextBox url;

          private Button load;

          private Button abort;

          private Button play;

          private TextBox log;

 

          private SoundLoader sdl = null;

 

          public Form1()

          {

               InitializeComponent();

          }

 

          private void InitializeComponent()

          {

               url= new TextBox();

               load= new Button();

               abort= new Button();

               play= new Button();

               log= new TextBox();

 

               this.SuspendLayout();

 

               url.Location= new Point(20, 20);

               url.Text= "";

               url.TextChanged += new EventHandler(on_text_changed);

               url.Width= 350;

 

               load.Location= new Point(20,url.Bottom+5);

               load.Text= "Load";

               load.Click += new EventHandler(on_load);

 

               abort.Location= new Point(load.Right+10,load.Top);

               abort.Text= "Abort";

               abort.Enabled= true;

               abort.Click += new EventHandler(on_abort);

 

               play.Location= new Point(abort.Right+10,abort.Top);

               play.Text= "Play";

               play.Enabled= true;

               play.Click += new EventHandler(on_play);

 

               log.Location= new Point(url.Left,abort.Bottom+10);

               log.Size= new Size( url.Width, 180 );

               log.Multiline= true;

               log.ScrollBars= ScrollBars.Vertical;

 

               abort.Enabled= false;

               load.Enabled= false;

               url.Enabled= true;

               play.Enabled= false;

 

               this.Controls.Add(url);

               this.Controls.Add(load);

               this.Controls.Add(abort);

               this.Controls.Add(play);

               this.Controls.Add(log);

 

               this.Text = "Form1";

               this.ResumeLayout(false);

          }

 

          void on_text_changed( object sender, EventArgs e )

          {

               load.Enabled= url.TextLength > 0;

               play.Enabled= url.TextLength > 0;

          }

 

          void on_play( object sender, EventArgs e )

          {

               Debug.Assert( sdl == null );

 

               sdl= new SoundLoader();

               sdl.PlayStream(url.Text);

               abort.Enabled= true;

               load.Enabled= false;

          }

 

          void on_load( object sender, EventArgs e )

          {

               Debug.Assert( sdl == null );

 

               sdl= new SoundLoader();

               sdl.StateChanged += new EventHandler(on_state_changed);

               print_msg("Loading: "+url.Text);

               sdl.Load(url.Text);

 

               abort.Enabled= true;

               play.Enabled= false;

               load.Enabled= false;

               url.Enabled= false;

          }

 

          void print_msg( string msg )

          {

               Debug.WriteLine(msg);

               log.AppendText( msg + "\n" );

               log.ScrollToBottom();

          }

 

          void on_state_changed( object sender, EventArgs e )

          {

               SoundLoader sdl= (SoundLoader) sender;

               switch( sdl.State )

               {

                case SoundLoaderState.Undefined:

                     print_msg("Undefined" );

                     break;

                case SoundLoaderState.Loading:

                     print_msg("Loading "+sdl.LoadedSize+"/"+sdl.ContentLength+" = "+sdl.LoadedPercentage+" ");

                     break;

                case SoundLoaderState.Completed:

                     print_msg("Completed");

                     break;

                case SoundLoaderState.Error:

                     print_msg("Error");

                     break;

               }

          }

 

          void on_abort( object sender, EventArgs e )

          {

               if( sdl == null )

                    return;

 

               sdl.Abort();

               reset();

          }

 

          void reset()

          {

               sdl= null;

               abort.Enabled= false;

               load.Enabled= true;

               play.Enabled= true;

               url.Enabled= true;

          }

 

          static void Main()

          {

               Application.Run( new Form1() );

          }

     }

}

 

Class Information

Namespace	System.Audio
Flash Library	corlib.scl
Flash Library Version	2.0.0.2466
Silverlight Library	System.Windows.Forms.dll