EK: Created page with "Set properties of a sound. {| class="ts" |- | style="width:15%" | Related functions | getSoundId | Global Command: getSoundProperty|getSoundP..."

2023-05-04T19:16:13Z

Created page with "Set properties of a sound. {| class="ts" |- | style="width:15%" | Related functions | getSoundId | Global Command: getSoundProperty|getSoundP..."

New page

Set properties of a sound.

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

== Syntax ==
<syntaxhighlight lang="lua">
setSoundProperty(soundId, flags)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:15%" colspan="2" | Type/Structure
! Description
|-
| soundId
| colspan="2" | integer
| Id of the sound to set the properties.
|-
| rowspan="5" | flags
| rowspan="5" | table
| flags = 1
| indicates flags table
|-
| balance (int)
| Set left/right audio balance value in the range of -100 (100% left channel) to 100 (100% right channel).
|-
| loop (bool)
| Set to true to loop the sound.
|-
| offset (int)
| Set the playtime position in milliseconds.
|-
| volume (int)
| Set the volume in the range of 0 (mute) to 100 (full volume).
|}

== Return values ==

{| class="ts"
|-
! style="width:15%" | Type
! Description
|-
| boolean
| True if properties were set successfully, false if setting failed.
|}

== Examples ==

'''Example 1:''' Set the properties 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")

setSoundProperty(mySoundId, {flags=1, balance=20, loop=true, offset=100, volume=80})
</syntaxhighlight>
{{toc}}

Global Command: setSoundProperty - Revision history

EK: Created page with "Set properties of a sound. {| class="ts" |- | style="width:15%" | Related functions | getSoundId | Global Command: getSoundProperty|getSoundP..."