Copyright © 2006-2018 MultiMedia Soft

WaveformAnalyzer.GraphicItemHorizontalLineParamsSetEx method

Previous pageReturn to chapter overviewNext page

Remarks

 

Modifies one of the settings for the given graphic item added to the waveform analyzer. Value of single settings can be obtained through the WaveformAnalyzer.GraphicItemHorizontalLineParamsGetEx method.

This method is an alternative to the WaveformAnalyzer.GraphicItemHorizontalLineParamsSet method and is provided with the purpose of allowing single settings modifications when dealing with languages like JavaScript where data structures are not easy to implement.

 

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer object section.

 

 

Syntax

 

[Visual Basic]

control.WaveformAnalzyer.GraphicItemHorizontalLineParamsSetEx (

nUniqueId as Integer,

nParam as short,

strValue as String

) as enumErrorCodes


 

[C++]

short control.WaveformAnalzyer.GraphicItemHorizontalLineParamsSetEx (

short nUniqueId,

short nParam,

LPCTSTR strValue

);


 

Parameter

Description

 

 

nUniqueId

Unique identification number assigned to the line by a previous call to the WaveformAnalyzer.GraphicItemHorizontalLineAdd method.

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Value

Meaning

0

color member of the WANALYZER_HORIZONTAL_LINE data structure

1

nChannel member of the WANALYZER_HORIZONTAL_LINE data structure

2

nDashStyle member of the WANALYZER_HORIZONTAL_LINE data structure

3

nHeightInPix member of the WANALYZER_HORIZONTAL_LINE data structure

4

nTranspFactor member of the WANALYZER_HORIZONTAL_LINE data structure

5

nVertPosInPerc member of the WANALYZER_HORIZONTAL_LINE data structure

6

nLeftCap member of the WANALYZER_HORIZONTAL_LINE data structure

7

nRightCap member of the WANALYZER_HORIZONTAL_LINE data structure

8

nDashCap member of the WANALYZER_HORIZONTAL_LINE data structure

strValue

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

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"

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.