Copyright © 2008-2018 MultiMedia Soft

WANALYZER_RULERS_SETTINGS structure

Previous pageReturn to chapter overviewNext page

The WANALYZER_RULERS_SETTINGS structure describes settings applied while rendering the time and amplitude rulers on the Waveform Analyzer. The current settings can be retrieved through the WaveformAnalyzer.SettingsRulersGet method and modified through the WaveformAnalyzer.SettingsRulersSet 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

{

     long nAmplitudeScale;

     short bVisibleLeft;

     short bTicksLeft;

     short bVisibleRight;

     short bTicksRight;

     short bVisibleTop;

     short bTicksTop;

     short bVisibleBottom;

     short bTicksBottom;

     OLE_COLOR colorBackground;

     OLE_COLOR colorTicks;

     OLE_COLOR colorText;

     short nTopRulerHeightInPix;

     short nBottomRulerHeightInPix;

     short nVertRulerWidthInPix;

     float fTimeTicksFrequencyInPix;

} WANALYZER_RULERS_SETTINGS;

 

This data structure is defined inside the AdjMmsEngDef.h header file which can be found inside the product's Include directory (default C:\Program Files\Active Sound Editor\include).

 

Visual Basic definition

 

Public Type WANALYZER_RULERS_SETTINGS

    nAmplitudeScale as enumVolumeScales

    bVisibleLeft as Boolean

    bTicksLeft as Boolean

    bVisibleRight as Boolean

    bTicksRight as Boolean

    bVisibleTop as Boolean

    bTicksTop as Boolean

    bVisibleBottom as Boolean

    bTicksBottom as Boolean

    colorBackground as OLE_COLOR

    colorTicks as OLE_COLOR

    colorText as OLE_COLOR

    nTopRulerHeightInPix as Integer

    nBottomRulerHeightInPix as Integer

    nVertRulerWidthInPix as Integer

    fTimeTicksFrequencyInPix as Single

End Type

 

This data structure is defined inside the AsoedDef.bas module file which can be found inside the product's Include directory (default C:\Program Files\Active Sound Recorder\include).

 

 

 

Member

Description

 

 

nAmplitudeScale

Scale used for vertical rulers indicating waveform amplitude.

Supported values are the following:

Mnemonic constant

Value

Meaning

SCALE_LINEAR (default)

0

Linear mode

SCALE_LOG

1

Logarithmic mode

bVisibleLeft

Boolean value that specifies if the left amplitude ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display left amplitude ruler

True (default)

Displays left amplitude ruler

bTicksLeft

Boolean value that specifies if the left amplitude ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the left amplitude ruler

True (default)

Displays ticks for the left amplitude ruler

bVisibleRight

Boolean value that specifies if the right amplitude ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display right amplitude ruler

True (default)

Displays right amplitude ruler

bTicksRight

Boolean value that specifies if the right amplitude ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the right amplitude ruler

True (default)

Displays ticks for the right amplitude ruler

bVisibleTop

Boolean value that specifies if the top time ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display top time ruler

True (default)

Displays top time ruler

bTicksTop

Boolean value that specifies if the top time ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the top time ruler

True (default)

Displays ticks for the top time ruler

bVisibleBottom

Boolean value that specifies if the bottom time ruler is visible.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display bottom time ruler

True (default)

Displays bottom time ruler

bTicksBottom

Boolean value that specifies if the bottom time ruler has ticks.

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display ticks for the bottom time ruler

True (default)

Displays ticks for the bottom time ruler

colorBackground

Color used for rendering the rulers background.

colorTicks

Color used for rendering rulers ticks.

colorText

Color used for rendering rulers texts.

nTopRulerHeightInPix

Height of the top time ruler in pixels.

The default value is 16 pixels.

nBottomRulerHeightInPix

Height of the bottom time ruler in pixels.

The default value is 16 pixels.

nVertRulerWidthInPix

Width of vertical amplitude rulers in pixels.

The default value is 41 pixels.

fTimeTicksFrequencyInPix

Frequency of the time ticks in pixels.

The default value is 40 pixels.