Difference between revisions of "Sound"

From GiderosMobile
Line 2: Line 2:
 
'''Supported platforms:''' android, ios, mac, pc<br/>
 
'''Supported platforms:''' android, ios, mac, pc<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
=== Description ===
+
=== <translate>Description</translate> ===
 
<translate><br />
 
<translate><br />
 
The [[Special:MyLanguage/Sound|Sound]] class lets you load and play WAV, MP3, MOD, XM, S3M and IT sound files.<br />
 
The [[Special:MyLanguage/Sound|Sound]] class lets you load and play WAV, MP3, MOD, XM, S3M and IT sound files.<br />
Line 8: Line 8:
 
object.<br />
 
object.<br />
 
<br /></translate>
 
<br /></translate>
=== Examples ===
+
=== <translate>Examples</translate> ===
 
'''Example'''<br/>
 
'''Example'''<br/>
 
<source lang="lua">local sound = Sound.new(&quot;music.mp3&quot;)
 
<source lang="lua">local sound = Sound.new(&quot;music.mp3&quot;)
Line 18: Line 18:
 
{|-
 
{|-
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== Methods ===
+
=== <translate>Methods</translate> ===
 
[[Special:MyLanguage/Sound.new|Sound.new]] ''<translate>creates a new Sound object</translate>''<br/>
 
[[Special:MyLanguage/Sound.new|Sound.new]] ''<translate>creates a new Sound object</translate>''<br/>
 
[[Special:MyLanguage/Sound.setListenerPosition|Sound.setListenerPosition]] <br/>
 
[[Special:MyLanguage/Sound.setListenerPosition|Sound.setListenerPosition]] <br/>
Line 24: Line 24:
 
[[Special:MyLanguage/Sound:play|Sound:play]] ''<translate>creates a new SoundChannel object to play the sound</translate>''<br/>
 
[[Special:MyLanguage/Sound:play|Sound:play]] ''<translate>creates a new SoundChannel object to play the sound</translate>''<br/>
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
=== Events ===
+
=== <translate>Events</translate> ===
=== Constants ===
+
=== <translate>Constants</translate> ===
 
|}
 
|}

Revision as of 08:28, 24 August 2018

Supported platforms: android, ios, mac, pc
Available since: Gideros 2011.6

Description


The Sound class lets you load and play WAV, MP3, MOD, XM, S3M and IT sound files.
Control of the playing sound is performed through the SoundChannel
object.

Examples

Example

local sound = Sound.new(&quot;music.mp3&quot;)

local channel = sound:play()

-- after some time --
channel:stop()

Methods

Sound.new creates a new Sound object
Sound.setListenerPosition
Sound:getLength
Sound:play creates a new SoundChannel object to play the sound

Events

Constants