TracksBoard.ItemWaveColorsGet method |
|
Remarks
If previously modified through the TracksBoard.ItemWaveColorsSet method, obtains colors used to render the item's waveform, its amplitude line and its volume points.
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.ItemWaveColorsGet ( nUniqueId as Long, ByRef colorWaveLineCenter as Color, ByRef colorWaveLinePeak as Color, ByRef colorVolumePointsLine as Color, ByRef colorVolumePoints as Color, ByRef colorVolumePointsSelected as Color, ByRef colorAmplitudeLine as Color ) as enumErrorCodes |
[#] public enumErrorCodes ItemWaveColorsGet ( long nUniqueId, ref Color colorWaveLineCenter, ref Color colorWaveLinePeak, ref Color colorVolumePointsLine, ref Color colorVolumePoints, ref Color colorVolumePointsSelected, ref Color colorAmplitudeLine ); |
[C++] public: enumErrorCodes ItemWaveColorsGet ( long nUniqueId, Color _gc *colorWaveLineCenter, Color _gc *colorWaveLinePeak, Color _gc *colorVolumePointsLine, Color _gc *colorVolumePoints, Color _gc *colorVolumePointsSelected, Color _gc *colorAmplitudeLine ); |
Parameter |
Description |
||||||
|
|
||||||
nUniqueId |
Unique identification number assigned to the sound item after being generated by one of the following methods:
|
||||||
colorWaveLineCenter |
Reference that, on return from the method call, will contain the color used for rendering the center of the waveform line; a returned value Color.Empty means that this color has not been modified through a previous call to the TracksBoard.ItemWaveColorsSet method and that the rendering is performed through the default color set into the colorWaveLineCenter field of the TRACKSBOARD_WAVEFORM_SETTINGS data structure |
||||||
colorWaveLinePeak |
Reference that, on return from the method call, will contain the color used for rendering peaks of the waveform line; a returned value Color.Empty means that this color has not been modified through a previous call to the TracksBoard.ItemWaveColorsSet method and that the rendering is performed through the default color set into the colorWaveLinePeak field of the TRACKSBOARD_WAVEFORM_SETTINGS data structure |
||||||
colorVolumePointsLine |
Reference that, on return from the method call, will contain the color used for rendering the line connecting available volume points; a returned value Color.Empty means that this color has not been modified through a previous call to the TracksBoard.ItemWaveColorsSet method and that the rendering is performed through the default color set into the colorVolumePointsLine field of the TRACKSBOARD_ITEM_SETTINGS data structure |
||||||
colorVolumePoints |
Reference that, on return from the method call, will contain the color used for rendering available volume points; a returned value Color.Empty means that this color has not been modified through a previous call to the TracksBoard.ItemWaveColorsSet method and that the rendering is performed through the default color set into the colorVolumePoints field of the TRACKSBOARD_ITEM_SETTINGS data structure |
||||||
colorVolumePointsSelected |
Reference that, on return from the method call, will contain the color used for rendering the selected volume point; a returned value Color.Empty means that this color has not been modified through a previous call to the TracksBoard.ItemWaveColorsSet method and that the rendering is performed through the default color set into the colorVolumePointsSelected field of the TRACKSBOARD_ITEM_SETTINGS data structure |
||||||
colorAmplitudeLine |
Reference that, on return from the method call, will contain the color used for rendering the amplitude line; a returned value Color.Empty means that this color has not been modified through a previous call to the TracksBoard.ItemWaveColorsSet method and that the rendering is performed through 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 |