Difference between revisions of "Sound:play"

From GiderosMobile
Line 4: Line 4:
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
Creates a new `SoundChannel` object to play the sound. By using the retured `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 />
 
you can stop the sound and monitor the position.<br />
 
you can stop the sound and monitor the position.<br />
 
<br /></translate>
 
<br /></translate>
Line 15: Line 15:
 
'''paused''': (boolean, default = false) <translate></translate> <br/>
 
'''paused''': (boolean, default = false) <translate></translate> <br/>
 
=== <translate>Return values</translate> ===
 
=== <translate>Return values</translate> ===
'''<translate>Returns</translate>''' (SoundChannel) <translate>A `SoundChannel` object, which you use to control the sound. This function returns `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 ''nil'' if you run out of available sound channels.</translate><br/>

Revision as of 10:35, 24 August 2018

Available since: Gideros 2011.6
Class: Sound

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.