RTRawVstParam Class Reference

This is the main class that the plugin should use as it exposes only the necessary methods of the param as well as redefine a couple of operators which helps in writing simpler and natural code (the param behaves like T in many ways). More...

#include <RTParameter.h>

Inherits Dereferenceable< RTRawVstParam >.

Public Member Functions
tresult	addToOutput (ProcessData &oData)
	Add the current normalized value as an output parameter changes which propagates the change to the vst sdk. More...
ParamID	getParamID () const
ParamValue const &	getValue () const
bool	hasChanged () const
ParamValue	operator * () const
	allow writing *param to access the underlying value (or in other words, *param is the same param.value()) More...
	operator ParamValue const & () const
RTRawVstParam &	operator= (ParamValue const &iValue)
	Allow to write param = 0.5. More...
ParamValue const &	previous () const
	RTRawVstParam (RTRawVstParameter *iPtr)
bool	update (ParamValue const &iNewValue)
	This method is typically called during the processing method when the plugin needs to update the value. More...
bool	update (ParamValue const &iNewValue, ProcessData &oData)
	This method is typically called during the processing method when the plugin needs to update the value. More...
ParamValue const &	value () const

Private Attributes
RTRawVstParameter *	fPtr

Detailed Description

This is the main class that the plugin should use as it exposes only the necessary methods of the param as well as redefine a couple of operators which helps in writing simpler and natural code (the param behaves like T in many ways).

Constructor & Destructor Documentation

RTRawVstParam()

RTRawVstParam ( RTRawVstParameter *  iPtr )

inline

Member Function Documentation

addToOutput()

tresult addToOutput ( ProcessData &  oData )

inline

Add the current normalized value as an output parameter changes which propagates the change to the vst sdk.

getParamID()

ParamID getParamID ( ) const

inline

getValue()

ParamValue const& getValue ( ) const

inline

hasChanged()

bool hasChanged ( ) const

inline

Returns

true if the parameter has changed within the frame (previous and current are different)

operator *()

ParamValue operator * ( ) const

inline

allow writing *param to access the underlying value (or in other words, *param is the same param.value())

operator ParamValue const &()

operator ParamValue const & ( ) const

inline

operator=()

RTRawVstParam& operator= ( ParamValue const &  iValue )

inline

Allow to write param = 0.5.

previous()

ParamValue const& previous ( ) const

inline

update() [1/2]

bool update ( ParamValue const &  iNewValue )

inline

This method is typically called during the processing method when the plugin needs to update the value.

In general the change needs to be propagated to the VST sdk (using addToOutput). Use this version of the call if you want to control when the update actually happens.

update() [2/2]

bool update ( ParamValue const &  iNewValue, ProcessData &  oData  )

inline

This method is typically called during the processing method when the plugin needs to update the value.

This version will automatically propagate the change to the the VST sdk.

value()

ParamValue const& value ( ) const

inline

Member Data Documentation

fPtr

RTRawVstParameter* fPtr

private

---

The documentation for this class was generated from the following file:

• pongasoft/VST/RT/RTParameter.h