Modifier

Partager via

SoundPlayer.LoadAsync Method

  • Reference

Definition

Namespace:
System.Media
Assembly:
System.Windows.Extensions.dll
Assembly:
System.dll
Package:
System.Windows.Extensions v8.0.0
Package:
System.Windows.Extensions v9.0.0-rc.2.24473.5
Source:
SoundPlayer.cs
Source:
SoundPlayer.cs
Source:
SoundPlayer.cs
Source:
SoundPlayer.cs

Loads a .wav file from a stream or a Web resource using a new thread.

public:
 void LoadAsync();
public void LoadAsync ();
member this.LoadAsync : unit -> unit
Public Sub LoadAsync ()

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 asynchronously load a .wav file for use by 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 = this->filepathTextbox->Text;
   
   // Load the .wav file.
   player->LoadAsync();
}
catch ( Exception^ ex ) 
{
   ReportStatus( ex->Message );
}

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

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

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

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

Remarks

If a SoundPlayer is configured to load a .wav file from a Stream or Web resource, this method begins loading a .wav file from the location using a new thread.

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

If a SoundPlayer is configured to load a .wav file from a local file path, this method does nothing, because loading is deferred until playing begins.

For more information about asynchronous loading, see How to: Load a Sound Asynchronously within a Windows Form.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Load().

Applies to

See also