Copyright © 2013-2014 MultiMedia Soft

MidiDjConsole.ProfileItemAdd method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds a new item inside the profile of the DJ Console. The added item can be modified at a later time through the MidiDjConsole.ProfileItemModify method.

 

For further details about interfacing with MIDI DJ Consoles see the MidiDjConsole object section and the How to manage MIDI DJ consoles tutorial.

 

 

Syntax

 

[Visual Basic]

MidiDevices.MidiDjConsole.ProfileItemAdd (

strItemName as String,

nItemType as enumDjConsoleItemType,

strItemDescr as String,

strItemTag as String

) as enumDjcErrorCodes


 

[C#]

public enumDjcErrorCodes MidiDjConsole.ProfileItemAdd (

string strItemName,

enumDjConsoleItemType nItemType,

string strItemDescr,

string strItemTag

);


 

[C++]

public: enumDjcErrorCodes MidiDjConsole.ProfileItemAdd (

string strItemName,

enumDjConsoleItemType nItemType,

string strItemDescr,

string strItemTag

);


 

Parameter

Description

 

 

strItemName

String containing the name of the new item.

Although not mandatory, it's strongly suggested to assign to the new item the same name assigned by the technical specifications of the specific DJ Console for which the profile is being written.

Duplication of items names is not allowed: if an other item having the same name should be already available inside the profile, the call to this method would fail and would return an error code; you can know if a specific name has already been assigned to an existing item through the MidiDjConsole.ProfileItemExistsByName method.

The item's name is UNICODE compliant so can support languages using the double-byte convention.

nItemType

Specifies the type of the item to add to the profile.

Supported values are the following:

Mnemonic constant

Value

Meaning

DJC_ITEM_TYPE_BUTTON

0

Simple push button control

DJC_ITEM_TYPE_BUTTON_WITH_LED

1

Push button control with an embedded led driven by the same MIDI command. The usage of this type is not mandatory when the push button and its led have the same MIDI command; if you want you can keep the push button separated from its led inside the profile.

DJC_ITEM_TYPE_RANGE

2

Range control: sliders, rotary knobs and jog wheels are included in this category.

DJC_ITEM_TYPE_LED

3

Led control or VFD (Vacuum Fluorescent Display) symbol driven as a led.

DJC_ITEM_TYPE_DISPLAY

4

VFD (Vacuum Fluorescent Display) element not driven as a simple led, for example the track number or the position of the track.

strItemDescr

String containing the friendly description of the item.

strItemTag

String containing the tag string of the item. You can use this string to assign a custom behaviour to the item of the profile without affecting any of its other settings or causing side effects.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred. Check the LastError property value in order to see the last error.

enumDjcErrorCodes.ERR_DJC_NOERROR (0)

The method call was successful.