ToneDetectInit

Initializes the tone detector state structure.

Syntax

IppStatus ippsToneDetectInit_EC_16s(IppsToneDetectState_EC_16s* pState, ippECFrequency sampleFreq);

IppStitus ippsToneDetectInit_EC_32f(IppsToneDetectState_EC_32f* pState, ippECFrequency sampleFreq);

Parameters

pState	Pointer to the tone detector state structure.
sampleFreq	Sample frequency.

Description

The functions ippsToneDetectInit_EC are declared in the ippsc.h file. These functions initialize the tone detector state structure that is used by the functionippsToneDetect_EC in the external buffer. Its size must be calculated by the function ippsToneDetectGetStateSize_EC beforehand.

Return Values

ippStsNoErr	Indicates no error.
ippStsNullPtrErr	Indicates an error when pState pointer is NULL.
ippStsRangeErr	Indicates an error when sampleFreq is not a valid element of the enumerated type IppFrequency.