adtf::services::bat::IRecorder Class Reference

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

#include <recorder_intf.h>

Inherits adtf::services::ant::IRecorder.

Inherited by adtf::services::devil::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
virtual tResult	DropHistory ()=0
Public Member Functions inherited from adtf::services::ant::IRecorder
	ADTF_IID (IRecorder, "recorder.ant.services.adtf.iid")
	Interface ID for the recorder service interface.
virtual tResult	Start (const char *strFileName)=0
virtual tResult	Stop (const char *strFileName)=0
virtual tResult	Split (const char *strFileName)=0
virtual tResult	GetTimeRange (tTimeStamp &tmFirstItem, tTimeStamp &tmLastItem) const =0
virtual tResult	GetCurrentFileName (adtf::base::ant::IString &&strFileName) const =0
virtual IRecorder::tState	GetCurrentState () const =0
Public Member Functions inherited from adtf::ucom::ant::IObject
	ADTF_IID (IObject, "object.ant.ucom.adtf.iid")

Additional Inherited Members
Public Types inherited from adtf::services::ant::IRecorder
enum	tState : uint32_t { Closed = 0 , Idle = 1 , Queueing = 2 , Recording = 3 }
Protected Member Functions inherited from adtf::ucom::ant::IObject
	~IObject ()=default
	Protected destructor --> Only the final implementation can be destroyed!

Detailed Description

Recorder Service Control interface to control the Recorder.

This interface enables you to control an instance of 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

Recorder

Member Function Documentation

AddMarker()

virtual tResult adtf::services::bat::IRecorder::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 adtf::services::bat::IRecorder::DropHistory ( )

pure virtual

Drops all data currently kept in the history buffer.

Returns

Standard result.

---

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

• src/libraries/base/include/plugins/recorder_intf.h