roc::audio::IFrameReader Class Reference

Frame reader interface. More...

#include <iframe_reader.h>

Inheritance diagram for roc::audio::IFrameReader:

Collaboration diagram for roc::audio::IFrameReader:

Public Member Functions
virtual bool	read (Frame &frame)=0
	Read audio frame. More...
Public Member Functions inherited from roc::core::ListNode< Tag >
ListData *	list_data () const
	Get pointer to internal data. More...

Additional Inherited Members
Static Public Member Functions inherited from roc::core::ListNode< Tag >
static ListNode *	list_node (ListData *data)
	Get pointer to parent node from pointer to internal data. More...

Detailed Description

Frame reader interface.

Definition at line 22 of file iframe_reader.h.

Member Function Documentation

read()

virtual bool roc::audio::IFrameReader::read ( Frame &  frame )

pure virtual

Read audio frame.

Remarks

Frame buffer and its size should be set by caller. The reader should fill the entire buffer and should not resize it.

Returns

false if there is nothing to read anymore.

Implemented in roc::audio::Watchdog, roc::audio::ProfilingReader, roc::audio::PcmMapperReader, roc::audio::Mixer, roc::audio::LatencyMonitor, roc::audio::Depacketizer, roc::audio::ChannelMapperReader, roc::audio::ResamplerReader, roc::sndio::WavSource, roc::sndio::PulseaudioDevice, roc::sndio::SoxSource, roc::sndio::SndfileSource, roc::pipeline::TranscoderSource, and roc::pipeline::ReceiverSource.

---

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

• roc_audio/iframe_reader.h