View source

class AudioScheduledSourceNode

package js.html.audio

extends AudioNode › EventTarget

extended by AudioBufferSourceNode, ConstantSourceNode, OscillatorNode

@:native("AudioScheduledSourceNode")

Available on js

The AudioScheduledSourceNode interface—part of the Web Audio API—is a parent interface for several types of audio source node interfaces which share the ability to be started and stopped, optionally at specified times. Specifically, this interface defines the start() and stop() methods, as well as the onended event handler.

Documentation AudioScheduledSourceNode by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See also:

Variables

onended:Function

A function to be called when the ended event is fired, indicating that the node has finished playing.

Methods

@:value({ when : 0.0 })start(when:Float = 0.0):Void

Throws:

null

DOMError

@:value({ when : 0.0 })stop(when:Float = 0.0):Void

Throws:

null

DOMError

Inherited Variables

Defined by AudioNode

channelCount:Int

Represents an integer used to determine how many channels are used when up-mixing and down-mixing connections to any inputs to the node. Its usage and precise definition depend on the value of AudioNode.channelCountMode.

channelCountMode:ChannelCountMode

Represents an enumerated value describing the way channels must be matched between the node's inputs and outputs.

channelInterpretation:ChannelInterpretation

Represents an enumerated value describing the meaning of the channels. This interpretation will define how audio up-mixing and down-mixing will happen.

The possible values are "speakers" or "discrete".

read onlycontext:BaseAudioContext

Returns the associated BaseAudioContext, that is the object representing the processing graph the node is participating in.

read onlynumberOfInputs:Int

Returns the number of inputs feeding the node. Source nodes are defined as nodes having a numberOfInputs property with a value of 0.

read onlynumberOfOutputs:Int

Returns the number of outputs coming out of the node. Destination nodes — like AudioDestinationNode — have a value of 0 for this attribute.

Inherited Methods

Defined by AudioNode

@:value({ output : 0 })connect(destination:AudioParam, output:Int = 0):Void

@:value({ input : 0, output : 0 })connect(destination:AudioNode, output:Int = 0, input:Int = 0):AudioNode

Allows us to connect the output of this node to be input into another node, either as audio data or as the value of an AudioParam.

Throws:

null

DOMError

disconnect(destination:AudioParam, output:Int):Void

disconnect():Void

disconnect(output:Int):Void

disconnect(destination:AudioNode):Void

disconnect(destination:AudioNode, output:Int):Void

disconnect(destination:AudioNode, output:Int, input:Int):Void

disconnect(destination:AudioParam):Void

Allows us to disconnect the current node from another one it is already connected to.

Throws:

null

DOMError

Defined by EventTarget

addEventListener(type:String, listener:Function, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

addEventListener(type:String, listener:EventListener, ?options:EitherType<AddEventListenerOptions, Bool>, ?wantsUntrusted:Bool):Void

Register an event handler of a specific event type on the EventTarget.

Throws:

null

DOMError

dispatchEvent(event:Event):Bool

Dispatch an event to this EventTarget.

Throws:

null

DOMError

removeEventListener(type:String, listener:Function, ?options:EitherType<EventListenerOptions, Bool>):Void

removeEventListener(type:String, listener:EventListener, ?options:EitherType<EventListenerOptions, Bool>):Void

Removes an event listener from the EventTarget.

Throws:

null

DOMError