Remarks
Sets the sensitivity of the internal mouse wheel management for scrolling the waveform.
By default the mouse wheel management of the waveform scroller is disabled: in order to enable the mouse wheel management set a valid value, higher than 0, into one of the available parameters.
The value of the current mouse wheel sensitivity and its enabled state can be obtained through the WaveformScroller.MouseWheelSensitivityGet 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.MouseWheelSensitivitySet (
hWndWaveformScroller as OLE_HANDLE,
nMsPerWheelMove as Long,
nPixelsPerWheelMove as Long,
fSampleRateMultiplier as Single
) as enumErrorCodes
|
|
[C++]
short control.WaveformScroller.MouseWheelSensitivitySet (
OLE_HANDLE hWndWaveformScroller,
long nMsPerWheelMove,
long nPixelsPerWheelMove,
float fSampleRateMultiplier
);
|
|
Parameter
|
Description
|
|
|
hWndWaveformScroller
|
Handle of the control returned by a previous call to the WaveformScroller.Create method
|
nMsPerWheelMove
|
The amount of movement for each mouse wheel movement expressed in milliseconds.
The default value for this setting is 0.
If this parameter is set to 0, the parameter is ignored and value inside the nPixelsPerWheelMove parameter will be considered for setting the sensitivity.
Accepted values for this parameter can range from 10 to 10000: values outside of this range will be automatically capped to the nearest valid value.
|
nPixelsPerWheelMove
|
The amount of movement for each mouse wheel movement expressed in screen pixels.
The default value for this setting is 0.
If both this parameter and the nMsPerWheelMove parameter are set to 0, the mouse wheel management is disabled.
Accepted values for this parameter can range from 1 to 100: values outside of this range, with the exception of value 0 that can be used for disabling the internal mouse wheel management, will be automatically capped to the nearest valid value.
|
fSampleRateMultiplier
|
The sample rate multiplier applied to the sound stream when the mouse wheel is moved.
This value can range from 0.1 (meaning that the sound stream will be played at 10% of its normal speed, 10 times slower) up to 20.0 (meaning that the sound stream will be played at 2000% of its normal speed, 20 times faster).
Values outside of the mentioned range will be automatically capped to the nearest valid value.
A value of 1.0 will play the sound stream at its original sample rate.
|
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
|
|
