Steinberg::Vst::ParameterInfo Struct Reference

#include <ivsteditcontroller.h>

List of all members.

Public Types

 kCanAutomate = 1 << 0
 parameter can be automated
 kIsReadOnly = 1 << 1
 parameter can not be changed from outside (implies that kCanAutomate is false)
 kIsProgramChange = 1 << 15
 parameter is a program change (unitId gives info about associated program list)
 kIsBypass = 1 << 16
 special bypass parameter (only one allowed): plugin can handle bypass
enum  ParameterFlags { kCanAutomate = 1 << 0, kIsReadOnly = 1 << 1, kIsProgramChange = 1 << 15, kIsBypass = 1 << 16 }

Public Attributes

ParamID id
 unique identifier of this parameter
String128 title
 parameter title (e.g. "Volume")
String128 shortTitle
 parameter shortTitle (e.g. "Vol")
String128 units
 parameter unit (e.g. "dB")
int32 stepCount
 number of discrete steps (0: infinite/float, 1: toggle, discrete value otherwise)
ParamValue defaultNormalizedValue
 default normalized value
UnitID unitId
 id of unit this parameter belongs to
int32 flags
 ParameterFlags (see below).


Detailed Description

GUI Parameter Info

Definition at line 64 of file ivsteditcontroller.h.


Member Enumeration Documentation

enum Steinberg::Vst::ParameterInfo::ParameterFlags

Enumerator:
kCanAutomate  parameter can be automated
kIsReadOnly  parameter can not be changed from outside (implies that kCanAutomate is false)
kIsProgramChange  parameter is a program change (unitId gives info about associated program list)
kIsBypass  special bypass parameter (only one allowed): plugin can handle bypass

Definition at line 76 of file ivsteditcontroller.h.


Member Data Documentation

ParamValue Steinberg::Vst::ParameterInfo::defaultNormalizedValue

default normalized value

Definition at line 72 of file ivsteditcontroller.h.

int32 Steinberg::Vst::ParameterInfo::flags

ParameterFlags (see below).

Definition at line 75 of file ivsteditcontroller.h.

ParamID Steinberg::Vst::ParameterInfo::id

unique identifier of this parameter

Definition at line 67 of file ivsteditcontroller.h.

String128 Steinberg::Vst::ParameterInfo::shortTitle

parameter shortTitle (e.g. "Vol")

Definition at line 69 of file ivsteditcontroller.h.

int32 Steinberg::Vst::ParameterInfo::stepCount

number of discrete steps (0: infinite/float, 1: toggle, discrete value otherwise)

Definition at line 71 of file ivsteditcontroller.h.

String128 Steinberg::Vst::ParameterInfo::title

parameter title (e.g. "Volume")

Definition at line 68 of file ivsteditcontroller.h.

UnitID Steinberg::Vst::ParameterInfo::unitId

id of unit this parameter belongs to

Definition at line 73 of file ivsteditcontroller.h.

String128 Steinberg::Vst::ParameterInfo::units

parameter unit (e.g. "dB")

Definition at line 70 of file ivsteditcontroller.h.


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

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.