audio::Effect Class Reference

audio.Filter More...

Public Member Functions
static function	Autowah (local id, local attack, local release, local resonance, local peakgain)
static function	Chorus (local id, local waveform, local phase, local rate, local depth, local feedback, local delay)
static function	Compressor (local id, local enable)
static function	Distortion (local id, local gain, local edge, local lowcut, local center, local bandwidth)
static function	Echo (local id, local delay, local tapdelay, local damping, local feedback, local spread)
static function	Equalizer (local id, local lowgain, local lowcut, local lowmidgain, local lowmidfrequency, local lowmidbandwidth, local highmidgain, local highmidfrequency, local highmidbandwidth, local highgain, local highcut)
static function	Flanger (local id, local waveform, local phase, local rate, local depth, local feedback, local delay)
static function	FreqShifter (local id, local frequency, local left_dir, local right_dir)
static function	Modulator (local id, local waveform, local frequency, local highcut)
static function	Morpher (local id, local waveform, local rate, local phonem_a, local phonem_b, local tune_a, local tune_b)
static function	PitchShifter (local id, local pitch)
static function	Reverb (local id, local gain, local highgain, local density, local diffusion, local decaytime, local decayhighratio, local earlygain, local earlydelay, local lategain, local latedelay, local roomrolloff, local airabsorption, local highlimit)

Detailed Description

audio.Filter

Member Function Documentation

Autowah()

static function Autowah	(	local	id,
		local	attack,
		local	release,
		local	resonance,
		local	peakgain
	)

Parameters

id	string
attack	number
release	number
resonance	number
peakgain	number

Returns

string return id if success, nil if failed

Chorus()

static function Chorus	(	local	id,
		local	waveform,
		local	phase,
		local	rate,
		local	depth,
		local	feedback,
		local	delay
	)

chorus: Plays multiple copies of the sound with slight pitch and time variation. Used to make sounds sound "fuller" or "thicker".

Parameters

id	string
waveform	audio.EffectWaveform
phase	number @[-180, 180], 90
rate	number @[0.0, 10.0], 1.1
depth	number @[0.0, 1.0], 0.1
feedback	number @[-1.0, 1.0], 0.25
delay	number @[0.0, 0.016], 0.016

Returns

string return id if success, nil if failed

Compressor()

static function Compressor	(	local	id,
		local	enable
	)

compressor: Decreases the dynamic range of the sound, making the loud and quiet parts closer in volume, producing a more uniform amplitude throughout time.

Parameters

id	string
enable	boolean

Returns

string return id if success, nil if failed

Distortion()

static function Distortion	(	local	id,
		local	gain,
		local	edge,
		local	lowcut,
		local	center,
		local	bandwidth
	)

distortion: Alters the sound by amplifying it until it clips, shearing off parts of the signal, leading to a compressed and distorted sound.

Parameters

id	string
gain	number
edge	number
lowcut	number
center	number
bandwidth	number

Returns

string return id if success, nil if failed

Echo()

static function Echo	(	local	id,
		local	delay,
		local	tapdelay,
		local	damping,
		local	feedback,
		local	spread
	)

echo: Decaying feedback based effect, on the order of seconds. Also known as delay causes the sound to repeat at regular intervals at a decreasing volume.

Parameters

id	string
delay	number
tapdelay	number
damping	number
feedback	number
spread	number

Returns

string return id if success, nil if failed

Equalizer()

static function Equalizer	(	local	id,
		local	lowgain,
		local	lowcut,
		local	lowmidgain,
		local	lowmidfrequency,
		local	lowmidbandwidth,
		local	highmidgain,
		local	highmidfrequency,
		local	highmidbandwidth,
		local	highgain,
		local	highcut
	)

equalizer: Adjust the frequency components of the sound using a 4-band (low-shelf, two band-pass and a high-shelf) equalizer.

Parameters

id	string
lowgain	number
lowcut	number
lowmidgain	number
lowmidfrequency	number
lowmidbandwidth	number
highmidgain	number
highmidfrequency	number
highmidbandwidth	number
highgain	number
highcut	number

Returns

string return id if success, nil if failed

Flanger()

static function Flanger	(	local	id,
		local	waveform,
		local	phase,
		local	rate,
		local	depth,
		local	feedback,
		local	delay
	)

flanger: Plays two copies of the sound while varying the phase, or equivalently delaying one of them, by amounts on the order of milliseconds, resulting in phasing sounds.

Parameters

id	string
waveform	audio.EffectWaveform
phase	number
rate	number
depth	number
feedback	number
delay	number

Returns

string return id if success, nil if failed

FreqShifter()

static function FreqShifter	(	local	id,
		local	frequency,
		local	left_dir,
		local	right_dir
	)

Parameters

id	string
frequency	number
left_dir	audio.EffectDirection
right_dir	audio.EffectDirection

Returns

string return id if success, nil if failed

Modulator()

static function Modulator	(	local	id,
		local	waveform,
		local	frequency,
		local	highcut
	)

modulator: An implementation of amplitude modulation multiplies the source signal with a simple waveform, to produce either volume changes, or inharmonic overtones.

Parameters

id	string
waveform	audio.EffectWaveform
frequency	number
highcut	number

Returns

string return id if success, nil if failed

Morpher()

static function Morpher	(	local	id,
		local	waveform,
		local	rate,
		local	phonem_a,
		local	phonem_b,
		local	tune_a,
		local	tune_b
	)

Parameters

id	string
waveform	audio.EffectWaveform
rate	number
phonem_a	audio.EffectPhoneme
phonem_b	audio.EffectPhoneme
tune_a	number
tune_b	number

Returns

string return id if success, nil if failed

PitchShifter()

static function PitchShifter	(	local	id,
		local	pitch
	)

Parameters

id	string
pitch	number

Returns

string return id if success, nil if failed

Reverb()

static function Reverb	(	local	id,
		local	gain,
		local	highgain,
		local	density,
		local	diffusion,
		local	decaytime,
		local	decayhighratio,
		local	earlygain,
		local	earlydelay,
		local	lategain,
		local	latedelay,
		local	roomrolloff,
		local	airabsorption,
		local	highlimit
	)

reverb: Decaying feedback based effect, on the order of milliseconds. Used to simulate the reflection off of the surroundings.

Parameters

id	string
gain	number
highgain	number
density	number
diffusion	number
decaytime	number
decayhighratio	number
earlygain	number
earlydelay	number
lategain	number
latedelay	number
roomrolloff	number
airabsorption	number
highlimit	boolean

Returns

string return id if success, nil if failed

---

The documentation for this class was generated from the following files:

• src/audio/__init__.lua.hpp
• src/audio/Effect.lua.hpp