Channel context interface: Vst::IInfoListener.
Allows the host to inform the plug-in about the context in which the plug-in is instantiated, mainly channel based info (color, name, index,...). Index can be defined inside a namespace (for example, index start from 1 to N for Type Input/Output Channel (Index namespace) and index start from 1 to M for Type Audio Channel).
As soon as the plug-in provides this IInfoListener interface, the host will call setChannelContextInfos for each change occurring to this channel (new name, new color, new indexation,...)
{
if (list)
{
{
...
}
{
...
}
{
...
}
{
...
}
{
...
}
{
String str;
Steinberg::UString (string128, 128).fromAscii (str);
...
}
{
...
}
{
...
}
{
...
}
{
switch (location)
{
Steinberg::UString (string128, 128).fromAscii ("PreVolFader");
break;
Steinberg::UString (string128, 128).fromAscii ("PostVolFader");
break;
Steinberg::UString (string128, 128).fromAscii ("UsedAsPanner");
break;
default: Steinberg::UString (string128, 128).fromAscii ("unknown!");
break;
}
}
}
}
Attribute list used in IMessage and IStreamAttributes: Vst::IAttributeList.
Definition ivstattributes.h:41
virtual tresult getString(AttrID id, TChar *string, uint32 sizeInBytes)=0
Gets string value (UTF16).
virtual tresult getInt(AttrID id, int64 &value)=0
Gets integer value.
TChar String128[128]
128 character UTF-16 string
Definition vsttypes.h:77
const CString kChannelNameLengthKey
integer (int64) [optional]: number of characters in kChannelNameKey
Definition ivstchannelcontextinfo.h:228
const CString kChannelPluginLocationKey
integer (int64) [optional]: routing position of the plug-in in the channel (see ChannelPluginLocation...
Definition ivstchannelcontextinfo.h:260
const CString kChannelColorKey
color (ColorSpec) [optional]: used color for the channel in mixer or track
Definition ivstchannelcontextinfo.h:231
const CString kChannelNameKey
string (TChar) [optional]: name of the channel like displayed in the mixer
Definition ivstchannelcontextinfo.h:225
const CString kChannelIndexKey
integer (int64) [optional]: index of the channel in a channel index namespace, start with 1 not 0!
Definition ivstchannelcontextinfo.h:235
const CString kChannelUIDKey
Keys used as AttrID (Attribute ID) in the return IAttributeList of IInfoListener::setChannelContextIn...
Definition ivstchannelcontextinfo.h:215
const CString kChannelIndexNamespaceLengthKey
integer (int64) [optional]: number of characters in kChannelIndexNamespaceKey
Definition ivstchannelcontextinfo.h:252
const CString kChannelRuntimeIDKey
integer (int64) [optional]: runtime id to identify a channel (may change when reloading project)
Definition ivstchannelcontextinfo.h:222
const CString kChannelIndexNamespaceKey
string (TChar) [optional]: name of the channel index namespace for example "Input",...
Definition ivstchannelcontextinfo.h:249
@ kPreVolumeFader
Definition ivstchannelcontextinfo.h:172
@ kPostVolumeFader
Definition ivstchannelcontextinfo.h:173
@ kUsedAsPanner
Definition ivstchannelcontextinfo.h:174
const CString kChannelIndexNamespaceOrderKey
integer (int64) [optional]: define the order of the current used index namespace, start with 1 not 0!
Definition ivstchannelcontextinfo.h:244
ColorComponent GetRed(ColorSpec cs)
Returns the Red part of the given ColorSpec.
Definition ivstchannelcontextinfo.h:200
ColorComponent GetBlue(ColorSpec cs)
Returns the Blue part of the given ColorSpec.
Definition ivstchannelcontextinfo.h:190
ColorComponent GetAlpha(ColorSpec cs)
Returns the Alpha part of the given ColorSpec.
Definition ivstchannelcontextinfo.h:205
ColorComponent GetGreen(ColorSpec cs)
Returns the Green part of the given ColorSpec.
Definition ivstchannelcontextinfo.h:195