Type aliases
AnalyserParams
Analyser
Params
: { fftSize
?: FFTSize; frequencyBinCount
?: number; maxDecibels
?: number; minDecibels
?: number; smoothingTimeConstant
?: number }Type declaration
Optional fftSize?: FFTSize
Optional Readonly frequencyBinCount?: number
Optional maxDecibels?: number
Optional minDecibels?: number
Optional smoothingTimeConstant?: number
AudioBufferSprite
AudioBufferSprite: {}
Type declaration
[spriteName: string]: AudioBuffer
AudioModuleParams
Audio
Module
Params
: SoundModuleParams & { currentTime
?: number; detune
?: number; duration
?: number; loop
?: boolean; numberOfChannels
?: number; playbackRate
?: number; sampleRate
?: number; vocalcanceler
: VocalCancelerParams }AutopannerParams
AutopannerParams: { depth?: number; rate?: number; state?: boolean }
Type declaration
Optional depth?: number
Optional rate?: number
Optional state?: boolean
CabinetParams
CabinetParams: { state?: boolean }
ChorusParams
ChorusParams: { depth?: number; feedback?: number; mix?: number; rate?: number; state?: boolean; time?: number; tone?: number }
Type declaration
Optional depth?: number
Optional feedback?: number
Optional mix?: number
Optional rate?: number
Optional state?: boolean
Optional time?: number
Optional tone?: number
CompressorParams
CompressorParams: { attack?: number; knee?: number; ratio?: number; release?: number; state?: boolean; threshold?: number }
Type declaration
Optional attack?: number
Optional knee?: number
Optional ratio?: number
Optional release?: number
Optional state?: boolean
Optional threshold?: number
CurrentTimeStyles
Current
Time
Styles
: { color
?: Color; width
?: number }Type declaration
Optional color?: Color
Optional width?: number
DataType
DataType: "uint" | "float"
DelayParams
DelayParams: { dry?: number; feedback?: number; state?: boolean; time?: number; tone?: number; wet?: number }
Type declaration
Optional dry?: number
Optional feedback?: number
Optional state?: boolean
Optional time?: number
Optional tone?: number
Optional wet?: number
DistortionCurve
DistortionCurve: Float32Array | null
DistortionParams
Type declaration
Optional samples?: number
Optional state?: boolean
DistortionType
DistortionType: "clean" | "crunch" | "overdrive" | "distortion" | "fuzz"
Domain
Domain: "timeoverview" | "time" | "fft"
DragCallbackFunction
Drag
Callback
Function
: (event
: MouseEvent | TouchEvent, startTime
: number, endTime
: number, mode
: DragMode, direction
: boolean) => voidType declaration
- (event: MouseEvent | TouchEvent, startTime: number, endTime: number, mode: DragMode, direction: boolean): void
Parameters
event: MouseEvent | TouchEvent
startTime: number
endTime: number
direction: boolean
Returns void
DragMode
DragMode: "update" | "sprite"
EnvelopeGeneratorParams
EnvelopeGeneratorParams: { attack?: number; decay?: number; release?: number; sustain?: number }
Type declaration
Optional attack?: number
Optional decay?: number
Optional release?: number
Optional sustain?: number
EqualizerParams
EqualizerParams: { bass?: number; middle?: number; presence?: number; state?: boolean; treble?: number }
Type declaration
Optional bass?: number
Optional middle?: number
Optional presence?: number
Optional state?: boolean
Optional treble?: number
FFTSize
FFTSize: 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384 | 32768
FileReadType
FileReadType: "arraybuffer" | "dataURL" | "text" | "json"
FileReaderErrorText
FileReaderErrorText: "NOT_FOUND_ERR" | "SECURITY_ERR" | "ABORT_ERR" | "NOT_READABLE_ERR" | "ERR" | ""
FilterParams
FilterParams: { Q?: number; attack?: number; decay?: number; frequency?: number; gain?: number; range?: number; release?: number; state?: boolean; sustain?: number; type?: BiquadFilterType }
Type declaration
Optional Q?: number
Optional attack?: number
Optional decay?: number
Optional frequency?: number
Optional gain?: number
Optional range?: number
Optional release?: number
Optional state?: boolean
Optional sustain?: number
Optional type?: BiquadFilterType
FlangerParams
FlangerParams: { depth?: number; feedback?: number; mix?: number; rate?: number; state?: boolean; time?: number; tone?: number }
Type declaration
Optional depth?: number
Optional feedback?: number
Optional mix?: number
Optional rate?: number
Optional state?: boolean
Optional time?: number
Optional tone?: number
Font
Font: { family?: string; size?: string; style?: string; weight?: string }
Type declaration
Optional family?: string
Optional size?: string
Optional style?: string
Optional weight?: string
GlideParams
Glide
Params
: { time
?: number; type
?: GlideType }GlideType
GlideType: "linear" | "exponential"
Gradient
Gradient: { color: string; offset: number }
Type declaration
color: string
offset: number
GraphicsApi
GraphicsApi: "canvas" | "svg" | ""
GraphicsStyles
Graphics
Styles
: { bottom
?: number; cap
?: CanvasLineCap; font
?: Font; gradients
?: Gradients; grid
?: Color; join
?: CanvasLineJoin; left
?: number; right
?: number; shape
?: Shape; text
?: Color; top
?: number; wave
?: Color; width
?: number }Type declaration
Optional bottom?: number
Optional cap?: CanvasLineCap
Optional font?: Font
Optional gradients?: Gradients
Optional grid?: Color
Optional join?: CanvasLineJoin
Optional left?: number
Optional right?: number
Optional shape?: Shape
Optional text?: Color
Optional top?: number
Optional wave?: Color
Optional width?: number
ListenerParams
ListenerParams: { fx?: number; fy?: number; fz?: number; ux?: number; uy?: number; uz?: number; x?: number; y?: number; z?: number }
Type declaration
Optional fx?: number
Optional fy?: number
Optional fz?: number
Optional ux?: number
Optional uy?: number
Optional uz?: number
Optional x?: number
Optional y?: number
Optional z?: number
MediaModuleParams
Media
Module
Params
: SoundModuleParams & { autoplay
?: boolean; controls
?: boolean; currentTime
?: number; duration
?: number; loop
?: boolean; muted
?: boolean; playbackRate
?: number; vocalcanceler
: VocalCancelerParams }MouseEventTypes
MouseEventTypes: "mousedown" | "mousemove" | "mouseup" | "touchstart" | "touchmove" | "touchend"
NoiseGateParams
NoiseGateParams: { level?: number }
NoiseSuppressorParams
NoiseSuppressorParams: { threshold?: number }
Type declaration
Optional threshold?: number
NoiseType
NoiseType: "whitenoise" | "pinknoise" | "browniannoise"
NumberOfSessionChannels
NumberOfSessionChannels: 1 | 2
OneshotErrorText
OneshotErrorText: "error" | "timeout" | "decode"
OneshotSetting
OneshotSetting: { bufferIndex: number; loop?: boolean; loopEnd?: number; loopStart?: number; playbackRate?: number; volume?: number }
Type declaration
bufferIndex: number
Optional loop?: boolean
Optional loopEnd?: number
Optional loopStart?: number
Optional playbackRate?: number
Optional volume?: number
OscillatorCustomType
OscillatorCustomType: { imag: Float32Array; real: Float32Array }
Type declaration
imag: Float32Array
real: Float32Array
OscillatorParams
Oscillator
Params
: { fine
?: number; octave
?: number; state
?: boolean; type
?: OscillatorType | OscillatorCustomType; volume
?: number }Type declaration
Optional fine?: number
Optional octave?: number
Optional state?: boolean
Optional volume?: number
PannerParams
PannerParams: { coneInnerAngle?: number; coneOuterAngle?: number; coneOuterGain?: number; distanceModel: DistanceModelType; maxDistance?: number; ox?: number; oy?: number; oz?: number; panningModel: PanningModelType; refDistance?: number; rolloffFactor?: number; state?: boolean; x?: number; y?: number; z?: number }
Type declaration
Optional coneInnerAngle?: number
Optional coneOuterAngle?: number
Optional coneOuterGain?: number
distanceModel: DistanceModelType
Optional maxDistance?: number
Optional ox?: number
Optional oy?: number
Optional oz?: number
panningModel: PanningModelType
Optional refDistance?: number
Optional rolloffFactor?: number
Optional state?: boolean
Optional x?: number
Optional y?: number
Optional z?: number
PhaserNumberOfStages
PhaserNumberOfStages: 0 | 2 | 4 | 8 | 12 | 24
PhaserParams
Phaser
Params
: { depth
?: number; feedback
?: number; frequency
?: number; mix
?: number; rate
?: number; resonance
?: number; stage
?: PhaserNumberOfStages; state
?: boolean }Type declaration
Optional depth?: number
Optional feedback?: number
Optional frequency?: number
Optional mix?: number
Optional rate?: number
Optional resonance?: number
Optional state?: boolean
PitchChar
PitchChar: "C" | "D" | "E" | "F" | "G" | "A" | "B" | "R"
PitchShifterParams
PitchShifterParams: { pitch?: number; state?: boolean }
Type declaration
Optional pitch?: number
Optional state?: boolean
Position3D
Position3D: { x: number; y: number; z: number }
Type declaration
x: number
y: number
z: number
PostEqualizerParams
Post
Equalizer
Params
: { bass
?: number; curve
?: DistortionCurve; frequency
?: number; middle
?: number; state
?: boolean; treble
?: number }Type declaration
Optional bass?: number
Optional frequency?: number
Optional middle?: number
Optional state?: boolean
Optional treble?: number
PreEqualizerParams
Pre
Equalizer
Params
: { curve
?: DistortionCurve; gain
?: number; lead
?: number; state
?: boolean }Type declaration
Optional gain?: number
Optional lead?: number
Optional state?: boolean
QuantizationBit
QuantizationBit: 8 | 16
RecordType
RecordType: 1 | 2
RecorderParams
RecorderParams: { 0?: number; 1?: number }
Type declaration
Optional 0?: number
Optional 1?: number
ReverbErrorText
ReverbErrorText: "error" | "timeout" | "decode"
ReverbParams
ReverbParams: { buffer?: number | AudioBuffer | null; dry?: number; state?: boolean; tone?: number; wet?: number }
Type declaration
Optional buffer?: number | AudioBuffer | null
Optional dry?: number
Optional state?: boolean
Optional tone?: number
Optional wet?: number
RingmodulatorParams
RingmodulatorParams: { depth?: number; rate?: number; state?: boolean }
Type declaration
Optional depth?: number
Optional rate?: number
Optional state?: boolean
RoomMap
RoomMap: {}
Type declaration
[id: string]: WebSocket | null
SessionParams
SessionParams: { host: string; path: string; port: number; tls: boolean; closeCallback?: any; errorCallback?: any; openCallback?: any }
Type declaration
host: string
path: string
port: number
tls: boolean
closeCallback?:function
- closeCallback(event: Event): void
errorCallback?:function
- errorCallback(event: Event): void
openCallback?:function
- openCallback(event: Event): void
Shape
Shape: "line" | "rect"
SourceName
SourceName: "oscillator" | "oneshot" | "noise" | "audio" | "media" | "stream" | "processor" | "mixer" | "midi" | "mml"
StereoParams
StereoParams: { state?: boolean; time?: number }
Type declaration
Optional state?: boolean
Optional time?: number
TokenType
TokenType: "TEMPO" | "OCTAVE" | "NOTE" | "REST" | "NUMBER" | "TIE" | "SPACE" | "EOS" | "UNKNOWN"
TremoloParams
TremoloParams: { depth?: number; rate?: number; state?: boolean; type?: OscillatorType }
Type declaration
Optional depth?: number
Optional rate?: number
Optional state?: boolean
Optional type?: OscillatorType
VisualizerParams
Type declaration
Optional interval?: number
VocalCancelerParams
VocalCancelerParams: { depth?: number }
WahParams
WahParams: { auto?: boolean; cutoff?: number; depth?: number; rate?: number; resonance?: number; state?: boolean }
Type declaration
Optional auto?: boolean
Optional cutoff?: number
Optional depth?: number
Optional rate?: number
Optional resonance?: number
Optional state?: boolean
WaveExportType
WaveExportType: "base64" | "dataURL" | "blob" | "objectURL"
{boolean} tls This argument is in order to select protocol (either
wss
orws
).{string} host This argument is server's hostname.
{number} port This argument is port number for connection.
{string} path This argument is script path that is executed in server side.
{function} openCallback This argument is invoked as
onopen
event handler in instance ofWebSocket
.{function} closeCallback This argument is invoked as
onclose
event handler in instance ofWebSocket
.{function} errorCallback This argument is invoked as
onerror
event handler in instance ofWebSocket
.