Export (0) Print
Expand All

Audio.Play Method (String)

Plays a .wav sound file.

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

public void Play(
	string location
)

Parameters

location
Type: System.String

A String containing the name of the sound file

ExceptionCondition
ArgumentNullException

location is an empty string.

IOException

The user does not have sufficient permissions to access the file named by location.

DirectoryNotFoundException

The file path is malformed in location.

PathTooLongException

The path name in location is too long.

SecurityException

A partial-trust situation exists in which the user lacks necessary permissions.

The Play method plays the .wav sound file stored as a file at location, as a byte array in data, or as a stream in stream.

If the overload that takes only the location parameter is used, the Play method plays the sound in the background. Otherwise, the playMode parameter determines how the sound will play.

playMode

Description

AudioPlayMode.Background

Plays the sound in the background. The calling code continues to execute.

AudioPlayMode.BackgroundLoop

Plays the sound in the background until the Stop method is called. The calling code continues to execute.

AudioPlayMode.WaitToComplete

Plays the sound and waits until it completes before the calling code continues.

Background playing lets the application execute other code while the sound plays.

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

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

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

This code example can only run 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. They can then be accessed through the My.Resources object.

.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

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft