PatchesModule Overview
PatchesModule Overview
PatchesOutputs

PatchesOutputs

The PatchesOutputs class encapsulates methods for getting outputs of the Patch Editor.

Properties

This module exposes no properties.

Methods

MethodDescription
get
get(name: string): Promise<ISignal>


Returns a promise, that is resolved to a signal of the correct type, existing in the
patch editor under the specified 'name'.
getBoolean
getBoolean(name: string): Promise<BoolSignal>


Returns a promise that is resolved with a BoolSignal existing in the Patch Editor under specified name.
getBooleanOrFallback
getBooleanOrFallback(name: string, fallback: BoolSignal | boolean): BoolSignal


Returns a BoolSignal existing in the Patch Editor under specified name or fallback on error.
getColor
getColor(name: string): Promise<RgbaSignal>


Returns a promise that is resolved with a RgbaSignal existing in the Patch Editor under specified name.
getColorOrFallback
getColorOrFallback(name: string, fallback: RgbaSignal): RgbaSignal


Returns a RgbaSignal existing in the Patch Editor under specified name or fallback on error.
getOrFallback
getOrFallback(name: string, fallback: ISignal | boolean | number | string): ISignal


Returns an ISignal existing in the Patch Editor under the specified name or the value fallback on error.
The type of the ISignal with name 'name' must match the type of the fallback, otherwise a type
error will be thrown.
getPoint
getPoint(name: string): Promise<PointSignal>


Returns a promise that is resolved with a PointSignal existing in the Patch Editor under specified name.
getPoint2D
getPoint2D(name: string): Promise<Vec2Signal>


Returns a promise that is resolved with a Vec2Signal existing in the Patch Editor under specified name.
getPoint2DOrFallback
getPoint2DOrFallback(name: string, fallback: Vec2Signal): Vec2Signal


Returns a Vec2Signal existing in the Patch Editor under specified name or fallback on error.
getPointOrFallback
getPointOrFallback(name: string, fallback: PointSignal): PointSignal


Returns a PointSignal existing in the Patch Editor under specified name or fallback on error.
getPulse
getPulse(name: string): Promise<EventSource<any>>


Returns a promise that is resolved with a EventSource<any> existing in the Patch Editor under specified name.
getPulseOrFallback
getPulseOrFallback(name: string, fallback: EventSource<any>): EventSource<any>


Returns a EventSource<any> existing in the Patch Editor under specified name or fallback on error.
getScalar
getScalar(name: string): Promise<ScalarSignal>


Returns a promise that is resolved with a ScalarSignal existing in the Patch Editor under specified name.
getScalarOrFallback
getScalarOrFallback(name: string, fallback: ScalarSignal | number): ScalarSignal


Returns a ScalarSignal existing in the Patch Editor under specified name or fallback on error.
getString
getString(name: string): Promise<StringSignal>


Returns a promise that is resolved with a StringSignal existing in the Patch Editor under specified name.
getStringOrFallback
getStringOrFallback(name: string, fallback: StringSignal | string): StringSignal


Returns a StringSignal existing in the Patch Editor under specified name or fallback on error.
getVector
getVector(name: string): Promise<VectorSignal>


Returns a promise that is resolved with a VectorSignal existing in the Patch Editor under specified name.
getVectorOrFallback
getVectorOrFallback(name: string, fallback: VectorSignal): VectorSignal


Returns a VectorSignal existing in the Patch Editor under specified name or fallback on error.

Was this article helpful?