Returns the name of the audio clip or sound file that is currently playing.
# Metadata
Platforms: desktop, server, mobile, mobile OS: mac, windows, linux, ios, android Introduced: 1.0 Security:
# Syntax
the sound
# Examples
the sound
wait until the sound is done
# Description
Use the sound function to synchronize other actions with sounds.
On desktop the sound function returns 'done' if no audio clip is playing. If an audio clip is playing the name of the audio clip is returned.
On iOS the sound function returns 'done' if there is no sound currently playing. If a sound is currently being played its filename is returned.
Sounds played with the beep command do not affect the value returned by the sound function.
# Tags
# See
- **command:** start, beep - **property:** soundChannel