View source for Global Command: toggleSoundPause

Toggle an active sound between playing and paused states.

{| class="ts"
|-
| style="width:15%" | Related functions
| [[Global Command: getSoundId|getSoundId]] | [[Global Command: getSoundProperty|getSoundProperty]] | [[Global Command: setSoundProperty|setSoundProperty]] | [[Global Command: startSound|startSound]] | [[Global Command: stopSound|stopSound]]
|}


== Syntax ==
<syntaxhighlight lang="lua">
toggleSoundPause(soundId)
</syntaxhighlight>


== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" | Type
! Description
|-
| soundId
| integer
| Id of the sound which should be paused/resumed.
|}


== Return values ==

{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| boolean
| True if sound was successfully paused/resumed, false otherwise.
|}


== Examples ==

'''Example 1:''' Toggle the pause state of an active sound.
<syntaxhighlight lang="lua">
-- Sound id can only be retrieved if the sound is active
local mySoundId = getSoundId('vispath:sounds/example.ogg')

toggleSoundPause(mySoundId)
</syntaxhighlight>
{{toc}}