VRS
A file format for sensor data.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
vrs_sample_apps::AudioStreamPlayer Class Reference

Audio stream reader showing how to read records from a typical stream containing audio blocks. More...

Inheritance diagram for vrs_sample_apps::AudioStreamPlayer:
vrs::RecordFormatStreamPlayer vrs::StreamPlayer

Public Member Functions

bool onAudioRead (const CurrentRecord &record, size_t blockIdx, const ContentBlock &cb) override
 
size_t getAudioBlockCount () const
 
- Public Member Functions inherited from vrs::RecordFormatStreamPlayer
virtual bool onDataLayoutRead (const CurrentRecord &record, size_t, DataLayout &)
 
virtual bool onImageRead (const CurrentRecord &record, size_t blockIndex, const ContentBlock &cb)
 
virtual bool onCustomBlockRead (const CurrentRecord &rec, size_t blkIdx, const ContentBlock &cb)
 
virtual bool onUnsupportedBlock (const CurrentRecord &rec, size_t blkIdx, const ContentBlock &cb)
 
void onAttachedToFileReader (RecordFileReader &recordFileReader, StreamId streamId) override
 
bool processRecordHeader (const CurrentRecord &record, DataReference &outDataReference) override
 
void processRecord (const CurrentRecord &record, uint32_t readSize) override
 
RecordFormatReadergetLastRecordFormatReader (StreamId id, Record::Type recordType) const
 
RecordFormatReadergetCurrentRecordFormatReader () const
 
- Public Member Functions inherited from vrs::StreamPlayer
virtual bool processStateHeader (const CurrentRecord &, DataReference &)
 
virtual void processState (const CurrentRecord &, uint32_t)
 
virtual bool processConfigurationHeader (const CurrentRecord &, DataReference &)
 
virtual void processConfiguration (const CurrentRecord &, uint32_t)
 
virtual bool processDataHeader (const CurrentRecord &, DataReference &)
 
virtual void processData (const CurrentRecord &, uint32_t)
 
virtual int recordReadComplete (RecordFileReader &, const IndexRecord::RecordInfo &)
 
virtual void flush ()
 

Additional Inherited Members

- Protected Member Functions inherited from vrs::RecordFormatStreamPlayer
template<class T >
T & getExpectedLayout (DataLayout &layout, size_t blockIndex)
 
template<class T >
T & getLegacyLayout (DataLayout &layout, size_t blockIndex)
 
template<class T >
T & getCachedLayout (vector< unique_ptr< DataLayout > > &layoutCache, DataLayout &layout, size_t blockIndex)
 
- Protected Attributes inherited from vrs::RecordFormatStreamPlayer
RecordFileReaderrecordFileReader_ {}
 
map< tuple< StreamId, Record::Type, uint32_t >, RecordFormatReaderreaders_
 
map< pair< StreamId, Record::Type >, RecordFormatReader * > lastReader_
 
RecordFormatReadercurrentReader_ {}
 

Detailed Description

Audio stream reader showing how to read records from a typical stream containing audio blocks.

Member Function Documentation

◆ onAudioRead()

bool vrs_sample_apps::AudioStreamPlayer::onAudioRead ( const CurrentRecord record,
size_t  blockIndex,
const ContentBlock cb 
)
inlineoverridevirtual

Callback for audio content blocks. The ContentBlock object 'cb' describes the audio content block, but the content block's data has not been read yet. Query the ContentBlock object to know the details about the audio data and the content block's size. Then you can allocate or reuse a buffer, and call record.reader->read() to read the content block's data in that buffer.

Parameters
recordMetadata associated with the record being read.
blockIndexIndex of the content block being read.
cbContentBlock describing the audio data to be read.
Returns
Return true if remaining record content blocks should be read.

Reimplemented from vrs::RecordFormatStreamPlayer.


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