Skip to content

Interface: AudioBufferSourceNode ​

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

Plays an AudioBuffer

Extends ​

Properties ​

buffer ​

ts
buffer: AudioBuffer | null;

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

Can be set to a buffer once


channelCount ​

ts
channelCount: number;

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

1 to 32

Inherited from ​

AudioScheduledSourceNode.channelCount


channelCountMode ​

ts
channelCountMode: ChannelCountMode;

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

Inherited from ​

AudioScheduledSourceNode.channelCountMode


channelInterpretation ​

ts
channelInterpretation: ChannelInterpretation;

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

Inherited from ​

AudioScheduledSourceNode.channelInterpretation


context ​

ts
readonly context: BaseAudioContext;

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

Inherited from ​

AudioScheduledSourceNode.context


detune ​

ts
readonly detune: AudioParam;

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


loop ​

ts
loop: boolean;

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


loopEnd ​

ts
loopEnd: number;

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


loopStart ​

ts
loopStart: number;

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


numberOfInputs ​

ts
readonly numberOfInputs: number;

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

Inherited from ​

AudioScheduledSourceNode.numberOfInputs


numberOfOutputs ​

ts
readonly numberOfOutputs: number;

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

Inherited from ​

AudioScheduledSourceNode.numberOfOutputs


onended ​

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

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

Called when the source stops playing

Inherited from ​

AudioScheduledSourceNode.onended


playbackRate ​

ts
readonly playbackRate: AudioParam;

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

Methods ​

addEventListener() ​

Call Signature ​

ts
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 ​
ParameterType
typeK
listener(this, event) => void
options?| boolean | AddEventListenerOptions
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.addEventListener

Call Signature ​

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

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

A boolean options (capture) is ignored

Parameters ​
ParameterType
typestring
listener| EventListenerOrEventListenerObject | null
options?| boolean | AddEventListenerOptions
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.addEventListener


connect() ​

Call Signature ​

ts
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 ​
ParameterType
destinationNodeT
output?number
input?number
Returns ​

T

Inherited from ​

AudioScheduledSourceNode.connect

Call Signature ​

ts
connect(destinationParam, output?): void;

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

Adds an output to the param's value

Parameters ​
ParameterType
destinationParamAudioParam
output?number
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.connect


disconnect() ​

Call Signature ​

ts
disconnect(): void;

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

Disconnects every output, or the outputs / connections given

Returns ​

void

Inherited from ​

AudioScheduledSourceNode.disconnect

Call Signature ​

ts
disconnect(output): void;

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

Parameters ​
ParameterType
outputnumber
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.disconnect

Call Signature ​

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

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

Parameters ​
ParameterType
destinationNodeAudioNode
output?number
input?number
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.disconnect

Call Signature ​

ts
disconnect(destinationParam, output?): void;

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

Parameters ​
ParameterType
destinationParamAudioParam
output?number
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.disconnect


dispatchEvent() ​

ts
dispatchEvent(event): boolean;

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

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

Parameters ​

ParameterType
eventEvent

Returns ​

boolean

Inherited from ​

AudioScheduledSourceNode.dispatchEvent


removeEventListener() ​

Call Signature ​

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

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

Type Parameters ​
Type Parameter
K extends "ended"
Parameters ​
ParameterType
typeK
listener(this, event) => void
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.removeEventListener

Call Signature ​

ts
removeEventListener(type, listener): void;

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

Parameters ​
ParameterType
typestring
listener| EventListenerOrEventListenerObject | null
Returns ​

void

Inherited from ​

AudioScheduledSourceNode.removeEventListener


start() ​

ts
start(
   when?, 
   offset?, 
   duration?
): void;

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

Plays from offset (seconds in the buffer) for duration seconds, or to the end

Parameters ​

ParameterType
when?number
offset?number
duration?number

Returns ​

void

Overrides ​

AudioScheduledSourceNode.start


stop() ​

ts
stop(when?): void;

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

After start()

Parameters ​

ParameterType
when?number

Returns ​

void

Inherited from ​

AudioScheduledSourceNode.stop

The SDK is released under the Apache License 2.0