EK at 19:17, 4 May 2023

2023-05-04T19:17:01Z

EK at 18:56, 4 May 2023

2023-05-04T18:56:22Z

EK: Created page with "Retrieve various properties of a sound, such as: current playtime, balance, volume, loop. Only applicable for active sounds. {| class="ts" |- | style="width:15%" | Related fu..."

2023-05-04T18:51:26Z

Created page with "Retrieve various properties of a sound, such as: current playtime, balance, volume, loop. Only applicable for active sounds. {| class="ts" |- | style="width:15%" | Related fu..."

New page

Retrieve various properties of a sound, such as: current playtime, balance, volume, loop. Only applicable for active sounds.

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

== Syntax ==
<syntaxhighlight lang="lua">
getSoundProperty(soundId, property)
</syntaxhighlight>

== Parameters ==

{| class="ts"
|-
! style="width:15%" | Parameter
! style="width:10%" | Type
! style="width:15%" | Supported values
! Description
|-
| soundId
| integer
|
| Id of the sound to get property from.
|-
| rowspan="7" | property
| rowspan="7" | string
| "balance"
| Get the balance of audio channels.
|-
| "duration"
| Get the total length of the sound.
|-
| "loop"
| Check if the sound is looping.
|-
| "offset"
| Get the current playtime (position from the beginning of the sound).
|-
| "paused"
| Check if the sound is currently paused.
|-
| "playing"
| Check if the sound is currently playing.
|-
| "volume"
| Get the volume of the sound.
|}

== Return values ==

The return value depends on the passed "property" parameter:

{| class="ts"
|-
! style="width:15%" | Passed parameter
! style="width:15%" | Return type
! Description
|-
| "balance"
| integer
| Balance value in the range of -100 (100% left channel) to 100 (100% right channel). A value of 0 means 50% balance or balance could not be retrieved.
|-
| "duration"
| integer
| Total length of sound in milliseconds, or -1 if the duration could not be retrieved.
|-
| "loop"
| boolean
| True if the sound is looped, false if it is only played once or if the property could not be retrieved.
|-
| "offset"
| integer
| Current playtime of the sound in milliseconds, or -1 if the offset could not be retrieved.
|-
| "paused"
| boolean
| True if the sound is currently paused, false if it is playing or not active at all.
|-
| "playing"
| boolean
| True if the sound is currently playing, false otherwise.
|-
| "volume"
| integer
| Level of volume in the range of 0 (mute) to 100 (full volume). A value of -1 is returned, if the volume could not be retrieved.
|}

== Examples ==

'''Example 1:''' Store the current playtime of a sound in a variable.
<syntaxhighlight lang="lua">
local mySoundId = getSoundId("vispath:sounds/example.ogg")
local soundOffset = getSoundProperty(mySoundId, "offset")
</syntaxhighlight>
{{toc}}

@@ Line 95: / Line 95: @@
 == Examples ==
-'''Example 1:''' Store the current playtime of a sound in a variable.
+'''Example 1:''' Store the current playtime of an active sound in a variable.
 <syntaxhighlight lang="lua">
 local mySoundId = getSoundId("vispath:sounds/example.ogg")
 local soundOffset = getSoundProperty(mySoundId, "offset")
 </syntaxhighlight>
 {{toc}}

@@ Line 31: / Line 31: @@
 | rowspan="7" | string
 | "balance"
-| Get the balance of audio channels.
+| Get the left/right audio balance.
 |-
 | "duration"

Global Command: getSoundProperty - Revision history

EK at 19:17, 4 May 2023

EK at 18:56, 4 May 2023

EK: Created page with "Retrieve various properties of a sound, such as: current playtime, balance, volume, loop. Only applicable for active sounds. {| class="ts" |- | style="width:15%" | Related fu..."