media.playEventSound()

Type Function

Library media.*

Return value none

Revision Release 2024.3703

Keywords media, sound, event sound, audio

See also media.newEventSound()

media.playSound()

Because of various limitations outlined below, it is recommended that the audio library be used for playing back audio.

Overview

Plays an event sound (1-3 seconds). The first argument may be either an event sound ID or a filename for the event sound. This function is recommended for short sounds, especially to avoid performance hiccups.

Gotchas

There is no volume control API for event sounds. It is intended for alert sounds and the volume is controlled by the device’s hardware controls.
Supported audio formats vary per-platform. See the Audio Usage/Functions guide for details.
For Android devices, the sound should be preloaded with the media.newEventSound() API.

Syntax

media.playEventSound( sound [, baseDir] [, completionListener] )

sound _^(required)

Userdata or String. The first argument is either an event sound ID (from media.newEventSound()) or a filename for the event sound.

baseDir _^(optional)

Constant. If specified, this argument is the directory where the sound file is located, if you specified a filename for sound. The default is system.ResourceDirectory. Other options include:

system.DocumentsDirectory
system.ApplicationSupportDirectory
system.TemporaryDirectory
system.CachesDirectory

completionListener _^(optional)

Function. If specified, a listener function that will be called each time the event sound is played. Note, however, that Android does not support this functionality.

Example

local soundID = media.newEventSound( "beep.caf" )

local playBeep = function()
    media.playEventSound( soundID )
end

timer.performWithDelay( 7500, playBeep, 0 )

Type	Function
Library	media.*
Return value	none
Revision	Release 2024.3703
Keywords	media, sound, event sound, audio
See also	media.newEventSound()
	media.playSound()