Difference between revisions of "Sound:play"
From GiderosMobile
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | '''Available since:''' Gideros 2011.6<br/> | + | '''<translate>Available since</translate>:''' Gideros 2011.6<br/> |
| − | === Description === | + | === <translate>Description</translate> === |
<translate><br /> | <translate><br /> | ||
Creates a new [[Special:MyLanguage/SoundChannel|SoundChannel]] object to play the sound. By using the retured [[Special:MyLanguage/SoundChannel|SoundChannel]] object,<br /> | Creates a new [[Special:MyLanguage/SoundChannel|SoundChannel]] object to play the sound. By using the retured [[Special:MyLanguage/SoundChannel|SoundChannel]] object,<br /> | ||
| Line 9: | Line 9: | ||
(SoundChannel) = Sound:play(startTime,looping,paused) | (SoundChannel) = Sound:play(startTime,looping,paused) | ||
</source> | </source> | ||
| − | === Parameters === | + | === <translate>Parameters</translate> === |
'''startTime''': (number, default = 0) <translate>The initial position in milliseconds at which playback should start.</translate> <br/> | '''startTime''': (number, default = 0) <translate>The initial position in milliseconds at which playback should start.</translate> <br/> | ||
'''looping''': (boolean, default = false) <translate></translate> <br/> | '''looping''': (boolean, default = false) <translate></translate> <br/> | ||
'''paused''': (boolean, default = false) <translate></translate> <br/> | '''paused''': (boolean, default = false) <translate></translate> <br/> | ||
| − | === Return values === | + | === <translate>Return values</translate> === |
| − | '''Returns''' (SoundChannel) <translate>A [[Special:MyLanguage/SoundChannel|SoundChannel]] object, which you use to control the sound. This function returns [[Special:MyLanguage/nil|nil]] if you run out of available sound channels.</translate><br/> | + | '''<translate>Returns</translate>''' (SoundChannel) <translate>A [[Special:MyLanguage/SoundChannel|SoundChannel]] object, which you use to control the sound. This function returns [[Special:MyLanguage/nil|nil]] if you run out of available sound channels.</translate><br/> |
Revision as of 08:27, 24 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.
