XCORE SDK
XCORE Software Development Kit
Public Member Functions | Public Attributes | List of all members
mic_array::FrameOutputHandler< MIC_COUNT, SAMPLE_COUNT, FrameTransmitter, FRAME_COUNT > Class Template Reference

OutputHandler for grouping samples into frames and sending frames to subsequent processing stages. More...

#include <OutputHandler.hpp>

Public Member Functions

 FrameOutputHandler ()
 Construct new FrameOutputHandler. More...
 
 FrameOutputHandler (FrameTransmitter< MIC_COUNT, SAMPLE_COUNT > frame_tx)
 Construct new FrameOutputHandler. More...
 
void OutputSample (int32_t sample[MIC_COUNT])
 Add new sample to current frame and output frame if filled. More...
 

Public Attributes

FrameTransmitter< MIC_COUNT, SAMPLE_COUNT > FrameTx
 FrameTransmitter used to transmit frames to the next stage for processing.
 

Detailed Description

template<unsigned MIC_COUNT, unsigned SAMPLE_COUNT, template< unsigned, unsigned > class FrameTransmitter, unsigned FRAME_COUNT = 1>
class mic_array::FrameOutputHandler< MIC_COUNT, SAMPLE_COUNT, FrameTransmitter, FRAME_COUNT >

OutputHandler for grouping samples into frames and sending frames to subsequent processing stages.

Template Parameters
MIC_COUNTNumber of audio channels in each frame.
SAMPLE_COUNTNumber of samples per frame.
FrameTransmitter
FRAME_COUNTNumber of frame buffers to rotate between.

Constructor & Destructor Documentation

◆ FrameOutputHandler() [1/2]

template<unsigned MIC_COUNT, unsigned SAMPLE_COUNT, template< unsigned, unsigned > class FrameTransmitter, unsigned FRAME_COUNT = 1>
mic_array::FrameOutputHandler< MIC_COUNT, SAMPLE_COUNT, FrameTransmitter, FRAME_COUNT >::FrameOutputHandler ( )
inline

Construct new FrameOutputHandler.

The default no-argument constructor for FrameTransmitter is used to create FrameTx.

◆ FrameOutputHandler() [2/2]

template<unsigned MIC_COUNT, unsigned SAMPLE_COUNT, template< unsigned, unsigned > class FrameTransmitter, unsigned FRAME_COUNT = 1>
mic_array::FrameOutputHandler< MIC_COUNT, SAMPLE_COUNT, FrameTransmitter, FRAME_COUNT >::FrameOutputHandler ( FrameTransmitter< MIC_COUNT, SAMPLE_COUNT >  frame_tx)
inline

Construct new FrameOutputHandler.

Uses the provided FrameTransmitter to send frames.

Parameters
frame_txFrame transmitter for sending frames.

Member Function Documentation

◆ OutputSample()

template<unsigned MIC_COUNT, unsigned SAMPLE_COUNT, template< unsigned, unsigned > class FrameTransmitter, unsigned FRAME_COUNT>
void mic_array::FrameOutputHandler< MIC_COUNT, SAMPLE_COUNT, FrameTransmitter, FRAME_COUNT >::OutputSample ( int32_t  sample[MIC_COUNT])

Add new sample to current frame and output frame if filled.

Parameters
sampleSample to be added to current frame.

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