nn::mic::CTR::SetClamp Function

Syntax

Result SetClamp(
     bool enable
);

Arguments

Name Description
in enable When true, clamping is enabled. (The default is true.)

Return Values

Returns the result of the operation.
Success: LEVEL_SUCCESS:SUMMARY_SUCCESS:MODULE_COMMON:DESCRIPTION_SUCCESS.

Description

Configures whether microphone data will be clamped.

The ideal is for the full range of microphone data input to be accepted, but in actual practice variations in microphones occur. A microphone's guaranteed input range is defined as the range for which input is guaranteed, regardless of the microphone.

When this function is executed with a true argument, clamping is performed for the value of the microphone's guaranteed input range. Always use clamping to avoid problems that could be caused by differences in microphones.

When a broader range is necessary, you can disable clamping. In that case, note that it is possible that you may be unable to get values outside the microphone's guaranteed input range.

See the following for the microphone's guaranteed input range based on the sampling type.
nn::mic::CTR::TYPE_8BIT_GUARANTEED_INPUT_MIN,
nn::mic::CTR::TYPE_8BIT_GUARANTEED_INPUT_MAX,
nn::mic::CTR::TYPE_16BIT_GUARANTEED_INPUT_MIN,
nn::mic::CTR::TYPE_16BIT_GUARANTEED_INPUT_MAX,
nn::mic::CTR::TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MIN,
nn::mic::CTR::TYPE_SIGNED_8BIT_GUARANTEED_INPUT_MAX,
nn::mic::CTR::TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MIN,
nn::mic::CTR::TYPE_SIGNED_16BIT_GUARANTEED_INPUT_MAX,

When sampling has already taken place when this function has executed, the settings from the currently written location and thereafter will be reflected.

Revision History

2010/10/15
Initial version.

CONFIDENTIAL