Steinberg::Vst::IUnitInfo Class Reference

#include <ivstunits.h>

Inheritance diagram for Steinberg::Vst::IUnitInfo:

List of all members.

Public Member Functions
virtual int32 PLUGIN_API	getUnitCount ()=0
virtual tresult PLUGIN_API	getUnitInfo (int32 unitIndex, UnitInfo &info)=0
virtual int32 PLUGIN_API	getProgramListCount ()=0
virtual tresult PLUGIN_API	getProgramListInfo (int32 listIndex, ProgramListInfo &info)=0
virtual tresult PLUGIN_API	getProgramName (ProgramListID listId, int32 programIndex, String128 name)=0
virtual tresult PLUGIN_API	getProgramInfo (ProgramListID listId, int32 programIndex, CString attributeId, String128 attributeValue)=0
virtual tresult PLUGIN_API	hasProgramPitchNames (ProgramListID listId, int32 programIndex)=0
virtual tresult PLUGIN_API	getProgramPitchName (ProgramListID listId, int32 programIndex, int16 midiPitch, String128 name)=0
virtual UnitID PLUGIN_API	getSelectedUnit ()=0
virtual tresult PLUGIN_API	selectUnit (UnitID unitId)=0
virtual tresult PLUGIN_API	getUnitByBus (MediaType type, BusDirection dir, int32 busIndex, int32 channel, UnitID &unitId)=0
virtual tresult PLUGIN_API	setUnitProgramData (ProgramListID listId, int32 programIndex, IBStream *data)=0
Static Public Attributes
static const FUID	iid

---

Detailed Description

Interface for describing plugin structure on controller side. [plug imp] [extends IEditController]

IUnitInfo describes the internal structure of the plugin.

the root unit is the component itself, so getUnitCount must return 1 at least. the root unit id should be kRootUnitId (0). each unit can reference one program list - this reference must not change. each unit using a program list, references one program of the list.

Definition at line 125 of file ivstunits.h.

---

Member Function Documentation

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::getProgramInfo	(	ProgramListID	listId,
		int32	programIndex,
		CString	attributeId,
		String128	attributeValue
	)			[pure virtual]

Gets for a given program list ID, program index and attributeId the associated attribute value.

virtual int32 PLUGIN_API Steinberg::Vst::IUnitInfo::getProgramListCount

(

)

[pure virtual]

Gets the count of Program List.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::getProgramListInfo	(	int32	listIndex,
		ProgramListInfo &	info
	)			[pure virtual]

Gets for a given index the Program List Info.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::getProgramName	(	ProgramListID	listId,
		int32	programIndex,
		String128	name
	)			[pure virtual]

Gets for a given program list ID and program index its program name.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::getProgramPitchName	(	ProgramListID	listId,
		int32	programIndex,
		int16	midiPitch,
		String128	name
	)			[pure virtual]

Gets the PitchName for a given program list ID, program index and pitch.

virtual UnitID PLUGIN_API Steinberg::Vst::IUnitInfo::getSelectedUnit

(

)

[pure virtual]

Gets the current selected unit.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::getUnitByBus	(	MediaType	type,
		BusDirection	dir,
		int32	busIndex,
		int32	channel,
		UnitID &	unitId
	)			[pure virtual]

Gets unit associated with given channel of input (or output) bus.

virtual int32 PLUGIN_API Steinberg::Vst::IUnitInfo::getUnitCount

(

)

[pure virtual]

Flat count of unit.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::getUnitInfo	(	int32	unitIndex,
		UnitInfo &	info
	)			[pure virtual]

Gets UnitInfo for a given index in the flat list of unit.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::hasProgramPitchNames	(	ProgramListID	listId,
		int32	programIndex
	)			[pure virtual]

Returns kResultTrue if the given program index of a given program list ID supports PitchNames.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::selectUnit

(

UnitID

unitId

)

[pure virtual]

Sets a new selected unit.

virtual tresult PLUGIN_API Steinberg::Vst::IUnitInfo::setUnitProgramData	(	ProgramListID	listId,
		int32	programIndex,
		IBStream *	data
	)			[pure virtual]

Sets for a given program list ID and program index a data stream.

---

Member Data Documentation

const FUID Steinberg::Vst::IUnitInfo::iid [static]

Reimplemented from Steinberg::FUnknown.

Definition at line 171 of file ivstunits.h.

---

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

• ivstunits.h

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.