Difference between revisions of "Sound"

From GiderosMobile
(separated class methods from functions methods)
Line 23: Line 23:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== <translate>Methods</translate> ===
 
=== <translate>Methods</translate> ===
[[Special:MyLanguage/Sound.new|Sound.new]] ''<translate>creates a new Sound object</translate>''<br/><!-- GIDEROSMTD:Sound.new(filename) creates a new Sound object -->
+
[[Special:MyLanguage/Sound.new|Sound.new]] ''<translate>creates a new Sound object</translate>''<br/>
[[Special:MyLanguage/Sound.setListenerPosition|Sound.setListenerPosition]] <br/><!-- GIDEROSMTD:Sound.setListenerPosition(x,y,z,vx,vy,vz,dx,dy,dz,ux,uy,uz) -->
+
<!-- GIDEROSMTD:Sound.new(filename) creates a new Sound object -->
[[Special:MyLanguage/Sound:getLength|Sound:getLength]] <br/><!-- GIDEROSMTD:Sound:getLength()  -->
+
[[Special:MyLanguage/Sound.setListenerPosition|Sound.setListenerPosition]] <br/>
[[Special:MyLanguage/Sound:play|Sound:play]] ''<translate>creates a new SoundChannel object to play the sound</translate>''<br/><!-- GIDEROSMTD:Sound:play(startTime,looping,paused) creates a new SoundChannel object to play the sound -->
+
<!-- GIDEROSMTD:Sound.setListenerPosition(x,y,z,vx,vy,vz,dx,dy,dz,ux,uy,uz) -->
 +
 
 +
[[Special:MyLanguage/Sound:getLength|Sound:getLength]] <br/>
 +
<!-- GIDEROSMTD:Sound:getLength()  -->
 +
[[Special:MyLanguage/Sound:play|Sound:play]] ''<translate>creates a new SoundChannel object to play the sound</translate>''<br/>
 +
<!-- GIDEROSMTD:Sound:play(startTime,looping,paused) creates a new SoundChannel object to play the sound -->
  
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|

Revision as of 08:07, 5 January 2020


Supported platforms: Platform android.pngPlatform ios.pngPlatform mac.pngPlatform pc.pngPlatform html5.pngPlatform winrt.pngPlatform win32.png
Available since: Gideros 2011.6
Inherits from: Object

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

local sound = Sound.new("music.mp3")
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