API Docs for: 2.7.1
Show:

Filter Class

Extends BaseEffect
Module: Effects

A simple stereo fader which moves the stereophonic image of the source left or right.

Constructor

Filter

()

Methods

connect

(
  • destination
  • [output]
  • [input]
)

Inherited from BaseEffect:

If the parameter output is an AudioNode, it connects to the outputNode. If the output is a BaseEffect, it will connect BaseEffect's outputNode to the output's inputNode.

Parameters:

  • destination AudioNode

    AudioNode to connect to.

  • [output] Number optional

    Index describing which output of the AudioNode from which to connect.

  • [input] Number optional

    Index describing which input of the destination AudioNode to connect to.

disconnect

(
  • [outputIndex]
)

Inherited from BaseEffect:

Disconnects the Sound from the AudioNode Chain.

Parameters:

  • [outputIndex] Number optional

    Index describing which output of the AudioNode to disconnect.

listParams

(
  • [paramArray]
)

Inherited from BaseEffect:

List all SPAudioParams this Sound exposes

Parameters:

  • [paramArray] Array optional

    Array of all the SPAudioParams this Sound exposes.

Properties

audioContext

AudioContext

Inherited from BaseEffect:

Web Audio API's AudioContext. If the context passed to the constructor is an AudioContext, a new one is created here.

destinations

Array

Inherited from BaseEffect:

Set of nodes the output of this effect is currently connected to.

detune

SPAudioParam

A detune value, in cents, for the frequency. Its default value is 0.

Default: 0

frequency

SPAudioParam

The frequency at which the BiquadFilterNode will operate, in Hz. Its nominal range is from 10Hz to half the Nyquist frequency.

Default: 350

inputNode

AudioNode final

Inherited from BaseEffect:

The output node of this effect. This node will be connected to the next Effect or destination

isInitialized

Boolean

Inherited from BaseEffect:

If Sound is currently initialized.

Default: false

isPlaying

Boolean

Inherited from BaseEffect:

If Sound is currently playing.

Default: false

modelName

String

Inherited from BaseEffect:

String name of the effect.

Default: "Model"

numberOfInputs

Number

Inherited from BaseEffect:

Number of inputs

Default: 0

numberOfOutputs

Number

Inherited from BaseEffect:

Number of outputs

Default: 0

outputNode

AudioNode final

Inherited from BaseEffect:

The output node of this effect. This node will be connected to the next Effect or destination

Q

SPAudioParam

The Q factor has a default value of 1, with a nominal range of 0.0001 to 1000.

Default: 1

type

SPAudioParam

The type of this BiquadFilterNode, lowpass, highpass, etc. The exact meaning of the other parameters depend on the value of the type attribute. Possible values for this type are : "lowpass" "highpass" "bandpass" "lowshelf" "highshelf" "peaking" "notch" "allpass"

Default: "lowpass"