Difference between revisions of "GetSoundId (CMS)"
From The Official Visionaire Studio: Adventure Game Engine Wiki
m (Text replacement - "{{toc}}" to "") |
|||
| Line 45: | Line 45: | ||
| '''Relevant Pages''': [[GetSoundProperty_(CMS)|getSoundProperty]] - [[SetSoundProperty_(CMS)|setSoundProperty]] - [[StartSound_(CMS)|startSound]] - [[StopSound_(CMS)|stopSound]] - [[ToggleSoundPause_(CMS)|toggleSoundPause]] | | '''Relevant Pages''': [[GetSoundProperty_(CMS)|getSoundProperty]] - [[SetSoundProperty_(CMS)|setSoundProperty]] - [[StartSound_(CMS)|startSound]] - [[StopSound_(CMS)|stopSound]] - [[ToggleSoundPause_(CMS)|toggleSoundPause]] | ||
|} | |} | ||
| − | |||
Revision as of 01:50, 4 November 2014
| Function History |
|---|
| Available since v4.0 |
Use this to store the sound.id for an audio file into a variable; which you can use to stop/pause/resume or edit the linked sounds properties.
Syntax:
getSoundId("filename")
Example:
-- let's store the sound ID into a variable for later use
local soundID = getSoundId("vispath:sounds/example.ogg")
Arguments
filename: path
The path to the audio file whose ID we want to obtain; vispath: must be included at the beginning of the path.
"vispath:path/filename.type"
Flags
none
Return
id
Returns the sound ID as an integer value.
| Relevant Pages: getSoundProperty - setSoundProperty - startSound - stopSound - toggleSoundPause |
