Copyright © 2008-2023 MultiMedia Soft

SPECTR_ENH_RULERS_SETTINGS structure

Previous pageReturn to chapter overviewNext page

The SPECTR_ENH_RULERS_SETTINGS data structure describes the settings applied to rulers of a specific enhanced spectrum analyzer. The current settings can be obtained through the SpectrumEnh.SettingsRulersGet method and modified through the SpectrumEnh.SettingsRulersSet 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.

 

Visual C++ definition

 

typedef struct

{

 short     bLinearScale;

 short     bScaleTopVisible;

 short     bScaleBottomVisible;

 short     bScaleLeftVisible;

 short     bScaleRightVisible;

 OLE_COLOR colorBackground;

 OLE_COLOR colorTicks;

 OLE_COLOR colorText;

} SPECTR_ENH_RULERS_SETTINGS;

 

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 Editor\include).

 

 

Visual Basic definition

 

Public Type SPECTR_ENH_RULERS_SETTINGS

bLinearScale As Boolean

bScaleTopVisible As Boolean

bScaleBottomVisible As Boolean

bScaleLeftVisible As Boolean

bScaleRightVisible As Boolean

colorBackground As OLE_COLOR

colorTicks As OLE_COLOR

colorText As OLE_COLOR

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 Editor\include).

 

 

 

Member

Description

 

 

bLinearScale

Boolean value that specifies if the frequency ruler should display a linear or logarithmic scale.

Supported values are the following:

Value

Meaning

false (default)

Displays logarithmic scale

true

Displays linear scale

bScaleTopVisible

Boolean value that specifies if the frequency ruler on the top should be visible.

Supported values are the following:

Value

Meaning

false

Doesn't display the frequency top ruler

true (default)

Displays the frequency top ruler

bScaleBottomVisible

Boolean value that specifies if the frequency ruler on the bottom should be visible.

Supported values are the following:

Value

Meaning

false

Doesn't display the frequency bottom ruler

true (default)

Displays the frequency bottom ruler

bScaleLeftVisible

Boolean value that specifies if the decibels ruler on the left side should be visible.

Supported values are the following:

Value

Meaning

false

Doesn't display the decibels left ruler

true (default)

Displays the decibels left ruler

bScaleRightVisible

Boolean value that specifies if the decibels ruler on the right side should be visible.

Supported values are the following:

Value

Meaning

false (default)

Doesn't display the decibels right ruler

true

Displays the decibels right ruler

colorBackground

The color used for rendering the rulers background.

colorTicks

The color used for rendering rulers ticks

colorText

The color used for rendering rulers text

 

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