TracksBoard.ItemWaveColorsSet method |
|
Remarks
Modifies colors used to render the item's waveform, its amplitude line and its volume points respect to the default set into TRACKSBOARD_WAVEFORM_SETTINGS and TRACKSBOARD_ITEM_SETTINGS data structures. Modified colors can be retrieved through the TracksBoard.ItemWaveColorsGet 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 class section.
Syntax
[Visual Basic] control.TracksBoard.ItemWaveColorsSet ( nUniqueId as Long, colorWaveLineCenter as OLE_COLOR, colorWaveLinePeak as OLE_COLOR, colorVolumePointsLine as OLE_COLOR, colorVolumePoints as OLE_COLOR, colorVolumePointsSelected as OLE_COLOR, colorAmplitudeLine as OLE_COLOR ) as enumErrorCodes |
[C++] short control.TracksBoard.ItemWaveColorsSet ( long nUniqueId, OLE_COLOR colorWaveLineCenter, OLE_COLOR colorWaveLinePeak, OLE_COLOR colorVolumePointsLine, OLE_COLOR colorVolumePoints, OLE_COLOR colorVolumePointsSelected, OLE_COLOR colorAmplitudeLine ); |
Parameter |
Description |
||||||
|
|
||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
|
||||||
colorWaveLineCenter |
The color used for rendering the center of the waveform line; set this value to -1 in order to continue using the default color set into the colorWaveLineCenter field of the TRACKSBOARD_WAVEFORM_SETTINGS data structure |
||||||
colorWaveLinePeak |
The color used for rendering peaks of the waveform line; set this value to -1 in order to continue using the default color set into the colorWaveLinePeak field of the TRACKSBOARD_WAVEFORM_SETTINGS data structure |
||||||
colorVolumePointsLine |
The color used for rendering the line connecting available volume points; set this value to -1 in order to continue using the default color set into the colorVolumePointsLine field of the TRACKSBOARD_ITEM_SETTINGS data structure |
||||||
colorVolumePoints |
The color used for rendering available volume points; set this value to -1 in order to continue using the default color set into the colorVolumePoints field of the TRACKSBOARD_ITEM_SETTINGS data structure |
||||||
colorVolumePointsSelected |
The color used for rendering the selected volume point; set this value to -1 in order to continue using the default color set into the colorVolumePointsSelected field of the TRACKSBOARD_ITEM_SETTINGS data structure |
||||||
colorAmplitudeLine |
The color used for rendering the amplitude line; set this value to -1 in order to continue using the default color set into the colorAmplitudeLine field of the TRACKSBOARD_ITEM_SETTINGS data structure |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred, check the LastError property value in order to get the error code |
enumErrorCodes.ERR_NOERROR (0) |
The method call was successful |