Sound (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Windows management functions

Miscellaneous WINDEV functions

Sound

Presentation

Example

Stopping a non-locking sound

Size of sound files

Locking sound

Sound and component

See also

Sound (Function)

In french: Son

Plays a sound in WAV format. This sound can be:

stored on the disk.
included in the library (.WDL).
in an HFSQL memo.

Versions 16 and later
This function can also be used to:

play a system sound.
Versions 19 and later
play a sound of a given frequency for the desired time.
New in version 19
play a sound of a given frequency for the desired time.
play a sound of a given frequency for the desired time.

New in version 16
This function can also be used to:

play a system sound.
Versions 19 and later
play a sound of a given frequency for the desired time.
New in version 19
play a sound of a given frequency for the desired time.
play a sound of a given frequency for the desired time.

This function can also be used to:

play a system sound.
Versions 19 and later
play a sound of a given frequency for the desired time.
New in version 19
play a sound of a given frequency for the desired time.
play a sound of a given frequency for the desired time.

Remark: A sound card must be installed on the computer. The sound will be played according to the Windows settings (volume, balance, quality, etc.).

Versions 15 and later

This function is now available for Java applications.

New in version 15

This function is now available for Java applications.

Versions 16 and later

This function is now available for Android applications.

This function is now available for Windows Phone applications.

New in version 16

This function is now available for Android applications.

This function is now available for Windows Phone applications.

This function is now available for Android applications.

This function is now available for Windows Phone applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android widget mode.

New in version 18

This function is now available in Android widget mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Example

// Plays the sound found in the "TADA.WAV" file
Sound("Tada.wav")
// Plays while locking on sound card
Sound("tada.wav", soundWait)
// Plays while looping on sound card
Sound("C:\MSOFFICE\Sounds\Car.wav", soundLoop)

// Play the music.mp3 file included in the application
Sound("music.mp3")

Versions 19 and later

// Plays a sound of a given frequency
LOOP (10)
FOR nIndex = 1 TO 5536 STEP 100
Sound(nIndex, 1)
END
FOR nIndex = 5536 TO 1 STEP -100
Sound(nIndex, 1)
END
END

New in version 19

// Plays a sound of a given frequency
LOOP (10)
FOR nIndex = 1 TO 5536 STEP 100
Sound(nIndex, 1)
END
FOR nIndex = 5536 TO 1 STEP -100
Sound(nIndex, 1)
END
END

Syntax

Playing a .WAV file Hide the details

Sound(<Name of WAV file> [, <Option>])

<Name of WAV file>: Character string

Full or relative name of file to play. This file can be:
a WAV file.
Versions 16 and later
an audio file corresponding to all the formats supported by the OS (wav, mp3, 3gp, ogg, etc.). A summary of the supported audio files is available from the following address: http://developer.android.com/guide/appendix/media-formats.html.
Remarks:
Android does not support 32-bit wav files.
This parameter can correspond to a URL. In this case, it is necessary to add the INTERNET permission when generating the application.

New in version 16
an audio file corresponding to all the formats supported by the OS (wav, mp3, 3gp, ogg, etc.). A summary of the supported audio files is available from the following address: http://developer.android.com/guide/appendix/media-formats.html.
Remarks:
Android does not support 32-bit wav files.
This parameter can correspond to a URL. In this case, it is necessary to add the INTERNET permission when generating the application.

an audio file corresponding to all the formats supported by the OS (wav, mp3, 3gp, ogg, etc.). A summary of the supported audio files is available from the following address: http://developer.android.com/guide/appendix/media-formats.html.
Remarks:
Android does not support 32-bit wav files.
This parameter can correspond to a URL. In this case, it is necessary to add the INTERNET permission when generating the application.

Versions 17 and later
a file in wav format.
New in version 17
a file in wav format.
a file in wav format.
Versions 21 and later
a file in mp3, wav, wma or m4a format.
New in version 21
a file in mp3, wav, wma or m4a format.
a file in mp3, wav, wma or m4a format.
Remarks:
Versions 16 and later
You cannot directly play an audio file in a directory or in a subdirectory of the application. It is recommended to play the audio files on the storage card (use SysDirStorageCard to get the storage card path and SysStatusStorageCard to get its name).
The audio file to play can also be included in the application via the generation wizard. To play it, simply specify the file name (name + extension).
WAV files in HFSQL memo items cannot be played.
New in version 16
You cannot directly play an audio file in a directory or in a subdirectory of the application. It is recommended to play the audio files on the storage card (use SysDirStorageCard to get the storage card path and SysStatusStorageCard to get its name).
The audio file to play can also be included in the application via the generation wizard. To play it, simply specify the file name (name + extension).
WAV files in HFSQL memo items cannot be played.
You cannot directly play an audio file in a directory or in a subdirectory of the application. It is recommended to play the audio files on the storage card (use SysDirStorageCard to get the storage card path and SysStatusStorageCard to get its name).
The audio file to play can also be included in the application via the generation wizard. To play it, simply specify the file name (name + extension).
WAV files in HFSQL memo items cannot be played.

<Option>: Optional integer constant

Sound execution mode:
soundDefault
(Default value) The code continues to run as soon as the sound is started.
soundLoop The sound is played in a loop.
Caution: The file to play must be found on disk and not in the library (WDL file).
soundWait The code is locked as long as the sound is not entirely played.

Versions 16 and later

Playing a system sound Hide the details

Sound(<System sound>)

<System sound>: Constant

Preset system sound to play:
soundSystemAsterisk Asterisk system sound.
soundSystemClosing System sound for closing Windows.
soundSystemCriticalStop System sound corresponding to the critical shutdown of the system.
soundSystemDefault Default system sound (beep in most cases).
soundSystemExclamation Exclamation system sound.
soundSystemQuestion Question system sound.

New in version 16

Playing a system sound Hide the details

Sound(<System sound>)

<System sound>: Constant

Preset system sound to play:
soundSystemAsterisk Asterisk system sound.
soundSystemClosing System sound for closing Windows.
soundSystemCriticalStop System sound corresponding to the critical shutdown of the system.
soundSystemDefault Default system sound (beep in most cases).
soundSystemExclamation Exclamation system sound.
soundSystemQuestion Question system sound.

Playing a system sound Hide the details

Sound(<System sound>)

<System sound>: Constant

Preset system sound to play:
soundSystemAsterisk Asterisk system sound.
soundSystemClosing System sound for closing Windows.
soundSystemCriticalStop System sound corresponding to the critical shutdown of the system.
soundSystemDefault Default system sound (beep in most cases).
soundSystemExclamation Exclamation system sound.
soundSystemQuestion Question system sound.

Versions 19 and later

Playing a sound of a given frequency during the requested time Hide the details

<Result> = Sound(<Frequency> , <Duration>)

<Result>: Boolean

True if the sound was played,
False otherwise.
Remark: Until Windows 7, the sound is played on the inside speaker of the PC. From Windows 7, the sound is played on the sound card.

<Frequency>: Unsigned integer

Frequency of the sound in Hertz.
Remark: For the versions earlier than Windows 7, only the audible frequencies can be used (between 37 and 32767).

<Duration>: Unsigned integer

Duration (in milliseconds) during which the sound is played. Caution: the sound is locking. This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the duration in a readable format (e.g., 1 s or 10 ms).
New in version 23
the duration in a readable format (e.g., 1 s or 10 ms).
the duration in a readable format (e.g., 1 s or 10 ms).

New in version 19

Playing a sound of a given frequency during the requested time Hide the details

<Result> = Sound(<Frequency> , <Duration>)

<Result>: Boolean

True if the sound was played,
False otherwise.
Remark: Until Windows 7, the sound is played on the inside speaker of the PC. From Windows 7, the sound is played on the sound card.

<Frequency>: Unsigned integer

Frequency of the sound in Hertz.
Remark: For the versions earlier than Windows 7, only the audible frequencies can be used (between 37 and 32767).

<Duration>: Unsigned integer

Duration (in milliseconds) during which the sound is played. Caution: the sound is locking. This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the duration in a readable format (e.g., 1 s or 10 ms).
New in version 23
the duration in a readable format (e.g., 1 s or 10 ms).
the duration in a readable format (e.g., 1 s or 10 ms).

Playing a sound of a given frequency during the requested time Hide the details

<Result> = Sound(<Frequency> , <Duration>)

<Result>: Boolean

True if the sound was played,
False otherwise.
Remark: Until Windows 7, the sound is played on the inside speaker of the PC. From Windows 7, the sound is played on the sound card.

<Frequency>: Unsigned integer

Frequency of the sound in Hertz.
Remark: For the versions earlier than Windows 7, only the audible frequencies can be used (between 37 and 32767).

<Duration>: Unsigned integer

Duration (in milliseconds) during which the sound is played. Caution: the sound is locking. This parameter can correspond to:
an integer corresponding to the number of milliseconds,
a Duration variable,
Versions 23 and later
the duration in a readable format (e.g., 1 s or 10 ms).
New in version 23
the duration in a readable format (e.g., 1 s or 10 ms).
the duration in a readable format (e.g., 1 s or 10 ms).

Remarks

Stopping a non-locking sound

A sound played in non-locking mode can be stopped by the following code, called on a user action for example (click, control modification, etc.):

Sound("")

Size of sound files

Using large WAV files may trigger several problems (not enough RAM to load the sound, system stopped depending on the Windows version, etc.). For large ".WAV" files (several dozen megabytes), we recommend that you use the MCI functions.

Locking sound

A sound is necessarily locking:

If the sound is stored in a WINDEV library (.WDL file).
If the sound comes from a binary memo.

Sound and component

Sound is a non-blocking function by default. To use Sound in a component without locking the application, you must comply with the following constraints:

The file corresponding to the sound must not be found in the WDL or in the component.
The file corresponding to the sound must be found in the EXE directory of the application.

Business / UI classification: UI Code

Component: wd270obj.dll