Remarks
Sets the parameters used for mixing a new loaded sound to the actual editing session contents: this feature is very useful if you want to apply a background sound to your editing session. The background sound can be also put in loop for a given range and you can apply a flat volume change to both the new loaded sound and the current sound contents of the editing session.
The call to this method must be performed after a call to the SetMixingPos method.
A mixing session can be performed after setting the loading mode to LOAD_MODE_MIX through a previous call to the SetLoadingMode method.
For details about applying a background sound to your recording session, take a look to the How to apply a background sound to your editing session tutorial
Syntax
[Visual Basic]
Public Function SetMixingParams (
bStopMixOnCompletion as Boolean,
bLoop as Boolean,
fVolumeOriginalSound as Single,
fVolumeNewSound as Single,
nScaleType as enumVolumeScales
) as enumErrorCodes
|
|
[C#]
public enumErrorCodes SetMixingParams (
bool bStopMixOnCompletion,
bool bLoop,
float fVolumeOriginalSound,
float fVolumeNewSound,
enumVolumeScales nScaleType
);
|
|
[C++]
public: enumErrorCodes SetMixingParams (
bool bStopMixOnCompletion,
bool bLoop,
float fVolumeOriginalSound,
float fVolumeNewSound,
enumVolumeScales nScaleType
);
|
|
Parameter
|
Description
|
|
|
bStopMixOnCompletion
|
Boolean value that specifies if the mixing should stop when one between the end of the current song or the final position of a range, selected through the SetMixingPos method, is reached
|
bLoop
|
Boolean value of the looping flag that specifies if the sound mixed to the editing session must be put in loop
|
fVolumeOriginalSound
|
Floating point value representing the volume applied to the current contents of the editing session
|
fVolumeNewSound
|
Floating point value representing the volume applied to the new loaded song that will be mixed to the current editing session contents
|
nScaleType
|
The volume scaling type.
Supported values are the following:
Mnemonic constant
|
Value
|
Meaning
|
SCALE_LINEAR
|
0
|
The passed volume is based upon a linear scale and can be in the range from 0.0 (silence) to 100.0 (max volume)
|
SCALE_LOG
|
1
|
The passed 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.ERR_NOERROR (0)
|
The method call was successful.
|
|
