Copyright © 2008-2023 MultiMedia Soft

TRACKSBOARD_WAVEFORM_SETTINGS structure

Previous pageReturn to chapter overviewNext page

The TRACKSBOARD_WAVEFORM_SETTINGS structure describes settings applied while rendering waveforms of items added to the TracksBoard. The current settings can be retrieved through the   TracksBoard.SettingsWaveGet method and modified through the TracksBoard.SettingsWaveSet method.

 

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard object section.

 

Visual C++ definition

 

typedef struct

{

     OLE_COLOR colorWaveBackground;

     OLE_COLOR colorWaveLinePeak;

     OLE_COLOR colorWaveLineCenter;

     OLE_COLOR colorWaveMuted;

     OLE_COLOR colorVolumeLine;

     OLE_COLOR colorTimeLine;

 

       OLE_COLOR colorLockedTrackForeground;

       OLE_COLOR colorLockedTrackBackground;

       short nLockedColorTranspFactor;

 

     short nWaveLineIntensityFactor;

     short bUseHalfColorsForPeaks;

     short bDrawLinesOverWave;

 

     long nViewMode;

} TRACKSBOARD_WAVEFORM_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 TRACKSBOARD_WAVEFORM_SETTINGS

    colorWaveBackground as OLE_COLOR

    colorWaveLinePeak as OLE_COLOR

    colorWaveLineCenter as OLE_COLOR

    colorWaveMuted as OLE_COLOR

    colorVolumeLine as OLE_COLOR

    colorTimeLine as OLE_COLOR

 

    colorLockedTrackForeground as OLE_COLOR

    colorLockedTrackBackground as OLE_COLOR

    nLockedColorTranspFactor as Integer

 

    nWaveLineIntensityFactor as Integer

    bUseHalfColorsForPeaks as Boolean

    bDrawLinesOverWave as Boolean

 

    nViewMode as enumTracksBoardViewModes

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

 

 

colorWaveBackground

Color used for rendering the waveform background.

colorWaveLinePeak

Color used for rendering peaks of the waveform line. This default setting can be modified on a "per item" basis through the TracksBoard.ItemWaveColorsSet method

colorWaveLineCenter

Color used for rendering the center of the waveform line. This default setting can be modified on a "per item" basis through the TracksBoard.ItemWaveColorsSet method

colorWaveMuted

Color used for rendering the waveform when in muted state

colorVolumeLine

Color used for rendering volume lines. Volume lines can be hidden by setting this value to -1.

colorTimeLine

Color used for rendering time lines. Time lines can be hidden by setting this value to -1.

colorLockedTrackForeground

Foreground color used for rendering the hatched brush on a locked track

colorLockedTrackBackground

Background color used for rendering the hatched brush on a locked track

nLockedColorTranspFactor

Transparency applied to colors of the hatched brush (colorLockedTrackForeground and colorLockedTrackBackground) on a locked track.

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.

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):

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

bDrawLinesOverWave

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

Supported values are the following:

Mnemonic constant

Meaning

False (default)

Time and amplitude lines are displayed under the waveform

True

Time and amplitude lines are displayed over the waveform

nViewMode

The current visualization mode for waveforms on the TracksBoard,

Supported values are the following:

Mnemonic constant

Value

Meaning

TRACKSBOARD_VIEW_MODE_WAVEFORM

0

Normal waveform view

TRACKSBOARD_VIEW_MODE_WAVEFORM_ABS

1

Waveform view with absolute values