Callback delegates > CallbackPercentage delegate

Remarks

Callback delegate invoked from a secondary thread in order to notify the percentage of advancement for a set of lengthy operations (loading, exporting, waveform analysis, etc.): this callback can be set through a call to the CallbackPercentageSet method.

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

Syntax

[Visual Basic]

Public Delegate Sub CallbackPercentage (

nOperation as enumOperationsWithPercentage,

nPercentage as Int16

)

[C#]

public delegate void CallbackPercentage (

enumOperationsWithPercentage nOperation,

Int16 nPercentage

)

[C++]

public delegate void CallbackPercentage (

enumOperationsWithPercentage nOperation,

Int16 nPercentage

)

Parameter

Description

nOperation

Identifier of the operation raising the notification.

Supported values are the following:

Mnemonic Value	Value	Meaning
OPERATION_WAVE_ANALYSIS	0	The operation is a waveform analysis started through the WaveformAnalyzer.AnalyzeFullSound method.
OPERATION_SOUND_UPLOAD_PERC	1	The operation is a sound file upload session started through the RequestUploadSessionToFTP or RequestUploadFileToFTP methods.
OPERATION_SOUND_LOADING	2	The operation is a sound loading started through one of the following methods: LoadSound LoadSoundEncrypted LoadSoundFromClipboard LoadSoundFromEditingSession LoadSoundFromMemory LoadSoundFromRawFile LoadSoundFromRawMemory LoadSoundFromRecordingSession The operation may be also the loading of a TracksBoard session started through the TracksBoard.Load method.
OPERATION_SOUND_EXPORT	3	The operation is a sound export session started through the ExportToFile method.
OPERATION_SILENCE_DETECTION	4	The operation is a silence detection session started through the SilencePositionsDetect method.
OPERATION_APPEND_AUTOM_TOTAL	5	The operation is an append automation session started through a call to the AppendAutomationExecute method to notify about the overall percentage of advancement; for single files being appended the involved callback is the CallbackAppendAutomationFilePerc delegate.
OPERATION_MIX_AUTOM	6	The operation is a mixing automation session started through the MixAutomationExecute method.
OPERATION_AUDIO_EXTRACT	7	The operation is an extraction of the audio track from a video clip started through the ExtractAudioFromVideoFile method.
OPERATION_JOIN_SOUNDS	8	The operation is a joining of two mono sounds started through the JoinFilesFromDisk method.
OPERATION_SOUND_COMPOSER	9	The operation is a sound composer session started through a call to the SoundComposer.SessionComposeItems method
OPERATION_SPECTRAL_ANALYSIS	10	The operation is a spectral analysis
OPERATION_ZIP	11	The operation is related to ZIP files management
OPERATION_TRACKS_DETECTION	12	The operation is related to audible tracks detection

nPercentage

Number representing the percentage of advancement for the given operation.