Copyright © 2013-2014 MultiMedia Soft

MidiDjConsole.DisplaySegmentStringScroll method

Previous pageReturn to chapter overviewNext page

Remarks

 

Allows displaying a scrolling string of text on the given VFD segment at a specific rate. Scrolling always occurs from right to left.

 

You can verify if the control comes with support for managing VFD segments of the connected DJ Console through the MidiDjConsole.DisplaySegmentManagementAvailable 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]

control.MidiDjConsole.DisplaySegmentStringScroll (

nIndex as Long,

pBuffer as Variant,

nBufferLen as Long,

nDelay as Long

) as enumDjcErrorCodes


 

[C++]

short control.MidiDjConsole.DisplaySegmentStringScroll (

long nIndex,

const VARIANT FAR& pBuffer,

long nBufferLen,

long nDelay

);


 

Parameter

Description

 

 

nIndex

Zero-based index of the VFD segment. The maximum number of available segments can be retrieved through the MidiDjConsole.DisplaySegmentCountGet method.

pBuffer

Variant parameter containing the pointer to the memory buffer containing the string to scroll.

The character set in use is usually provided inside the technical specifications of the DJ Console in use.

nBufferLen

Length in bytes of the given buffer. Usually one single byte is required to store one single character.

The length of the buffer can be up to 256 bytes, allowing a string longer than the number of available cells per segment to be scrolled.

In case the source buffer should have a size larger than 256 bytes, only the first 256 bytes would be taken into consideration while bytes exceeding this size would be ignored.

nDelay

Number representing the applied scrolling 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 scrolling of the displayed string would occur every second.

 

 

Return value

 

Value

Meaning

 

 

enumDjcErrorCodes.ERR_DJC_NOERROR (0)

The call was successful.

Negative value

An error occurred: see the LastError property for further error details or for a list of the possible error values.