IRecorder

ADTFDAT File Recorder Service Control interface to control the ADTFDAT File Recorder. More...

Inheritance diagram for IRecorder:

Public Member Functions
	ADTF_IID (IRecorder, "recorder.bat.services.adtf.iid")
	Interface ID for the recorder service interface.
virtual tResult	AddMarker (tTimeStamp tmTimeStamp, const char *strName=nullptr, const char *strAdditional=nullptr)=0
	Adds a marker to the corrently ongoing recording. More...
virtual tResult	DropHistory ()=0
	Drops all data currently kept in the history buffer. More...
Public Member Functions inherited from IRecorder
	ADTF_IID (IRecorder, "recorder.ant.services.adtf.iid")
	Interface ID for the recorder service interface.
virtual tResult	Start (const char *strFileName)=0
	Starts a new recording. More...
virtual tResult	Stop (const char *strFileName)=0
	Stops an ongoing recording. More...
virtual tResult	Split (const char *strFileName)=0
	Stops an ongoing recording and starts a new one. More...
virtual tResult	GetTimeRange (tTimeStamp &tmFirstItem, tTimeStamp &tmLastItem) const =0
	Information interface to get the time range of the current opened files. More...
virtual tResult	GetCurrentFileName (adtf::base::ant::IString &&strFileName) const =0
	Information interface to get the name of the currently opened file. More...
virtual IRecorder::tState	GetCurrentState () const =0
	Information interface to get the current state of the Recorder. 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
Public Types inherited from IRecorder
enum	tState : uint32_t { Closed = 0 , Idle = 1 , Queueing = 2 , Recording = 3 }
Protected Member Functions inherited from IObject
	~IObject ()=default
	Protected destructor --> Use implemented Destroy() instead of delete!

Detailed Description

ADTFDAT File Recorder Service Control interface to control the ADTFDAT File Recorder.

This interface enables you to control an instance of ADTFDAT File Recorder Streaming Sink.

ucom::object_ptr<IRecorder> pRecorder;
// MIND: This call will only succeed if a recorder is present and it will be called _AFTER_ the Streaming Graph has been constructed! (RL_StreamingGraph)
// But a Start call is only possible while RL_Running
if (IS_OK(get_recorder(pRecorder))
{
    if (IS_OK(pRecorder->Start("c:/temp/my_test_file.adtfdat")))
    {
        //Recorder is now recording
    }
}
 
///...

See also

Streaming Graph, ADTFDAT File Recorder

Definition at line 187 of file recorder_intf.h.

Member Function Documentation

AddMarker()

virtual tResult AddMarker ( tTimeStamp  tmTimeStamp, const char *  strName = nullptr, const char *  strAdditional = nullptr  )

pure virtual

Adds a marker to the corrently ongoing recording.

Parameters

[in]	tmTimeStamp	The timestamp of the marker. If -1 then the recorder will take the current stream time from the reference clock.
[in]	strName	The name of the marker.
[in]	strAdditional	Optional additional string data.

Returns

Standard result.

DropHistory()

virtual tResult DropHistory ( )

pure virtual

Drops all data currently kept in the history buffer.

Returns

Standard result.