soundParams: Difference between revisions
Killzone Kid (talk | contribs) No edit summary |
Killzone Kid (talk | contribs) No edit summary |
||
| Line 18: | Line 18: | ||
* time: [[Number]] - time passed since the start of playback | * time: [[Number]] - time passed since the start of playback | ||
* volume: [[Number]] - playback volume | * volume: [[Number]] - playback volume | ||
* loop: [[Boolean]] - the sound is looping (Since Arma3 2.22) | * loop: [[Boolean]] - [[true]] if the sound is looping (Since Arma3 2.22) | ||
Or if id is -1 - [[Array]] in format [sid1, sid2, sid3..., sidn], where sid is sound id returned by [[playSoundUI]] and [[playSound3D]] (Since Arma3 2.22) | Or if id is -1 - [[Array]] in format [sid1, sid2, sid3..., sidn], where sid is sound id returned by [[playSoundUI]] and [[playSound3D]] (Since Arma3 2.22) | ||
Revision as of 18:17, 21 November 2025
Description
- Description:
- Returns various params for the given sound
- Groups:
- Sounds
Syntax
- Syntax:
- soundParams id
- Parameters:
- id: Number - id returned by playSoundUI and playSound3D commands, -1 to return all currenttly playing ids (Since Arma3 2.22)
- Return Value:
- Array in format [path, curPos, length, time, volume], where:
- path: String - the path to the played sound file
- curPos: Number - current play position in 0...1 range
- length: Number - total sound duration in seconds
- time: Number - time passed since the start of playback
- volume: Number - playback volume
- loop: Boolean - true if the sound is looping (Since Arma3 2.22)
Examples
- Example 1:
Additional Information
- See also:
- playSoundUI playSound3D stopSound
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
- Posted on May 14, 2023 - 13:57 (UTC)
- Wait for sound to end: