#include <ipslcontextinfo.h>

Inheritance diagram for Presonus::IContextInfoProvider:

Public Member Functions
virtual Steinberg::tresult PLUGIN_API	getContextInfoValue (Steinberg::int32 &value, Steinberg::FIDString id)=0
virtual Steinberg::tresult PLUGIN_API	getContextInfoString (Steinberg::Vst::TChar *string, Steinberg::int32 maxCharCount, Steinberg::FIDString id)=0
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
virtual uint32 PLUGIN_API	addRef ()=0
virtual uint32 PLUGIN_API	release ()=0

Static Public Attributes
static const Steinberg::FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Callback interface to access context information from the host. Implemented by the host as extension of Steinberg::Vst::IComponentHandler.

The host might not be able to report all available attributes at all times. Please check the return value of getContextInfoValue() and getContextInfoString(). It's not required to implement IContextInfoHandler on the plug-in side, but we recommend to do so. The host will then call notifyContextInfoChange() during initialization to inform the plug-in about the initial state of the available attributes.

Usage Example:

IComponentHandler* handler; FUnknownPtr<IContextInfoProvider> contextInfoProvider (handler);

void PLUGIN_API MyEditController::notifyContextInfoChange () { int32 channelIndex = 0; contextInfoProvider->getContextInfoValue (channelIndex, ContextInfo::kIndex);

TChar channelName[128] = {0}; contextInfoProvider->getContextInfoString (channelName, 128, ContextInfo::kName); }

Member Function Documentation

◆ getContextInfoString()

virtual Steinberg::tresult PLUGIN_API Presonus::IContextInfoProvider::getContextInfoString	(	Steinberg::Vst::TChar *	string,
		Steinberg::int32	maxCharCount,
		Steinberg::FIDString	id )

pure virtual

Get context information by identifier.

◆ getContextInfoValue()

virtual Steinberg::tresult PLUGIN_API Presonus::IContextInfoProvider::getContextInfoValue	(	Steinberg::int32 &	value,
		Steinberg::FIDString	id )

pure virtual

Get context information by identifier.

Implemented in Presonus::IContextInfoProvider2.

Member Data Documentation

◆ iid

const Steinberg::FUID Presonus::IContextInfoProvider::iid

static

The documentation for this struct was generated from the following file:

/home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/format_types/pslextensions/ipslcontextinfo.h