Copyright © 2008-2023 MultiMedia Soft

TRACKSBOARD_GENERAL_SETTINGS structure

Previous pageReturn to chapter overviewNext page

The TRACKSBOARD_GENERAL_SETTINGS structure describes the general settings applied to the TracksBoard. The current settings can be retrieved through the TracksBoard.SettingsGeneralGet method and modified through the TracksBoard.SettingsGeneralSet 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

{

         short bAppearance3d;

         float fHorizontalZoomFactor;

         float fVerticalZoomFactor;

         short nPlayHeadLineWidth;

         long nPlayHeadLineDashStyle;

         OLE_COLOR colorPlayHeadLine;

         long nPlayHeadLineHighCap;

         long nPlayHeadLineLowCap;

         long nPlayHeadLineDashCap;

         short nPlayHeadLineTranspFactor;

         short bItemAutoRefresh;

         short bItemsMoveEnabled;

} TRACKSBOARD_GENERAL_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_GENERAL_SETTINGS

         bAppearance3d as Boolean

         fHorizontalZoomFactor as Single

         fVerticalZoomFactor as Single

         nPlayHeadLineWidth as Integer

         nPlayHeadLineDashStyle as enumWaveformLineDashStyles

         colorPlayHeadLine as OLE_COLOR

         nPlayHeadLineHighCap as enumLineCaps

         nPlayHeadLineLowCap as enumLineCaps

         nPlayHeadLineDashCap as enumLineDashCaps

         nPlayHeadLineTranspFactor as Integer

         bItemAutoRefresh as Boolean

         bItemsMoveEnabled as Boolean

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

 

 

bAppearance3d

Boolean value that specifies if the Waveform Analyzer is displayed with 3D borders.

asrec_i00007c

Supported values are the following:

Mnemonic constant

Meaning

False

Doesn't display 3D borders

True

Displays 3D borders

fHorizontalZoomFactor

Floating point value indicating the factor applied to horizontal zooming operations: by default the zoom factor is 2.0.

The value of this field cannot be lower than 1.01. Lower values will be automatically capped to 1.01.

fVerticalZoomFactor

Floating point value indicating the factor applied to vertical zooming operations: by default the zoom factor is 2.0.

The value of this field cannot be lower than 1.01. Lower values will be automatically capped to 1.01.

nPlayHeadLineWidth

Width in pixels of the play head line.

nPlayHeadLineDashStyle

Dash style of the play head line

Supported values are the following:

Mnemonic constant

Value

Meaning

LINE_DASH_STYLE_SOLID

0

Solid line.

LINE_DASH_STYLE_DASH

1

Dashed line.

LINE_DASH_STYLE_DOT

2

Dotted line.

LINE_DASH_STYLE_DASH_DOT

3

Alternating dash-dot line line.

LINE_DASH_STYLE_DASH_DOT_DOT

4

Alternating dash-dot-dot line line.

 

On the screenshot below you can see the different dash styles with the corresponding value displayed:

 

colorPlayHeadLine

Color used for rendering the play head line.

nPlayHeadLineHighCap

Type of high cap for the play head line.

Supported values are the following:

Mnemonic constant

Value

Meaning

LINE_CAP_SQUARE

0

Specifies a square cap.

LINE_CAP_ROUND

1

Specifies a circular cap.

LINE_CAP_TRIANGLE

2

Specifies a triangular cap.

LINE_CAP_SQUARE_ANCHOR

3

Specifies that the line ends are anchored with a square.

LINE_CAP_ROUND_ANCHOR

4

Specifies that the line ends are anchored with a circle.

LINE_CAP_DIAMOND_ANCHOR

5

Specifies that the line ends are anchored with a diamond.

LINE_CAP_ARROW_ANCHOR

6

Specifies that the line ends are anchored with arrowheads.

 

On the screenshot below you can see the different types of line caps with the corresponding value displayed:

 

nPlayHeadLineLowCap

Type of low cap for the play head line.

Supported values are the same as seen for the nPositionLineHighCap field above.

nPlayHeadLineDashCap

Type of dash/dot cap for the play head line.

Supported values are the following:

Mnemonic constant

Value

Meaning

LINE_DASH_CAP_FLAT

0

Specifies a square cap that squares off both ends of each dash.

LINE_DASH_CAP_ROUND

1

Specifies a circular cap that rounds off both ends of each dash.

LINE_DASH_CAP_TRIANGLE

2

Specifies a triangular cap that points both ends of each dash.

 

On the screenshot below you can see the different types of line dash caps with the corresponding value displayed:

 

nPlayHeadLineTranspFactor

Transparent factor applied to the play head line.

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.

bItemAutoRefresh

Boolean value that specifies if the sound item is automatically refreshed during the analysis phase.

Supported values are the following:

Mnemonic constant

Meaning

False (default)

Auto-refresh is disabled.

True

Auto-refresh is enabled.

bItemsMoveEnabled

Boolean value that specifies if selected items can be moved or resized through the mouse.

Supported values are the following:

Mnemonic constant

Meaning

False

Move and resize are disabled.

True (default)

Move and resized are enabled.