Difference between revisions of "SoundChannel"

From GiderosMobile
Line 28: Line 28:
 
| style="width: 50%; vertical-align:top;"|
 
| style="width: 50%; vertical-align:top;"|
 
=== Methods ===
 
=== Methods ===
[[SoundChannel:getPitch]] ''returns the current pitch of the sound channel''<br/><!--GIDEROSMTD:SoundChannel:getPitch() returns the current pitch of the sound channel-->
+
[[SoundChannel:getPitch]] ''returns the current sound channel pitch''<br/><!--GIDEROSMTD:SoundChannel:getPitch() returns the current sound channel pitch-->
[[SoundChannel:getPosition]] ''returns the position of the current playback''<br/><!--GIDEROSMTD:SoundChannel:getPosition() returns the position of the current playback-->
+
[[SoundChannel:getPosition]] ''returns the current playback position''<br/><!--GIDEROSMTD:SoundChannel:getPosition() returns the current playback position-->
[[SoundChannel:getVolume]] ''returns the current volume of the sound channel''<br/><!--GIDEROSMTD:SoundChannel:getVolume() returns the current volume of the sound channel-->
+
[[SoundChannel:getStreamId]] ''returns the channel stream id''<br/><!--GIDEROSMTD:SoundChannel:getStreamId() returns the channel stream id-->
[[SoundChannel:isLooping]] ''returns the looping state of the channel''<br/><!--GIDEROSMTD:SoundChannel:isLooping() returns the looping state of the channel-->
+
[[SoundChannel:getVolume]] ''returns the current sound channel volume''<br/><!--GIDEROSMTD:SoundChannel:getVolume() returns the current sound channel volume-->
[[SoundChannel:isPaused]] ''returns the paused state of the channel''<br/><!--GIDEROSMTD:SoundChannel:isPaused() returns the paused state of the channel-->
+
[[SoundChannel:isLooping]] ''returns the channel looping state''<br/><!--GIDEROSMTD:SoundChannel:isLooping() returns the channel looping state-->
[[SoundChannel:isPlaying]] ''returns the playing state for the sound channel''<br/><!--GIDEROSMTD:SoundChannel:isPlaying() returns the playing state for the sound channel-->
+
[[SoundChannel:isPaused]] ''returns the channel paused state''<br/><!--GIDEROSMTD:SoundChannel:isPaused() returns the channel paused state-->
[[SoundChannel:setEffect]] ''enables effects on the sound channel''<br/><!--GIDEROSMTD:SoundChannel:setEffect(channel, effect, params) enables effects on the sound channel-->
+
[[SoundChannel:isPlaying]] ''returns the sound channel playing state''<br/><!--GIDEROSMTD:SoundChannel:isPlaying() returns the sound channel playing state-->
[[SoundChannel:setLooping]] ''sets the looping state of the channel''<br/><!--GIDEROSMTD:SoundChannel:setLooping(looping) sets the looping state of the channel-->
+
[[SoundChannel:setEffect]] ''enables sound channel effects''<br/><!--GIDEROSMTD:SoundChannel:setEffect(channel, effect, params) enables sound channel effects-->
[[SoundChannel:setPaused]] ''sets the paused state of the channel''<br/><!--GIDEROSMTD:SoundChannel:setPaused(paused) sets the paused state of the channel-->
+
[[SoundChannel:setLooping]] ''sets the channel looping state''<br/><!--GIDEROSMTD:SoundChannel:setLooping(looping) sets the channel looping state-->
[[SoundChannel:setPitch]] ''sets the pitch of the sound channel''<br/><!--GIDEROSMTD:SoundChannel:setPitch(pitch) sets the pitch of the sound channel-->
+
[[SoundChannel:setPaused]] ''sets the channel paused state''<br/><!--GIDEROSMTD:SoundChannel:setPaused(paused) sets the channel paused state-->
[[SoundChannel:setPosition]] ''sets the position of the current playback''<br/><!--GIDEROSMTD:SoundChannel:setPosition(position) sets the position of the current playback-->
+
[[SoundChannel:setPitch]] ''sets the sound channel pitch''<br/><!--GIDEROSMTD:SoundChannel:setPitch(pitch) sets the sound channel pitch-->
[[SoundChannel:setVolume]] ''sets the volume of the sound channel''<br/><!--GIDEROSMTD:SoundChannel:setVolume(volume) sets the volume of the sound channel-->
+
[[SoundChannel:setPosition]] ''sets the current playback position''<br/><!--GIDEROSMTD:SoundChannel:setPosition(position) sets the current playback position-->
 +
[[SoundChannel:setVolume]] ''sets the sound channel volume''<br/><!--GIDEROSMTD:SoundChannel:setVolume(volume) sets the sound channel volume-->
 
[[SoundChannel:setWorldPosition]] ''sets the position of the sound in a 3D world''<br/><!--GIDEROSMTD:SoundChannel:setWorldPosition(x,y,z,vx,vy,vz) sets the position of the sound in a 3D world-->
 
[[SoundChannel:setWorldPosition]] ''sets the position of the sound in a 3D world''<br/><!--GIDEROSMTD:SoundChannel:setWorldPosition(x,y,z,vx,vy,vz) sets the position of the sound in a 3D world-->
 
[[SoundChannel:stop]] ''stops the sound playing in the channel''<br/><!--GIDEROSMTD:SoundChannel:stop() stops the sound playing in the channel-->
 
[[SoundChannel:stop]] ''stops the sound playing in the channel''<br/><!--GIDEROSMTD:SoundChannel:stop() stops the sound playing in the channel-->

Revision as of 09:25, 12 March 2023

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)

See also

Playing_Sound_and_Music

Methods

SoundChannel:getPitch returns the current sound channel pitch
SoundChannel:getPosition returns the current playback position
SoundChannel:getStreamId returns the channel stream id
SoundChannel:getVolume returns the current sound channel volume
SoundChannel:isLooping returns the channel looping state
SoundChannel:isPaused returns the channel paused state
SoundChannel:isPlaying returns the sound channel playing state
SoundChannel:setEffect enables sound channel effects
SoundChannel:setLooping sets the channel looping state
SoundChannel:setPaused sets the channel paused state
SoundChannel:setPitch sets the sound channel pitch
SoundChannel:setPosition sets the current playback position
SoundChannel:setVolume sets the sound channel volume
SoundChannel:setWorldPosition sets the position of the sound in a 3D world
SoundChannel:stop stops the sound playing in the channel

Events

SoundChannel_Event.COMPLETE

Constants