Public Member Functions
void	process (const FrameDataType inputSamples, size_t numInputSamples, FrameDataType outputSamples, size_t numOutputSamples)
	Processes an input frame of audio data.

Static Public Member Functions
static std::shared_ptr< Al< FrameDataType > >	create (const AlSessionConfig &config)
	Creates a new instance of Al session.

Detailed Description

template<typename FrameDataType>
class Krisp::AudioSdk::Al< FrameDataType >

Template Parameters

FrameDataType supports int16 and float types.

Member Function Documentation

template<typename FrameDataType >

static std::shared_ptr< Al< FrameDataType > > Krisp::AudioSdk::Al< FrameDataType >::create ( const AlSessionConfig & config )

static

Creates a new instance of Al session.

Parameters

[in] config Configuration for the Al Session.

Return values

std::shared_ptr<AlSession> on success

Exceptions

Throws std exception in case of error.

template<typename FrameDataType >

void Krisp::AudioSdk::Al< FrameDataType >::process	(	const FrameDataType *	inputSamples,
		size_t	numInputSamples,
		FrameDataType *	outputSamples,
		size_t	numOutputSamples )

Processes an input frame of audio data.

Parameters

[in]	inputSamples	Pointer to the input buffer containing audio samples. The buffer should hold enough samples to fill a frame of audio data, calculated as frameDuration * inputSampleRate / 1000 of FrameDataType samples.
[in]	numInputSamples	The number of samples in the input buffer. Must be sufficient to match the expected input frame size.
[out]	outputSamples	Pointer to the buffer for the processed audio samples. The caller must allocate a buffer of sufficient size to handle a frame of output samples, calculated as frameDuration * outputSampleRate / 1000 of FrameDataType samples.
[in]	numOutputSamples	The number of samples the output buffer can handle. Must be sufficient to match the expected output frame size.

Exceptions

Throws a std exception in case of error.

The documentation for this class was generated from the following file:

/Users/gharutyunyan/Desktop/krisp/sw/krisp-audio-sdk/include/krisp-audio-sdk-al.hpp