nn::mic::CTR::GetBufferFullEvent Function

Syntax

Result GetBufferFullEvent(
     nn::os::Event * pEvent
);

Arguments

Name Description
out pEvent Manually resetting event that is caused when the buffer is full.

Return Values

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

Description

Gets the manually resetting event used to detect when the microphone buffer is full.

The nn::os::Event object is signaled when the amount of data specified by the size argument of the StartSampling member function has been written.
If loop is set to true in StartSampling and sampling will be performed from the offset position, the nn::os::Event object will be signaled after size bytes of data have been written.

Because this is a manually resetting event, once the event has been signaled you must call nn::os::Event::ClearSignal if you want to retrieve another event.

Revision History

2010/01/07
Initial version.

CONFIDENTIAL