Global Command: startSound - Revision history

EK at 19:46, 4 May 2023

2023-05-04T19:46:23Z

EK: EK moved page StartSound (CMS) to Global Command: startSound

2023-05-04T19:38:32Z

EK moved page StartSound (CMS) to Global Command: startSound

EK at 19:38, 4 May 2023

2023-05-04T19:38:05Z

David Stoffel: Text replacement - "{{toc}}" to ""

2014-11-03T23:52:18Z

Text replacement - "{{toc}}" to ""

AFRLme at 17:03, 28 September 2014

2014-09-28T17:03:33Z

AFRLme: Created page with "{| class="toccolours mw-collapsible mw-collapsed ts" |- ! Function History |- | Available since v4.0 |} Allows you to play sound files; with optional property values. {|clas..."

2014-09-28T16:58:55Z

Created page with "{| class="toccolours mw-collapsible mw-collapsed ts" |- ! Function History |- | Available since v4.0 |} Allows you to play sound files; with optional property values. {|clas..."

New page

{| class="toccolours mw-collapsible mw-collapsed ts"
|-
! Function History
|-
| Available since v4.0
|}

Allows you to play sound files; with optional property values.
{|class="toccolours mw-collapsible mw-collapsed ts"
|-
! Additional Info
|-
| Properties currently available...
|-
| volume, balance, offset & loop
|-
|  
|-
| ''Please note that only mono sounds can be panned using the balance property; all stereo channel sounds will remain centered''.
|}

Syntax:
<syntaxhighlight>
startSound("filename", {flags=1, properties})
</syntaxhighlight>

Example 1: basic play audio file method
<syntaxhighlight>
startSound("vispath:sounds/example.ogg")
</syntaxhighlight>

Example 2: again with properties
<syntaxhighlight>
-- play example.ogg at 100% volume level, audio centered, from 1 second mark with loop mode on
startSound("vispath:sounds/example.ogg", {flags=1, volume=100, balance=0, offset=1000, loop=true})

--[[
let's say you have an audio file with a duration of 00:03:24 & you want to start the audio file at: 2 minutes & 44 seconds;
so what we need to do is convert minutes/seconds into ms like so: (2*60)*1000 + (44*1000) = 164000ms

math explanation:
2m*60s = 120 seconds * 1000ms = 120,000ms | 44s*1000ms = 44,000ms
120,000 + 44,000 = 164,000ms
--]]
</syntaxhighlight>

Arguments

filename: path 
The path to the audio file to be played; '''vispath:''' must be included at the beginning of the path.
<syntaxhighlight>"vispath:sounds/filename.type"</syntaxhighlight>

Flags

properties
* volume: allows you to set volume level via an integer value
* balance: allows you to set the left/right audio balance via an integer value (-100 to 100; 0 is centered)
* offset: allows you to start audio file from x time via an integer value (in ms)
* loop: allows you to declare if audio file should loop via a boolean value (true/false)

Return

none

{| class="ts"
|-
| '''Relevant Pages''': [[GetSoundId_(CMS)|getSoundId]] - [[GetSoundProperty_(CMS)|getSoundProperty]] - [[SetSoundProperty_(CMS)|setSoundProperty]] - [[StopSound_(CMS)|stopSound]] - [[ToggleSoundPause_(CMS)|toggleSoundPause]]
|}
{{toc}}

@@ Line 10: / Line 10: @@
 == Syntax ==
 <syntaxhighlight lang="lua">
-startSound(soundfile[, flags])
+startSound(soundfile [, flags])
 </syntaxhighlight>

@@ Line 1: / Line 1: @@
-{| class="toccolours mw-collapsible mw-collapsed ts"
+Play an audio file; optionally pass property values.
-|-
-! Function History
+{| class="ts"
 |-
-| Available since v4.0
+| style="width:15%" | Related functions
 |}
-Allows you to play sound files; with optional property values.
+== Syntax ==
-{|class="toccolours mw-collapsible mw-collapsed ts"
+<syntaxhighlight lang="lua">
 |-
-! Additional Info
+! style="width:15%" | Parameter
 |-
-| Properties currently available...
+| soundfile
 |-
-| volume, balance, offset & loop
+| rowspan="5" | flags
 |-
-| &nbsp;
+| balance (int)
 |-
-| ''Please note that only mono sounds can be panned using the balance property; all stereo channel sounds will remain centered''.
+| loop (bool)
 |}
-Syntax:
+== Return values ==
---[[
+== Examples ==
-math explanation:
+'''Example 1:''' Play an audio file and store the sound id for later use. Update the left/right balance of the sound while it is playing.
-m*60s = 120 seconds * 1000ms = 120,000ms | 44s*1000ms = 44,000ms
+<syntaxhighlight lang="lua">
-,000 + 44,000 = 164,000ms
+local mySoundId = startSound('vispath:sounds/example.ogg')
---]]
+setSoundProperty(mySoundId, {flags=1, balance=40})
 </syntaxhighlight>
+'''Example 2:''' Play an audio file and set balance, offset and volume.
-<span class="bold underline">Arguments</span>
+<syntaxhighlight lang="lua">
+startSound('vispath:sounds/example.ogg', {flags=1, balance=-10, offset=1000, volume=70})
-<span class="bold">filename</span>: path <br/>
+</syntaxhighlight>
-The path to the audio file to be played; '''vispath:''' must be included at the beginning of the path.
+{{toc}}

← Older revision		Revision as of 23:52, 3 November 2014
Line 74:		Line 74:
	\| '''Relevant Pages''': [[GetSoundId_(CMS)\|getSoundId]] - [[GetSoundProperty_(CMS)\|getSoundProperty]] - [[SetSoundProperty_(CMS)\|setSoundProperty]] - [[StopSound_(CMS)\|stopSound]] - [[ToggleSoundPause_(CMS)\|toggleSoundPause]]		\| '''Relevant Pages''': [[GetSoundId_(CMS)\|getSoundId]] - [[GetSoundProperty_(CMS)\|getSoundProperty]] - [[SetSoundProperty_(CMS)\|setSoundProperty]] - [[StopSound_(CMS)\|stopSound]] - [[ToggleSoundPause_(CMS)\|toggleSoundPause]]
	\|}		\|}
−	~~{{toc}}~~

@@ Line 54: / Line 54: @@
 <span class="bold">filename</span>: path <br/>
 The path to the audio file to be played; '''vispath:''' must be included at the beginning of the path.
-<syntaxhighlight>"vispath:sounds/filename.type"</syntaxhighlight>
+<syntaxhighlight>"vispath:path/filename.type"</syntaxhighlight>

← Older revision	Revision as of 19:38, 4 May 2023
(No difference)