ADTF  3.18.2
IRecorderabstract

Remote Recorder interface. More...

Inheritance diagram for IRecorder:
[legend]

Public Member Functions

 ADTF_IID (IRecorder, "recorder.bat.remote.adtf")
 RPC IID of the Recorder.
 
virtual tResult AddMarker (tTimeStamp tmTimeStamp, const char *strName)=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.remote.adtf")
 RPC IID of the Recorder.
 
virtual const char * GetCurrentFileName () const =0
 Retrieves the current filename set for the file recording. More...
 
virtual tResult Start (const char *strFileName)=0
 Starts Recording. More...
 
virtual tResult Stop (const char *strFileName)=0
 Stops Recording. More...
 
virtual tResult Split (const char *strFileName)=0
 Splits Recording. More...
 
virtual int8_t GetCurrentState () const =0
 Retrieves the current state of the recorder. More...
 
virtual tTimeStamp GetFirstTime () const =0
 Retrieves the first (chunk) time of the currently recorded file. More...
 
virtual tTimeStamp GetLastTime () const =0
 Retrieves the last (chunk) time of the currently recorded files. More...
 

Additional Inherited Members

- Static Public Attributes inherited from IRecorder
static constexpr const tChar *const DEFAULT_NAME = "recorder"
 Default name of the recorder.
 

Detailed Description

Remote Recorder interface.

Use this interface to communicate to the ADTFDAT File Recorder via RPC call.

See also
section_recorder, Demo Qt5 Recorder Control View Plugin

Definition at line 102 of file adtf_remote_recorder_intf.h.

Member Function Documentation

◆ AddMarker()

virtual tResult AddMarker ( tTimeStamp  tmTimeStamp,
const char *  strName 
)
pure virtual

Adds a marker to the corrently ongoing recording.

Parameters
[in]tmTimeStampThe timestamp of the marker. If -1 then the recorder will take the current stream time from the reference clock.
[in]strNameThe name of the marker.
Returns
Standard result.

◆ DropHistory()

virtual tResult DropHistory ( )
pure virtual

Drops all data currently kept in the history buffer.

Returns
Standard result.