Copyright © 2006-2023 MultiMedia Soft

WANALYZER_VERTICAL_LINE structure

Previous pageReturn to chapter overviewNext page

The WANALYZER_VERTICAL_LINE structure describes settings applied to a vertical line added to the Waveform Analyzer through the WaveformAnalyzer.GraphicItemVerticalLineAdd method. The current settings can be retrieved through the WaveformAnalyzer.GraphicItemVerticalLineParamsGet method and modified through the WaveformAnalyzer.GraphicItemVerticalLineParamsSet method.

 

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.

 

Visual C++ definition

 

typedef struct

{

         OLE_COLOR color;

         long nDashStyle;

         short nWidth;

         short nTranspFactor;

         long nHighCap;

         long nLowCap;

         long nDashCap;

} WANALYZER_VERTICAL_LINE;

 

This data structure is defined inside the AdjMmsEngDef.h header file which can be found inside the product's Include directory (default \Program files\MultiMedia Soft\Active Sound Recorder\include).

 

Visual Basic definition

 

Public Type WANALYZER_VERTICAL_LINE

         color As OLE_COLOR

         nDashStyle As enumWaveformLineDashStyles

         nWidth As Integer

         nTranspFactor As Integer

         nHighCap As enumLineCaps

         nLowCap As enumLineCaps

         nDashCap As enumLineDashCaps

End Type

 

This data structure is defined inside the AdjMmsEngDef.bas module file which can be found inside the product's Include directory (default \Program files\MultiMedia Soft\Active Sound Recorder\include).

 

 

Member

Description

 

 

color

Color used for rendering the line.

nDashStyle

Line dash style.

Supported values are the following:

Mnemonic constant

Value

Meaning

LINE_DASH_STYLE_SOLID

0

Solid line.

LINE_DASH_STYLE_DASH

1

Dashed line.

LINE_DASH_STYLE_DOT

2

Dotted line.

LINE_DASH_STYLE_DASH_DOT

3

Alternating dash-dot line line.

LINE_DASH_STYLE_DASH_DOT_DOT

4

Alternating dash-dot-dot line line.

 

On the screenshot below you can see the different types of vertical lines with the corresponding value displayed on the buddy text:

 

nWidth

Line width in pixels.

nTranspFactor

Transparent factor. This value can range from 0 (total opacity) to 255 (total transparency). Values outside of this range will be automatically capped to the nearest valid value.

nHighCap

Type of cap for the high end of the line.

Supported values are the following:

Mnemonic constant

Value

Meaning

LINE_CAP_SQUARE

0

Specifies a square cap.

LINE_CAP_ROUND

1

Specifies a circular cap.

LINE_CAP_TRIANGLE

2

Specifies a triangular cap.

LINE_CAP_SQUARE_ANCHOR

3

Specifies that the line ends are anchored with a square.

LINE_CAP_ROUND_ANCHOR

4

Specifies that the line ends are anchored with a circle.

LINE_CAP_DIAMOND_ANCHOR

5

Specifies that the line ends are anchored with a diamond.

LINE_CAP_ARROW_ANCHOR

6

Specifies that the line ends are anchored with arrowheads.

 

On the screenshot below you can see the different types of line caps with the corresponding value displayed on the buddy text:

 

nLowCap

Type of cap for the low end of the line.

Supported values are the same as seen for the nHighCap field above.

nDashCap

Type of dash/dot cap for the line.

Supported values are the following:

Mnemonic constant

Value

Meaning

LINE_DASH_CAP_FLAT

0

Specifies a square cap that squares off both ends of each dash.

LINE_DASH_CAP_ROUND

1

Specifies a circular cap that rounds off both ends of each dash.

LINE_DASH_CAP_TRIANGLE

2

Specifies a triangular cap that points both ends of each dash.

 

On the screenshot below you can see the different types of line dash caps with the corresponding value displayed on the buddy text: