Remarks
Obtains the current 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 or in order to modify the current wheel sensitivity, use the WaveformScroller.MouseWheelSensitivitySet 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]
Public Function MouseWheelSensitivityGet (
hWndWaveformScroller as IntPtr,
ByRef nMsPerWheelMove as Int32,
ByRef nPixelsPerWheelMove as Int32,
ByRef fSampleRateMultiplier as Single
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes MouseWheelSensitivityGet (
IntPtr hWndWaveformScroller,
ref Int32 nMsPerWheelMove,
ref Int32 nPixelsPerWheelMove,
ref float fSampleRateMultiplier
);
|
|
[C++]
public: enumErrorCodes MouseWheelSensitivityGet (
IntPtr hWndWaveformScroller,
Int32 __gc *nMsPerWheelMove,
Int32 __gc *nPixelsPerWheelMove,
float __gc *fSampleRateMultiplier
);
|
|
Parameter
|
Description
|
|
|
hWndWaveformScroller
|
Handle of the control returned by a previous call to the WaveformScroller.Create method
|
nMsPerWheelMove
|
Reference that, on return from the method call, will contain the amount of movement for each mouse wheel movement expressed in milliseconds.
The default value for this setting is 0.
|
nPixelsPerWheelMove
|
Reference that, on return from the method call, will contain the amount of movement for each mouse wheel movement expressed in screen pixels.
The default value for this setting is 0.
|
fSampleRateMultiplier
|
Reference that, on return from the method call, will contain the current sample rate multiplier applied to the sound stream when the mouse wheel is moved.
|
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.
|
|
