Copyright © 2013-2014 MultiMedia Soft

MidiDjConsole.ProfileLedBlink method

Previous pageReturn to chapter overviewNext page

Remarks

 

Starts blinking the physical led associated to the given led item.

 

For DJ Consoles not supporting native blinking there is the possibility to simulate blinking programmatically by specifying a certain delay: in case of simulation the component will send to the console the MIDI command for switching the led on and off set through a previous call to the MidiDjConsole.ProfileLedMidiCommandSet method or loaded through an eventual call to the MidiDjConsole.ProfileLoad method.

 

Blinking can be stopped at any time by switching the same led on or off through the MidiDjConsole.ProfileLedSwitch method.

 

Certain models of console come with a specific MIDI command for blinking a led natively but usually don't allow specifying at which rate this should occur: through simulation, the usage of this specific method gives more freedom about the blinking rate also for console supporting native blinking at a fixed rate.

 

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]

control.MidiDjConsole.ProfileLedBlink (

strItemName as String,

bSimulated as enumBoolean,

nBlinkDelay as Long

) as enumDjcErrorCodes


 

[C++]

short control.MidiDjConsole.ProfileLedBlink (

BSTR strItemName,

short bSimulated,

long nBlinkDelay

);


 

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.

bSimulated

Boolean value specifying if the blinking is simulated or native.

Supported values are the following:

Mnemonic constant

Value

Meaning

BOOL_FALSE

0

Led blinking occurs natively by sending to the console the appropriate MIDI command.

When this option is selected the nBlinkDelay parameter below is ignored.

BOOL_TRUE

1

Led blinking is simulated by the control which automatically sends to the console the sequence of on/off MIDI commands.

The blink rate is determined through the nBlinkDelay parameter below.

nBlinkDelay

Number representing the applied blinking rate expressed in milliseconds.  The minimal accepted value is 50 milliseconds; values under this limit will be automatically capped to 50.

If for example this parameter should be set to 1000, the led would start blinking by staying on for 1 seconds, then off for 1 seconds and so on.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred, check the LastError property value in order to get the error code

enumErrorCodes.ERR_NOERROR (0)

The method call was successful