Copyright © 2011-2019 MultiMedia Soft

SPECTR_ENH_WAVE_SETTINGS structure

Previous pageReturn to chapter overviewNext page

The SPECTR_ENH_WAVE_SETTINGS data structure (defined as SPECTR_ENH_WAVE_SETTINGS_DLL when used for COM interoperability) describes the graphical settings applied to the spectrum wave displayed on the spectrum analyzer. The current settings can be obtained through the SpectrumEnh.SettingsWaveGet method and modified through the SpectrumEnh.SettingsWaveSet method.

 

For further details about using the Enhanced Spectrum Analyzer refer to the SpectrumEnh section.

For details about using the Enhanced Spectrum Analyzer refer to the How to use the Enhanced Spectrum Analyzer tutorial.

 

C# definition

 

public struct SPECTR_ENH_WAVE_SETTINGS

{

 public Int16         nAreaTransparency;

 public bool         bClearSpectralViewOnEnd;

 public Color         colorLineTopLeftChan;

 public Color         colorLineTopRightChan;

 public Color         colorLineCoveredLeftChan;

 public Color         colorLineCoveredRightChan;

 public Color         colorAreaLeftChan;

 public Color         colorAreaRightChan;

 public Color         colorAreaCoveredLeftChan;

 public Color         colorAreaCoveredRightChan;

 public Color         colorVertLineSpectralView;

}

 

Definition for COM Interoperability

 

public struct SPECTR_ENH_WAVE_SETTINGS_DLL

{

 public Int16         nAreaTransparency;

 public Int16         bClearSpectralViewOnEnd;

 public Int32         colorLineTopLeftChan;

 public Int32         colorLineTopRightChan;

 public Int32         colorLineCoveredLeftChan;

 public Int32         colorLineCoveredRightChan;

 public Int32         colorAreaLeftChan;

 public Int32         colorAreaRightChan;

 public Int32         colorAreaCoveredLeftChan;

 public Int32         colorAreaCoveredRightChan;

 public Int32         colorVertLineSpectralView;

}

 

 

Member

Description

 

 

nAreaTransparency

Numerical value representing the transparency applied to area colors: can be in the range from 0 to 100 where 0 means solid (no transparency) while 100 means totally transparent. The default value is 25.

bClearSpectralViewOnEnd

Boolean value that specifies if the spectral view must be cleared when the end of the spectrum analyzer's display is reached.

Supported values are the following:

Value

Meaning

false (default)

Doesn't clear the display.

In the image below you can see the vertical line of the spectral view in grey

true

Clears the display.

colorLineTopLeftChan

The color used for rendering the top line of left channel

colorLineTopRightChan

The color used for rendering the top line of right channel

colorLineCoveredLeftChan

The color used for rendering the top line of left channel when covered by the area of the right channel

colorLineCoveredRightChan

The color used for rendering the top line of right channel when covered by the area of the left channel

colorAreaLeftChan

The color used for rendering the area of left channel

colorAreaRightChan

The color used for rendering the area of right channel

colorAreaCoveredLeftChan

The color used for rendering the area of left channel when covered by the area of the right channel

colorAreaCoveredRightChan

The color used for rendering the area of right channel when covered by the area of the left channel

colorVertLineSpectralView

The color used for rendering the vertical line of the spectral view.

In the image below you can see the vertical line of the spectral view in grey

 

Below you can see an image of the enhanced spectrum analyzer evidencing some of the configurable elements:

 

 

In the image above the left channel, which is represented on top respect to the right channel, is rendered through the cyan line and through the blue area while the left channel, partially covered by the left channel, is rendered through the red line and through the darker red area; the portion of right channel area covered by the left channel's area is rendered in violet.

As you can see, frequency and dB grids are still partially visible also when covered by channels areas: this is obtained by rending areas in transparency through the setting of the nAreaTransparency field: in this case the value was set to 25.