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
Returns
BaseElement
Overrides
Properties
context
protectedreadonlycontext:ElementContext
definition
readonlydefinition:ElementDefinition
Set by defineElement once init resolves, so it can't be used from a constructor.
pads
readonlypads:Pad[] =[]
Methods
createPad()
protectedcreatePad(direction,capabilities):Pad
Creates a pad and emits padadded.
Parameters
direction
"sink" | "src"
capabilities
Returns
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
matchesCapabilities()
protectedmatchesCapabilities(pad):boolean
True if the pad matches one of the definition's in capability bundles.
Parameters
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
Returns
void
Inherited from
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
Returns
void
Inherited from
removePad()
protectedremovePad(pad,failed?):void
Removes a pad and emits padremoved. Pass failed when a failure, not a catalog update, lost it.
Parameters
pad
failed?
boolean = false
Returns
void