Methods > Init and info > SoundActivationSystemGet method

Remarks

Obtains information about the Sound Activation System during a recording session. The Sound Activation System can be enabled/disabled through the SoundActivationSystemSet method.

For further details see the How the Sound Activation System works tutorial.

Syntax

[Visual Basic]

control.SoundActivationSystemGet (

nMode as enumSoundActivationSystemModes,

nSilenceThreshold as Integer,

nSilenceMinLength as Long

) as enumErrorCodes

[C++]

short control.SoundActivationSystemGet (

short *nMode,

short *nSilenceThreshold,

long *nSilenceMinLength

);

Parameter

Description

nMode

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

Supported values are the following:

Mnemonic constant	Value	Meaning
SOUND_ACTIVATION_SYSTEM_DISABLED	0	The Sound Activation System is disabled
SOUND_ACTIVATION_SYSTEM_DISCARD_SILENCE	1	The Sound Activation System is enabled and silence will be discarded
SOUND_ACTIVATION_SYSTEM_KEEP_SILENCE	2	The Sound Activation System is enabled but silence is not discarded: this mode is not supported when recording from sound files through the StartFromFile method.

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.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to see the error code meaning
enumErrorCodes.ERR_NOERROR (0)	The method call was successful.