Abstract Class: TransformElement
Takes pads from upstream and writes its output to source pads it creates.
Extends
Constructors
Constructor
new TransformElement(
context):TransformElement
Calls context.attach(this), so the player hears everything the instance emits.
Parameters
context
Returns
TransformElement
Inherited from
Properties
context
protectedreadonlycontext:ElementContext
Inherited from
definition
readonlydefinition:ElementDefinition
Set by defineElement once init resolves, so it can't be used from a constructor.
Inherited from
pads
readonlypads:Pad[] =[]
Inherited from
Methods
createPad()
protectedcreatePad(direction,capabilities):Pad
Creates a pad and emits padadded.
Parameters
direction
"sink" | "src"
capabilities
Returns
Inherited from
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>
Inherited from
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
Inherited from
BaseElement.matchesCapabilities
negotiate()
abstractnegotiate(pad):boolean
Whether to take this upstream source pad.
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
receive()
abstractreceive(pad,item):void|Promise<void>
Called once per item; the pad's next item waits for the returned promise.
Parameters
pad
item
Returns
void | Promise<void>
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