Skip to content

Abstract Class: BaseElement ​

Base of every element instance.

Extends ​

Extended by ​

Constructors ​

Constructor ​

new BaseElement(context): BaseElement

Calls context.attach(this), so the player hears everything the instance emits.

Parameters ​

context ​

ElementContext

Returns ​

BaseElement

Overrides ​

Emitter.constructor

Properties ​

context ​

protected readonly context: ElementContext


definition ​

readonly definition: ElementDefinition

Set by defineElement once init resolves, so it can't be used from a constructor.


pads ​

readonly pads: Pad[] = []

Methods ​

createPad() ​

protected createPad(direction, capabilities): Pad

Creates a pad and emits padadded.

Parameters ​

direction ​

"sink" | "src"

capabilities ​

Capabilities

Returns ​

Pad


destroy() ​

destroy(): Promise<void>

Removes the element's pads. The runtime aborts context.signal before and releases the elements this one loaded after. Override for your own cleanup and call super.destroy().

Returns ​

Promise<void>


emit() ​

emit<K>(event, ...args): void

Calls every listener of event with args. Allocates nothing when there are none.

Type Parameters ​

K ​

K extends "ready" | "padadded" | "padremoved" | "nomorepads"

Parameters ​

event ​

K

args ​

...Parameters<ElementEvents[K]>

Returns ​

void

Inherited from ​

Emitter.emit


matchesCapabilities() ​

protected matchesCapabilities(pad): boolean

True if the pad matches one of the definition's in capability bundles.

Parameters ​

pad ​

Pad

Returns ​

boolean


off() ​

off<K>(event, listener): void

Removes listener, the same function given to on(), from event.

Type Parameters ​

K ​

K extends "ready" | "padadded" | "padremoved" | "nomorepads"

Parameters ​

event ​

K

listener ​

ElementEvents[K]

Returns ​

void

Inherited from ​

Emitter.off


on() ​

on<K>(event, listener): void

Adds listener for event. Adding the same function twice has no effect.

Type Parameters ​

K ​

K extends "ready" | "padadded" | "padremoved" | "nomorepads"

Parameters ​

event ​

K

listener ​

ElementEvents[K]

Returns ​

void

Inherited from ​

Emitter.on


removePad() ​

protected removePad(pad, failed?): void

Removes a pad and emits padremoved. Pass failed when a failure, not a catalog update, lost it.

Parameters ​

pad ​

Pad

failed? ​

boolean = false

Returns ​

void