Difference between revisions of "Sound:play"

From GiderosMobile
m
Line 16: Line 16:
 
=== Return values ===
 
=== 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/>
 
=== See also ===
 
'''[[Playing_Sound_and_Music]]'''
 
  
 
{{Sound}}
 
{{Sound}}

Revision as of 07:42, 5 September 2021

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