JS API Reference IPatcherDescription interface

IPatcherDescription interface

Patcher Description of a generated RNBO Patcher

Signature

export interface IPatcherDescription 

Properties

externalDataRefs

Type: ExternalDataInfo[]

a list of external dataref ids

inports

Type: MessagePort[]

a list of inports

meta

Type: { maxversion?: string; rnboversion: string; }

numInputChannels

Type: number

number of input channels on the patcher

numMidiInputPorts

Type: number

number of MIDI input ports on the patcher

numMidiOutputPorts

Type: number

number of MIDI output ports on the patcher

numOutputChannels

Type: number

number of output channels on the patcher

numParameters

Type: number

number of parameters

numSignalInParameters

Type: number

number of signal input parameters

numSignalOutParameters

Type: number

number of signal output parameters (aka. additional named audio outputs)

options

Type: IPatcherOptions

Patcher Options

outports

Type: MessagePort[]

a list of outports

parameters

Type: IParameterDescription[]

Parameter description see IParameterDescription

patcherSerial

Type: number

serial number pf patcher, used for state restoration

rnboVersion

Type: string

Warning: This API is deprecated.

since version 0.18.0, see meta.rnboversion