Parameter

Plugin parameter. Implement the Observer pattern for UI support. Note: Recursive mutexes are needed here because getNormalized() could need locking an already taken mutex.

class Parameter {

string name();

string label();

int index();

void setFromHost(double hostValue);

double getForHost();

void toDisplayN(char* buffer, size_t numBytes);

void addListener(IParameterListener listener);

void removeListener(IParameterListener listener);

void beginParamEdit();

void endParamEdit();

double getNormalized();

double getNormalizedDefault();

void stringFromNormalizedValue(double normalizedValue, char* buffer, size_t len);

bool normalizedValueFromString(string valueString, double result);

~this();

this(int index, string name, string label);

void setNormalized(double hostValue);

void toStringN(char* buffer, size_t numBytes);

void notifyListeners();

}

Constructors

this this(int index, string name, string label): Undocumented in source.

Destructor

~this ~this(): Undocumented in source.

Members

Functions

addListener void addListener(IParameterListener listener): Adds a parameter listener.
beginParamEdit void beginParamEdit(): Warns the host that a parameter will be edited.
endParamEdit void endParamEdit(): Warns the host that a parameter has finished being edited.
getForHost double getForHost()
getNormalized double getNormalized()
getNormalizedDefault double getNormalizedDefault()
index int index()
label string label()
name string name()
normalizedValueFromString bool normalizedValueFromString(string valueString, double result)
notifyListeners void notifyListeners(): Undocumented in source. Be warned that the author may not have intended to support it.
removeListener void removeListener(IParameterListener listener): Removes a parameter listener.
setClientReference void setClientReference(Client client): Parameters are owned by a client, this is used to make them refer back to it.
setFromHost void setFromHost(double hostValue): From a normalized double [0..1], set the parameter value.
setNormalized void setNormalized(double hostValue): From a normalized double, set the parameter value. No guarantee at all that getNormalized will return the same, because this value is rounded to fit.
stringFromNormalizedValue void stringFromNormalizedValue(double normalizedValue, char* buffer, size_t len)
toDisplayN void toDisplayN(char* buffer, size_t numBytes): Undocumented in source. Be warned that the author may not have intended to support it.
toStringN void toStringN(char* buffer, size_t numBytes): Display parameter (without label).

Parameter

Constructors

Destructor

Members

Functions

Meta

Source