Difference between revisions of "Sound:play"

From GiderosMobile
Line 3: Line 3:
 
=== Description ===
 
=== Description ===
 
<translate><br />
 
<translate><br />
Creates a new [[[SoundChannel` object to play the sound. By using the retured `SoundChannel]]] object,<br />
+
Creates a new [[SoundChannel` object to play the sound. By using the retured `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 14: Line 14:
 
'''paused''': (boolean, default = false) <translate></translate> <br/>
 
'''paused''': (boolean, default = false) <translate></translate> <br/>
 
=== Return values ===
 
=== Return values ===
'''Returns''' (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/>
+
'''Returns''' (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/>

Revision as of 13:54, 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.