Class NPlugParameterSet

Namespace

PluginUI.NPlug

Assembly

PluginUI.NPlug.dll

The NPlug parameters of one editor as IParameters. Listens to the model while the editor is open and forwards value changes (automation, presets, edits) to the bound controls.

public sealed class NPlugParameterSet

Inheritance

object

NPlugParameterSet

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

NPlugParameterSet(IParameterEditSink)

Creates the set for a controller.

public NPlugParameterSet(IParameterEditSink sink)

Parameters

sink IParameterEditSink

Properties

this[AudioParameter]

Wrapper of parameter (created on first use, then cached).

public NPlugParameter this[AudioParameter parameter] { get; }

Parameters

parameter AudioParameter

Property Value

NPlugParameter

Sink

Edit sink (the controller).

public IParameterEditSink Sink { get; }

Property Value

IParameterEditSink

Methods

Find(AudioParameterId)

Wrapper of the parameter with this id, or null.

public NPlugParameter? Find(AudioParameterId id)

Parameters

id AudioParameterId

Returns

NPlugParameter

Get(AudioParameter)

Wrapper of parameter (created on first use, then cached).

public NPlugParameter Get(AudioParameter parameter)

Parameters

parameter AudioParameter

Returns

NPlugParameter

GetSnapshotParameters(bool)

Wrappers of the model's user-editable parameters, in declaration order: what an A/B comparison (Parameters), an undo point or a randomizer should capture. Read-only, hidden and program-change parameters are left out, as is the bypass unless includeBypass is set.

public IReadOnlyList<NPlugParameter> GetSnapshotParameters(bool includeBypass = false)

Parameters

includeBypass bool

Includes the bypass parameter.

Returns

IReadOnlyList<NPlugParameter>

The wrappers.

StartListening()

Starts forwarding model events (editor opened).

public void StartListening()

StopListening()

Stops forwarding model events (editor closed).

public void StopListening()