Usine SDK  HH3-7.01.001
Create user modules for Usine Software
Classes | Macros | Typedefs | Enumerations
Datatypes

Classes

struct  UsineMessage
 Usine internal message. More...
 
struct  TuPixel
 Data type for video Frames pixels Used in video modules. More...
 
struct  TUsineFrame
 Data type for video Frames. More...
 
struct  UsineMidiCode
 Usine Midi code format. More...
 
struct  VstTimeInfo
 VST Time info structure as defined by the Steinberg VST SDK. More...
 
struct  TCommandPacket
 
struct  TPointF
 To store 2D coordinates in coefficiant (from 0 to 1). More...
 
struct  T3DPointF
 To store 3D coordinates in coefficiant (from 0 to 1). More...
 
struct  TRectF
 To store Rectangle coordinates in coefficiant (from 0 to 1). More...
 
struct  MasterInfo
 Contains globals infos provided by Usine and all functions handle of the module wrapper. More...
 
struct  TParamInfo
 Usine parameter description. More...
 
struct  ModuleInfo
 Contain characteristics and infos about the module. More...
 
struct  TPointI
 To store 2D coordinates in pixels. More...
 
struct  TColorArgb
 To store color information in ARGB format (from 0 to 1). More...
 
struct  TColorAhsl
 To store color information in AHSL format (from 0 to 1). More...
 

Macros

#define FALSE   0
 To test LongBool equality against false. More...
 
#define TRUE   1
 To test LongBool equality against false. More...
 

Typedefs

typedef int LongBool
 Custom bool type to match the 4 bytes DELPHI LongBool type.
 
typedef LongBoolLongBoolPtr
 Pointer to a LongBool variable.
 
typedef const char * AnsiCharPtr
 Pointer to an ANSI string variable. More...
 
typedef unsigned long ULong
 
typedef ULong TShiftState
 keys state modifier. More...
 
typedef TUsinePixel * PTUsinePixel
 data type Pixels Pointer
 
typedef ULong TColorUsine
 Usine native color format.
 
typedef float TPrecision
 Type used in all parameters data.
 
typedef void * AudioFilePtr
 handle to an audio file.
 
typedef int(* FuncDialogBox) (AnsiCharPtr msg)
 Function pointer for a dialog box.
 
typedef TPointFTPointFArray
 To store an array of 2D coordinates.
 
typedef T3DPointFT3DPointFArray
 To store an array of 3D coordinates.
 
typedef UsineEvent * UsineEventPtr
 Handle to a paramerer event. More...
 

Enumerations

enum  TMouseButton { mbLeft, mbRight, mbMiddle }
 Mouse buttons available for a mouse event callback. More...
 
enum  TScale { scLinear, scLog, scExp }
 Scale type available for a parameter. More...
 
enum  TParamType {
  ptTextField, ptChooseColor, ptMidi, ptGainFader,
  ptAudio, ptDataField, ptDataFader, ptButton,
  ptListBox, ptSwitch, ptArray, ptIpAddress,
  ptSmpte, ptMidiNoteFader, ptPointerBitMap, ptPointer,
  ptRightLed, ptChooseFolder, ptLeftLed, ptTriggerLed,
  ptOther
}
 parameters type available in usine. More...
 
enum  TFlowType {
  ftNone, ftPCM, ftInternText, ftData,
  ftMIDI, ftArray, ftUser, ftEvtText
}
 Data type of the parameter. More...
 
enum  TUsineColorSet
 Colorset used by Usine.
 
enum  TDialogsResults
 Dialogs popup results The value returned by a popup. More...
 
enum  TTextAlign
 Text vertical alignement. More...
 
enum  TUsineVersionType
 Versions type of Usine. More...
 
enum  TFastCallBackType { ctNormal, ctImmediate, ctAsynchronous }
 Possible type of callback for a parameter. More...
 
enum  TModuleType {
  mtSimple, mtVideo, mtControl, mtDeviceAudio,
  mtDeviceMidi, mtDeviceOther, mtPluginWrapper, mtPluginLister,
  mtDeviceDMX, mtOther
}
 Possible type of user modules. More...
 

UsineMessage::lParam

Possible values for UsineMessage::lParam.

static const NativeInt MSG_CHANGE = 0
 the parameter value has changed
 
static const NativeInt MSG_CLICK = 1
 the parameter has been clicked
 
static const NativeInt MSG_DBLCLICK = 2
 the parameter has been double clicked
 
static const NativeInt MSG_SETCAPTION = 3
 change the caption of a control
 
static const NativeInt MSG_MOUSEUP = 4
 mouse Up
 
static const NativeInt MSG_MOUSEMOVE = 5
 mouse Move
 
static const NativeInt MSG_DROP = 6
 Something has been dropped on the control.
 
static const NativeInt MSG_COMMATEXT = 7
 A commatext has changed.
 

Notifications Target types.

Possible target for a notification to Usine

See also
sdkNotifyUsine
static const NativeInt NOTIFY_TARGET_USINE = 1
 notify the main Usine panel
 
static const NativeInt NOTIFY_TARGET_SETUP = 2
 notify the setup of Usine
 
static const NativeInt NOTIFY_TARGET_USER_MODULE = 3
 notify the current User module
 

Notifications Message types.

Possible message for a notification to Usine

See also
sdkNotifyUsine
static const NativeInt NOTIFY_MSG_AUDIO_DRIVER_CHANGED = 0xFAB000
 no param
 
static const NativeInt NOTIFY_MSG_MIDI_DRIVER_CHANGED = 0xFAB001
 no param
 
static const NativeInt NOTIFY_MSG_SAMPLE_RATE_CHANGED = 0xFAB002
 param1 = samplerate
 
static const NativeInt NOTIFY_MSG_BLOC_SIZE_CHANGED = 0xFAB003
 param1 = blocsize
 
static const NativeInt NOTIFY_MSG_RESCAN_PLUGINS_DONE = 0xFAB004
 no param
 
static const NativeInt NOTIFY_MSG_RECREATE_CONTROLS = 0xFAB005
 no param
 
static const NativeInt NOTIFY_MSG_KEY_DOWN = 0xFAB006
 param1 = keycode, param2 = modifier
 
static const NativeInt NOTIFY_MSG_KEY_UP = 0xFAB007
 param
 
static const NativeInt NOTIFY_MSG_FOCUS_LOST = 0xFAB008
 no param
 
static const NativeInt NOTIFY_MSG_USINE_LOADED = 0xFAB009
 param1 = 0, param2 = 0
 
static const NativeInt NOTIFY_MSG_USINE_CALLBACK = 0xFAB679
 identify a Message->message as a callback for user module
 
static const NativeInt CALLBACK_WPARAM_LIMIT = 0xF000000
 

TShiftState

Possible value for a TShiftState variable.

See also
onMouseMove, onMouseDown, onMouseUp, onMouseMoveMultiProc, onMouseDownMultiProc, onMouseUpMultiProc
static const ULong ssShift = 0x1
 Shift keyboard state.
 
static const ULong ssAlt = 0x2
 Alt keyboard state.
 
static const ULong ssCtrl = 0x4
 Ctrl keyboard state.
 
static const ULong ssLeft = 0x8
 Left mouse button state.
 
static const ULong ssRight = 0x10
 Right mouse button state.
 
static const ULong ssMiddle = 0x20
 Middle mouse button state.
 
static const ULong ssDouble = 0x40
 Mouse Double click state.
 

UsineMidiCode::Msg

Possible value for a UsineMidiCode::Msg variable.

static const unsigned char MIDI_ALLNOTESOFF = 0x7B
 Midi msg.
 
static const unsigned char MIDI_NOTEON = 0x90
 Midi msg.
 
static const unsigned char MIDI_NOTEOFF = 0x80
 Midi msg.
 
static const unsigned char MIDI_KEYAFTERTOUCH = 0xa0
 Midi msg.
 
static const unsigned char MIDI_CONTROLCHANGE = 0xb0
 Midi msg.
 
static const unsigned char MIDI_PROGRAMCHANGE = 0xc0
 Midi msg.
 
static const unsigned char MIDI_CHANAFTERTOUCH = 0xd0
 Midi msg.
 
static const unsigned char MIDI_PITCHBEND = 0xe0
 Midi msg.
 
static const unsigned char MIDI_SYSTEMMESSAGE = 0xf0
 Midi msg.
 
static const unsigned char MIDI_BEGINSYSEX = 0xf0
 Midi msg.
 
static const unsigned char MIDI_MTCQUARTERFRAME = 0xf1
 Midi msg.
 
static const unsigned char MIDI_SONGPOSPTR = 0xf2
 Midi msg.
 
static const unsigned char MIDI_SONGSELECT = 0xf3
 Midi msg.
 
static const unsigned char MIDI_ENDSYSEX = 0xF7
 Midi msg.
 
static const unsigned char MIDI_TIMINGCLOCK = 0xF8
 Midi msg.
 
static const unsigned char MIDI_START = 0xFA
 Midi msg.
 
static const unsigned char MIDI_CONTINUE = 0xFB
 Midi msg.
 
static const unsigned char MIDI_STOP = 0xFC
 Midi msg.
 
static const unsigned char MIDI_ACTIVESENSING = 0xFE
 Midi msg.
 
static const unsigned char MIDI_SYSTEMRESET = 0xFF
 Midi msg.
 

Settings Panel Tab's name

See also
sdkAddSettingLineCaption ...
static const AnsiCharPtr PROPERTIES_TAB_NAME = "tab_properties"
 Used to populate the properties tab of the Settings panel.
 
static const AnsiCharPtr DESIGN_TAB_NAME = "tab_design"
 Used to populate the design tab of the Settings panel.
 
static const AnsiCharPtr MOUSE_TAB_NAME = "tab_mouse"
 Used to populate the mouse tab of the Settings panel.
 
static const AnsiCharPtr OTHER_TAB_NAME = "tab_other"
 Used to populate the other tab of the Settings panel.
 
static const AnsiCharPtr REMOTE_TAB_NAME = "tab_remote"
 Used to populate the remote tab of the Settings panel.
 
static const AnsiCharPtr CURVES_TAB_NAME = "tab_curves"
 Used to populate the curves tab of the Settings panel.
 
static const AnsiCharPtr LAN_TAB_NAME = "tab_lan"
 Used to populate the lan tab of the Settings panel.
 
static const AnsiCharPtr SIZE_TAB_NAME = "tab_size"
 Used to populate the size tab of the Settings panel.
 

Numeric format

See also
sdkAddSettingLineSingle ...
static const AnsiCharPtr DEFAULT_FORMAT_FLOAT_3 = "%.3f"
 Default format for a 3 decimals number.
 
static const AnsiCharPtr DEFAULT_FORMAT_FLOAT_2 = "%.2f"
 Default format for a 2 decimals number.
 
static const AnsiCharPtr DEFAULT_FORMAT_FLOAT_1 = "%.1f"
 Default format for a 1 decimal number.
 
static const AnsiCharPtr DEFAULT_FORMAT_INTEGER = "%.0f"
 Default format for an integer number.
 
static const AnsiCharPtr DEFAULT_FORMAT_GENERAL = "%g"
 Default format for a string.
 

Detailed Description

Macro Definition Documentation

§ FALSE

#define FALSE   0

To test LongBool equality against false.

See also
LongBool

§ TRUE

#define TRUE   1

To test LongBool equality against false.

See also
LongBool

Typedef Documentation

§ AnsiCharPtr

typedef const char* AnsiCharPtr

Pointer to an ANSI string variable.

Strings format conformance between CPP and DELPHI

§ ULong

typedef unsigned long ULong
See also
TShifyState, TColorUsine

§ TShiftState

typedef ULong TShiftState

keys state modifier.

See also
MouseEventsCallbacks

§ UsineEventPtr

typedef UsineEvent* UsineEventPtr

Handle to a paramerer event.

See also
onGetParamEvent

Enumeration Type Documentation

§ TMouseButton

Mouse buttons available for a mouse event callback.

See also
onMouseMove, onMouseDown, onMouseUp, onMouseMoveMultiProc, onMouseDownMultiProc, onMouseUpMultiProc
Enumerator
mbLeft 

Left mouse button.

mbRight 

Right mouse button.

mbMiddle 

Middle mouse button.

§ TScale

enum TScale

Scale type available for a parameter.

See also
TParamInfo
Enumerator
scLinear 

Linear type of scale.

scLog 

Logarithmic type of scale.

scExp 

Exponantial type of scale.

§ TParamType

enum TParamType

parameters type available in usine.

See also
TParamInfo
Enumerator
ptTextField 

param contain a string

ptChooseColor 

parameter

ptMidi 

parameter

ptGainFader 

parameter

ptAudio 

parameter

ptDataField 

parameter

ptDataFader 

parameter

ptButton 

parameter

ptListBox 

parameter

ptSwitch 

parameter

ptArray 

parameter

ptIpAddress 

parameter

ptSmpte 

parameter

ptMidiNoteFader 

parameter

ptPointerBitMap 

parameter

ptPointer 

parameter

ptRightLed 

parameter

ptChooseFolder 

parameter

ptLeftLed 

parameter

ptTriggerLed 

parameter

ptOther 

parameter

§ TFlowType

enum TFlowType

Data type of the parameter.

Used in UsineEvent, not used in user modules

Enumerator
ftNone 

Exponantial type of scale.

ftPCM 

Exponantial type of scale.

ftInternText 

Exponantial type of scale.

ftData 

Exponantial type of scale.

ftMIDI 

Exponantial type of scale.

ftArray 

Exponantial type of scale.

ftUser 

Exponantial type of scale.

ftEvtText 

Exponantial type of scale.

§ TDialogsResults

§ TTextAlign

enum TTextAlign

Text vertical alignement.

See also
sdkFillText

§ TUsineVersionType

Versions type of Usine.

See also
sdkGetUsineVersionType

§ TFastCallBackType

Possible type of callback for a parameter.

See also
TParamInfo
Enumerator
ctNormal 

Processed in the normal Usine messages handler. The latencie is defined by the User in the Usine Setup.

ctImmediate 

Each time the parameter change, callback is processed immediatelly. Be careful, the the callBack procedure is called in the audio thread.

ctAsynchronous 

Processed in the window message handler (slower than ctNormal). Use this if the process is very long or if you open a modal window.

§ TModuleType

Possible type of user modules.

See also
onGetModuleInfo, ModuleInfo
Enumerator
mtSimple 

module without graphic canvas

mtVideo 

video module

mtControl 

module with a graphic canvas

mtDeviceAudio 

not for public use

mtDeviceMidi 

not for public use

mtDeviceOther 

not for public use

mtPluginWrapper 

not for public use

mtPluginLister 

not for public use

mtDeviceDMX 

not for public use

mtOther 

not for public use