AnalyserNode

open class AnalyserNode(context: BaseAudioContext, options: AnalyserOptions = definedExternally) : AudioNode(source)

The AnalyserNode interface represents a node able to provide real-time frequency and time-domain analysis information.

MDN Reference

Constructors

AnalyserNode

constructor(context: BaseAudioContext, options: AnalyserOptions = definedExternally)

Properties

channelCount

var channelCount: Int

The channelCount property of the AudioNode interface represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.

channelCountMode

var channelCountMode: ChannelCountMode

The channelCountMode property of the AudioNode interface represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

channelInterpretation

var channelInterpretation: ChannelInterpretation

The channelInterpretation property of the AudioNode interface represents an enumerated value describing how input channels are mapped to output channels when the number of inputs/outputs is different.

context

val context: BaseAudioContext

The read-only context property of the the node is participating in.

fftSize

var fftSize: Int

The fftSize property of the AnalyserNode interface is an unsigned long value and represents the window size in samples that is used when performing a Fast Fourier Transform (FFT) to get frequency domain data.

frequencyBinCount

val frequencyBinCount: Int

The frequencyBinCount read-only property of the AnalyserNode interface contains the total number of data points available to AudioContext BaseAudioContext.sampleRate.

maxDecibels

var maxDecibels: Double

The maxDecibels property of the AnalyserNode interface is a double value representing the maximum power value in the scaling range for the FFT analysis data, for conversion to unsigned byte values — basically, this specifies the maximum value for the range of results when using getByteFrequencyData().

minDecibels

var minDecibels: Double

The minDecibels property of the AnalyserNode interface is a double value representing the minimum power value in the scaling range for the FFT analysis data, for conversion to unsigned byte values — basically, this specifies the minimum value for the range of results when using getByteFrequencyData().

numberOfInputs

val numberOfInputs: Int

The numberOfInputs property of the AudioNode interface returns the number of inputs feeding the node.

numberOfOutputs

val numberOfOutputs: Int

The numberOfOutputs property of the AudioNode interface returns the number of outputs coming out of the node.

smoothingTimeConstant

var smoothingTimeConstant: Double

The smoothingTimeConstant property of the AnalyserNode interface is a double value representing the averaging constant with the last analysis frame.

Functions

connect

fun connect(destinationParam: AudioParam, output: Int = definedExternally)

fun connect(destinationNode: AudioNode, output: Int = definedExternally, input: Int = definedExternally): AudioNode

The connect() method of the AudioNode interface lets you connect one of the node's outputs to a target, which may be either another AudioNode (thereby directing the sound data to the specified node) or an change the value of that parameter over time.

disconnect

fun disconnect()

The disconnect() method of the AudioNode interface lets you disconnect one or more nodes from the node on which the method is called.

fun disconnect(output: Int)

fun disconnect(destinationNode: AudioNode)

fun disconnect(destinationParam: AudioParam)

fun disconnect(destinationNode: AudioNode, output: Int)

fun disconnect(destinationParam: AudioParam, output: Int)

fun disconnect(destinationNode: AudioNode, output: Int, input: Int)

dispatchEvent

fun dispatchEvent(event: Event): Boolean

getByteFrequencyData

fun getByteFrequencyData(array: Uint8Array<ArrayBuffer>)

The getByteFrequencyData() method of the AnalyserNode interface copies the current frequency data into a Uint8Array (unsigned byte array) passed into it.

getByteTimeDomainData

fun getByteTimeDomainData(array: Uint8Array<ArrayBuffer>)

The getByteTimeDomainData() method of the AnalyserNode Interface copies the current waveform, or time-domain, data into a Uint8Array (unsigned byte array) passed into it.

getFloatFrequencyData

fun getFloatFrequencyData(array: Float32Array<ArrayBuffer>)

The getFloatFrequencyData() method of the AnalyserNode Interface copies the current frequency data into a Float32Array array passed into it.

getFloatTimeDomainData

fun getFloatTimeDomainData(array: Float32Array<ArrayBuffer>)

The getFloatTimeDomainData() method of the AnalyserNode Interface copies the current waveform, or time-domain, data into a Float32Array array passed into it.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>