Copyright © 2005-2011 MultiMedia Soft

DetectSoundSilence method

Previous pageReturn to chapter overviewNext page

Remarks

 

Performs the calculation of silent portions at the start and end of the sound loaded inside the given player: useful when the automatic silence detection has been disabled through a call to the SetAutomaticSilenceDetection method.

 

Differently from the RequestSoundSilenceDetection method, where silence detection is performed inside a secondary thread, in this case silence detection is performed inside the main thread so, when the method returns, silence positions are immediately available and there is no need to wait for the SilencePositionAvailable event.

 

This method doesn't work with sounds with more than 2 channels (5.1 or 7.1) or if the EnableMixingFeatures property has been set to false.

 

 

Syntax

 

[Visual Basic]

Public Function DetectSoundSilence (

nPlayerIndex as Int16,

nThresholdInitial as Int32,

nThresholdFinal as Int32,

ByRef nInitialPosition as Int32,

ByRef nFinalPosition as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes DetectSoundSilence (

Int16 nPlayerIndex,

Int32 nThresholdInitial,

Int32 nThresholdFinal,

ref Int32 nInitialPosition,

ref Int32 nFinalPosition

);


 

[C++]

public: enumErrorCodes DetectSoundSilence (

Int16 nPlayerIndex,

Int32 nThresholdInitial,

Int32 nThresholdFinal,

Int32 __gc *nInitialPosition,

Int32 __gc *nFinalPosition

 

);


 

 

Parameter

Description

 

 

nPlayer

Number representing the zero-based index of the involved player

nThresholdInitial

Number representing the silence threshold at the start of the loaded sound: can assume values from 0 (no sound) to 32767 (max volume).

nThresholdFinal

Number representing the silence threshold at the end of the loaded sound: can assume values from 0 (no sound) to 32767 (max volume).

nInitialPosition

Reference that, on return from the method call, will contain the detected position, expressed in milliseconds, where audible sound begins

nFinalPosition

Reference that, on return from the method call, will contain the detected position, expressed in milliseconds, where audible sound ends

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.NOERROR (0

The method call was successful.