Sound:play: Difference between revisions
From GiderosMobile
Created page with "__NOTOC__ '''Available since:''' Gideros 2011.6<br/> === Description === <br /> Creates a new `SoundChannel` object to play the sound. By using the retured `SoundChannel` obje..." |
m linked Sound Channel page |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2011.6<br/> | '''Available since:''' Gideros 2011.6<br/> | ||
'''Class:''' [[Sound]]<br/> | |||
=== 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 | <syntaxhighlight lang="lua"> | ||
you can stop the sound and monitor the position. | (SoundChannel) = Sound:play(startTime,looping,paused) | ||
< | </syntaxhighlight> | ||
(SoundChannel) | === Parameters === | ||
</ | '''startTime''': (number, default = 0) the initial position in milliseconds at which playback should start<br/> | ||
'''startTime | '''looping''': (boolean, default = false) <br/> | ||
'''looping | '''paused''': (boolean, default = false) <br/> | ||
'''paused | |||
'''Returns''' (SoundChannel) | === 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/> | |||
{{Sound}} | |||
Latest revision as of 18: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