|
StreamVolumeSmoothingSetEx method |
  
|
|
StreamVolumeSmoothingSetEx method |
|
Remarks
Sets the smoothing times, expressed in milliseconds, and related volume curve required to perform a fade-in after a PlaySound call or a fade-out after a StopSound call.
During the fading session the CallbackForPlayersEvents delegate is invoked with the nEvent parameter set to the following values:
| • | EV_FADEIN_STARTED, EV_FADING_VOLUME_CHANGED and EV_FADEIN_COMPLETED after a call to the PlaySound method |
| • | EV_FADEOUT_STARTED, EV_FADING_VOLUME_CHANGED and EV_FADEOUT_COMPLETED after a call to the StopSound method |
Syntax
[Visual Basic] Public Function StreamVolumeSmoothingSetEx ( nPlayerIndex as Int16, bfadeIn as Boolean, nSlideDuration as Int32, nCurveType as enumVolumeCurves, nLeftX as Int16, nLeftY as Int16, nRightX as Int16, nRightY as Int16 ) as enumErrorCodes |
[C#] public enumErrorCodes StreamVolumeSmoothingSetEx ( Int16 nPlayerIndex, bool bfadeIn, Int32 nSlideDuration, enumVolumeCurves nCurveType, Int16 nLeftX, Int16 nLeftY, Int16 nRightX, Int16 nRightY ); |
[C++] public: enumErrorCodes StreamVolumeSmoothingSetEx ( Int16 nPlayerIndex, bool bfadeIn, Int32 nSlideDuration, enumVolumeCurves nCurveType, Int16 nLeftX, Int16 nLeftY, Int16 nRightX, Int16 nRightY ); |
Parameter |
Description |
|||||||||||||||||||||
|
|
|||||||||||||||||||||
nPlayerIndex |
Number representing the zero-based index of the involved player |
|||||||||||||||||||||
bfadeIn |
Boolean value indicating if the smoothing, obtained through a volume sliding. must be applied on start or stop of playback. Supported values are the following: |
|||||||||||||||||||||
nSlideDuration |
The time required to perform the volume sliding after a call to the PlaySound or StopSound method. Accepted values are from 0 (default value, no sliding, immediate play or stop) to 20000: higher or lower values will be automatically cut to the nearest supported value. |
|||||||||||||||||||||
nCurveType |
Type of curve applied to the volume sliding. Supported values are the following:
|
|||||||||||||||||||||
nLeftX |
The horizontal position, expressed in percentage of the custom curve designer's area, of the left control point (*). This parameter is ignored if the nScaleType parameter above has been set to a value different from VOLUME_CURVE_CUSTOM. |
|||||||||||||||||||||
nLeftY |
The vertical position, expressed in percentage of the custom curve designer's area, of the left control point (*). This parameter is ignored if the nScaleType parameter above has been set to a value different from VOLUME_CURVE_CUSTOM. |
|||||||||||||||||||||
nRightX |
The horizontal position, expressed in percentage of the custom curve designer's area, of the right control point (*). This parameter is ignored if the nScaleType parameter above has been set to a value different from VOLUME_CURVE_CUSTOM. |
|||||||||||||||||||||
nRightY |
The vertical position, expressed in percentage of the custom curve designer's area, of the right control point (*). This parameter is ignored if the nScaleType parameter above has been set to a value different from VOLUME_CURVE_CUSTOM. |
(*) The custom curve designer manages a windowed control, whose visual aspect can be defined programmatically, which allows designing volume curves based upon Bézier curves whose shape is defined through the manual positioning of 2 control points (displayed in cyan color on the graphic below). For further information about the use of the embedded CurveDesigner refer to the tutorial How to create custom volume curves.
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. |
