Copyright © 2006-2019 MultiMedia Soft

WaveformAnalyzer.SettingsGeneralParamSet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Sets one of the general settings for the waveform analyzer. Value of single settings can be obtained through the WaveformAnalyzer.SettingsGeneralParamGet method.

This method is an alternative to the WaveformAnalyzer.SettingsGeneralSet method and it's 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.SettingsGeneralParamSet (

nParam as short,

strValue as String

) as String

 

[C++]

BSTR control.WaveformAnalzyer.SettingsGeneralParamSet (

short nParam,

LPCTSTR strValue

);

 

Parameter

Description

 

 

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Value

Meaning

0

bAppearance3d member of the WANALYZER_GENERAL_SETTINGS data structure

1

nResolution member of the WANALYZER_GENERAL_SETTINGS data structure

2

fHorizontalZoomFactor member of the WANALYZER_GENERAL_SETTINGS data structure

3

fVerticalZoomFactor member of the WANALYZER_GENERAL_SETTINGS data structure

4

nPositionLineWidth member of the WANALYZER_GENERAL_SETTINGS data structure

5

nPositionLineDashStyle member of the WANALYZER_GENERAL_SETTINGS data structure

6

colorPositionLine member of the WANALYZER_GENERAL_SETTINGS data structure

7

bPlaybackLineVisible member of the WANALYZER_GENERAL_SETTINGS data structure

8

nPlaybackLineWidth member of the WANALYZER_GENERAL_SETTINGS data structure

9

nPlaybackLineDashStyle member of the WANALYZER_GENERAL_SETTINGS data structure

10

colorPlaybackLine member of the WANALYZER_GENERAL_SETTINGS data structure

11

nPositionLineHighCap member of the WANALYZER_GENERAL_SETTINGS data structure

12

nPositionLineLowCap member of the WANALYZER_GENERAL_SETTINGS data structure

13

nPositionLineDashCap member of the WANALYZER_GENERAL_SETTINGS data structure

14

nPositionLineTranspFactor member of the WANALYZER_GENERAL_SETTINGS data structure

15

nPlaybackLineHighCap member of the WANALYZER_GENERAL_SETTINGS data structure

16

nPlaybackLineLowCap member of the WANALYZER_GENERAL_SETTINGS data structure

17

nPlaybackLineDashCap member of the WANALYZER_GENERAL_SETTINGS data structure

18

nPlaybackLineTranspFactor member of the WANALYZER_GENERAL_SETTINGS data structure

19

VerticalLinesOnTimeRuler member of the WANALYZER_GENERAL_SETTINGS data structure

20

bAutoRefresh member of the WANALYZER_GENERAL_SETTINGS 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

 

 

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