Class PluginChainController

Owns the plugin chains for every strip. The server calls the mutating methods in response to plugin.* frames and reads chainState to broadcast.

Index

Constructors

Methods

add chainState loadPreset move remove setBypass setParam setPatch ref

Constructors

constructor

new PluginChainController(
options: PluginChainControllerOptions,
): PluginChainController
Parameters
- options: PluginChainControllerOptions
Returns PluginChainController

Methods

add

add(strip: ChannelId, slot: number, uri: string): Promise<PluginSlotState[]>
Load uri into strip at slot. Appends when slot is at/after the end; replaces the plugin currently at that position otherwise. Reconciles the chain.
Parameters
- strip: ChannelId
- slot: number
- uri: string
Returns Promise<PluginSlotState[]>
the strip's new chain state

chainState

chainState(strip: ChannelId): PluginSlotState[]
The current plugin.chain payload for a strip (empty array if none loaded).
Parameters
- strip: ChannelId
Returns PluginSlotState[]

loadPreset

loadPreset(
    strip: ChannelId,
    slot: number,
    presetUri: string,
): Promise<PluginSlotState[]>
Load an LV2 preset into the plugin at slot.
Parameters
- strip: ChannelId
- slot: number
- presetUri: string
Returns Promise<PluginSlotState[]>

move

move(strip: ChannelId, from: number, to: number): Promise<PluginSlotState[]>
Move the plugin at from to to (the rack reorder): splice the slot out, then reinsert it at the destination clamped to the chain. Params and bypass ride with their plugin. An out-of-range from (or a no-op move) leaves the chain untouched.
Parameters
- strip: ChannelId
- from: number
- to: number
Returns Promise<PluginSlotState[]>

remove

remove(strip: ChannelId, slot: number): Promise<PluginSlotState[]>
Remove the plugin at slot from strip (no-op if the slot is empty).
Parameters
- strip: ChannelId
- slot: number
Returns Promise<PluginSlotState[]>

setBypass

setBypass(
    strip: ChannelId,
    slot: number,
    bypassed: boolean,
): Promise<PluginSlotState[]>
Bypass / un-bypass the plugin at slot.
Parameters
- strip: ChannelId
- slot: number
- bypassed: boolean
Returns Promise<PluginSlotState[]>

setParam

setParam(
    strip: ChannelId,
    slot: number,
    symbol: string,
    value: number,
): Promise<PluginSlotState[]>
Set a control-port value on the plugin at slot, clamped to the param range.
Parameters
- strip: ChannelId
- slot: number
- symbol: string
- value: number
Returns Promise<PluginSlotState[]>

setPatch

setPatch(
    strip: ChannelId,
    slot: number,
    uri: string,
    value: string | number,
): Promise<PluginSlotState[]>
Set an lv2:Parameter (Patch ext) on the plugin at slot.
Parameters
- strip: ChannelId
- slot: number
- uri: string
- value: string | number
Returns Promise<PluginSlotState[]>

`Static`ref

ref(strip: ChannelId): ChannelRef
The channel ref for a strip (for building the broadcast frame).
Parameters
- strip: ChannelId
Returns ChannelRef