Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

SoundPlayer Class

Controls playback of a sound from a .wav file.

Namespace:  System.Media
Assembly:  System (in System.dll)

[HostProtectionAttribute(SecurityAction.LinkDemand, UI = true)]
public class SoundPlayer : Component, 

The SoundPlayer type exposes the following members.

Public methodSoundPlayer()Initializes a new instance of the SoundPlayer class.
Public methodSoundPlayer(Stream)Initializes a new instance of the SoundPlayer class, and attaches the .wav file within the specified Stream.
Public methodSoundPlayer(String)Initializes a new instance of the SoundPlayer class, and attaches the specified .wav file.
Protected methodSoundPlayer(SerializationInfo, StreamingContext)Initializes a new instance of the SoundPlayer class.

Protected propertyCanRaiseEventsGets a value indicating whether the component can raise an event. (Inherited from Component.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Protected propertyDesignModeGets a value that indicates whether the Component is currently in design mode. (Inherited from Component.)
Protected propertyEventsGets the list of event handlers that are attached to this Component. (Inherited from Component.)
Public propertyIsLoadCompletedGets a value indicating whether loading of a .wav file has successfully completed.
Public propertyLoadTimeoutGets or sets the time, in milliseconds, in which the .wav file must load.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Public propertySoundLocationGets or sets the file path or URL of the .wav file to load.
Public propertyStreamGets or sets the Stream from which to load the .wav file.
Public propertyTagGets or sets the Object that contains data about the SoundPlayer.

Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeReleases unmanaged resources and performs other cleanup operations before the Component is reclaimed by garbage collection. (Inherited from Component.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodGetServiceReturns an object that represents a service provided by the Component or by its Container. (Inherited from Component.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodLoadLoads a sound synchronously.
Public methodLoadAsyncLoads a .wav file from a stream or a Web resource using a new thread.
Protected methodMemberwiseClone()Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodMemberwiseClone(Boolean)Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject.)
Protected methodOnLoadCompletedRaises the LoadCompleted event.
Protected methodOnSoundLocationChangedRaises the SoundLocationChanged event.
Protected methodOnStreamChangedRaises the StreamChanged event.
Public methodPlayPlays the .wav file using a new thread, and loads the .wav file first if it has not been loaded.
Public methodPlayLoopingPlays and loops the .wav file using a new thread, and loads the .wav file first if it has not been loaded.
Public methodPlaySyncPlays the .wav file and loads the .wav file first if it has not been loaded.
Public methodStopStops playback of the sound if playback is occurring.
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)

Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Public eventLoadCompletedOccurs when a .wav file has been successfully or unsuccessfully loaded.
Public eventSoundLocationChangedOccurs when a new audio source path for this SoundPlayer has been set.
Public eventStreamChangedOccurs when a new Stream audio source for this SoundPlayer has been set.

Explicit interface implemetationPrivate methodISerializable.GetObjectDataFor a description of this member, see the ISerializable.GetObjectData method.

The SoundPlayer class provides a simple interface for loading and playing a .wav file. The SoundPlayer class supports loading a .wav file from a file path, a URL, a Stream that contains a .wav file, or an embedded resource that contains a .wav file.

To play a sound using the SoundPlayer class, configure a SoundPlayer with a path to the .wav file and call one of the play methods. You can identify the .wav file to play by using one of the constructors or by setting either the SoundLocation or Stream property. The file can be loaded prior to playing by using one of the load methods, or loading can be deferred until one of the play methods is called. A SoundPlayer configured to load a .wav file from a Stream or URL must load the .wav file into memory before playback begins.

You can load or play a .wav file synchronously or asynchronously. If you call a synchronous load or play method, the calling thread will wait until the method returns, which may cause painting and other events to be interrupted. Calling an asynchronous load or play method will allow the calling thread to continue without interruption. For more information on asynchronous method calls, see How to: Run an Operation in the Background.

When a SoundPlayer has finished loading a .wav file, it raises the LoadCompleted event. You can examine the AsyncCompletedEventArgs in your event handler to determine if the load succeeded or failed. The SoundLocationChanged event is raised when the audio source is set to a new file path or URL. The StreamChanged event is raised when the audio source is set to a new Stream. For more information about handling events, see Consuming Events.

For more information about SoundPlayer, see SoundPlayer Class Overview.


   The SoundPlayer class cannot play other file types, such as .wma or .mp3. If you want to play other file types, you can use the Windows Media Player control. For more information, see Using the Windows Media Player Control in a .NET Framework Solution and Windows Media Player Object Model Reference for Visual Basic .NET and C# in the Windows Media Player SDK.


The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: UI. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following code example demonstrates the use of the SoundPlayer class for playing .wav files from a local path or a Uniform Resource Identifier (URI).

using System;
using System.Collections;
using System.ComponentModel;
using System.Diagnostics;
using System.Drawing;
using System.Media;
using System.Windows.Forms;

namespace SoundApiExample
    public class SoundTestForm : System.Windows.Forms.Form
        private System.Windows.Forms.Label label1;
        private System.Windows.Forms.TextBox filepathTextbox;        
        private System.Windows.Forms.Button playOnceSyncButton;
        private System.Windows.Forms.Button playOnceAsyncButton;
        private System.Windows.Forms.Button playLoopAsyncButton;
        private System.Windows.Forms.Button selectFileButton;

        private System.Windows.Forms.Button stopButton;
        private System.Windows.Forms.StatusBar statusBar;
        private System.Windows.Forms.Button loadSyncButton;
        private System.Windows.Forms.Button loadAsyncButton;        
        private SoundPlayer player;

        public SoundTestForm()
            // Initialize Forms Designer generated code.
            // Disable playback controls until a valid .wav file  
            // is selected.

            // Set up the status bar and other controls.

            // Set up the SoundPlayer object.

        // Sets up the status bar and other controls. 
        private void InitializeControls()
            // Set up the status bar.
            StatusBarPanel panel = new StatusBarPanel();
            panel.BorderStyle = StatusBarPanelBorderStyle.Sunken;
            panel.Text = "Ready.";
            panel.AutoSize = StatusBarPanelAutoSize.Spring;
            this.statusBar.ShowPanels = true;

        // Sets up the SoundPlayer object. 
        private void InitializeSound()
            // Create an instance of the SoundPlayer class.
            player = new SoundPlayer();

            // Listen for the LoadCompleted event.
            player.LoadCompleted += new AsyncCompletedEventHandler(player_LoadCompleted);

            // Listen for the SoundLocationChanged event.
            player.SoundLocationChanged += new EventHandler(player_LocationChanged);

        private void selectFileButton_Click(object sender, 
            System.EventArgs e)
            // Create a new OpenFileDialog.
            OpenFileDialog dlg = new OpenFileDialog();

            // Make sure the dialog checks for existence of the  
            // selected file.
            dlg.CheckFileExists = true;

            // Allow selection of .wav files only.
            dlg.Filter = "WAV files (*.wav)|*.wav";
            dlg.DefaultExt = ".wav";

            // Activate the file selection dialog. 
            if (dlg.ShowDialog() == DialogResult.OK)
                // Get the selected file's path from the dialog. 
                this.filepathTextbox.Text = dlg.FileName;

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

        // Convenience method for setting message text in  
        // the status bar. 
        private void ReportStatus(string statusMessage)
            // If the caller passed in a message... 
            if ((statusMessage != null) && (statusMessage != String.Empty))
                // ...post the caller's message to the status bar. 
                this.statusBar.Panels[0].Text = statusMessage;

        // Enables and disables play controls. 
        private void EnablePlaybackControls(bool enabled)
            this.playOnceSyncButton.Enabled = enabled;
            this.playOnceAsyncButton.Enabled = enabled;
            this.playLoopAsyncButton.Enabled = enabled;
            this.stopButton.Enabled = enabled;

        private void filepathTextbox_TextChanged(object sender, 
            EventArgs e)
            // Disable playback controls until the new .wav is loaded.

        private void loadSyncButton_Click(object sender, 
            System.EventArgs e)
            // Disable playback controls until the .wav is  
            // successfully loaded. The LoadCompleted event  
            // handler will enable them.

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

                // Load the .wav file.
            catch (Exception ex)

        private void loadAsyncButton_Click(System.Object sender, 
            System.EventArgs e)
            // Disable playback controls until the .wav is  
            // successfully loaded. The LoadCompleted event  
            // handler will enable them.

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

                // Load the .wav file.
            catch (Exception ex)

        // Synchronously plays the selected .wav file once. 
        // If the file is large, UI response will be visibly  
        // affected. 
        private void playOnceSyncButton_Click(object sender, 
            System.EventArgs e)
            ReportStatus("Playing .wav file synchronously.");
            ReportStatus("Finished playing .wav file synchronously.");

        // Asynchronously plays the selected .wav file once. 
        private void playOnceAsyncButton_Click(object sender, 
            System.EventArgs e)
            ReportStatus("Playing .wav file asynchronously.");

        // Asynchronously plays the selected .wav file until the user 
        // clicks the Stop button. 
        private void playLoopAsyncButton_Click(object sender, 
            System.EventArgs e)
            ReportStatus("Looping .wav file asynchronously.");

        // Stops the currently playing .wav file, if any. 
        private void stopButton_Click(System.Object sender,
            System.EventArgs e)
            ReportStatus("Stopped by user.");

        // Handler for the LoadCompleted event. 
        private void player_LoadCompleted(object sender, 
            AsyncCompletedEventArgs e)
            string message = String.Format("LoadCompleted: {0}", 

        // Handler for the SoundLocationChanged event. 
        private void player_LocationChanged(object sender, EventArgs e)
            string message = String.Format("SoundLocationChanged: {0}", 

        private void playSoundFromResource(object sender, EventArgs e)
            System.Reflection.Assembly a = System.Reflection.Assembly.GetExecutingAssembly();
            System.IO.Stream s = a.GetManifestResourceStream("<AssemblyName>.chimes.wav");
            SoundPlayer player = new SoundPlayer(s);

        #region Windows Form Designer generated code
        private void InitializeComponent()
            this.filepathTextbox = new System.Windows.Forms.TextBox();
            this.selectFileButton = new System.Windows.Forms.Button();
            this.label1 = new System.Windows.Forms.Label();
            this.loadSyncButton = new System.Windows.Forms.Button();
            this.playOnceSyncButton = new System.Windows.Forms.Button();
            this.playOnceAsyncButton = new System.Windows.Forms.Button();
            this.stopButton = new System.Windows.Forms.Button();
            this.playLoopAsyncButton = new System.Windows.Forms.Button();
            this.statusBar = new System.Windows.Forms.StatusBar();
            this.loadAsyncButton = new System.Windows.Forms.Button();
            // filepathTextbox 
            this.filepathTextbox.Anchor = ((System.Windows.Forms.AnchorStyles)(((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Left) | System.Windows.Forms.AnchorStyles.Right)));
            this.filepathTextbox.Location = new System.Drawing.Point(7, 25);
            this.filepathTextbox.Name = "filepathTextbox";
            this.filepathTextbox.Size = new System.Drawing.Size(263, 20);
            this.filepathTextbox.TabIndex = 1;
            this.filepathTextbox.Text = "";
            this.filepathTextbox.TextChanged += new System.EventHandler(this.filepathTextbox_TextChanged);
            // selectFileButton 
            this.selectFileButton.Anchor = ((System.Windows.Forms.AnchorStyles)((System.Windows.Forms.AnchorStyles.Top | System.Windows.Forms.AnchorStyles.Right)));
            this.selectFileButton.Location = new System.Drawing.Point(276, 25);
            this.selectFileButton.Name = "selectFileButton";
            this.selectFileButton.Size = new System.Drawing.Size(23, 21);
            this.selectFileButton.TabIndex = 2;
            this.selectFileButton.Text = "...";
            this.selectFileButton.Click += new System.EventHandler(this.selectFileButton_Click);
            // label1 
            this.label1.Location = new System.Drawing.Point(7, 7);
            this.label1.Name = "label1";
            this.label1.Size = new System.Drawing.Size(145, 17);
            this.label1.TabIndex = 3;
            this.label1.Text = ".wav path or URL:";
            // loadSyncButton 
            this.loadSyncButton.Location = new System.Drawing.Point(7, 53);
            this.loadSyncButton.Name = "loadSyncButton";
            this.loadSyncButton.Size = new System.Drawing.Size(142, 23);
            this.loadSyncButton.TabIndex = 4;
            this.loadSyncButton.Text = "Load Synchronously";
            this.loadSyncButton.Click += new System.EventHandler(this.loadSyncButton_Click);
            // playOnceSyncButton 
            this.playOnceSyncButton.Location = new System.Drawing.Point(7, 86);
            this.playOnceSyncButton.Name = "playOnceSyncButton";
            this.playOnceSyncButton.Size = new System.Drawing.Size(142, 23);
            this.playOnceSyncButton.TabIndex = 5;
            this.playOnceSyncButton.Text = "Play Once Synchronously";
            this.playOnceSyncButton.Click += new System.EventHandler(this.playOnceSyncButton_Click);
            // playOnceAsyncButton 
            this.playOnceAsyncButton.Location = new System.Drawing.Point(149, 86);
            this.playOnceAsyncButton.Name = "playOnceAsyncButton";
            this.playOnceAsyncButton.Size = new System.Drawing.Size(147, 23);
            this.playOnceAsyncButton.TabIndex = 6;
            this.playOnceAsyncButton.Text = "Play Once Asynchronously";
            this.playOnceAsyncButton.Click += new System.EventHandler(this.playOnceAsyncButton_Click);
            // stopButton 
            this.stopButton.Location = new System.Drawing.Point(149, 109);
            this.stopButton.Name = "stopButton";
            this.stopButton.Size = new System.Drawing.Size(147, 23);
            this.stopButton.TabIndex = 7;
            this.stopButton.Text = "Stop";
            this.stopButton.Click += new System.EventHandler(this.stopButton_Click);
            // playLoopAsyncButton 
            this.playLoopAsyncButton.Location = new System.Drawing.Point(7, 109);
            this.playLoopAsyncButton.Name = "playLoopAsyncButton";
            this.playLoopAsyncButton.Size = new System.Drawing.Size(142, 23);
            this.playLoopAsyncButton.TabIndex = 8;
            this.playLoopAsyncButton.Text = "Loop Asynchronously";
            this.playLoopAsyncButton.Click += new System.EventHandler(this.playLoopAsyncButton_Click);
            // statusBar 
            this.statusBar.Location = new System.Drawing.Point(0, 146);
            this.statusBar.Name = "statusBar";
            this.statusBar.Size = new System.Drawing.Size(306, 22);
            this.statusBar.SizingGrip = false;
            this.statusBar.TabIndex = 9;
            this.statusBar.Text = "(no status)";
            // loadAsyncButton 
            this.loadAsyncButton.Location = new System.Drawing.Point(149, 53);
            this.loadAsyncButton.Name = "loadAsyncButton";
            this.loadAsyncButton.Size = new System.Drawing.Size(147, 23);
            this.loadAsyncButton.TabIndex = 10;
            this.loadAsyncButton.Text = "Load Asynchronously";
            this.loadAsyncButton.Click += new System.EventHandler(this.loadAsyncButton_Click);
            // SoundTestForm 
            this.ClientSize = new System.Drawing.Size(306, 168);
            this.MinimumSize = new System.Drawing.Size(310, 165);
            this.Name = "SoundTestForm";
            this.SizeGripStyle = System.Windows.Forms.SizeGripStyle.Show;
            this.Text = "Sound API Test Form";


        static void Main()
            Application.Run(new SoundTestForm());

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
© 2015 Microsoft