Difference between revisions of "SoundChannel"

From GiderosMobile
(Created page with "__NOTOC__ '''Supported platforms:''' <br/> '''Available since:''' Gideros 2011.6<br/> === Description === <br /> The `SoundChannel` class is used to control and monitor a play...")
 
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
'''Supported platforms:''' <br/>
+
'''Supported platforms:''' android, ios, mac, pc<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
'''Available since:''' Gideros 2011.6<br/>
 
=== Description ===
 
=== Description ===
Line 11: Line 11:
 
</ul><br />
 
</ul><br />
 
<br />
 
<br />
 +
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 +
 
 
{|-
 
{|-
 
| style="width: 50%;"|
 
| style="width: 50%;"|
 
=== Methods ===
 
=== Methods ===
 +
[[SoundChannel:getPitch]] - returns the current pitch of the sound channel<br/>
 +
[[SoundChannel:getPosition]] - returns the position of the current playback<br/>
 +
[[SoundChannel:getVolume]] - returns the current volume of the sound channel<br/>
 +
[[SoundChannel:isLooping]] - returns the looping state of the channel<br/>
 +
[[SoundChannel:isPaused]] - returns the paused state of the channel<br/>
 +
[[SoundChannel:isPlaying]] - returns the playing state for the sound channel<br/>
 +
[[SoundChannel:setLooping]] - sets the looping state of the channel<br/>
 +
[[SoundChannel:setPaused]] - sets the paused state of the channel<br/>
 +
[[SoundChannel:setPitch]] - sets the pitch of the sound channel<br/>
 +
[[SoundChannel:setPosition]] - sets the position of the current playback<br/>
 +
[[SoundChannel:setVolume]] - sets the volume of the sound channel<br/>
 +
[[SoundChannel:setWorldPosition]] - <br/>
 +
[[SoundChannel:stop]] - stops the sound playing in the channel<br/>
 
| style="width: 50%;"|
 
| style="width: 50%;"|
 
=== Events ===
 
=== Events ===
 +
[[Event.COMPLETE]]
 
=== Constants ===
 
=== Constants ===
 
|}
 
|}

Revision as of 08:57, 23 August 2018

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

Description


The `SoundChannel` class is used to control and monitor a playing sound.

SoundChannel Events



  • `Event.COMPLETE = "complete"` When the sound channel has finished playing, `Event.COMPLETE` event is dispatched.












Methods

SoundChannel:getPitch - returns the current pitch of the sound channel
SoundChannel:getPosition - returns the position of the current playback
SoundChannel:getVolume - returns the current volume of the sound channel
SoundChannel:isLooping - returns the looping state of the channel
SoundChannel:isPaused - returns the paused state of the channel
SoundChannel:isPlaying - returns the playing state for the sound channel
SoundChannel:setLooping - sets the looping state of the channel
SoundChannel:setPaused - sets the paused state of the channel
SoundChannel:setPitch - sets the pitch of the sound channel
SoundChannel:setPosition - sets the position of the current playback
SoundChannel:setVolume - sets the volume of the sound channel
SoundChannel:setWorldPosition -
SoundChannel:stop - stops the sound playing in the channel

Events

Event.COMPLETE

Constants