IUnitInfo Class Reference
[VST 3 Interfaces to be implemented by Plug-inVST 3 Interfaces defined in version 3.0.0]

Edit controller extension to describe the Plug-in structure. More...

#include <ivstunits.h>

Inheritance diagram for IUnitInfo:
Inheritance graph
[legend]

Public Member Functions

virtual int32 getUnitCount ()=0
 Returns the flat count of units.
virtual tresult getUnitInfo (int32 unitIndex, UnitInfo &info)=0
 Gets UnitInfo for a given index in the flat list of unit.
virtual int32 getProgramListCount ()=0
 Component intern program structure.
virtual tresult getProgramListInfo (int32 listIndex, ProgramListInfo &info)=0
 Gets for a given index the Program List Info.
virtual tresult getProgramName (ProgramListID listId, int32 programIndex, String128 name)=0
 Gets for a given program list ID and program index its program name.
virtual tresult getProgramInfo (ProgramListID listId, int32 programIndex, CString attributeId, String128 attributeValue)=0
 Gets for a given program list ID, program index and attributeId the associated attribute value.
virtual tresult hasProgramPitchNames (ProgramListID listId, int32 programIndex)=0
 Returns kResultTrue if the given program index of a given program list ID supports PitchNames.
virtual tresult getProgramPitchName (ProgramListID listId, int32 programIndex, int16 midiPitch, String128 name)=0
 Gets the PitchName for a given program list ID, program index and pitch.
virtual UnitID getSelectedUnit ()=0
 Gets the current selected unit.
virtual tresult selectUnit (UnitID unitId)=0
 Sets a new selected unit.
virtual tresult getUnitByBus (MediaType type, BusDirection dir, int32 busIndex, int32 channel, UnitID &unitId)=0
 Gets the according unit if there is an unambiguous relation between a channel or a bus and a unit.
virtual tresult setUnitProgramData (int32 listOrUnitId, int32 programIndex, IBStream *data)=0
 Receives a preset data stream.

Static Public Attributes

static const FUID iid

Detailed Description

Edit controller extension to describe the Plug-in structure.

IUnitInfo describes the internal structure of the Plug-in.

See also:
Units, IUnitHandler

Member Function Documentation

virtual int32 getUnitCount (  )  [pure virtual]

Returns the flat count of units.

Implemented in EditControllerEx1.

virtual tresult getUnitInfo ( int32  unitIndex,
UnitInfo info 
) [pure virtual]

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

Implemented in EditControllerEx1.

virtual int32 getProgramListCount (  )  [pure virtual]

Component intern program structure.

Gets the count of Program List.

Implemented in EditControllerEx1.

virtual tresult getProgramListInfo ( int32  listIndex,
ProgramListInfo info 
) [pure virtual]

Gets for a given index the Program List Info.

Implemented in EditControllerEx1.

virtual tresult getProgramName ( ProgramListID  listId,
int32  programIndex,
String128  name 
) [pure virtual]

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

Implemented in EditControllerEx1.

virtual tresult 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.

Implemented in EditControllerEx1.

virtual tresult hasProgramPitchNames ( ProgramListID  listId,
int32  programIndex 
) [pure virtual]

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

Implemented in EditControllerEx1.

virtual tresult getProgramPitchName ( ProgramListID  listId,
int32  programIndex,
int16  midiPitch,
String128  name 
) [pure virtual]

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.

Implemented in EditControllerEx1.

virtual UnitID getSelectedUnit (  )  [pure virtual]

Gets the current selected unit.

Implemented in EditControllerEx1.

virtual tresult selectUnit ( UnitID  unitId  )  [pure virtual]

Sets a new selected unit.

Implemented in EditControllerEx1.

virtual tresult getUnitByBus ( MediaType  type,
BusDirection  dir,
int32  busIndex,
int32  channel,
UnitID unitId 
) [pure virtual]

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.

Implemented in EditControllerEx1.

virtual tresult setUnitProgramData ( int32  listOrUnitId,
int32  programIndex,
IBStream data 
) [pure virtual]

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).

Implemented in EditControllerEx1.


Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.