Copyright © 2006-2018 MultiMedia Soft

WaveformScroller.PlaybackOnScrollInfoGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains information about playback's support during the manual scroll of the waveform through the mouse.

Current settings can be modified through the WaveformScroller.PlaybackOnScrollEnable method.

 

For further details about methods of the Waveform scroller refer to the WaveformScroller object.

For a tutorial about the use of Waveform scrollers refer to the How to scroll the sound's waveform during playback tutorial.

 

 

Syntax

 

[Visual Basic]

control.WaveformScroller.PlaybackOnScrollInfoGet (

hWndWaveformScroller as OLE_HANDLE,

bEnable as enumBoolean,

nScrollSensitivity as Long

) as enumErrorCodes


 

[C++]

short control.WaveformScroller.PlaybackOnScrollInfoGet (

OLE_HANDLE hWndWaveformScroller,

short *bEnable,

long *nScrollSensitivity

);


 

 

Parameter

Description

 

 

hWndWaveformScroller

Handle of the control returned by a previous call to the WaveformScroller.Create method

bEnable

Reference that, on return from the method call, will contain the boolean value that specifies if playback is enabled or disabled.

Supported values are the following:

Value

Meaning

BOOL_FALSE (default)

Playback is disabled

BOOL_TRUE

Playback is enabled

nScrollSensitivity

Reference that, on return from the method call, will contain the scroll sensitivity expressed in percentage.

Default value is 100, meaning that audio data will be played at the same rate of the waveform scrolling during mouse movement: values lower than 100 will decrease the speed of playback while values higher than 100 will increase the speed of playback.

 

 

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