Steinberg::Vst::ParameterContainer Class Reference

#include <vstparameters.h>

Public Member Functions
	ParameterContainer ()
	~ParameterContainer ()
void	init (int32 initialSize=10, int32 resizeDelta=100)
Parameter *	addParameter (const ParameterInfo &info)
Parameter *	addParameter (const TChar *title, const TChar *units=nullptr, int32 stepCount=0, ParamValue defaultValueNormalized=0., int32 flags=ParameterInfo::kCanAutomate, int32 tag=-1, UnitID unitID=kRootUnitId, const TChar *shortTitle=nullptr)
Parameter *	addParameter (Parameter *p)
int32	getParameterCount () const
Parameter *	getParameterByIndex (int32 index) const
void	removeAll ()
Parameter *	getParameter (ParamID tag) const
bool	removeParameter (ParamID tag)

Protected Types
using	ParameterPtrVector = std::vector<IPtr<Parameter>>
using	IndexMap = std::map<ParamID, ParameterPtrVector::size_type>

Protected Attributes
ParameterPtrVector *	params
IndexMap	id2index

Detailed Description

Collection of parameters.

Member Typedef Documentation

IndexMap

using Steinberg::Vst::ParameterContainer::IndexMap = std::map<ParamID, ParameterPtrVector::size_type>

protected

ParameterPtrVector

using Steinberg::Vst::ParameterContainer::ParameterPtrVector = std::vector<IPtr<Parameter>>

protected

Constructor & Destructor Documentation

ParameterContainer()

Steinberg::Vst::ParameterContainer::ParameterContainer

(

)

~ParameterContainer()

Steinberg::Vst::ParameterContainer::~ParameterContainer

(

)

Member Function Documentation

addParameter() [1/3]

Parameter * Steinberg::Vst::ParameterContainer::addParameter

(

const ParameterInfo &

info

)

Creates and adds a new parameter from a ParameterInfo.

addParameter() [2/3]

Parameter * Steinberg::Vst::ParameterContainer::addParameter	(	const TChar *	title,
		const TChar *	units = nullptr,
		int32	stepCount = 0,
		ParamValue	defaultValueNormalized = 0.,
		int32	flags = ParameterInfo::kCanAutomate,
		int32	tag = -1,
		UnitID	unitID = kRootUnitId,
		const TChar *	shortTitle = nullptr )

Creates and adds a new parameter with given properties.

addParameter() [3/3]

Parameter * Steinberg::Vst::ParameterContainer::addParameter

(

Parameter *

p

)

Adds a given parameter.

getParameter()

Parameter * Steinberg::Vst::ParameterContainer::getParameter

(

ParamID

tag

)

const

Gets parameter by ID.

getParameterByIndex()

Parameter * Steinberg::Vst::ParameterContainer::getParameterByIndex ( int32 index ) const

inline

Gets parameter by index.

getParameterCount()

int32 Steinberg::Vst::ParameterContainer::getParameterCount ( ) const

inline

Returns the count of parameters.

init()

void Steinberg::Vst::ParameterContainer::init	(	int32	initialSize = 10,
		int32	resizeDelta = 100 )

Init param array.

removeAll()

void Steinberg::Vst::ParameterContainer::removeAll ( )

inline

Removes all parameters.

removeParameter()

bool Steinberg::Vst::ParameterContainer::removeParameter

(

ParamID

tag

)

Remove a specific parameter by ID.

Member Data Documentation

id2index

IndexMap Steinberg::Vst::ParameterContainer::id2index

protected

params

ParameterPtrVector* Steinberg::Vst::ParameterContainer::params

protected

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vstparameters.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/vst3sdk/public.sdk/source/vst/vstparameters.cpp