SoundChannel

From GiderosMobile
Revision as of 21:33, 30 May 2019 by MoKaLux (talk | contribs) (→‎Description: added some sample code)


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 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.


Example

local sound1 = Sound.new("audio/sound1.ogg")
local audio1 = sound1:play()
audio1:addEventListener(Event.COMPLETE, function()
	-- play a second audio when the first one is complete
	local sound2 = Sound.new("audio/sound2.ogg")
	local audio2 = sound2:play()
end)


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