Classes > FaderObject class > Methods > Fader.FadeInTargetVolumeSet method

Remarks

Sets the volume target level applied to player fading-in. The current target level can be obtained through the Fader.FadeInTargetVolumeGet method.

For details about using the Automatic Fader refer to the How to use the Automatic Fader section.

Syntax

[Visual Basic]

Public Function FadeInTargetVolumeSet (

fTargetVolume as Single,

[C#]

public enumErrorCodes FadeInTargetVolumeSet (

float fTargetVolume,

);

[C++]

public: enumErrorCodes FadeInTargetVolumeSet (

float fTargetVolume,

);

Parameter

Description

fTargetVolume

Number representing the volume target level (the meaning of the passed value depends upon the nScaleType parameter).

nScaleType

The volume scaling type.

Supported values are the following:

Mnemonic constant

Value

Meaning

SCALE_LINEAR

The returned volume is based upon a linear scale and can be in the range from 0.0 (silence) to 100.0 (max volume)

SCALE_LOG

The returned volume, expressed in dB, is based upon a logarithmic scale and can be in the range from -100 (silence) to 0 (max volume)

The actual applied formula for converting a linear volume into a logarithmic volume is the following:

VolumeInDB = 20 * log10 (VolumeLinear/100)

The C syntax for converting a logarithmic volume into a linear volume is the following:

VolumeLinear = 100 * pow (10, VolumeInDB/20);

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.