IRecordingFile

Interface for manipulating recording files. More...

Inheritance diagram for IRecordingFile:

Public Member Functions
	ADTF_IID (IRecordingFile, "recording_file.ant.system.adtf.iid")
	definiton of interface id
virtual tResult	SetDescription (const char *strDescription)=0
	Set the description in the file header. More...
virtual tResult	SetTargetFileName (const char *strFileName)=0
	Set the filename that the file should be moved to after it has been closed. More...
virtual tResult	AddExtension (const char *strName, const adtf::base::ant::IRawMemory &oData, uint32_t ui32UserId=0, uint32_t ui32TypeId=0, uint32_t ui32VersionId=0)=0
	Add a new extension. More...
virtual tResult	GetExtensionStream (const char *strName, uint32_t ui32UserId, uint32_t ui32TypeId, uint32_t ui32VersionId, adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IOutputStream > &pStream)=0
	Get a handle to a stream interface to directly write extensiond data to the file without an intermediate buffer. More...
Public Member Functions inherited from IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")
	Marks the IObject to be castable with the ucom_cast() More...

Additional Inherited Members
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

Interface for manipulating recording files.

Definition at line 24 of file recording_file_intf.h.

Member Function Documentation

AddExtension()

virtual tResult AddExtension ( const char *  strName, const adtf::base::ant::IRawMemory &  oData, uint32_t  ui32UserId = 0, uint32_t  ui32TypeId = 0, uint32_t  ui32VersionId = 0  )

pure virtual

Add a new extension.

Parameters

[in]	strName	The identifier of the extension.
[in]	oData	The raw data of the extension.
[in]	ui32UserId	An optional user id.
[in]	ui32TypeId	An optional type id.
[in]	ui32VersionId	An optional version id.

Returns

Standard result.

GetExtensionStream()

virtual tResult GetExtensionStream ( const char *  strName, uint32_t  ui32UserId, uint32_t  ui32TypeId, uint32_t  ui32VersionId, adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IOutputStream > &  pStream  )

pure virtual

Get a handle to a stream interface to directly write extensiond data to the file without an intermediate buffer.

Parameters

[in]	strName	The identifier of the extension.
[in]	ui32UserId	An optional user id.
[in]	ui32TypeId	An optional type id.
[in]	ui32VersionId	An optional version id.
[out]	pStream	This will be set to the stream interface pointer.

Returns

Standard result.

SetDescription()

virtual tResult SetDescription ( const char *  strDescription )

pure virtual

Set the description in the file header.

Parameters

[in]

strDescription

The description.

Returns

Standard result.

SetTargetFileName()

virtual tResult SetTargetFileName ( const char *  strFileName )

pure virtual

Set the filename that the file should be moved to after it has been closed.

Parameters

[in]

strFileName

The target filename.

Returns

Standard result.