Class Analyser

This private class manages 3 private classes (TimeOverview, Time, FFT) for visualizing sound wave.

Implements

Implements

Connectable

Index

Constructors

Properties

analyser fft frequencyDomainAnimationId frequencyDomainTimerId input time timeDomainAnimationId timeDomainTimerId timeOverviewL timeOverviewR

Accessors

Methods

domain get param start stop

Constructors

constructor

new Analyser(context): Analyser
Parameters
- context: AudioContext
  This argument is in order to use Web Audio API.
Returns Analyser
- Defined in SoundModule/Analyser/index.ts:69

Properties

`Private` analyser

analyser: AnalyserNode

`Private` fft

fft: FFT

`Private` frequencyDomainAnimationId

frequencyDomainAnimationId: null | number = null

`Private` frequencyDomainTimerId

frequencyDomainTimerId: null | number = null

`Private` input

input: GainNode

`Private` time

time: Time

`Private` timeDomainAnimationId

timeDomainAnimationId: null | number = null

`Private` timeDomainTimerId

timeDomainTimerId: null | number = null

`Private` timeOverviewL

timeOverviewL: TimeOverview

`Private` timeOverviewR

timeOverviewR: TimeOverview

Accessors

INPUT

get INPUT(): GainNode
Returns GainNode
Implementation of Connectable.INPUT
- Defined in SoundModule/Analyser/index.ts:370

OUTPUT

get OUTPUT(): GainNode
Returns GainNode
Implementation of Connectable.OUTPUT
- Defined in SoundModule/Analyser/index.ts:375

Methods

domain

domain(domain, channel?): TimeOverview
This method selects domain for visualization. This method is overloaded for type interface and type check.
Parameters
- domain: "timeoverview"
  This argument is one of 'timeoverview', 'time', 'fft'.
- Optional channel: ChannelNumber
  This argument is channel number (Left: 0, Right: 1 ...).
Returns TimeOverview
Return value is instance of selected Visualizer class.
- Defined in SoundModule/Analyser/index.ts:330
domain(domain, channel?): Time
Parameters
- domain: "time"
- Optional channel: ChannelNumber
Returns Time
- Defined in SoundModule/Analyser/index.ts:331
domain(domain, channel?): FFT
Parameters
- domain: "fft"
- Optional channel: ChannelNumber
Returns FFT
- Defined in SoundModule/Analyser/index.ts:332

get

get(): AnalyserNode
This method gets instance of AnalyserNode.

Returns AnalyserNode
- Defined in SoundModule/Analyser/index.ts:365

param

param(params): number
This method gets or sets parameters for analyser. This method is overloaded for type interface and type check.
Parameters
- params: "fftSize"
  This argument is string if getter. Otherwise, setter.
Returns number
Return value is parameter for analyser if getter. Otherwise, return value is for method chain.
- Defined in SoundModule/Analyser/index.ts:265
param(params): number
Parameters
- params: "frequencyBinCount"
Returns number
- Defined in SoundModule/Analyser/index.ts:266
param(params): number
Parameters
- params: "minDecibels"
Returns number
- Defined in SoundModule/Analyser/index.ts:267
param(params): number
Parameters
- params: "maxDecibels"
Returns number
- Defined in SoundModule/Analyser/index.ts:268
param(params): number
Parameters
- params: "smoothingTimeConstant"
Returns number
- Defined in SoundModule/Analyser/index.ts:269
param(params): Analyser
Parameters
- params: AnalyserParams
Returns Analyser
- Defined in SoundModule/Analyser/index.ts:270

start

start(domain, channel?, buffer?): Analyser
This method visualizes sound wave.
Parameters
- domain: Domain
  This argument is one of 'timeoverview', 'time', 'fft'.
- Optional channel: ChannelNumber
  This argument is channel number (Left: 0, Right: 1 ...).
- Optional buffer: AudioBuffer
  This argument is instance of AudioBuffer (If domain is 'timeoverview', this argument is required).
Returns Analyser
Return value is for method chain.
- Defined in SoundModule/Analyser/index.ts:95

stop

stop(domain): Analyser
This method stops visualizer.
Parameters
- domain: Domain
  This argument is one of 'timeoverview', 'time', 'fft'.
Returns Analyser
Return value is for method chain.
- Defined in SoundModule/Analyser/index.ts:216