ScriptProcessorNode class abstract
The ScriptProcessorNode
allows the generation, processing, or
analyzing of audio using JavaScript.
Note: This feature was replaced by AudioWorklets and the AudioWorkletNode interface.
The ScriptProcessorNode
is an AudioNode audio-processing
module that is linked to two buffers, one containing the input audio data,
one containing the processed output audio data. An event, implementing the
AudioProcessingEvent interface, is sent to the object each time the input
buffer contains new data, and the event handler terminates when it has
filled the output buffer with data.
The size of the input and output buffer are defined at the creation time,
when the BaseAudioContext.createScriptProcessor method is called (both are
defined by BaseAudioContext.createScriptProcessor's bufferSize
parameter). The buffer size must be a power of 2 between 256
and 16384
,
that is 256
, 512
, 1024
, 2048
, 4096
, 8192
or 16384
. Small
numbers lower the latency, but large number may be necessary to avoid
audio breakup and glitches.
If the buffer size is not defined, which is recommended, the browser will pick one that its heuristic deems appropriate.
Number of inputs | 1 |
---|---|
Number of outputs | 1 |
Channel count mode | "max" |
Channel count | 2 (not used in the default count mode) |
Channel interpretation | "speakers" |
API documentation sourced from MDN Web Docs.
- Implemented types
Constructors
Properties
- bufferSize → int
-
The
bufferSize
property of the ScriptProcessorNode returns an integer representing both the input and output buffer size, in sample-frames. Its value can be a power of 2 value in the range256
–16384
.no setter - channelCount ↔ int
-
The
channelCount
property of the AudioNode represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node.getter/setter pairinherited - channelCountMode ↔ ChannelCountMode
-
The
channelCountMode
property of the AudioNode represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.getter/setter pairinherited - 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. For example, this setting defines how a mono input will be up-mixed to a stereo or 5.1 channel output, or how a quad channel input will be down-mixed to a stereo or mono output.getter/setter pairinherited - context → BaseAudioContext
-
The read-only
context
property of the AudioNode returns the associated BaseAudioContext, that is the object representing the processing graph the node is participating in.no setterinherited - hashCode → int
-
The hash code for this object.
no setterinherited
- numberOfInputs → int
-
The
numberOfInputs
property of the AudioNode returns the number of inputs feeding the node. Source nodes are defined as nodes having anumberOfInputs
property with a value of 0.no setterinherited - numberOfOutputs → int
-
The
numberOfOutputs
property of the AudioNode returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.no setterinherited - onaudioprocess ↔ EventHandler
-
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
connect(
AudioNode destinationNode, [int output, int input]) → AudioNode -
The
connect()
method of the AudioNode lets you connect one of the node's outputs to a target, which may be either anotherAudioNode
(thereby directing the sound data to the specified node). See also AudioNode.connectParaminherited -
connectParam(
AudioParam destinationParam, [int output, int input]) → void -
This is a variant of AudioNode.connect with a
DestinationParam
argument instead of anAudioNode
. Note : The W3C recommandation uses just one verb for both.inherited -
disconnect(
[AudioNode destinationParamOrOutput, int output, int input]) → void -
The
disconnect()
method of the AudioNode lets you disconnect one or more nodes from the node on which the method is called. See also AudioNode.disconnectParaminherited -
disconnectParam(
AudioParam destinationParam, [int output, int input]) → void -
This is a variant of AudioNode.disconnect with a
DestinationParam
argument instead of anAudioNode
. Note : The W3C recommandation uses just one verb for both.inherited -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited