[Visual Basic]

Public Function SoundActivationSystemGet (

ByRef nMode as enumSoundActivationSystemModes,

ByRef nSilenceThreshold as Int16,

ByRef nSilenceMinLength as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes SoundActivationSystemGet (

ref enumSoundActivationSystemModes nMode,

ref Int16 nSilenceThreshold,

ref Int32 nSilenceMinLength

);

[C++]

public: enumErrorCodes SoundActivationSystemGet (

enumSoundActivationSystemModes __gc *nMode,

Int16 __gc *nSilenceThreshold,

Int32 __gc *nSilenceMinLength

);

Parameter

Description

nMode

Reference that, on return from the method call, will contain the Sound Activation System mode.

Supported values are the following:

nSilenceThreshold

Reference that, on return from the method call, will contain the threshold for the Sound Activation System.

Supported values are in the range from 0  (Sound Activation System disabled, same as setting nMode parameter to SOUND_ACTIVATION_SYSTEM_DISABLED) to 32767 (sound recording always enabled).

If for example you should set a value of 800, any incoming sound having a volume level lower than 800 would be considered as silent and would be discarded.

In case you should need to set a threshold value expressed in dB, before setting this parameter you could convert the value in dB into a linear value through the following formula (C syntax):

ValueLinear = 32767 * pow (10, ValueInDB/20);

nSilenceMinLength

Reference that, on return from the method call, will contain the minimal length of silence for the Sound Activation System. This property's value is expressed in milliseconds with default value 0.

Value

Meaning

Negative value

An error occurred. Check the LastError property value in order to see the last error.

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.