Copyright © 2006-2018 MultiMedia Soft

CustomDSP.Enable method

Previous pageReturn to chapter overviewNext page

Remarks

 

Enables/disables the given DSP effect.

 

For further details about managing a custom DSP effect refer to the How to manage custom DSP effects section.

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

 

 

Syntax

 

[Visual Basic]

Public Function Enable (

nIdDsp as Int32,

bEnable as Boolean,

nUserData as Int32,

nPriority as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes Enable (

Int32 nIdDsp,

bool bEnable,

Int32 nUserData,

Int32 nPriority

);


 

[C++]

public: enumErrorCodes Enable (

Int32 nIdDsp,

bool bEnable,

Int32 nUserData,

Int32 nPriority

);


 

 

Parameter

Description

 

 

nIdDsp

Unique identifier of the custom DSP

bEnable

Boolean flag that specifies if the custom DSP must be enabled or disabled.

Supported values are the following:

Value

Meaning

false

Disable the custom DSP effect

true

Enable the custom DSP effect

nUserData

User data to pass to the custom DSP

nPriority

DSP priority

 

 

 

 

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.