Classes > WaveformAnalyzer class > Data structures > WANALYZER_GENERAL

The WANALYZER_GENERAL_SETTINGS structure (defined as WANALYZER_GENERAL_SETTINGS_DLL when used for COM interoperability) describes the general settings applied to the Waveform Analyzer. The current settings can be retrieved through the WaveformAnalyzer.SettingsGeneralGet method and modified through the WaveformAnalyzer.SettingsGeneralSet 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 class section.

C# definition

public struct WANALYZER_GENERAL_SETTINGS

{

public bool bAppearance3d;

public enumAnalyzerResolutions nResolution;

public float fHorizontalZoomFactor;

public float fVerticalZoomFactor;

public Int16 nPositionLineWidth;

public enumWaveformLineDashStyles nPositionLineDashStyle;

public Color colorPositionLine;

public bool bPlaybackLineVisible;

public Int16 nPlaybackLineWidth;

public enumWaveformLineDashStyles nPlaybackLineDashStyle;

public Color colorPlaybackLine;

public enumLineCaps nPositionLineHighCap;

public enumLineCaps nPositionLineLowCap;

public enumLineDashCaps nPositionLineDashCap;

public Int16 nPositionLineTranspFactor;

public enumLineCaps nPlaybackLineHighCap;

public enumLineCaps nPlaybackLineLowCap;

public enumLineDashCaps nPlaybackLineDashCap;

public Int16 nPlaybackLineTranspFactor;

public bool bVerticalLinesOnTimeRuler;

public bool bAutoRefresh;

}

Definition for COM Interoperability

public struct WANALYZER_GENERAL_SETTINGS_DLL

{

public Int16 bAppearance3d;

public Int32 nResolution;

public float fHorizontalZoomFactor;

public float fVerticalZoomFactor;

public Int16 nPositionLineWidth;

public Int32 nPositionLineDashStyle;

public Int32 colorPositionLine;

public Int16 bPlaybackLineVisible;

public Int16 nPlaybackLineWidth;

public Int32 nPlaybackLineDashStyle;

public Int32 colorPlaybackLine;

public Int32 nPositionLineHighCap;

public Int32 nPositionLineLowCap;

public Int32 nPositionLineDashCap;

public Int16 nPositionLineTranspFactor;

public Int32 nPlaybackLineHighCap;

public Int32 nPlaybackLineLowCap;

public Int32 nPlaybackLineDashCap;

public Int16 nPlaybackLineTranspFactor;

public Int16 bVerticalLinesOnTimeRuler;

public Int16 bAutoRefresh;

}

Member

Description

bAppearance3d

Boolean value that specifies if the Waveform Analyzer is displayed with 3D borders.

asrecnet_i000070

Supported values are the following:

Mnemonic constant	Meaning
False	Doesn't display 3D borders
True	Displays 3D borders

nResolution

Resolution used for waveform's analysis.

Supported values are the following:

Mnemonic constant	Value	Meaning
WAVEANALYZER_RES_MINIMUM	100	Minimum resolution, faster calculation time. Each line on the analyzer is the average for 256 PCM samples.
WAVEANALYZER_RES_VERY_LOW	101	Very low resolution. Each line on the analyzer is the average for 128 PCM samples.
WAVEANALYZER_RES_LOW	102	Low resolution. Each line on the analyzer is the average for 64 PCM samples.
WAVEANALYZER_RES_MIDDLE	103	Middle resolution. Each line on the analyzer is the average for 32 PCM samples.
WAVEANALYZER_RES_HIGH	104	High resolution. Each line on the analyzer is the average for 16 PCM samples.
WAVEANALYZER_RES_VERY_HIGH	105	Very high resolution. Each line on the analyzer is the average for 8 PCM samples.
WAVEANALYZER_RES_MAXIMUM	106	Maximum resolution, slower calculation time. Each line on the analyzer is the average for 4 PCM samples.

fHorizontalZoomFactor

Floating point value indicating the factor applied to zooming operations: by default the zoom factor is 2.0.

The value of this field cannot be lower than 1.01. Smaller values will be automatically capped to 1.01.

fVerticalZoomFactor

Factor applied to vertical zooming operations. can assume values ranging from 0.5 to 5. Values outside of this range will be automatically capped to the nearest valid value.

- Values smaller than 1 will vertically zoom-out the waveform, reducing its vertical size

- Value 1 will display the waveform without zooming (default)

- Values higher than 1 will vertically zoom-in the waveform, increasing its vertical size

nPositionLineWidth

Width in pixels of the line that indicates a selected position on the waveform

nPositionLineDashStyle

Dash style of the line that indicates a selected position on the waveform.

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 dash styles with the corresponding value displayed:

colorPositionLine

Color used for rendering the line that indicates a selected position on the waveform.

bPlaybackLineVisible

Boolean value that specifies if the line that indicates the playback position is visible during a playback session.

Supported values are the following:

Mnemonic constant	Meaning
False	Doesn't display the position line during playback
True	Displays the position line during playback

nPlaybackLineWidth

Width in pixels of the playback line

nPlaybackLineDashStyle

Dash style of the line that indicates the playback position on the waveform during a playback session.

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

colorPlaybackLine

Color used for rendering the line that indicates the playback position on the waveform during a playback session.

nPositionLineHighCap

Type of cap for the high end of the position 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:

nPositionLineLowCap

Type of cap for the low end of the position line.

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

nPositionLineDashCap

Type of dash/dot cap for the position 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:

nPositionLineTranspFactor

Transparent factor applied to the position line.

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.

nPlaybackLineHighCap

Type of cap for the high end of the playback line.

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

nPlaybackLineLowCap

Type of cap for the low end of the playback line.

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

nPlaybackLineDashCap

Type of dash/dot cap for the playback line.

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

nPlaybackLineTranspFactor

Transparent factor applied to the playback line.

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.

bVerticalLinesOnTimeRuler

Boolean value that specifies if caps of vertical lines must be rendered over time rulers.

Supported values are the following:

Mnemonic constant	Meaning
False (default)	Caps of vertical lines must be rendered over time rulers.
True	Caps of vertical lines must be rendered over the waveform are without exceeding over time rulers..

bAutoRefresh

Boolean value that specifies if the waveform is refreshed automatically during the analysis phase.

Supported values are the following:

Mnemonic constant	Meaning
False (default)	Auto-refresh is disabled.
True	Auto-refresh is enabled. This setting doesn't apply when the WaveformAnalyzer.ViewModeSet method has been invoked with the nMode parameter set to WANALYZER_VIEW_MODE_SPECTRAL.