aukit::effects Class Reference

Effects that can modify audio chunks. More...

Public Member Functions
aukit Audio	amplify (aukit.Audio audio, number multiplier)
	Amplifies the audio by the multiplier specified.
aukit Audio	center (aukit.Audio audio)
	Centers the DC offset of each channel.
aukit Audio	delay (aukit.Audio audio, number delay, number? multiplier)
	Adds a delay to the specified audio.
aukit Audio	echo (aukit.Audio audio, number? delay, number? multiplier)
	Adds an echo to the specified audio.
aukit Audio	fade (aukit.Audio audio, number startTime, number startAmplitude, number endTime, number endAmplitude)
	Fades a period of music from one amplitude to another.
aukit Audio	highpass (aukit.Audio audio, number frequency)
	Applies a high-pass filter to the specified audio.
aukit Audio	invert (aukit.Audio audio)
	Inverts all channels in the specified audio.
aukit Audio	lowpass (aukit.Audio audio, number frequency)
	Applies a low-pass filter to the specified audio.
aukit Audio	normalize (aukit.Audio audio, number? peakAmplitude, boolean? independent)
	Normalizes audio to the specified peak amplitude.
aukit Audio	reverb (aukit.Audio audio, number? delay, number? decay, number? wetMultiplier, number? dryMultiplier)
	Adds reverb to the specified audio.
aukit Audio	speed (aukit.Audio audio, number multiplier)
	Changes the speed and pitch of audio by a multiplier, resampling to keep the same sample rate.
aukit Audio	trim (aukit.Audio audio, number? threshold)
	Trims any extra silence on either end of the specified audio.

Detailed Description

Effects that can modify audio chunks.

Member Function Documentation

amplify()

aukit Audio aukit::effects::amplify	(	aukit.Audio	audio,
		number	multiplier )

Amplifies the audio by the multiplier specified.

Parameters

audio	(aukit.Audio) The audio to modify
multiplier	(number) The multiplier to apply

Returns

(aukit.Audio) The audio modified

center()

aukit Audio aukit::effects::center

(

aukit.Audio

audio

)

Centers the DC offset of each channel.

Parameters

audio

(aukit.Audio) The audio to modify

Returns

(aukit.Audio) The audio modified

delay()

aukit Audio aukit::effects::delay	(	aukit.Audio	audio,
		number	delay,
		number?	multiplier )

Adds a delay to the specified audio.

Parameters

audio	(aukit.Audio) The audio to modify
delay	(number) The amount of time to delay for, in seconds
multiplier	(number?) The multiplier to apply to the delayed audio

Returns

(aukit.Audio) The audio modified

echo()

aukit Audio aukit::effects::echo	(	aukit.Audio	audio,
		number?	delay,
		number?	multiplier )

Adds an echo to the specified audio.

Parameters

audio	(aukit.Audio) The audio to modify
delay	(number?) The amount of time to echo after, in seconds
multiplier	(number?) The decay multiplier to apply to the echoed audio

Returns

(aukit.Audio) The audio modified

fade()

aukit Audio aukit::effects::fade	(	aukit.Audio	audio,
		number	startTime,
		number	startAmplitude,
		number	endTime,
		number	endAmplitude )

Fades a period of music from one amplitude to another.

Parameters

audio	(aukit.Audio) The audio to modify
startTime	(number) The start time of the fade, in seconds
startAmplitude	(number) The amplitude of the beginning of the fade
endTime	(number) The end time of the fade, in seconds
endAmplitude	(number) The amplitude of the end of the fade

Returns

(aukit.Audio) The audio modified

highpass()

aukit Audio aukit::effects::highpass	(	aukit.Audio	audio,
		number	frequency )

Applies a high-pass filter to the specified audio.

Parameters

audio	(aukit.Audio) The audio to modify
frequency	(number) The cutoff frequency for the filter

Returns

(aukit.Audio) The audio modified

invert()

aukit Audio aukit::effects::invert

(

aukit.Audio

audio

)

Inverts all channels in the specified audio.

Parameters

audio

(aukit.Audio) The audio to modify

Returns

(aukit.Audio) The audio modified

lowpass()

aukit Audio aukit::effects::lowpass	(	aukit.Audio	audio,
		number	frequency )

Applies a low-pass filter to the specified audio.

Parameters

audio	(aukit.Audio) The audio to modify
frequency	(number) The cutoff frequency for the filter

Returns

(aukit.Audio) The audio modified

normalize()

aukit Audio aukit::effects::normalize	(	aukit.Audio	audio,
		number?	peakAmplitude,
		boolean?	independent )

Normalizes audio to the specified peak amplitude.

Parameters

audio	(aukit.Audio) The audio to modify
peakAmplitude	(number?) The maximum amplitude
independent	(boolean?) Whether to normalize each channel independently

Returns

(aukit.Audio) The audio modified

reverb()

aukit Audio aukit::effects::reverb	(	aukit.Audio	audio,
		number?	delay,
		number?	decay,
		number?	wetMultiplier,
		number?	dryMultiplier )

Adds reverb to the specified audio.

Parameters

audio	(aukit.Audio) The audio to modify
delay	(number?) The amount of time to reverb after, in milliseconds
decay	(number?) The decay factor to use
wetMultiplier	(number?) The wet (reverbed) mix amount
dryMultiplier	(number?) The dry (original) mix amount

Returns

(aukit.Audio) The audio modified

speed()

aukit Audio aukit::effects::speed	(	aukit.Audio	audio,
		number	multiplier )

Changes the speed and pitch of audio by a multiplier, resampling to keep the same sample rate.

Parameters

audio	(aukit.Audio) The audio to modify
multiplier	(number) The multiplier to apply

Returns

(aukit.Audio) The audio modified

trim()

aukit Audio aukit::effects::trim	(	aukit.Audio	audio,
		number?	threshold )

Trims any extra silence on either end of the specified audio.

Parameters

audio	(aukit.Audio) The audio to modify
threshold	(number?) The maximum value to register as silence

Returns

(aukit.Audio) The audio modified

---

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

• aukit.lua