Difference between revisions of "Sound:play"
From GiderosMobile
m |
m (linked Sound Channel page) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
=== Description === | === 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. | + | Creates a new '''[[SoundChannel]]''' object to play the sound. By using the returned '''SoundChannel''' object, you can stop the sound and monitor the position. |
| − | < | + | <syntaxhighlight lang="lua"> |
(SoundChannel) = Sound:play(startTime,looping,paused) | (SoundChannel) = Sound:play(startTime,looping,paused) | ||
| − | </ | + | </syntaxhighlight> |
=== Parameters === | === Parameters === | ||
| Line 16: | Line 16: | ||
=== Return values === | === 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<br/> | '''Returns''' (SoundChannel) a SoundChannel object which you use to control the sound. This function returns ''nil'' if you run out of available sound channels<br/> | ||
| − | |||
| − | |||
| − | |||
{{Sound}} | {{Sound}} | ||
Latest revision as of 20:32, 7 January 2024
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
