Copyright © 2005-2018 MultiMedia Soft

CustomDSP.UseFloatSamples method

Previous pageReturn to chapter overviewNext page

Remarks

 

Tells to the component to pass floating point samples to DSP callbacks instead of 8 or 16 bits samples.

 

For further details about methods related to the use of custom DSP effects refer to the CustomDSPs class.

Further information about the use of Custom DSP effects can be found inside the How to manage custom DSP effects tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function UseFloatSamples (

bUseFloatSamples as Boolean

) as enumErrorCodes


 

[C#]

public enumErrorCodes UseFloatSamples (

bool bUseFloatSamples

);


 

[C++]

public: enumErrorCodes UseFloatSamples (

bool bUseFloatSamples

);


 

 

Parameter

Description

 

 

bUseFloatSamples

Boolean value that specifies if the callback function needs to receive floating samples.

Supported values are the following:

Value

Meaning

false (default)

The callback function will receive original 8 or 16 bits samples

true

The callback function will receive samples converted to floating point values.

The use of this setting and of floating point DSPs is mandatory when an embedded filter (activated through the FilterApply method) or the normalization filter (activated through the NormalizationEnable method) are enabled.

 

 

 

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.