Audio Class

.NET Framework (current version)

Other Versions

Provides methods for playing sounds.

Namespace: Microsoft.VisualBasic.Devices
Assembly: Microsoft.VisualBasic (in Microsoft.VisualBasic.dll)

Inheritance Hierarchy

System::Object
Microsoft.VisualBasic.Devices::Audio

Syntax

C++

[HostProtectionAttribute(SecurityAction::LinkDemand, Resources = HostProtectionResource::ExternalProcessMgmt)]
public ref class Audio

Constructors

	Name	Description
	Audio()	Initializes a new instance of the Audio class.

Methods

	Name	Description
	Equals(Object^)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	Play(array<Byte>^, AudioPlayMode)	Plays a .wav sound file.
	Play(Stream^, AudioPlayMode)	Plays a .wav sound file.
	Play(String^)	Plays a .wav sound file.
	Play(String^, AudioPlayMode)	Plays a .wav sound file.
	PlaySystemSound(SystemSound^)	Plays a system sound.
	Stop()	Stops a sound playing in the background.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)

Remarks

You can use the My.Computer.Audio.Play and My.Computer.Audio.PlaySystemSound methods to play .wav sound files and system sounds.

For more information, see Playing Sounds (Visual Basic).

Availability by Project Type

Project type	Available
Windows Application	Yes
Class Library	Yes
Console Application	Yes
Windows Control Library	Yes
Web Control Library	No
Windows Service	Yes
Web Site	No

Examples

The My.Computer.Audio.Play method plays the specified sound in the background when AudioPlayMode.Background is specified.

Sub PlayBackgroundSoundFile()
    My.Computer.Audio.Play("C:\Waterfall.wav", 
        AudioPlayMode.WaitToComplete)
End Sub

This code can run only within a Windows Forms application.

The file name should reference a .wav sound file on your system.

To simplify the management of your sound files, consider storing the files as application resources. The files can then be accessed through the My.Resources object.

Version Information

.NET Framework
Available since 2.0

Thread Safety

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