WerkstattEffect

interface WerkstattEffect extends AudioEffect, ScriptDevice { uuid: string label: string enabled: boolean minimized: boolean index: number audioUnit: AnyAudioUnit key: 'Werkstatt' code: string parameters: readonly ScriptParameter[] samples: readonly ScriptSample[] remove(): void move(index: number): void parameter(label: string): ScriptParameter sample(label: string): ScriptSample }

Scriptable audio effect. See ScriptDevice

Hierarchy


Properties

uuid: string

readonly

Inherited from uuid

Unique id

label: string

Inherited from label

Custom label

enabled: boolean

Inherited from enabled

Enable or bypass the device

minimized: boolean

Inherited from minimized

Collapse the device editor in the studio

index: number

readonly

Inherited from index

Position in the effect chain (0 = first)

audioUnit: AnyAudioUnit

readonly

Inherited from audioUnit

The audio unit this effect belongs to

key: 'Werkstatt'

readonly

Overrides key

Always "Werkstatt"

code: string

Inherited from code

The script source. Setting it re-declares the parameters and samples from its // @param / // @sample lines

parameters: readonly ScriptParameter[]

readonly

Inherited from parameters

Declared parameters

samples: readonly ScriptSample[]

readonly

Inherited from samples

Declared sample slots

Methods

remove(): void

Inherited from remove

Remove this device from its host

Returns

  • void

move(index: number): void

Inherited from move

Move this effect to another position in its chain

Parameters

  • index (number)

Returns

  • void

parameter(label: string): ScriptParameter

Inherited from parameter

Find a parameter by its declared name

Parameters

  • label (string)

Returns

sample(label: string): ScriptSample

Inherited from sample

Find a sample slot by its declared name

Parameters

  • label (string)

Returns