Class NPlugParameter

Namespace

PluginUI.NPlug

Assembly

PluginUI.NPlug.dll

IParameter view of an NPlug NPlug.AudioParameter: bind any PluginUI control to a VST3 parameter. Obtain instances from NPlugParameterSet (one per editor), which raises Changed for host automation, preset loads and edits.

public sealed class NPlugParameter : IParameter

Inheritance

object

NPlugParameter

Implements

IParameter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ParameterExtensions.PlainValue(IParameter)

ParameterExtensions.SetValue(IParameter, double)

ParameterExtensions.StateIndex(IParameter)

ParameterExtensions.ToDisplayStringWithUnits(IParameter, double)

Properties

DefaultNormalizedValue

Default normalized value.

public double DefaultNormalizedValue { get; }

Property Value

double

Id

VST3 parameter id.

public AudioParameterId Id { get; }

Property Value

AudioParameterId

IsEditing

true between BeginEdit() and EndEdit().

public bool IsEditing { get; }

Property Value

bool

Name

Display name.

public string Name { get; }

Property Value

string

NormalizedValue

Current normalized value.

public double NormalizedValue { get; }

Property Value

double

Parameter

Wrapped NPlug parameter.

public AudioParameter Parameter { get; }

Property Value

AudioParameter

StepCount

0 = continuous; otherwise number of steps (states − 1).

public int StepCount { get; }

Property Value

int

Units

Unit label (Hz, dB, %, ms...).

public string Units { get; }

Property Value

string

Methods

BeginEdit()

Starts an edit gesture.

public void BeginEdit()

EndEdit()

Ends the edit gesture.

public void EndEdit()

PerformEdit(double)

Sets the value during a gesture.

public void PerformEdit(double normalized)

Parameters

normalized double

ToDisplayString(double)

Text for a normalized value (without units).

public string ToDisplayString(double normalized)

Parameters

normalized double

Returns

string

ToNormalized(double)

Plain → normalized value.

public double ToNormalized(double plain)

Parameters

plain double

Returns

double

ToPlain(double)

Normalized → plain value.

public double ToPlain(double normalized)

Parameters

normalized double

Returns

double

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

TryParse(string, out double)

Parses user text (with or without units) into a normalized value.

public bool TryParse(string text, out double normalized)

Parameters

text string

normalized double

Returns

bool

Events

Changed

Raised after every value change.

public event Action<IParameter>? Changed

Event Type

Action<IParameter>