beepSound

Typeproperty
DictionaryLCS
LibraryLiveCode Script
Syntax
set the beepSound to { <beepType> }
get the beepSound
Summary

Specifies the method used to produce sound when the beep command is used.

Introduced2.9
OSwindows, ios
Platformsdesktop, mobile
Example
set the beepSound to "system"
set the beepSound to "internal"
set the beepSound to "vibrate"
-- on iOS there is no default beep sound, so you have to set one.
on preopencard
    local tBeepPath
    put specialFolderPath("resources") & "/myBeepSound.m4a" into tBeepPath
    set the beepsound to tBeepPath
end preopencard
Values
NameTypeDescription
Value

(enum): A string describing the beep method.

  • system: The system standard alert sound is played (default).
  • internal: The computer's motherboard speaker is used (if present).
  • vibrate: The device vibrates rather than play a sound (iOS only).
RelatedCommand: mobileVibrate, beep
Description

Use the beepSound property to change the sound made when the beep command is used.

When the beep command is executed, LiveCode makes a sound using the method specified by the beepSound property.

Note: Setting the beepSound property only has an effect on the Windows desktop platform. On other desktop platforms the "system" method is used regardless of its setting.

Note: The iPhone does not have a default system alert sound so if a sound is required one must be specified using the beepSound property. On iOS, there is no default beep sound, so you have to set one. The sound file has to be included in the 'Copy Files' section of the standalone application settings. The audio file type must be m4a; other file types such as mp3 are not supported.

Important: If you use beep with beepSound set to "internal" be sure to test your program on the machines you will be running it on. Some Windows machines have faulty drivers for the motherboard speaker which can cause applications using it to crash.