Interface: AudioScheduledSourceNode

Defined in: types/desktop-engine.d.ts:4912

A source played once between start() and stop()

Extends

• AudioNode

Extended by

• AudioBufferSourceNode
• OscillatorNode
• ConstantSourceNode

Properties

channelCount

channelCount: number;

Defined in: types/desktop-engine.d.ts:4874

1 to 32

Inherited from

AudioNode.channelCount

---

channelCountMode

channelCountMode: ChannelCountMode;

Defined in: types/desktop-engine.d.ts:4875

Inherited from

AudioNode.channelCountMode

---

channelInterpretation

channelInterpretation: ChannelInterpretation;

Defined in: types/desktop-engine.d.ts:4876

Inherited from

AudioNode.channelInterpretation

---

context

readonly context: BaseAudioContext;

Defined in: types/desktop-engine.d.ts:4870

Inherited from

AudioNode.context

---

numberOfInputs

readonly numberOfInputs: number;

Defined in: types/desktop-engine.d.ts:4871

Inherited from

AudioNode.numberOfInputs

---

numberOfOutputs

readonly numberOfOutputs: number;

Defined in: types/desktop-engine.d.ts:4872

Inherited from

AudioNode.numberOfOutputs

---

onended

onended: ((this, event) => void) | null;

Defined in: types/desktop-engine.d.ts:4914

Called when the source stops playing

Methods

addEventListener()

Call Signature

addEventListener<K>(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:4919

A boolean options (capture) is ignored

Type Parameters

Type Parameter
K extends "ended"

Parameters

Parameter	Type
type	K
listener	(this, event) => void
options?	| boolean | AddEventListenerOptions

Returns

void

Overrides

AudioNode.addEventListener

Call Signature

addEventListener(
   type, 
   listener, 
   options?
): void;

Defined in: types/desktop-engine.d.ts:4920

A boolean options (capture) is ignored

Parameters

Parameter	Type
type	string
listener	| EventListenerOrEventListenerObject | null
options?	| boolean | AddEventListenerOptions

Returns

void

Overrides

AudioNode.addEventListener

---

connect()

Call Signature

connect<T>(
   destinationNode, 
   output?, 
   input?
): T;

Defined in: types/desktop-engine.d.ts:4878

Connects an output to an input of a node of the same context; returns that node, for chaining

Type Parameters

Type Parameter
T extends AudioNode

Parameters

Parameter	Type
destinationNode	T
output?	number
input?	number

Returns

T

Inherited from

AudioNode.connect

Call Signature

connect(destinationParam, output?): void;

Defined in: types/desktop-engine.d.ts:4880

Adds an output to the param's value

Parameters

Parameter	Type
destinationParam	AudioParam
output?	number

Returns

void

Inherited from

AudioNode.connect

---

disconnect()

Call Signature

disconnect(): void;

Defined in: types/desktop-engine.d.ts:4882

Disconnects every output, or the outputs / connections given

Returns

void

Inherited from

AudioNode.disconnect

Call Signature

disconnect(output): void;

Defined in: types/desktop-engine.d.ts:4883

Parameters

Parameter	Type
output	number

Returns

void

Inherited from

AudioNode.disconnect

Call Signature

disconnect(
   destinationNode, 
   output?, 
   input?
): void;

Defined in: types/desktop-engine.d.ts:4884

Parameters

Parameter	Type
destinationNode	AudioNode
output?	number
input?	number

Returns

void

Inherited from

AudioNode.disconnect

Call Signature

disconnect(destinationParam, output?): void;

Defined in: types/desktop-engine.d.ts:4885

Parameters

Parameter	Type
destinationParam	AudioParam
output?	number

Returns

void

Inherited from

AudioNode.disconnect

---

dispatchEvent()

dispatchEvent(event): boolean;

Defined in: types/desktop-engine.d.ts:3937

Returns false when a listener called preventDefault() on a cancelable event

Parameters

Parameter	Type
event	Event

Returns

boolean

Inherited from

AudioNode.dispatchEvent

---

removeEventListener()

Call Signature

removeEventListener<K>(type, listener): void;

Defined in: types/desktop-engine.d.ts:4921

Type Parameters

Type Parameter
K extends "ended"

Parameters

Parameter	Type
type	K
listener	(this, event) => void

Returns

void

Overrides

AudioNode.removeEventListener

Call Signature

removeEventListener(type, listener): void;

Defined in: types/desktop-engine.d.ts:4922

Parameters

Parameter	Type
type	string
listener	| EventListenerOrEventListenerObject | null

Returns

void

Overrides

AudioNode.removeEventListener

---

start()

start(when?): void;

Defined in: types/desktop-engine.d.ts:4916

Once only; when is in seconds of context.currentTime, 0 (the default) is now

Parameters

Parameter	Type
when?	number

Returns

void

---

stop()

stop(when?): void;

Defined in: types/desktop-engine.d.ts:4918

After start()

Parameters

Parameter	Type
when?	number

Returns

void