iPlug 2: IPluginBase Class Reference

Base class that contains plug-in info and state manipulation methods. More...

#include <IPlugPluginBase.h>

Public Member Functions
	IPluginBase (int nParams, int nPresets)

	IPluginBase (const IPluginBase &)=delete

IPluginBase &	operator= (const IPluginBase &)=delete

const char *	GetPluginName () const

int	GetPluginVersion (bool decimal) const
	Get the plug-in version number. More...

void	GetPluginVersionStr (WDL_String &str) const
	Gets the plug-in version as a string. More...

const char *	GetMfrName () const
	Get the manufacturer name as a CString. More...

const char *	GetProductName () const
	Get the product name as a CString. More...

int	GetUniqueID () const

int	GetMfrID () const

EHost	GetHost () const

void	GetHostStr (WDL_String &str) const
	Get the host name (name is normalized) More...

void	GetRawHostStr (WDL_String &str) const
	Get raw host name (as it is reported from the host) More...

int	GetHostVersion (bool decimal) const
	Get the host version number as an integer. More...

void	GetHostVersionStr (WDL_String &str) const
	Get the host version number as a string. More...

EAPI	GetAPI () const

const char *	GetAPIStr () const

const char *	GetArchStr () const

void	GetBuildInfoStr (WDL_String &str, const char date, const char time) const
	Get the build date of the plug-in and architecture/api details in one string. More...

bool	HasUI () const

bool	GetHostResizeEnabled () const

const char *	GetBundleID () const

const char *	GetAppGroupID () const

int	NParamGroups () const

int	AddParamGroup (const char *name)
	Called to add a parameter group name, when a unique group name is discovered. More...

const char *	GetParamGroupName (int idx) const
	Get the parameter group name as a particular index. More...

virtual void	InformHostOfParameterDetailsChange ()
	Implemented by the API class, call this if you update parameter labels and hopefully the host should update it's displays (not applicable to all APIs) More...

bool	DoesStateChunks () const

bool	SerializeParams (IByteChunk &chunk) const
	Serializes the current double precision floating point, non-normalised values (IParam::mValue) of all parameters, into a binary byte chunk. More...

int	UnserializeParams (const IByteChunk &chunk, int startPos)
	Unserializes double precision floating point, non-normalised values from a byte chunk into mParams. More...

virtual bool	SerializeState (IByteChunk &chunk) const
	Override this method to serialize custom state data, if your plugin does state chunks. More...

virtual int	UnserializeState (const IByteChunk &chunk, int startPos)
	Override this method to unserialize custom state data, if your plugin does state chunks. More...

virtual bool	SerializeVST3CtrlrState (IByteChunk &chunk) const
	VST3 ONLY! - THIS IS ONLY INCLUDED FOR COMPATIBILITY - NOONE ELSE SHOULD NEED IT! More...

virtual int	UnserializeVST3CtrlrState (const IByteChunk &chunk, int startPos)
	VST3 ONLY! - THIS IS ONLY INCLUDED FOR COMPATIBILITY - NOONE ELSE SHOULD NEED IT! More...

int	GetCurrentPresetIdx () const
	Get the index of the current, active preset. More...

void	SetCurrentPresetIdx (int idx)
	Set the index of the current, active preset. More...

virtual void	InformHostOfPresetChange ()
	Implemented by the API class, called by the UI (etc) when the plug-in initiates a program/preset change (not applicable to all APIs) More...

IPreset *	GetPreset (int idx)
	Get a ptr to a factory preset @ param idx The index number of the preset you are referring to. More...

void	ModifyCurrentPreset (const char *name=0)
	This method should update the current preset with current values NOTE: This is only relevant for VST2 plug-ins, which is the only format to have the notion of banks? More...

int	NPresets () const
	Gets the number of factory presets. More...

bool	RestorePreset (int idx)
	Restore a preset by index. More...

bool	RestorePreset (const char *name)
	Restore a preset by name. More...

const char *	GetPresetName (int idx) const
	Get the name a preset. More...

void	CopyPreset (IPreset *pSrc, int destIdx, bool copyname=false)
	Copy source preset to preset at index. More...

void	MakeDefaultPreset (const char *name=0, int nPresets=1)
	This method can be used to initialize baked-in factory presets with the default parameter values. More...

void	MakePreset (const char *name,...)
	Create a baked-in factory preset, specifiying parameter values sequentially usage: MakePreset(name, param1, param2, ..., paramN) See DumpMakePresetSrc() which is a utility that can be used to create the code for MakePreset() calls. More...

void	MakePresetFromNamedParams (const char *name, int nParamsNamed,...)
	Create a baked-in factory preset, specifiying parameter values with a list of parameter index and value pairs usage: MakePresetFromNamedParams(name, nParamsNamed, paramEnum1, paramVal1, paramEnum2, paramVal2, ..., paramEnumN, paramVal2) See DumpMakePresetFromNamedParamsSrc() which is a utility that can be used to create the code for MakePreset() calls nParamsNamed may be less than the total number of params. More...

void	MakePresetFromChunk (const char *name, IByteChunk &chunk)
	Creates a preset from an IByteChunk containing serialized data. More...

void	MakePresetFromBlob (const char name, const char blob, int sizeOfChunk)
	Creates a preset from a base64 encoded CString. More...

void	PruneUninitializedPresets ()
	[AUV2 only] Removes any presets that weren't initialized More...

virtual void	OnPresetsModified ()
	[VST2 only] Called when the preset name is changed by the host More...

void	EnsureDefaultPreset ()
	[VST2 only] Called to fill uninitialzed presets More...

bool	SerializePresets (IByteChunk &chunk) const
	[VST2 only] Called when the VST2 host calls effGetChunk for a bank * More...

int	UnserializePresets (const IByteChunk &chunk, int startPos)
	[VST2 only] Called when the VST2 host calls effSetChunk for a bank * More...

void	DumpMakePresetSrc (const char *file) const
	Writes a call to MakePreset() for the current preset to a new text file. More...

void	DumpMakePresetFromNamedParamsSrc (const char file, const char paramEnumNames[]) const
	Writes a call to MakePresetFromNamedParams() for the current preset to a new text file. More...

void	DumpPresetBlob (const char *file) const
	Writes a call to MakePresetFromBlob() for the current preset to a new text file. More...

bool	SavePresetAsFXP (const char *file) const
	Save current state as a VST2 format preset. More...

bool	SaveBankAsFXB (const char *file) const
	Save current bank as a VST2 format bank [VST2 only]. More...

bool	LoadPresetFromFXP (const char *file)
	Load VST2 format preset. More...

bool	LoadBankFromFXB (const char *file)
	Load VST2 format bank [VST2 only]. More...

void	InitParamRange (int startIdx, int endIdx, int countStart, const char nameFmtStr, double defaultVal, double minVal, double maxVal, double step, const char label="", int flags=0, const char *group="", const IParam::Shape &shape=IParam::ShapeLinear(), IParam::EParamUnit unit=IParam::kUnitCustom, IParam::DisplayFunc displayFunc=nullptr)
	Initialise a range of parameters simultaneously. More...

void	CloneParamRange (int cloneStartIdx, int cloneEndIdx, int startIdx, const char searchStr="", const char replaceStr="", const char *newGroup="")
	Clone a range of parameters, optionally doing a string substitution on the parameter name. More...

void	ForParamInRange (int startIdx, int endIdx, std::function< void(int paramIdx, IParam &param)> func)
	Modify a range of parameters with a lamda function. More...

void	ForParamInGroup (const char *paramGroup, std::function< void(int paramIdx, IParam &param)> func)
	Modify a parameter group simulataneously. More...

void	CopyParamValues (int startIdx, int destIdx, int nParams)
	Copy a range of parameter values. More...

void	CopyParamValues (const char inGroup, const char outGroup)
	Copy a range of parameter values for a parameter group. More...

void	RandomiseParamValues ()
	Randomise all parameters. More...

void	RandomiseParamValues (int startIdx, int endIdx)
	Randomise parameter values within a range. More...

void	RandomiseParamValues (const char *paramGroup)
	Randomise parameter values for a parameter group. More...

void	DefaultParamValues ()
	Set all parameters to their default values. More...

void	DefaultParamValues (int startIdx, int endIdx)
	Default parameter values within a range. More...

void	DefaultParamValues (const char *paramGroup)
	Default parameter values for a parameter group. More...

void	PrintParamValues ()
	Default parameter values for a parameter group More...

Friends
class	IPlugAPP

class	IPlugAAX

class	IPlugVST2

class	IPlugVST3

class	IPlugVST3Controller

class	IPlugVST3Processor

class	IPlugAU

class	IPlugAUv3

class	IPlugWEB

class	IPlugWAM

class	IPlugAPIBase

Base class that contains plug-in info and state manipulation methods.

Definition at line 26 of file IPlugPluginBase.h.

IPluginBase::IPluginBase	(	int	nParams,
		int	nPresets
	)

◆ ~IPluginBase()

IPluginBase::~IPluginBase

(

)

virtual

◆ AddParamGroup()

int IPluginBase::AddParamGroup

(

const char *

name

)

inline

Called to add a parameter group name, when a unique group name is discovered.

Parameters

name	CString for the unique group name

Returns: Number of parameter groups

Definition at line 118 of file IPlugPluginBase.h.

References NParamGroups().

◆ CloneParamRange()

void IPluginBase::CloneParamRange	(	int	cloneStartIdx,
		int	cloneEndIdx,
		int	startIdx,
		const char *	searchStr = `""`,
		const char *	replaceStr = `""`,
		const char *	newGroup = `""`
	)

Clone a range of parameters, optionally doing a string substitution on the parameter name.

Parameters

cloneStartIdx	The index of the first parameter to clone
cloneEndIdx	The index of the last parameter to clone
startIdx	The start of the cloned range
searchStr	A CString to search for in the input parameter name
replaceStr	A CString to replace searchStr in the output parameter name
newGroup	If the new parameter should have a different group, update here

Definition at line 157 of file IPlugPluginBase.cpp.

References IParam::Value().

◆ CopyParamValues() [1/2]

void IPluginBase::CopyParamValues	(	const char *	inGroup,
		const char *	outGroup
	)

Copy a range of parameter values for a parameter group.

Parameters

inGroup	The name of the group to copy from
outGroup	The name of the group to copy to

Definition at line 180 of file IPlugPluginBase.cpp.

References IParam::GetGroup().

◆ CopyParamValues() [2/2]

void IPluginBase::CopyParamValues	(	int	startIdx,
		int	destIdx,
		int	nParams
	)

Copy a range of parameter values.

Parameters

startIdx	The index of the first parameter value to copy
destIdx	The index of the first destination parameter
nParams	The number of parameters to copy

Definition at line 168 of file IPlugPluginBase.cpp.

◆ CopyPreset()

void IPluginBase::CopyPreset	(	IPreset *	pSrc,
		int	destIdx,
		bool	copyname = `false`
	)

inline

◆ DefaultParamValues() [1/3]

void IPluginBase::DefaultParamValues

(

)

◆ DefaultParamValues() [2/3]

void IPluginBase::DefaultParamValues

(

const char *

paramGroup

)

◆ DefaultParamValues() [3/3]

void IPluginBase::DefaultParamValues	(	int	startIdx,
		int	endIdx
	)

◆ DoesStateChunks()

bool IPluginBase::DoesStateChunks

(

)

const

inline

◆ DumpMakePresetFromNamedParamsSrc()

void IPluginBase::DumpMakePresetFromNamedParamsSrc	(	const char *	file,
		const char *	paramEnumNames[]
	)		const

◆ DumpMakePresetSrc()

void IPluginBase::DumpMakePresetSrc

(

const char *

file

)

const

◆ DumpPresetBlob()

void IPluginBase::DumpPresetBlob

(

const char *

file

)

const

◆ EnsureDefaultPreset()

void IPluginBase::EnsureDefaultPreset

(

)

◆ ForParamInGroup()

void IPluginBase::ForParamInGroup	(	const char *	paramGroup,
		std::function< void(int paramIdx, IParam &param)>	func
	)

◆ ForParamInRange()

void IPluginBase::ForParamInRange	(	int	startIdx,
		int	endIdx,
		std::function< void(int paramIdx, IParam &param)>	func
	)

Modify a range of parameters with a lamda function.

Parameters

startIdx	The index of the first parameter to modify
endIdx	The index of the last parameter to modify
func	A lambda function to modify the parameter. Ideas: you could randomise the parameter value or reset to default, modify certain params based on their group

Definition at line 205 of file IPlugPluginBase.cpp.

Referenced by DefaultParamValues(), PrintParamValues(), and RandomiseParamValues().

◆ GetAPI()

EAPI IPluginBase::GetAPI

(

)

const

inline

◆ GetAPIStr()

const char * IPluginBase::GetAPIStr

(

)

const

◆ GetAppGroupID()

const char * IPluginBase::GetAppGroupID

(

)

const

inline

◆ GetArchStr()

const char * IPluginBase::GetArchStr

(

)

const

◆ GetBuildInfoStr()

void IPluginBase::GetBuildInfoStr	(	WDL_String &	str,
		const char *	date,
		const char *	time
	)		const

Get the build date of the plug-in and architecture/api details in one string.

Parameters

str	WDL_String will be set with the Plugin name, architecture, api, build date, build time
date	CString, use DATE macro
time	CString, use TIME macro

Definition at line 100 of file IPlugPluginBase.cpp.

References GetAPIStr(), GetArchStr(), and GetPluginVersionStr().

◆ GetBundleID()

const char * IPluginBase::GetBundleID

(

)

const

inline

◆ GetCurrentPresetIdx()

int IPluginBase::GetCurrentPresetIdx

(

)

const

inline

◆ GetHost()

EHost IPluginBase::GetHost

(

)

const

inline

◆ GetHostResizeEnabled()

bool IPluginBase::GetHostResizeEnabled

(

)

const

inline

Returns: true if the plug-in allows reszing via the host's window chrome, as defined in config.h

Definition at line 102 of file IPlugPluginBase.h.

◆ GetHostStr()

void IPluginBase::GetHostStr

(

WDL_String &

str

)

const

inline

◆ GetHostVersion()

int IPluginBase::GetHostVersion

(

bool

decimal

)

const

Get the host version number as an integer.

Parameters

decimal true indicates decimal format = VVVVRRMM, otherwise hexadecimal 0xVVVVRRMM.

Returns: The host version number as an integer.

Definition at line 53 of file IPlugPluginBase.cpp.

References GetDecimalVersion().

◆ GetHostVersionStr()

void IPluginBase::GetHostVersionStr

(

WDL_String &

str

)

const

◆ GetMfrID()

int IPluginBase::GetMfrID

(

)

const

inline

Returns: The plug-in manufacturer's unique four character ID as an integer

Definition at line 61 of file IPlugPluginBase.h.

◆ GetMfrName()

const char * IPluginBase::GetMfrName

(

)

const

inline

◆ GetParamGroupName()

const char * IPluginBase::GetParamGroupName

(

int

idx

)

const

inline

Get the parameter group name as a particular index.

Parameters

Returns: CString for the unique group name

Definition at line 123 of file IPlugPluginBase.h.

◆ GetPluginName()

const char * IPluginBase::GetPluginName

(

)

const

inline

◆ GetPluginVersion()

int IPluginBase::GetPluginVersion

(

bool

decimal

)

const

◆ GetPluginVersionStr()

void IPluginBase::GetPluginVersionStr

(

WDL_String &

str

)

const

Gets the plug-in version as a string.

Parameters

str	WDL_String to write to The output format is vX.M.m, where X - version, M - major, m - minor

Note: If _DEBUG is defined, D is appended to the version string; If TRACER_BUILD is defined, T is appended to the version string

Definition at line 42 of file IPlugPluginBase.cpp.

References GetVersionStr().

Referenced by GetBuildInfoStr().

◆ GetPreset()

IPreset * IPluginBase::GetPreset

(

int

idx

)

inline

Get a ptr to a factory preset @ param idx The index number of the preset you are referring to.

Definition at line 180 of file IPlugPluginBase.h.

◆ GetPresetName()

const char * IPluginBase::GetPresetName

(

int

idx

)

const

◆ GetProductName()

const char * IPluginBase::GetProductName

(

)

const

inline

Get the product name as a CString.

A shipping product may contain multiple plug-ins, hence this. Not used in all APIs

Definition at line 55 of file IPlugPluginBase.h.

◆ GetRawHostStr()

void IPluginBase::GetRawHostStr

(

WDL_String &

str

)

const

inline

Get raw host name (as it is reported from the host)

Parameters

str	WDL_String into which to write the host name

Definition at line 72 of file IPlugPluginBase.h.

◆ GetUniqueID()

int IPluginBase::GetUniqueID

(

)

const

inline

◆ HasUI()

bool IPluginBase::HasUI

(

)

const

inline

◆ InformHostOfParameterDetailsChange()

virtual void IPluginBase::InformHostOfParameterDetailsChange

(

)

inlinevirtual

Implemented by the API class, call this if you update parameter labels and hopefully the host should update it's displays (not applicable to all APIs)

Reimplemented in IPlugAU, and IPlugVST3.

Definition at line 126 of file IPlugPluginBase.h.

◆ InformHostOfPresetChange()

virtual void IPluginBase::InformHostOfPresetChange

(

)

inlinevirtual

◆ InitParamRange()

void IPluginBase::InitParamRange	(	int	startIdx,
		int	endIdx,
		int	countStart,
		const char *	nameFmtStr,
		double	defaultVal,
		double	minVal,
		double	maxVal,
		double	step,
		const char *	label = `""`,
		int	flags = `0`,
		const char *	group = `""`,
		const IParam::Shape &	shape = `IParam::ShapeLinear()`,
		IParam::EParamUnit	unit = `IParam::kUnitCustom`,
		IParam::DisplayFunc	displayFunc = `nullptr`
	)

Initialise a range of parameters simultaneously.

This mirrors the arguments available in IParam::InitDouble, for maximum flexibility

Parameters

startIdx	The index of the first parameter to initialise
endIdx	The index of the last parameter to initialise
countStart	An integer representing the start of the count in the format string. If the first parameter should have "0" in its name, set this to 0
nameFmtStr	A limited format string where i can be used to get the index + countStart, in the range of parameters specified
defaultVal	A default real value for the parameter
minVal	A minimum real value for the parameter
maxVal	A Maximum real value for the parameter
step	The parameter step
label	A CString label for the parameter e.g. "decibels"
flags	Any flags, see IParam::EFlags
group	A CString group name for the parameter, e.g. "envelope"
shape	A IParam::Shape class to determine how the parameter shape should be skewed
unit	An IParam::EParamUnit which can be used in audiounit plug-ins to specify certain kinds of parameter
displayFunc	An IParam::DisplayFunc lambda function to specify a custom display function

Definition at line 147 of file IPlugPluginBase.cpp.

◆ LoadBankFromFXB()

bool IPluginBase::LoadBankFromFXB

(

const char *

file

)

Load VST2 format bank [VST2 only].

Parameters

file	The full path of the file to load

Returns: /c true on success

Definition at line 921 of file IPlugPluginBase.cpp.

References DoesStateChunks(), IByteChunk::Get(), IByteChunk::GetBytes(), IByteChunk::GetData(), IByteChunk::GetIPlugVerFromChunk(), GetUniqueID(), InformHostOfPresetChange(), ModifyCurrentPreset(), IByteChunk::Resize(), RestorePreset(), and UnserializePresets().

◆ LoadPresetFromFXP()

bool IPluginBase::LoadPresetFromFXP

(

const char *

file

)

Load VST2 format preset.

Parameters

file	The full path of the file to load

Returns: /c true on success

Definition at line 830 of file IPlugPluginBase.cpp.

References DoesStateChunks(), IByteChunk::Get(), IByteChunk::GetBytes(), GetCurrentPresetIdx(), IByteChunk::GetData(), IByteChunk::GetIPlugVerFromChunk(), GetUniqueID(), InformHostOfPresetChange(), ModifyCurrentPreset(), IByteChunk::Resize(), RestorePreset(), and UnserializeState().

◆ MakeDefaultPreset()

void IPluginBase::MakeDefaultPreset	(	const char *	name = `0`,
		int	nPresets = `1`
	)

This method can be used to initialize baked-in factory presets with the default parameter values.

It finds the first uninitialized preset and initializes nPresets that follow sequentially. Typically you would use it if you have configured you plugin bank to e.g. 32 presets, you provide e.g. 8 factory presets via MakePresetXXX, but you want to fill the rest of the 32 presets with default values

Parameters

name	The name to give the presets
nPresets	The number of presets to fill with default values

Definition at line 281 of file IPlugPluginBase.cpp.

References SerializeState().

Referenced by EnsureDefaultPreset().

◆ MakePreset()

void IPluginBase::MakePreset	(	const char *	name,
			...
	)

Create a baked-in factory preset, specifiying parameter values sequentially usage: MakePreset(name, param1, param2, ..., paramN) See DumpMakePresetSrc() which is a utility that can be used to create the code for MakePreset() calls.

Parameters

name	The preset name
...	The list of parameter values, ordered sequentially according to paramIdx

Definition at line 295 of file IPlugPluginBase.cpp.

References IByteChunk::Put().

◆ MakePresetFromBlob()

void IPluginBase::MakePresetFromBlob	(	const char *	name,
		const char *	blob,
		int	sizeOfChunk
	)

◆ MakePresetFromChunk()

void IPluginBase::MakePresetFromChunk	(	const char *	name,
		IByteChunk &	chunk
	)

◆ MakePresetFromNamedParams()

void IPluginBase::MakePresetFromNamedParams	(	const char *	name,
		int	nParamsNamed,
			...
	)

Create a baked-in factory preset, specifiying parameter values with a list of parameter index and value pairs usage: MakePresetFromNamedParams(name, nParamsNamed, paramEnum1, paramVal1, paramEnum2, paramVal2, ..., paramEnumN, paramVal2) See DumpMakePresetFromNamedParamsSrc() which is a utility that can be used to create the code for MakePreset() calls nParamsNamed may be less than the total number of params.

Parameters

name	The preset name
nParamsNamed	The number of parameter index/value pairs. Parameters that are not set will be defaulted.
...	The list of parameter index and value pairs

Definition at line 316 of file IPlugPluginBase.cpp.

◆ ModifyCurrentPreset()

void IPluginBase::ModifyCurrentPreset ( const char * name = 0 )

◆ NParamGroups()

int IPluginBase::NParamGroups

(

)

const

inline

◆ NPresets()

int IPluginBase::NPresets

(

)

const

inline

◆ OnPresetsModified()

virtual void IPluginBase::OnPresetsModified

(

)

inlinevirtual

◆ PrintParamValues()

void IPluginBase::PrintParamValues

(

)

◆ PruneUninitializedPresets()

void IPluginBase::PruneUninitializedPresets

(

)

◆ RandomiseParamValues() [1/3]

void IPluginBase::RandomiseParamValues

(

)

◆ RandomiseParamValues() [2/3]

void IPluginBase::RandomiseParamValues

(

const char *

paramGroup

)

◆ RandomiseParamValues() [3/3]

void IPluginBase::RandomiseParamValues	(	int	startIdx,
		int	endIdx
	)

◆ RestorePreset() [1/2]

bool IPluginBase::RestorePreset

(

const char *

name

)

◆ RestorePreset() [2/2]

bool IPluginBase::RestorePreset

(

int

idx

)

◆ SaveBankAsFXB()

bool IPluginBase::SaveBankAsFXB

(

const char *

file

)

const

Save current bank as a VST2 format bank [VST2 only].

Parameters

file	The full path of the file to write or overwrite

Returns: /c true on success

Definition at line 725 of file IPlugPluginBase.cpp.

References DoesStateChunks(), IByteChunk::Get(), GetCurrentPresetIdx(), IByteChunk::GetData(), GetPluginVersion(), GetUniqueID(), IByteChunk::InitChunkWithIPlugVer(), NPresets(), IByteChunk::Put(), IByteChunk::PutBytes(), SerializePresets(), and IByteChunk::Size().

◆ SavePresetAsFXP()

bool IPluginBase::SavePresetAsFXP

(

const char *

file

)

const

Save current state as a VST2 format preset.

Parameters

file	The full path of the file to write or overwrite

Returns: /c true on success

Definition at line 652 of file IPlugPluginBase.cpp.

References DoesStateChunks(), GetCurrentPresetIdx(), IByteChunk::GetData(), GetPluginVersion(), GetPresetName(), GetUniqueID(), IByteChunk::InitChunkWithIPlugVer(), IByteChunk::Put(), IByteChunk::PutBytes(), SerializeState(), and IByteChunk::Size().

◆ SerializeParams()

bool IPluginBase::SerializeParams

(

IByteChunk &

chunk

)

const

Serializes the current double precision floating point, non-normalised values (IParam::mValue) of all parameters, into a binary byte chunk.

Parameters

chunk

The output chunk to serialize to. Will append data if the chunk has already been started.

Returns: true if the serialization was successful

Definition at line 109 of file IPlugPluginBase.cpp.

References IParam::GetName(), IByteChunk::Put(), and IParam::Value().

Referenced by SerializeState().

◆ SerializePresets()

bool IPluginBase::SerializePresets

(

IByteChunk &

chunk

)

const

◆ SerializeState()

virtual bool IPluginBase::SerializeState

(

IByteChunk &

chunk

)

const

inlinevirtual

◆ SerializeVST3CtrlrState()

virtual bool IPluginBase::SerializeVST3CtrlrState

(

IByteChunk &

chunk

)

const

inlinevirtual

VST3 ONLY! - THIS IS ONLY INCLUDED FOR COMPATIBILITY - NOONE ELSE SHOULD NEED IT!

Parameters

chunk

The output bytechunk where data can be serialized.

Returns: true if serialization was successful

Definition at line 158 of file IPlugPluginBase.h.

◆ SetCurrentPresetIdx()

void IPluginBase::SetCurrentPresetIdx

(

int

idx

)

inline

Set the index of the current, active preset.

Parameters

idx	The index of the current preset

Definition at line 171 of file IPlugPluginBase.h.

References NPresets().

◆ UnserializeParams()

int IPluginBase::UnserializeParams	(	const IByteChunk &	chunk,
		int	startPos
	)

◆ UnserializePresets()

int IPluginBase::UnserializePresets	(	const IByteChunk &	chunk,
		int	startPos
	)

◆ UnserializeState()

virtual int IPluginBase::UnserializeState	(	const IByteChunk &	chunk,
		int	startPos
	)

inlinevirtual

◆ UnserializeVST3CtrlrState()

virtual int IPluginBase::UnserializeVST3CtrlrState	(	const IByteChunk &	chunk,
		int	startPos
	)

inlinevirtual

VST3 ONLY! - THIS IS ONLY INCLUDED FOR COMPATIBILITY - NOONE ELSE SHOULD NEED IT!

Public Member Functions

Friends

◆ ~IPluginBase()

◆ AddParamGroup()

◆ CloneParamRange()

◆ CopyParamValues() [1/2]

◆ CopyParamValues() [2/2]

◆ CopyPreset()

◆ DefaultParamValues() [1/3]

◆ DefaultParamValues() [2/3]

◆ DefaultParamValues() [3/3]

◆ DoesStateChunks()

◆ DumpMakePresetFromNamedParamsSrc()

◆ DumpMakePresetSrc()

◆ DumpPresetBlob()

◆ EnsureDefaultPreset()

◆ ForParamInGroup()

◆ ForParamInRange()

◆ GetAPI()

◆ GetAPIStr()

◆ GetAppGroupID()

◆ GetArchStr()

◆ GetBuildInfoStr()

◆ GetBundleID()

◆ GetCurrentPresetIdx()

◆ GetHost()

◆ GetHostResizeEnabled()

◆ GetHostStr()

◆ GetHostVersion()

◆ GetHostVersionStr()

◆ GetMfrID()

◆ GetMfrName()

◆ GetParamGroupName()

◆ GetPluginName()

◆ GetPluginVersion()

◆ GetPluginVersionStr()

◆ GetPreset()

◆ GetPresetName()

◆ GetProductName()

◆ GetRawHostStr()

◆ GetUniqueID()

◆ HasUI()

◆ InformHostOfParameterDetailsChange()

◆ InformHostOfPresetChange()

◆ InitParamRange()

◆ LoadBankFromFXB()

◆ LoadPresetFromFXP()

◆ MakeDefaultPreset()

◆ MakePreset()

◆ MakePresetFromBlob()

◆ MakePresetFromChunk()

◆ MakePresetFromNamedParams()

◆ ModifyCurrentPreset()

◆ NParamGroups()

◆ NPresets()

◆ OnPresetsModified()

◆ PrintParamValues()

◆ PruneUninitializedPresets()

◆ RandomiseParamValues() [1/3]

◆ RandomiseParamValues() [2/3]

◆ RandomiseParamValues() [3/3]

◆ RestorePreset() [1/2]

◆ RestorePreset() [2/2]

◆ SaveBankAsFXB()

◆ SavePresetAsFXP()

◆ SerializeParams()

◆ SerializePresets()

◆ SerializeState()

◆ SerializeVST3CtrlrState()

◆ SetCurrentPresetIdx()

◆ UnserializeParams()

◆ UnserializePresets()

◆ UnserializeState()

◆ UnserializeVST3CtrlrState()

◆ IPlugAAX

◆ IPlugAPIBase

◆ IPlugAPP

◆ IPlugAU

◆ IPlugAUv3

◆ IPlugVST2