Older Newer
Mon, 30 Dec 2019 14:08:22 . . . . SyneRyder [Reformat example code width for eBooks]


Changes by last author:

Added:
= playSoundWaveSync =

== Syntax ==

bool playSoundWaveSync(string filepath)

== Arguments ==

:filepath

:: The filename of the sound file to play.

== Return ==

Returns true if the file was played, false otherwise.

== Description ==

Plays a sound synchronously (ie the plugin will stop all operation until the sound has completed). The function first tries finding the sound file in the embedded plug-in resources, then tries searching the usual system folders for the sound file.

== Example ==

<code>

// Play an alert sound that stops

// all operations temporarily

playSoundWaveSync("awooga.wav");

</code>

== See Also ==

playSoundWave, playSoundWaveLoop