Classes > SoundComposerMan class > Methods > SoundComposer.ItemSoundFileVolumeFadingSet method

Remarks

Predisposes parameters of the requested volume fading that will be applied to the given sound file item when it will be merged into the session's stream. Current parameters of a specific volume fading can be obtained through the SoundComposer.ItemSoundFileVolumeFadingGet method.

A specific volume fading can be removed through the SoundComposer.ItemSoundFileVolumeFadingRemove method.

The volume fading implemented by this method applies to the beginning (fade-in) or to the end (fade-out) of the sound file's audio stream. If you should need to add one or more linear volume sliding at specific positions of the sound file item, use the SoundComposer.ItemSoundFileVolumeSlidingAdd method.

For further details about sound composing see the the SoundComposerMan class and the How to compose a sound tutorial.

Syntax

[Visual Basic]

Public Function ItemSoundFileVolumeFadingSet (

nUniqueId as Int32,

bFadeIn as Boolean,

nFadeLengthMs as Int32,

nCurveType as enumVolumeCurves,

nLeftX as Int32,

nLeftY as Int32,

nRightX as Int32,

nRightY as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes ItemSoundFileVolumeFadingSet (

Int32 nUniqueId,

bool bFadeIn,

Int32 nFadeLengthMs,

enumVolumeCurves nCurveType,

Int32 nLeftX,

Int32 nLeftY,

Int32 nRightX,

Int32 nRightY

);

[C++]

public: enumErrorCodes ItemSoundFileVolumeFadingSet (

Int32 nUniqueId,

bool bFadeIn,

Int32 nFadeLengthMs,

enumVolumeCurves nCurveType,

Int32 nLeftX,

Int32 nLeftY,

Int32 nRightX,

Int32 nRightY

);

Parameter

Description

nUniqueId

The unique identifier of the sound file item previously returned by the call to one of the following methods: SoundComposer.ItemSoundFileAdd, SoundComposer.ItemSoundFileMemoryAdd, SoundComposer.ItemSoundFileRawAdd, SoundComposer.ItemSoundFileMemoryRawAdd, SoundComposer.ItemSoundFileFromEditorAdd, or SoundComposer.ItemSoundFileFromRecorderAdd.

bFadeIn

Boolean value specifying if the fading is a fade-in or a fade-out.

Supported values are the following:

Mnemonic Value	Meaning
false	This is a fade-out
true	This is a fade-in

nFadeLengthMs

Length of the fade expressed in milliseconds

nCurveType

Type of curve applied to perform the volume fading..

Supported values are the following:

Mnemonic constant	Value	Meaning

VOLUME_CURVE_NONE	0	No curve is applied: volume will be changed immediately and will be kept till next volume point.
VOLUME_CURVE_LINEAR	1	Linear curve
VOLUME_CURVE_EXPONENTIAL	2	Exponential curve
VOLUME_CURVE_COSINE	3	Cosine curve
VOLUME_CURVE_SMOOTH	4	Smooth curve
VOLUME_CURVE_CUSTOM	5	Custom Bézier curve. 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.

nLeftX

Horizontal position, expressed in percentage, of the left control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

nLeftY

Vertical position, expressed in percentage, of the left control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

nRightX

Horizontal position, expressed in percentage, of the right control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

nRightY

Vertical position, expressed in percentage, of the right control point of the Bézier curve.

This parameter is ignored when the nCurveType parameter is set to a value different from VOLUME_CURVE_CUSTOM.

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.