ivstrepresentation.h File Reference

#include "pluginterfaces/base/funknown.h"
#include "pluginterfaces/vst/vsttypes.h"
#include "pluginterfaces/base/falignpush.h"
#include "pluginterfaces/base/falignpop.h"

Classes
struct	RepresentationInfo
	RepresentationInfo is the structure describing a representation This structure is used in the function More...
class	IXmlRepresentationController
	Extended plug-in interface IEditController for a component: Vst::IXmlRepresentationController. More...

Namespaces
namespace	Steinberg
namespace	Steinberg::Vst
	All VST specific interfaces are located in Vst namespace.
namespace	Steinberg::Vst::LayerType
	Layer Types used in a VST XML Representation.
namespace	Steinberg::Vst::CurveType
	Curve Types used in a VST XML Representation.
namespace	Steinberg::Vst::Attributes
	Attributes used to defined a Layer in a VST XML Representation.
namespace	Steinberg::Vst::AttributesFunction
	Attributes Function used to defined the function of a Layer in a VST XML Representation.
namespace	Steinberg::Vst::AttributesStyle
	Attributes Style associated a specific Layer Type in a VST XML Representation.
namespace	Steinberg::Vst::AttributesFlags
	Attributes Flags defining a Layer in a VST XML Representation.

Macros
#define	ROOTXML_TAG   "vstXML"
	Defines for XML representation Tags and Attributes.
#define	COMMENT_TAG   "comment"
#define	CELL_TAG   "cell"
#define	CELLGROUP_TAG   "cellGroup"
#define	CELLGROUPTEMPLATE_TAG   "cellGroupTemplate"
#define	CURVE_TAG   "curve"
#define	CURVETEMPLATE_TAG   "curveTemplate"
#define	DATE_TAG   "date"
#define	LAYER_TAG   "layer"
#define	NAME_TAG   "name"
#define	ORIGINATOR_TAG   "originator"
#define	PAGE_TAG   "page"
#define	PAGETEMPLATE_TAG   "pageTemplate"
#define	PLUGIN_TAG   "plugin"
#define	VALUE_TAG   "value"
#define	VALUEDISPLAY_TAG   "valueDisplay"
#define	VALUELIST_TAG   "valueList"
#define	REPRESENTATION_TAG   "representation"
#define	SEGMENT_TAG   "segment"
#define	SEGMENTLIST_TAG   "segmentList"
#define	TITLEDISPLAY_TAG   "titleDisplay"
#define	ATTR_CATEGORY   "category"
#define	ATTR_CLASSID   "classID"
#define	ATTR_ENDPOINT   "endPoint"
#define	ATTR_INDEX   "index"
#define	ATTR_FLAGS   "flags"
#define	ATTR_FUNCTION   "function"
#define	ATTR_HOST   "host"
#define	ATTR_LEDSTYLE   "ledStyle"
#define	ATTR_LENGTH   "length"
#define	ATTR_LINKEDTO   "linkedTo"
#define	ATTR_NAME   "name"
#define	ATTR_ORDER   "order"
#define	ATTR_PAGE   "page"
#define	ATTR_PARAMID   "parameterID"
#define	ATTR_STARTPOINT   "startPoint"
#define	ATTR_STYLE   "style"
#define	ATTR_SWITCHSTYLE   "switchStyle"
#define	ATTR_TEMPLATE   "template"
#define	ATTR_TURNSPERFULLRANGE   "turnsPerFullRange"
#define	ATTR_TYPE   "type"
#define	ATTR_UNITID   "unitID"
#define	ATTR_VARIABLES   "variables"
#define	ATTR_VENDOR   "vendor"
#define	ATTR_VERSION   "version"
#define	GENERIC   "Generic"
	Defines some predefined Representation Remote Names.
#define	GENERIC_4_CELLS   "Generic 4 Cells"
#define	GENERIC_8_CELLS   "Generic 8 Cells"
#define	GENERIC_12_CELLS   "Generic 12 Cells"
#define	GENERIC_24_CELLS   "Generic 24 Cells"
#define	GENERIC_N_CELLS   "Generic %d Cells"
#define	QUICK_CONTROL_8_CELLS   "Quick Controls 8 Cells"

Enumerations
enum	{   kKnob = 0, kPressedKnob, kSwitchKnob, kSwitch,   kLED, kLink, kDisplay, kFader,   kEndOfLayerType }

Variables
const CString	kSegment = "segment"
const CString	kValueList = "valueList"
const CString	kStyle = "style"
	string attribute : See AttributesStyle for available string value
const CString	kLEDStyle = "ledStyle"
	string attribute : See AttributesStyle for available string value
const CString	kSwitchStyle = "switchStyle"
	string attribute : See AttributesStyle for available string value
const CString	kKnobTurnsPerFullRange = "turnsPerFullRange"
	float attribute
const CString	kFunction = "function"
	string attribute : See AttributesFunction for available string value
const CString	kFlags = "flags"
	string attribute : See AttributesFlags for available string value
const CString	kPanPosCenterXFunc = "PanPosCenterX"
	Global Style.
const CString	kPanPosCenterYFunc = "PanPosCenterY"
	Gravity point Y-axis (Front-Rear)
const CString	kPanPosFrontLeftXFunc = "PanPosFrontLeftX"
	Left channel Position in X-axis.
const CString	kPanPosFrontLeftYFunc = "PanPosFrontLeftY"
	Left channel Position in Y-axis.
const CString	kPanPosFrontRightXFunc = "PanPosFrontRightX"
	Right channel Position in X-axis.
const CString	kPanPosFrontRightYFunc = "PanPosFrontRightY"
	Right channel Position in Y-axis.
const CString	kPanRotationFunc = "PanRotation"
	Rotation around the Center (gravity point)
const CString	kPanLawFunc = "PanLaw"
	Panning Law.
const CString	kPanMirrorModeFunc = "PanMirrorMode"
	Panning Mirror Mode.
const CString	kPanLfeGainFunc = "PanLfeGain"
	Panning LFE Gain.
const CString	kGainReductionFunc = "GainReduction"
	Gain Reduction for compressor.
const CString	kSoloFunc = "Solo"
	Solo.
const CString	kMuteFunc = "Mute"
	Mute.
const CString	kVolumeFunc = "Volume"
	Volume.
const CString	kInverseStyle = "inverse"
	Global Style.
const CString	kLEDWrapLeftStyle = "wrapLeft"
	LED Style.
const CString	kLEDWrapRightStyle = "wrapRight"
	----—<====|
const CString	kLEDSpreadStyle = "spread"
	—<==|==>—
const CString	kLEDBoostCutStyle = "boostCut"
	---—|===>–
const CString	kLEDSingleDotStyle = "singleDot"
	-----—|-—
const CString	kSwitchPushStyle = "push"
	Switch Style.
const CString	kSwitchPushIncLoopedStyle = "pushIncLooped"
	Push will increment the value.
const CString	kSwitchPushDecLoopedStyle = "pushDecLooped"
	Push will decrement the value. When the min is reached it will restart with max.
const CString	kSwitchPushIncStyle = "pushInc"
	Increment after each press (delta depends of the curve).
const CString	kSwitchPushDecStyle = "pushDec"
	Decrement after each press (delta depends of the curve).
const CString	kSwitchLatchStyle = "latch"
	Each push-release will change the value between min and max.
const CString	kHideableFlag = "hideable"
	the associated layer marked as hideable allows a remote to hide or make it not usable a parameter when the associated value is inactive

Macro Definition Documentation

#define ROOTXML_TAG   "vstXML"

Defines for XML representation Tags and Attributes.

#define COMMENT_TAG   "comment"

#define CELL_TAG   "cell"

#define CELLGROUP_TAG   "cellGroup"

#define CELLGROUPTEMPLATE_TAG   "cellGroupTemplate"

#define CURVE_TAG   "curve"

#define CURVETEMPLATE_TAG   "curveTemplate"

#define DATE_TAG   "date"

#define LAYER_TAG   "layer"

#define NAME_TAG   "name"

#define ORIGINATOR_TAG   "originator"

#define PAGE_TAG   "page"

#define PAGETEMPLATE_TAG   "pageTemplate"

#define PLUGIN_TAG   "plugin"

#define VALUE_TAG   "value"

#define VALUEDISPLAY_TAG   "valueDisplay"

#define VALUELIST_TAG   "valueList"

#define REPRESENTATION_TAG   "representation"

#define SEGMENT_TAG   "segment"

#define SEGMENTLIST_TAG   "segmentList"

#define TITLEDISPLAY_TAG   "titleDisplay"

#define ATTR_CATEGORY   "category"

#define ATTR_CLASSID   "classID"

#define ATTR_ENDPOINT   "endPoint"

#define ATTR_INDEX   "index"

#define ATTR_FLAGS   "flags"

#define ATTR_FUNCTION   "function"

#define ATTR_HOST   "host"

#define ATTR_LEDSTYLE   "ledStyle"

#define ATTR_LENGTH   "length"

#define ATTR_LINKEDTO   "linkedTo"

#define ATTR_NAME   "name"

#define ATTR_ORDER   "order"

#define ATTR_PAGE   "page"

#define ATTR_PARAMID   "parameterID"

#define ATTR_STARTPOINT   "startPoint"

#define ATTR_STYLE   "style"

#define ATTR_SWITCHSTYLE   "switchStyle"

#define ATTR_TEMPLATE   "template"

#define ATTR_TURNSPERFULLRANGE   "turnsPerFullRange"

#define ATTR_TYPE   "type"

#define ATTR_UNITID   "unitID"

#define ATTR_VARIABLES   "variables"

#define ATTR_VENDOR   "vendor"

#define ATTR_VERSION   "version"

#define GENERIC   "Generic"

Defines some predefined Representation Remote Names.

#define GENERIC_4_CELLS   "Generic 4 Cells"

#define GENERIC_8_CELLS   "Generic 8 Cells"

#define GENERIC_12_CELLS   "Generic 12 Cells"

#define GENERIC_24_CELLS   "Generic 24 Cells"

#define GENERIC_N_CELLS   "Generic %d Cells"

#define QUICK_CONTROL_8_CELLS   "Quick Controls 8 Cells"