Copyright © 2001-2018 MultiMedia Soft

WaveformScroller.SettingsParamSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets one of the graphical settings for the given waveform scroller. Value of single settings can be obtained through the WaveformScroller.SettingsParamGet method.

 

For further details about methods of the Waveform scroller refer to the WaveformScroller object.

For a tutorial about the use of Waveform scrollers refer to the How to scroll the sound's waveform during playback tutorial.

 

 

Syntax

 

[Visual Basic]

control.WaveformScroller.SettingsParamSet (

hWndWaveformScroller as OLE_HANDLE,

pParamData as Long,

strValue as String

) as enumErrorCodes


 

[C++]

short control.WaveformScroller.SettingsParamSet (

OLE_HANDLE hWndWaveformScroller,

void *pParamData,

LPCTSTR strValue

);


 

Parameter

Description

 

 

hWndWaveformScroller

Handle of the control returned by a previous call to the WaveformScroller.Create method

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Numeric value

Meaning

0

nStereoVisualizationMode field of the WSCROLLER_SETTINGS data structure

1

colorWaveLinePeak field of the WSCROLLER_SETTINGS data structure

2

colorWaveLineCenter field of the WSCROLLER_SETTINGS data structure

3

nWaveLineIntensityFactor field of the WSCROLLER_SETTINGS data structure

4

colorWaveBackground field of the WSCROLLER_SETTINGS data structure

5

bUseHalfColorsForPeaks field of the WSCROLLER_SETTINGS data structure

6

bAppearance3d field of the WSCROLLER_SETTINGS data structure

7

colorPositionLine field of the WSCROLLER_SETTINGS data structure

8

colorBorder field of the WSCROLLER_SETTINGS data structure

9

bPositionLineShow field of the WSCROLLER_SETTINGS data structure

10

nPositionLineDashStyle field of the WSCROLLER_SETTINGS data structure

11

nPositionLineWidth field of the WSCROLLER_SETTINGS data structure

12

nPositionLineHighCap field of the WSCROLLER_SETTINGS data structure

13

nPositionLineLowCap field of the WSCROLLER_SETTINGS data structure

14

nPositionLineDashCap field of the WSCROLLER_SETTINGS data structure

15

nPositionLineTranspFactor field of the WSCROLLER_SETTINGS data structure

16

nGraphicItemsMask field of the WSCROLLER_SETTINGS data structure

17

nUpdateSpeed field of the WSCROLLER_SETTINGS data structure

18

fVerticalZoomFactor field of the WSCROLLER_SETTINGS data structure

strValue

String representing the numerical value to set: the multimedia engine will manage converting the string into the corresponding numerical value.

 

 

 

 

Return value

 

Value

Meaning

 

 

enumErrorCodes.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.