adtf_file_library  0.13.1
Public Member Functions | List of all members
adtf_file::SampleSerializer Class Referenceabstract

Interface class for a sample serializer. Usually the implementaion has a serialization state depending on the last setStreamType call. More...

#include <adtf_file_writer.h>

Inheritance diagram for adtf_file::SampleSerializer:
[legend]

Public Member Functions

virtual std::string getId () const =0
 Get the Id of the sample serializer. More...
 
virtual void setStreamType (const StreamType &stream_type)=0
 Set the Stream Type and the serialization state of the serializer. More...
 
virtual void serialize (const WriteSample &sample, OutputStream &stream)=0
 Serializes the sample into the given stream. These samples usually are described by the previous set stream type. More...
 

Detailed Description

Interface class for a sample serializer. Usually the implementaion has a serialization state depending on the last setStreamType call.

Member Function Documentation

◆ getId()

virtual std::string adtf_file::SampleSerializer::getId ( ) const
pure virtual

◆ serialize()

virtual void adtf_file::SampleSerializer::serialize ( const WriteSample sample,
OutputStream stream 
)
pure virtual

Serializes the sample into the given stream. These samples usually are described by the previous set stream type.

Parameters
samplethe sample to serialize.
streamthe stream to write to.
Remarks
The serializer itself might have a serialization state depending on the setStreamType call.

Implemented in adtf_file::adtf3::SampleCopySerializerNs, adtf_file::adtf3::SampleCopySerializer, adtf_file::adtf3::MediaDescriptionSerializerNs, adtf_file::adtf3::MediaDescriptionSerializer, and adtf_file::adtf2::AdtfCoreMediaSampleSerializer.

◆ setStreamType()

virtual void adtf_file::SampleSerializer::setStreamType ( const StreamType stream_type)
pure virtual

Set the Stream Type and the serialization state of the serializer.

Parameters
stream_typethe stream type describes all following samples of the serialize call

Implemented in adtf_file::adtf3::SampleCopySerializerNs, adtf_file::adtf3::SampleCopySerializer, adtf_file::adtf3::MediaDescriptionSerializerNs, adtf_file::adtf3::MediaDescriptionSerializer, and adtf_file::adtf2::AdtfCoreMediaSampleSerializer.


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

Copyright © CARIAD SE.
Generated on Fri Apr 19 2024 by doxygen 1.9.1
GIT Commit Hash: 82d535f82776c20b12fc60740bdae991b62444a7