Copyright © 2008-2018 MultiMedia Soft

Effects.CustomDspApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies a custom DSP effect to the given portion of sound under editing.

 

A successful call to this method will fire the SoundEditStarted event followed by a number of SoundEditPerc events and finally by the SoundEditDone event.

 

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 special effects refer to the EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function CustomDspApply (

nStartPosition as Int32,

nEndPosition as Int32,

nIdDsp as Int32,

nUserData as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes CustomDspApply (

Int32 nStartPosition,

Int32 nEndPosition,

Int32 nIdDsp,

Int32 nUserData

);


 

[C++]

public: enumErrorCodes CustomDspApply (

Int32 nStartPosition,

Int32 nEndPosition,

Int32 nIdDsp,

Int32 nUserData

);


 

 

Parameter

Description

 

 

nStartPosition

Start position, expressed in milliseconds, of the affected sound range.

nEndPosition

End position, expressed in milliseconds, of the affected sound range.. If set to -1 the end position will be set to the end of the sound.

nIdDsp

Unique identifier of the custom DSP as returned by the Effects.CustomDspExternalLoad or by the Effects.CustomDspInternalLoad methods

nUserData

User data to pass to the custom DSP

 

 

 

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.