Class PluginUIMessages

Namespace

PluginUI.NPlug

Assembly

PluginUI.NPlug.dll

Messages exchanged by PluginUIController<TModel> and PluginUIProcessor<TModel> through the VST3 connection (IConnectionPoint::notify, always on the UI thread).

public static class PluginUIMessages

Inheritance

object

PluginUIMessages

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Message identifiers start with PluginUI.: use another prefix for your own messages. Unknown messages are left to the derived classes (override OnMessage and call the base method).

Fields

Note

A note played on the editor (attributes kind, pitch, velocity, channel).

public const string Note = "PluginUI.Note"

Field Value

string

SharedState

The processor announces its shared state (attribute handle).

public const string SharedState = "PluginUI.SharedState"

Field Value

string

SharedStateRequest

The controller asks the processor to announce its shared state.

public const string SharedStateRequest = "PluginUI.SharedStateRequest"

Field Value

string

Methods

TrySend(AudioHostApplication?, IAudioConnectionPoint?, string, Action<AudioAttributeList>?)

Creates a message, lets fill set its attributes and sends it to peer.

public static bool TrySend(AudioHostApplication? host, IAudioConnectionPoint? peer, string id, Action<AudioAttributeList>? fill = null)

Parameters

host AudioHostApplication

Host application of the sending component (creates the message).

peer IAudioConnectionPoint

Connection point of the other component.

id string

Message identifier.

fill Action<AudioAttributeList>

Sets the attributes (may be null).

Returns

bool

false if there is no host, no connection or the host could not create the message.