Copyright © 2011-2019 MultiMedia Soft

Effects.PlayerSettingsApply method

Previous pageReturn to chapter overviewNext page

Remarks

 

Applies, in one single shot, to the sound under editing all of the following audio settings previously applied to a specific audio player instanced by the Audio DJ Studio API for .NET component:

 

•Volume level
•Balance
•Preamplifier
•Equalization
•DMO (DirectX Media Object) effects
•Chorus, Compressor, Distortion, Echo, Phaser, Reverb, Auto Wah and Dynamic amplifier effects
•Internal and External Custom DSP effects
•Commercial and freeware VST effects
•Audio channels remapping
•Tempo change
•Playback rate change
•Pitch change
•IIR and FIR filters
•Vocal removal filter
•Bass boost

 

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

 

 

Syntax

 

[Visual Basic]

Public Function PlayerSettingsApply (

nStartPosition as Int32,

nEndPosition as Int32,

nPlayerHandle as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes PlayerSettingsApply (

Int32 nStartPosition,

Int32 nEndPosition,

Int32 nPlayerHandle

);


 

[C++]

public: enumErrorCodes PlayerSettingsApply (

Int32 nStartPosition,

Int32 nEndPosition,

Int32 nPlayerHandle

);


 

 

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.

nPlayerHandle

Handle of the audio player, containing needed settings to apply, returned by the GetPlayerHandle method of the Audio DJ Studio API for .NET component.

 

 

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.