SoundPlayer.Load Method

Definition

Namespace:

System.Media

Assembly:

System.Windows.Extensions.dll

Loads a sound synchronously.

public:
 void Load();

public void Load ();

member this.Load : unit -> unit

Public Sub Load ()

Exceptions

TimeoutException

The elapsed time during loading exceeds the time, in milliseconds, specified by LoadTimeout.

FileNotFoundException

The file specified by SoundLocation cannot be found.

Examples

The following code example demonstrates the use of the LoadAsync method to attach a .wav file to an instance of the SoundPlayer class. This code example is part of a larger example provided for the SoundPlayer class.

try
{
   
   // Assign the selected file's path to 
   // the SoundPlayer object.  
   player->SoundLocation = filepathTextbox->Text;
   
   // Load the .wav file.
   player->Load();
}
catch ( Exception^ ex ) 
{
   ReportStatus( ex->Message );
}

try
{
    // Assign the selected file's path to 
    // the SoundPlayer object.  
    player.SoundLocation = filepathTextbox.Text;

    // Load the .wav file.
    player.Load();
}
catch (Exception ex)
{
    ReportStatus(ex.Message);
}

Try
    ' Assign the selected file's path to the SoundPlayer object.
    player.SoundLocation = filepathTextbox.Text

    ' Load the .wav file.
    player.Load()
Catch ex As Exception
    ReportStatus(ex.Message)
End Try

Remarks

The Load method uses the current thread to load a .wav file, preventing the thread from handling other messages until the load is complete.

Caution

The Load method may produce a delay while loading a large .wav file. In addition, painting and other events will be blocked until the load is completed. Use the LoadAsync method to load a sound asynchronously, which allows the calling thread to continue without interruption.

This method raises the LoadCompleted event when loading completes, even if the load was not successful.

See also

• LoadAsync()
• LoadCompleted
• SoundPlayer Class Overview (Windows Forms)