Copyright © 2013-2014 MultiMedia Soft

MidiDjConsole.ProfileLedMidiCommandGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains parameters of the short MIDI command specific for a led item stored inside the profile. See the MidiDjConsole.ProfileLedMidiCommandSet method for details about the structure of a short MIDI command representing a led item.

 

The combination of MIDI command parameters is usually defined inside the technical specifications of the physical DJ Console and may vary a lot depending upon the DJ Console in use.

 

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.ProfileLedMidiCommandGet (

strItemName as String,

ByRef nMidiCommandOn as Int16,

ByRef nMidiCommandOff as Int16,

ByRef nMidiCommandBlink as Int16,

ByRef nMidiChannel as Int16,

ByRef nMidiDataOn as Int16,

ByRef nMidiDataOff as Int16,

ByRef nMidiDataBlink as Int16

) as enumDjcErrorCodes


 

[C#]

public enumDjcErrorCodes MidiDjConsole.ProfileLedMidiCommandGet (

string strItemName,

ref Int16 nMidiCommandOn,

ref Int16 nMidiCommandOff,

ref Int16 nMidiCommandBlink,

ref Int16 nMidiChannel,

ref Int16 nMidiDataOn,

ref Int16 nMidiDataOff,

ref Int16 nMidiDataBlink

);


 

[C++]

public: enumDjcErrorCodes MidiDjConsole.ProfileLedMidiCommandGet (

string strItemName,

Int16 __gc *nMidiCommandOn,

Int16 __gc *nMidiCommandOff,

Int16 __gc *nMidiCommandBlink,

Int16 __gc *nMidiChannel,

Int16 __gc *nMidiDataOn,

Int16 __gc *nMidiDataOff,

Int16 __gc *nMidiDataBlink

);


 

Parameter

Description

 

 

strItemName

String containing the name of the led item.

If no led item with this specific name should be available inside the profile, the method would fail and would return an error code.

nMidiCommandOn

Reference that, on return from the method call, will contain the number representing the MIDI command issued when the physical led needs to be switched on.

nMidiCommandOff

Reference that, on return from the method call, will contain the number representing the MIDI command issued when the physical led needs to be switched off: in some case this value could be identical to the value  of the nMidiCommandOn parameter in which case the on/off status would be identified by different values of the nMidiDataOn and nMidiDataOff parameters below.

nMidiCommandBlink

Reference that, on return from the method call and only for DJ Consoles supporting native blinking, will contain the number representing the MIDI command issued when the physical led needs to blink.

For DJ Consoles not supporting native blinking, the returned value will be 0.

nMidiChannel

Reference that, on return from the method call, will contain the number representing the MIDI channel.

Some DJ Console makes use of this parameter in order to discriminate between the DJ Console's decks, in other cases it's simply left to 0.

nMidiDataOn

Reference that, on return from the method call, will contain the number representing the "Data" parameter of the MIDI command issued when the physical led needs to be switched on.

The "Data" parameter is a 16 bits integer value which combines 2 bytes ("Data1" and "Data2") which usually indicates the code of the led and its status (on/off).

Separate values of the "Data1" and "Data2" bytes can be extracted from this parameter using custom functions and/or macros.

nMidiDataOff

Reference that, on return from the method call, will contain the number representing the "Data" parameter of the MIDI command issued when the physical led needs to be switched off.

As mentioned above, the "Data" parameter is a 16 bits integer value which combines 2 bytes ("Data1" and "Data2") which usually indicates the code of the led and its status (on/off): in some case this value could be identical to the value of the nMidiDataOn parameter in which case the on/off status would be identified by different values of the nMidiCommandOn and nMidiCommandOff parameters above.

Separate values of the "Data1" and "Data2" bytes can be combined in one single 16 bits integer value using custom functions and/or macros.

nMidiDataBlink

Reference that, on return from the method call and only for DJ Consoles supporting native blinking, will contain the number representing the "Data" parameter of the MIDI command issued when the physical led needs to be blinked.

For DJ Consoles not supporting native blinking, the returned value will be 0.

As mentioned above, the "Data" parameter is a 16 bits integer value which combines 2 bytes ("Data1" and "Data2") which usually indicates the code of the led and its status (on/off/blink).

Separate values of the "Data1" and "Data2" bytes can be combined in one single 16 bits integer value using custom functions and/or macros.

 

 

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.