IUnitInfo

Edit controller extension to describe the Plug-in structure. \ingroup vstIPlug vst300 - [plug imp] - [extends IEditController] - [released: 3.0.0]

IUnitInfo describes the internal structure of the Plug-in. - The root unit is the component itself, so getUnitCount must return 1 at least. - The root unit id has to be 0 (kRootUnitId). - Each unit can reference one program list - this reference must not change. - Each unit using a program list, references one program of the list.

\see \ref vst3Units, IUnitHandler

version(VST3)

interface IUnitInfo : FUnknown {

int32 getUnitCount();

tresult getUnitInfo(int32 unitIndex, UnitInfo info);

int32 getProgramListCount();

tresult getProgramListInfo(int32 listIndex, ProgramListInfo info);

tresult getProgramName(ProgramListID listId, int32 programIndex, String128* name);

tresult getProgramInfo(ProgramListID listId, int32 programIndex, const(wchar)* attributeId, String128* attributeValue);

tresult hasProgramPitchNames(ProgramListID listId, int32 programIndex);

tresult getProgramPitchName(ProgramListID listId, int32 programIndex, int16 midiPitch, String128* name);

UnitID getSelectedUnit();

tresult selectUnit(UnitID unitId);

tresult getUnitByBus(MediaType type, BusDirection dir, int32 busIndex, int32 channel, UnitID unitId);

tresult setUnitProgramData(int32 listOrUnitId, int32 programIndex, IBStream data);

nothrow @nogc __gshared immutable

TUID iid;

}

Members

Functions

getProgramInfo tresult getProgramInfo(ProgramListID listId, int32 programIndex, const(wchar)* attributeId, String128* attributeValue): Gets for a given program list ID, program index and attributeId the associated attribute value.
getProgramListCount int32 getProgramListCount(): Gets the count of Program List.
getProgramListInfo tresult getProgramListInfo(int32 listIndex, ProgramListInfo info): Gets for a given index the Program List Info.
getProgramName tresult getProgramName(ProgramListID listId, int32 programIndex, String128* name): Gets for a given program list ID and program index its program name.
getProgramPitchName tresult getProgramPitchName(ProgramListID listId, int32 programIndex, int16 midiPitch, String128* name): Gets the PitchName for a given program list ID, program index and pitch. If PitchNames are changed the Plug-in should inform the host with IUnitHandler::notifyProgramListChange.
getSelectedUnit UnitID getSelectedUnit(): Gets the current selected unit.
getUnitByBus tresult getUnitByBus(MediaType type, BusDirection dir, int32 busIndex, int32 channel, UnitID unitId): Gets the according unit if there is an unambiguous relation between a channel or a bus and a unit. This method mainly is intended to find out which unit is related to a given MIDI input channel.
getUnitCount int32 getUnitCount(): Returns the flat count of units.
getUnitInfo tresult getUnitInfo(int32 unitIndex, UnitInfo info): Gets UnitInfo for a given index in the flat list of unit.
hasProgramPitchNames tresult hasProgramPitchNames(ProgramListID listId, int32 programIndex): Returns kResultTrue if the given program index of a given program list ID supports PitchNames.
selectUnit tresult selectUnit(UnitID unitId): Sets a new selected unit.
setUnitProgramData tresult setUnitProgramData(int32 listOrUnitId, int32 programIndex, IBStream data): Receives a preset data stream. - If the component supports program list data (IProgramListData), the destination of the data stream is the program specified by list-Id and program index (first and second parameter) - If the component supports unit data (IUnitData), the destination is the unit specified by the first parameter - in this case parameter programIndex is < 0).

IUnitInfo

Members

Functions

Static variables

Inherited Members

From FUnknown

Meta

Source