Difference between revisions of "Sound"

From GiderosMobile
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Supported platforms:''' android, ios, mac, pc<br/>
+
<languages />
'''Available since:''' Gideros 2011.6<br/>
+
<!-- GIDEROSOBJ:Sound -->
 +
'''<translate>Supported platforms</translate>:''' [[File:Platform android.png]][[File:Platform ios.png]][[File:Platform mac.png]][[File:Platform pc.png]][[File:Platform html5.png]][[File:Platform winrt.png]][[File:Platform win32.png]]<br/>
 +
'''<translate>Available since</translate>:''' Gideros 2011.6<br/>
 +
'''<translate>Inherits from</translate>:''' [[Special:MyLanguage/Object|Object]]<br/>
 +
 
 
=== <translate>Description</translate> ===
 
=== <translate>Description</translate> ===
<translate><br />
+
The [[Special:MyLanguage/Sound|Sound]] class lets you load and play WAV, MP3, MOD, XM, S3M and IT sound files.
The [[Special:MyLanguage/Sound|Sound]] class lets you load and play WAV, MP3, MOD, XM, S3M and IT sound files.<br />
+
 
Control of the playing sound is performed through the [[Special:MyLanguage/SoundChannel|SoundChannel]]<br />
+
Control of the playing sound is performed through the [[Special:MyLanguage/SoundChannel|SoundChannel]] object.
object.<br />
+
 
<br /></translate>
 
 
=== <translate>Examples</translate> ===
 
=== <translate>Examples</translate> ===
'''Example'''<br/>
+
<source lang="lua">
<source lang="lua">local sound = Sound.new(&quot;music.mp3&quot;)
+
local sound = Sound.new("music.mp3")
 
 
 
local channel = sound:play()
 
local channel = sound:play()
  
 
-- after some time --
 
-- after some time --
channel:stop()</source>
+
channel:stop()
 +
</source>
 +
 
 
{|-
 
{|-
 
| 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/>
 
[[Special:MyLanguage/Sound.new|Sound.new]] ''<translate>creates a new Sound object</translate>''<br/>
[[Special:MyLanguage/Sound.setListenerPosition|Sound.setListenerPosition]] <br/>
+
<!-- GIDEROSMTD:Sound.new(filename) creates a new Sound object -->
[[Special:MyLanguage/Sound:getLength|Sound:getLength]] <br/>
+
[[Special:MyLanguage/Sound.setListenerPosition|Sound.setListenerPosition]] ''Sets the position, velocity and orientation of the listener'' <br/>
 +
<!-- GIDEROSMTD:Sound.setListenerPosition(x,y,z,vx,vy,vz,dx,dy,dz,ux,uy,uz) Sets the position, velocity and orientation of the listener -->
 +
[[Special:MyLanguage/Sound:getLength|Sound:getLength]] ''Get the duration of this sound'' <br/>
 +
<!-- GIDEROSMTD:Sound:getLength() Get the duration of this sound -->
 
[[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/>
 +
<!-- 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;"|
 +
 
=== <translate>Events</translate> ===
 
=== <translate>Events</translate> ===
 
=== <translate>Constants</translate> ===
 
=== <translate>Constants</translate> ===
 
|}
 
|}
 +
 +
{{GIDEROS IMPORTANT LINKS}}

Revision as of 08:30, 8 January 2021


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 Sets the position, velocity and orientation of the listener
Sound:getLength Get the duration of this sound
Sound:play creates a new SoundChannel object to play the sound

Events

Constants