ADTF
Loading...
Searching...
No Matches
adtf::mediadescription::flash::cSampleWithCodec Class Reference

#include <codec_sample_streamer_legacy.h>

Inherits adtf::mediadescription::ant::cSampleCodec.

Public Member Functions

 cSampleWithCodec ()=default
 
 cSampleWithCodec (ant::cSampleCodec &&oCodec, const ucom::ant::iobject_ptr< const streaming::ant::ISample > &pSample)
 
 cSampleWithCodec (cSampleWithCodec &&)=default
 
cSampleWithCodecoperator= (cSampleWithCodec &&)=default
 
ucom::ant::object_ptr< const streaming::ant::ISampleRelease ()
 
- Public Member Functions inherited from adtf::mediadescription::ant::cSampleCodec
 cSampleCodec ()=default
 
 cSampleCodec (cSampleCodec &&)=default
 
cSampleCodecoperator= (cSampleCodec &&)=default
 
void SetElementValue (const char *strElementName, const adtf::util::cVariant &oValue)
 

Detailed Description

Helper class that combines a Sample Codec with a Sample instance.

Constructor & Destructor Documentation

◆ cSampleWithCodec() [1/2]

adtf::mediadescription::flash::cSampleWithCodec::cSampleWithCodec ( )
default

Default Constructor -> invalid object.

◆ cSampleWithCodec() [2/2]

adtf::mediadescription::flash::cSampleWithCodec::cSampleWithCodec ( ant::cSampleCodec && oCodec,
const ucom::ant::iobject_ptr< const streaming::ant::ISample > & pSample )

Constructor that initializes a valid object.

Parameters
[in]oCodecThe codec the encodes values into the sample.
[in]pSampleThe sample.

Member Function Documentation

◆ Release()

ucom::ant::object_ptr< const streaming::ant::ISample > adtf::mediadescription::flash::cSampleWithCodec::Release ( )

Retrieve the sample instance.

Call this when you're done updating the sample data in order to write it via streaming::flash::ISampleWriter::Write.

Do not call any other methods of the object after you have called this method.

Returns
A Pointer to the sample.

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