Difference between revisions of "Sound"
From GiderosMobile
(removed language stuff) |
|||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| − | |||
<!-- GIDEROSOBJ:Sound --> | <!-- GIDEROSOBJ:Sound --> | ||
| − | ''' | + | '''Supported platforms:''' [[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/> |
| − | ''' | + | '''Available since:''' Gideros 2011.6<br/> |
| − | ''' | + | '''Inherits from:''' [[Object]]<br/> |
| − | === | + | === Description === |
| − | The | + | 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 [[ | + | Control of the playing sound is performed through the [[SoundChannel]] object. |
| − | === | + | === Examples === |
<source lang="lua"> | <source lang="lua"> | ||
local sound = Sound.new("music.mp3") | local sound = Sound.new("music.mp3") | ||
| Line 22: | Line 21: | ||
{|- | {|- | ||
| style="width: 50%; vertical-align:top;"| | | style="width: 50%; vertical-align:top;"| | ||
| − | === | + | === Methods === |
| − | [[ | + | [[Sound.new]] ''creates a new Sound object''<br/><!--GIDEROSMTD:Sound.new(filename) creates a new Sound object--> |
| − | <!-- GIDEROSMTD:Sound.new(filename) creates a new Sound object --> | + | [[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--> |
| − | [[ | + | [[Sound:getLength]] ''gets the sound duration''<br/><!--GIDEROSMTD:Sound:getLength() gets the sound duration--> |
| − | <!-- GIDEROSMTD:Sound.setListenerPosition(x,y,z,vx,vy,vz,dx,dy,dz,ux,uy,uz) | + | [[Sound:play]] ''creates a new SoundChannel object to play the sound''<br/><!--GIDEROSMTD:Sound:play(startTime,looping,paused) creates a new SoundChannel object to play the sound--> |
| − | [[ | ||
| − | <!-- GIDEROSMTD:Sound:getLength() | ||
| − | [[ | ||
| − | <!-- 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;"| | ||
| − | + | === Events === | |
| − | === | + | === Constants === |
| − | === | ||
|} | |} | ||
{{GIDEROS IMPORTANT LINKS}} | {{GIDEROS IMPORTANT LINKS}} | ||
Revision as of 08:19, 29 May 2021
Supported platforms: 
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()
MethodsSound.new creates a new Sound object |
EventsConstants |
