COM Objects > WaveformScroller object > Methods > WaveformScroller.SettingsParamGet method

Remarks

Retrieves one of the current graphical settings for the given waveform scroller. Single settings can be modified through the WaveformScroller.SettingsParamSet method.

This method is an alternative to the WaveformScroller.SettingsGet method and it's provided with the purpose of allowing single settings retrieval when dealing with languages like JavaScript where data structures are not easy to implement.

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

hWndWaveformScroller as OLE_HANDLE,

nParam as short

) as String

[C++]

BSTR control.WaveformScroller.SettingsParamGet (

OLE_HANDLE hWndWaveformScroller,

short nParam

);

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

Return value

Value

Meaning

Empty string

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

Valid string

String containing the value of the requested parameter..

The value is formatted with the following rules:

•	Color values are formatted like "#RRGGBB" where:

- "#" represents the control character used for formatting colors in HTML code: the presence of this character is mandatory

- RR represents the hexadecimal value of the color's red component

- GG represents the hexadecimal value of the color's green component

- BB represents the hexadecimal value of the color's blue component

For example the green color will be represented with the value "#00FF00"

•	Boolean values are rendered as

- "1" or "True" for indicating the boolean "true"

- "0" or "False" for indicating the boolean "false"