Difference between revisions of "Sound:play"
From GiderosMobile
| Line 9: | Line 9: | ||
(SoundChannel) = Sound:play(startTime,looping,paused) | (SoundChannel) = Sound:play(startTime,looping,paused) | ||
</source> | </source> | ||
| − | '''startTime''': (number, default = 0) The initial position in milliseconds at which playback should start. | + | === Parameters === |
| − | '''looping''': (boolean, default = false) | + | '''startTime''': (number, default = 0) The initial position in milliseconds at which playback should start. <br/> |
| − | '''paused''': (boolean, default = false) | + | '''looping''': (boolean, default = false) <br/> |
| + | '''paused''': (boolean, default = false) <br/> | ||
| + | === 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/> | ||
Revision as of 10:44, 23 August 2018
Available since: Gideros 2011.6
Description
Creates a new `SoundChannel` object to play the sound. By using the retured `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.
