Difference between revisions of "Sound:play"
From GiderosMobile
m (Text replacement - "<source" to "<syntaxhighlight") |
m (Text replacement - "</source>" to "</syntaxhighlight>") |
||
Line 7: | Line 7: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
(SoundChannel) = Sound:play(startTime,looping,paused) | (SoundChannel) = Sound:play(startTime,looping,paused) | ||
− | </ | + | </syntaxhighlight> |
=== Parameters === | === Parameters === |
Revision as of 14:32, 13 July 2023
Available since: Gideros 2011.6
Class: Sound
Description
Creates a new SoundChannel object to play the sound. By using the returned SoundChannel object, you can stop the sound and monitor the position.
(SoundChannel) = Sound:play(startTime,looping,paused)
Parameters
startTime: (number, default = 0) the initial position in milliseconds at which playback should start
looping: (boolean, default = false)
paused: (boolean, default = false)
Return values
Returns (SoundChannel) a SoundChannel object which you use to control the sound. This function returns nil if you run out of available sound channels