Commit 9ae2ff82 authored by kimon-satan's avatar kimon-satan

updated API

parent e82f42d8
......@@ -7,6 +7,12 @@ This the audio context. You must always have one to produce sound with maxiLib
##### .init() #####
initialise the audio engine
##### .outputIsArray( isArray, numChannels) #####
for multi channel sound
- isArray = true or false
- numChannels = 2, 4, or 8
##### .loadSample(sampleUrl, maxiSample) #####
load a sample into a maxiSample object
......@@ -213,6 +219,65 @@ An adsr envelope.
- level (the overall level of the envelope; everything will be scaled by this value)
- trigger (envelope will begin attack when set to 1.0 and release when set to 0.0)
<br><br>
### maxiFilter ###
A bunch of useful filter methods
#### methods ####
##### .lores(input, cutoff, resonance) #####
A lowpass resonant filter. Returns the filtered frequency.
- input = input signal
- cutoff = cutoff frequency in Hz
- resonance = a value between 0.0 & 10.0
##### .hires(input, cutoff, resonance) #####
A highpass resonant filter. Returns the filtered frequency.
- input = input signal
- cutoff = cutoff frequency in Hz
- resonance = a value between 0.0 & 10.0
### maxiFFT ###
#### methods ####
##### .setup(fftSize, windowSize, hopSize) #####
must be called before using the FFT
- fftSize = (A power of two, 1024, 512 .. etc)
- windowSize = half the fftSize
- hopSize = half the windowSize
##### .process(sig) #####
returns true if successful
- sig = signal in
##### .getMagnitude(index) #####
get the magnitude of a particular bin
- index = A number between 0 and the fftSize/2
##### .getMagnitudeDB(index) #####
get the decibels of a particular bin
##### .magsToDb() #####
perform the conversion on all bins
<br><br>
### convert ###
A collection of conversion functions. Currently numbering one !
......@@ -223,6 +288,29 @@ A collection of conversion functions. Currently numbering one !
pass a midi value and its frequency is returned
<br><br>
### maxiMix ###
A multichannel mixer.
#### methods ####
##### .stereo(sig, outputArray, pan) #####
Makes a stereo mix.
- sig = inputsignal
- outputArray = VectorDbl array (see maxiTools)
- pan = a value between 0 & 1
<br><br>
### maxiTools ###
#### methods ####
##### .getArrayAsVectorDbl(inputArray) #####
Returns the array as a VectorDbl object. (Needed for maxiMix).
### Undocumented classes ###
......@@ -233,10 +321,9 @@ pass a midi value and its frequency is returned
- maxiDistortion
- maxiDyn
- maxiEnvelope
- maxiEnvelopeFollower
- maxiFFT
- maxiEnvelopeFollower (undefined)
- maxiFFTOctaveAnalyzer
- maxiFilter
- maxiFlanger
- maxiHats
- maxiIFFT
......@@ -244,9 +331,7 @@ pass a midi value and its frequency is returned
- maxiLagExp
- maxiMFCC
- maxiMap
- maxiMix
- maxiSVF
- maxiSettings
- maxiSnare
- maxiTools
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment