Classes > WaveformAnalyzer class > Data structures > WANALYZER_WAVEFORM

The WANALYZER_WAVEFORM_SETTINGS structure (defined as WANALYZER_WAVEFORM_SETTINGS_DLL when used for COM interoperability) describes settings applied while rendering the waveform on the Waveform Analyzer. The current settings can be retrieved through the WaveformAnalyzer.SettingsWaveGet method and modified through the WaveformAnalyzer.SettingsWaveSet 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_WAVEFORM_SETTINGS

{

public enumWaveformStereoModes nStereoVisualizationMode;

public Color colorWaveLinePeak;

public Color colorWaveLineCenter;

public Int16 nWaveLineIntensityFactor;

public Color colorWaveBackground;

public bool bUseHalfColorsForPeaks;

public enumWaveformSelectionMode nSelectionMode;

public Color colorWaveLineSelPeak;

public Color colorWaveLineSelCenter;

public Color colorWaveSelBackground;

public Color colorTransparentGlass;

public Int16 nTransparentGlassFactor;

public Color colorVolumeLevelLine;

public Color colorTimeLine;

public enumTranspGlassType nTransparentGlassType;

public Int16 nTransparentGlassPos3D;

public bool bTransparentGlassInvert3D;

public bool bDrawLinesOverWave;

}

Definition for COM Interoperability

public struct WANALYZER_WAVEFORM_SETTINGS_DLL

{

public Int32 nStereoVisualizationMode;

public Int32 colorWaveLinePeak;

public Int32 colorWaveLineCenter;

public Int16 nWaveLineIntensityFactor;

public Int32 colorWaveBackground;

public Int16 bUseHalfColorsForPeaks;

public Int32 nSelectionMode;

public Int32 colorWaveLineSelPeak;

public Int32 colorWaveLineSelCenter;

public Int32 colorWaveSelBackground;

public Int32 colorTransparentGlass;

public Int16 nTransparentGlassFactor;

public Int32 colorVolumeLevelLine;

public Int32 colorTimeLine;

public Int32 nTransparentGlassType;

public Int16 nTransparentGlassPos3D;

public Int16 bTransparentGlassInvert3D;

public Int16 bDrawLinesOverWave;

}

On the screenshot A below you can see the various involved colors: the portion with blue background represents a selection:

Screenshot A

On the screenshot B below you can see the default colors with a selection rendered as a transparent glass.:

Screenshot B

Member

Description

nStereoVisualizationMode

Visualization mode used for displaying stereo sounds

Supported values are the following:

Mnemonic constant	Value	Meaning
STEREO_MODE_CHANNELS_BOTH (default)	0	Right and left channels are displayed separately on two different panes as seen on the pictures A and B above.
STEREO_MODE_CHANNELS_LEFT	1	Only the left channel content is displayed on a single pane
STEREO_MODE_CHANNELS_RIGHT	2	Only the right channel content is displayed on a single pane
STEREO_MODE_CHANNELS_MIXED	3	Right and left channels contents are mixed together and displayed on a single pane

colorWaveLinePeak

Color used for rendering peaks of the waveform line. See screenshot A above.

colorWaveLineCenter

Color used for rendering the center of the waveform line. See screenshot A above.

nWaveLineIntensityFactor

Factor of gradient intensity of the waveform line.

This value can range from 0 to 100 with a default value of 50. Values outside of this range will be automatically capped to the nearest valid value.

On the screenshot below you can appreciate the difference between the default value 50 (on the left) and a value of 20 (on the right):

colorWaveBackground

Color used for rendering the waveform background. See screenshot A above.

bUseHalfColorsForPeaks

Boolean value that specifies if waveform peaks will have a half intensity color.

This field is ignored when colors set into the colorWaveLinePeak and colorWaveLineCenter fields are different.

Supported values are the following:

Mnemonic constant	Meaning
False	Doesn't use half color for peaks
True (default)	Uses half color for peaks

nSelectionMode

Specifies how waveform selection is rendered. See screenshots A and B above.

Supported values are the following:

Mnemonic constant	Value	Meaning
WAVE_SEL_INVERT_COLORS (default)	0	Render selection by inverting waveform colors.
WAVE_SEL_TRANSPARENT_GLASS	1	Render selection simulating a transparent glass. See screenshot B above.
WAVE_SEL_CUSTOM_COLORS	2	Render selection by using custom colors. See screenshot A above.

colorWaveLineSelPeak

Color used for rendering gradient of peaks of the waveform line when selected. See screenshot A above.

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_CUSTOM_COLORS.

colorWaveLineSelCenter

Color used for rendering gradient of center of the waveform line when selected. See screenshot A above.

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_CUSTOM_COLORS.

colorWaveSelBackground

Color used for rendering the waveform background when selected. See screenshot A above.

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_CUSTOM_COLORS.

colorTransparentGlass

Color used for rendering the transparent glass selection. See screenshot B above.

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_TRANSPARENT_GLASS.

nTransparentGlassFactor

Transparent factor for rendering the transparent glass selection.

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

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_TRANSPARENT_GLASS.

colorVolumeLevelLine

Color used for rendering horizontal lines related to the volume level. See screenshot A above.

You can set this field to -1 in order to hide volume level lines.

colorTimeLine

Color used for rendering vertical lines related to time. See screenshot A above.

You can set this field to -1 in order to hide time lines.

nTransparentGlassType

Type of transparent glass.

Supported values are the following:

Mnemonic constant	Value	Meaning
TRANSP_GLASS_TYPE_FLAT	0	Flat glass.
TRANSP_GLASS_TYPE_3D_VERT (default)	1	3D vertical glass.
TRANSP_GLASS_TYPE_3D_HORZ	2	3D horizontal glass.

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_TRANSPARENT_GLASS.

On the screenshot below you can appreciate the difference between the available settings:

nTransparentGlassPos3D

Position of the 3D effect for the transparent glass.

This value can range from 0 to 100 with a default value of 50. Values outside of this range will be automatically capped to the nearest valid value.

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_TRANSPARENT_GLASS.

bTransparentGlassInvert3D

Boolean value that specifies if the transparency of the 3D effect is inverted.

Supported values are the following:

Mnemonic constant	Meaning
False (default)	Doesn't invert 3D effect
True	Inverts 3D effect

This setting is ignored when the nSelectionMode field above is set to a value different from WAVE_SEL_TRANSPARENT_GLASS.

On the screenshot below you can appreciate the difference between the available settings (inverted 3D effect on the left):

bDrawLinesOverWave

Boolean value that specifies if time and volume lines must be drawn over the waveform.

Supported values are the following:

Mnemonic constant	Meaning
False (default)	Time and volume lines are drawn under the waveform.
True	Time and volume lines are drawn over the waveform.