Get Started

Create AR effects for Instagram and Meta.
Get Started

Scripting API

PatchesModule

PatchesInputs

PatchesInputs

Contents

Contents

The PatchesInputs class encapsulates methods for setting inputs to the Patch Editor.

Example

Properties

This module exposes no properties.

Methods

Method	Description
`set`	set(name: string, signal: ISignal \| boolean \| number \| string): Promise<void> Sends a generic ISignal to the Patch Editor under the specified 'name'
`setBoolean`	setBoolean(name: string, signal: BoolSignal \| boolean): Promise<void> Sends a `BoolSignal` to the Patch Editor under specified `name`.
`setColor`	setColor(name: string, signal: RgbaSignal): Promise<void> Sends a `RgbaSignal` to the Patch Editor under specified `name`.
`setPoint`	setPoint(name: string, signal: PointSignal): Promise<void> Sends a `PointSignal` to the Patch Editor under specified `name`.
`setPoint2D`	setPoint2D(name: string, signal: Vec2Signal): Promise<void> Sends a `Vec2Signal` to the Patch Editor under specified `name`.
`setPulse`	setPulse(name: string, pulse: EventSource<any>): Promise<void> Sends a `EventSource<any>` to the Patch Editor under specified `name`. Note: The `Reactive.once()` method can be used to return an `EventSource<void>` that emits an empty event as soon as possible.
`setScalar`	setScalar(name: string, signal: ScalarSignal \| number): Promise<void> Sends a `ScalarSignal` to the Patch Editor under specified `name`.
`setString`	setString(name: string, signal: StringSignal \| string): Promise<void> Sends a `StringSignal` to the Patch Editor under specified `name`.
`setVector`	setVector(name: string, signal: VectorSignal): Promise<void> Sends a `VectorSignal` to the Patch Editor under specified `name`.