Difference between revisions of "SoundChannel:setEffect"
From GiderosMobile
(Created page with "__NOTOC__ '''Available since:''' Gideros 2022.6<br/> '''Class:''' SoundChannel<br/> === Description === Sets effects on a sound channel. <source lang="lua"> SoundChannel:...") |
|||
| Line 9: | Line 9: | ||
</source> | </source> | ||
| + | Available effects are: | ||
| + | * '''"equalizer"''' | ||
| + | * '''"biquad"''' | ||
| − | + | Available parameters for '''equalizer''' are: | |
| + | * AL_EQUALIZER_LOW_GAIN 0x0001 | ||
| + | * AL_EQUALIZER_LOW_CUTOFF 0x0002 | ||
| + | * AL_EQUALIZER_MID1_GAIN 0x0003 | ||
| + | * AL_EQUALIZER_MID1_CENTER 0x0004 | ||
| + | * AL_EQUALIZER_MID1_WIDTH 0x0005 | ||
| + | * AL_EQUALIZER_MID2_GAIN 0x0006 | ||
| + | * AL_EQUALIZER_MID2_CENTER 0x0007 | ||
| + | * AL_EQUALIZER_MID2_WIDTH 0x0008 | ||
| + | * AL_EQUALIZER_HIGH_GAIN 0x0009 | ||
| + | * AL_EQUALIZER_HIGH_CUTOFF 0x000A | ||
=== Parameters === | === Parameters === | ||
| − | '''effect''': ( | + | '''effect''': (String) the effect to set new values to<br/> |
'''params''': (number) the new values of the effect<br/> | '''params''': (number) the new values of the effect<br/> | ||
| Line 20: | Line 33: | ||
local sndcoin = Sound.new("audio/sfx/sfx_coin_double1.wav") | local sndcoin = Sound.new("audio/sfx/sfx_coin_double1.wav") | ||
local channel = sndcoin:play() | local channel = sndcoin:play() | ||
| + | -- audioChannel:setEffect("equalizer",{ equalizer settings }) | ||
channel:setEffect("equalizer", {AL_EQUALIZER_HIGH_GAIN, 10}) | channel:setEffect("equalizer", {AL_EQUALIZER_HIGH_GAIN, 10}) | ||
| + | -- audioChannel:setEffect("biquad",{ biquad coefficients }) | ||
| + | channel:setEffect("biquad", {2,1,12}) | ||
</source> | </source> | ||
{{SoundChannel}} | {{SoundChannel}} | ||
Revision as of 10:30, 12 March 2023
Available since: Gideros 2022.6
Class: SoundChannel
Description
Sets effects on a sound channel.
SoundChannel:setEffect(effect,params)
Available effects are:
- "equalizer"
- "biquad"
Available parameters for equalizer are:
- AL_EQUALIZER_LOW_GAIN 0x0001
- AL_EQUALIZER_LOW_CUTOFF 0x0002
- AL_EQUALIZER_MID1_GAIN 0x0003
- AL_EQUALIZER_MID1_CENTER 0x0004
- AL_EQUALIZER_MID1_WIDTH 0x0005
- AL_EQUALIZER_MID2_GAIN 0x0006
- AL_EQUALIZER_MID2_CENTER 0x0007
- AL_EQUALIZER_MID2_WIDTH 0x0008
- AL_EQUALIZER_HIGH_GAIN 0x0009
- AL_EQUALIZER_HIGH_CUTOFF 0x000A
Parameters
effect: (String) the effect to set new values to
params: (number) the new values of the effect
Example
local sndcoin = Sound.new("audio/sfx/sfx_coin_double1.wav")
local channel = sndcoin:play()
-- audioChannel:setEffect("equalizer",{ equalizer settings })
channel:setEffect("equalizer", {AL_EQUALIZER_HIGH_GAIN, 10})
-- audioChannel:setEffect("biquad",{ biquad coefficients })
channel:setEffect("biquad", {2,1,12})
- SoundChannel:getPitch
- SoundChannel:getPosition
- SoundChannel:getStreamId
- SoundChannel:getVolume
- SoundChannel:isLooping
- SoundChannel:isPaused
- SoundChannel:isPlaying
- SoundChannel:setEffect
- SoundChannel:setLooping
- SoundChannel:setPaused
- SoundChannel:setPitch
- SoundChannel:setPosition
- SoundChannel:setVolume
- SoundChannel:setWorldPosition
- SoundChannel:stop
