soundParams

From Bohemia Interactive Community
Revision as of 15:30, 24 February 2023 by Killzone Kid (talk | contribs) (Created page with "{{RV|type=command |game1= arma3 |version1= 2.14 |branch= dev |gr1= Sounds |descr= Returns various params for the given sound |s1= soundParams id |p1= id: Number -...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.14.

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
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

Examples

Example 1:
_params = soundParams 10;

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