Steinberg::Vst::ParameterContainer Class Reference

Collection of parameters. More...

#include "vstparameters.h"

Public Member Functions
void	init (int32 initialSize=10, int32 resizeDelta=100)
	Init param array.
Parameter *	addParameter (const ParameterInfo &info)
	Creates and adds a new parameter from a ParameterInfo.
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)
	Creates and adds a new parameter with given properties.
Parameter *	addParameter (Parameter *p)
	Adds a given parameter.
int32	getParameterCount () const
	Returns the count of parameters.
Parameter *	getParameterByIndex (int32 index) const
	Gets parameter by index.
void	removeAll ()
	Removes all parameters.
Parameter *	getParameter (ParamID tag) const
	Gets parameter by ID.
bool	removeParameter (ParamID tag)
	Remove a specific parameter by ID.

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.

Definition at line 189 of file vstparameters.h.

Member Typedef Documentation

IndexMap

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

protected

Definition at line 233 of file vstparameters.h.

ParameterPtrVector

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

protected

Definition at line 232 of file vstparameters.h.

Constructor & Destructor Documentation

ParameterContainer()

Steinberg::Vst::ParameterContainer::ParameterContainer

(

)

Definition at line 344 of file vstparameters.cpp.

~ParameterContainer()

Steinberg::Vst::ParameterContainer::~ParameterContainer

(

)

Definition at line 349 of file vstparameters.cpp.

Member Function Documentation

addParameter() [1/3]

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

(

const ParameterInfo &

info

)

Creates and adds a new parameter from a ParameterInfo.

Definition at line 377 of file vstparameters.cpp.

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.

Definition at line 424 of file vstparameters.cpp.

addParameter() [3/3]

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

(

Parameter *

p

)

Adds a given parameter.

Definition at line 367 of file vstparameters.cpp.

getParameter()

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

(

ParamID

tag

)

const

Gets parameter by ID.

Definition at line 397 of file vstparameters.cpp.

getParameterByIndex()

Parameter * Steinberg::Vst::ParameterContainer::getParameterByIndex

(

int32

index

)

const

Gets parameter by index.

Definition at line 389 of file vstparameters.cpp.

getParameterCount()

int32 Steinberg::Vst::ParameterContainer::getParameterCount

(

)

const

Returns the count of parameters.

Definition at line 212 of file vstparameters.h.

init()

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

Init param array.

Definition at line 356 of file vstparameters.cpp.

removeAll()

void Steinberg::Vst::ParameterContainer::removeAll

(

)

Removes all parameters.

Definition at line 218 of file vstparameters.h.

removeParameter()

bool Steinberg::Vst::ParameterContainer::removeParameter

(

ParamID

tag

)

Remove a specific parameter by ID.

Definition at line 409 of file vstparameters.cpp.

Member Data Documentation

id2index

IndexMap Steinberg::Vst::ParameterContainer::id2index

protected

Definition at line 235 of file vstparameters.h.

params

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

protected

Definition at line 234 of file vstparameters.h.

---

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

• juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstparameters.h
• juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstparameters.cpp