nn::mic::CTR::GetForbiddenArea Function

Syntax

bool GetForbiddenArea(
     s32 * upper,
     s32 * lower,
     SamplingType type,
     u8 gain
);

Arguments

Name Description
out upper Maximum value for the region within which it is prohibited to determine if there is microphone input.
out lower Minimum value for the region within which it is prohibited to determine if there is microphone input.
in type Specifies the sampling type.
in gain Sets the microphone amp's gain. Specify a value in the range 0-119 (10.5-70.0 dB).

Return Values

Returns the result of the operation.
Value Description
true Successfully obtained a region.
false Could not successfully obtain a region. Determine whether the input values are within the proper range.

Description

Gets the maximum and minimum values for a region within which it is prohibited to determine that there is microphone input, given a gain and sampling type. Do not determine that there is microphone input between these upper and lower limits.

Revision History

2010/12/18
Revised the description of the return values.
2010/07/15
Initial version.

CONFIDENTIAL