Class Vst3ParameterCollection

Namespace

NAudio.Vst3

Assembly

NAudio.Vst3.dll

Read-only collection of every parameter exposed by a Vst3Plugin's IEditController, in declaration order.

public sealed class Vst3ParameterCollection : IReadOnlyList<Vst3Parameter>, IReadOnlyCollection<Vst3Parameter>, IEnumerable<Vst3Parameter>, IEnumerable

Inheritance

object

Vst3ParameterCollection

Implements

IReadOnlyList<Vst3Parameter>

IReadOnlyCollection<Vst3Parameter>

IEnumerable<Vst3Parameter>

IEnumerable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Built once at plug-in instantiation by walking IEditController::getParameterCount / getParameterInfo. The collection itself is immutable; individual Vst3Parameter values are live (each property read round-trips to the controller).

Properties

BypassParameter

The bypass parameter, if the plug-in declared one with IsBypass. Most hosts surface bypass as a switch separate from the rest of the parameter list.

public Vst3Parameter? BypassParameter { get; }

Property Value

Vst3Parameter

Count

Gets the number of elements in the collection.

public int Count { get; }

Property Value

int

The number of elements in the collection.

this[int]

Gets the element at the specified index in the read-only list.

public Vst3Parameter this[int index] { get; }

Parameters

index int

The zero-based index of the element to get.

Property Value

Vst3Parameter

The element at the specified index in the read-only list.

Methods

FindByTitle(string)

Case-insensitive title lookup; returns null when no match is found. Titles are NOT guaranteed unique across a plug-in — for unambiguous addressing prefer GetById(uint).

public Vst3Parameter? FindByTitle(string title)

Parameters

title string

Returns

Vst3Parameter

GetById(uint)

O(1) lookup by VST 3 parameter id.

public Vst3Parameter GetById(uint id)

Parameters

id uint

Returns

Vst3Parameter

Exceptions

KeyNotFoundException

When no parameter has the requested id.

GetEnumerator()

Returns an enumerator that iterates through the collection.

public IEnumerator<Vst3Parameter> GetEnumerator()

Returns

IEnumerator<Vst3Parameter>

An enumerator that can be used to iterate through the collection.

TryGetById(uint, out Vst3Parameter)

Tries to find a parameter by id without throwing.

public bool TryGetById(uint id, out Vst3Parameter parameter)

Parameters

id uint

parameter Vst3Parameter

Returns

bool