Copyright © 2005-2018 MultiMedia Soft

Waveform.BitmapViewVerticalLineAdd method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds a new vertical line that will be displayed when rendering the waveform's graphics through the Waveform.BitmapViewDrawToHdc method. This line can be removed at any time by using the Waveform.BitmapViewVerticalLineRemove method.

 

For further details about generating a waveform bitmap of the loaded sound, before starting its playback, refer to the How to obtain the sound's waveform tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function BitmapViewVerticalLineAdd (

nUniqueId as Int16,

nPosition as Int32,

color as Color,

nMode as enumWaveformLineModes,

nWidth as Int16

) as enumErrorCodes


 

[C#]

public enumErrorCodes BitmapViewVerticalLineAdd (

Int16 nUniqueId,

Int32 nPosition,

Color color,

enumWaveformLineModes nMode,

Int16 nWidth

);


 

[C++]

public: enumErrorCodes BitmapViewVerticalLineAdd (

Int16 nUniqueId,

Int32 nPosition,

Color color,

enumWaveformLineModes nMode,

Int16 nWidth

);


 

 

Parameter

Description

 

 

nUniqueId

Unique identification number assigned to this new line.

nPosition

Initial position expressed in milliseconds

color

Color of the line

nMode

Line mode used for rendering the line.

Supported values are the following:

Mnemonic constant

Numeric value

Meaning

LINE_MODE_DOTTED

0

Dotted line (applied only if the nWidth parameter below is set to 1)

LINE_MODE_DASHED

1

Dashed line (applied only if the nWidth parameter below is set to 1)

LINE_MODE_SOLID

2

Solid line

nWidth

Width of the line expressed in pixels. In case the parameter should be set to a value higher than 1, the nMode parameter above would be automatically set to LINE_MODE_SOLID.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0)

The method call was successful.