Copyright © 2011-2018 MultiMedia Soft

Effects.PitchApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies a Pitch change to the given portion of sound under editing. A pitch change will affect sound pitch or key, without affecting the sound tempo or playback rate so the sound duration won't be altered.

 

During the execution of the editing session the CallbackEditPerc delegate is invoked in order to notify about the percentage of advancement.

 

For further details about callback delegates see the How to synchronize the container application with the API tutorial.

For further details about methods related to the use of special effects refer to the EffectsMan class.

 

 

Syntax

 

[Visual Basic]

Public Function PitchApply (

nStartPosition as Int32,

nEndPosition as Int32,

fPitch as Single

) as enumErrorCodes


 

[C#]

public enumErrorCodes PitchApply (

Int32 nStartPosition,

Int32 nEndPosition,

float fPitch

);


 

[C++]

public: enumErrorCodes PitchApply (

Int32 nStartPosition,

Int32 nEndPosition,

float fPitch

);


 

 

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.

fPitch

Pitch increment/decrement expressed in semitones. Supported values are from -50 to 50.

 

 

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.