soundParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(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 -...")
 
(2.12 mini-update)
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:


|game1= arma3
|game1= arma3
|version1= 2.14
|version1= 2.12
|branch= dev


|gr1= Sounds
|gr1= Sounds
Line 22: Line 21:
|x1= <sqf>_params = soundParams 10;</sqf>
|x1= <sqf>_params = soundParams 10;</sqf>


|seealso= [[playSoundUI]] [[playSound3D]] [[stopSound]]
|seealso= [[playSoundUI]] [[playSound3D]] [[stopSound]]
}}
 
{{Note
|user= Hypoxic125
|timestamp= 20230514135752
|text= Wait for sound to end:
 
<sqf>
private _sound = playSound3D ["A3\Sounds_F\sfx\blip1.wss", player];
waitUntil { soundParams _sound isEqualTo [] };
</sqf>
}}
}}

Latest revision as of 14:35, 20 July 2023

Hover & click on the images for description

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
Hypoxic125 - c
Posted on May 14, 2023 - 13:57 (UTC)
Wait for sound to end:
private _sound = playSound3D ["A3\Sounds_F\sfx\blip1.wss", player]; waitUntil { soundParams _sound isEqualTo [] };