Copyright © 2008-2023 MultiMedia Soft

TRACKSBOARD_ITEM_SETTINGS structure

Previous pageReturn to chapter overviewNext page

The TRACKSBOARD_ITEM_SETTINGS structure describes graphical settings applied to sound items rendered over the TracksBoard. Current settings can be retrieved through the TracksBoard.SettingsItemGet method and modified through the TracksBoard.SettingsItemSet 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 colorRect;

     OLE_COLOR colorRectBorder;

     OLE_COLOR colorRectSelected;

     OLE_COLOR colorRectSelectedBorder;

 

         short        bDisplayVolumePoints;

         OLE_COLOR colorVolumePointsLine;

         OLE_COLOR colorVolumePoints;

         OLE_COLOR colorVolumePointsSelected;

         short bAutoApplyVolumeAutomation;

 

         short bDisplayAmplitudeLine;

         OLE_COLOR colorAmplitudeLine;

 

         OLE_COLOR colorTrackerPosition;

         OLE_COLOR colorTrackerVolumePointPos;

 

         long nShowTitleText;

         OLE_COLOR colorTitleText;

         OLE_COLOR colorTitleTextSel;

         OLE_COLOR colorTitleTextBackground;

         OLE_COLOR colorTitleTextBackgroundSel;

} TRACKSBOARD_ITEM_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_ITEM_SETTINGS

    colorRect as OLE_COLOR

    colorRectBorder as OLE_COLOR

    colorRectSelected as OLE_COLOR

    colorRectSelectedBorder as OLE_COLOR

 

         bDisplayVolumePoints as Integer

         colorVolumePointsLine as OLE_COLOR

         colorVolumePoints as OLE_COLOR

         colorVolumePointsSelected as OLE_COLOR

         bAutoApplyVolumeAutomation as Integer

 

         bDisplayAmplitudeLine as Integer

         colorAmplitudeLine as OLE_COLOR

 

         colorTrackerPosition as OLE_COLOR

         colorTrackerVolumePointPos as OLE_COLOR

 

         nShowTitleText as enumTracksBoardTitleModes

         colorTitleText as OLE_COLOR

         colorTitleTextSel as OLE_COLOR

         colorTitleTextBackground as OLE_COLOR

         colorTitleTextBackgroundSel 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

 

 

colorRect

Color used for rendering the rectangle that encloses the waveform of each sound item.

colorRectBorder

Color used for rendering the rectangle that encloses the waveform of each sound item.

colorRectSelected

Color used for rendering the rectangle that encloses the waveform of a selected sound item.

colorRectSelectedBorder

Color used for rendering the border for the rectangle that encloses the waveform of a selected sound item. The selected border can be hidden by setting this value to -1.

bDisplayVolumePoints

Boolean value that specifies if volume points and related connecting lines should be displayed or hidden.

Supported values are the following:

Mnemonic constant

Meaning

False (default)

Volume points are hidden.

True

Volume points are visible.

colorVolumePointsLine

Color used for rendering the line connecting volume points on the selected item. This default setting can be modified on a "per item" basis through the TracksBoard.ItemWaveColorsSet method

colorVolumePoints

Color used for rendering volume points. This default setting can be modified on a "per item" basis through the TracksBoard.ItemWaveColorsSet method

colorVolumePointsSelected

Color used for rendering selected volume points. This default setting can be modified on a "per item" basis through the TracksBoard.ItemWaveColorsSet method

bAutoApplyVolumeAutomation

Boolean value that specifies if volume points, after being changed, should be automatically applied to the sound item.

Supported values are the following:

Mnemonic constant

Meaning

False (default)

Auto-refresh of volume points is disabled: in this case, when needed, volume points will be applied all at once through the TracksBoard.ItemVolumePointsApply method.

True

Auto-refresh of volume points is enabled.

bDisplayAmplitudeLine

Boolean value that specifies if the amplitude line is displayed.

Supported values are the following:

Mnemonic constant

Meaning

False (default)

The amplitude line is hidden.

True

The amplitude line is visible.

colorAmplitudeLine

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

colorTrackerPosition

Color used for rendering the tracker position of a selected item. The tracker position can be hidden by setting this value to -1.

colorTrackerVolumePointPos

Color used for rendering the tracker position of a selected volume point. The tracker position can be hidden by setting this value to -1.

nShowTitleText

Visualization mode of the title containing the friendly name

Supported values are the following:

Mnemonic constant

Value

Meaning

TRACKSBOARD_TITLE_HIDDEN (default)

0

Title text is hidden

TRACKSBOARD_TITLE_TOP

1

Title text is visible on top of the item's rectangle

TRACKSBOARD_TITLE_BOTTOM

2

Title text is visible on bottom of the item's rectangle

colorTitleText

Color used for rendering the title text

colorTitleTextSel

Color used for rendering the title text when the item is selected

colorTitleTextBackground

Color used for rendering the background of the title text

colorTitleTextBackgroundSel

Color used for rendering the background of the title text text when the item is selected