IRecorder

Remote Recorder interface. More...

Inheritance diagram for IRecorder:

Public Member Functions
	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...

Static Public Attributes
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 26 of file adtf_remote_recorder_intf.h.

Member Function Documentation

GetCurrentFileName()

virtual const char* GetCurrentFileName ( ) const

pure virtual

Retrieves the current filename set for the file recording.

Returns

The filename set

Return values

empty

if no filename set or not recording

GetCurrentState()

virtual int8_t GetCurrentState ( ) const

pure virtual

Retrieves the current state of the recorder.

Returns

The current state (adtf::service::ant::IRecorder::tState)

See also

adtf::service::ant::IRecorder::tState

GetFirstTime()

virtual tTimeStamp GetFirstTime ( ) const

pure virtual

Retrieves the first (chunk) time of the currently recorded file.

Returns

The first (chunk) time of the currently recorded file

Return values

-1	no file recorded

GetLastTime()

virtual tTimeStamp GetLastTime ( ) const

pure virtual

Retrieves the last (chunk) time of the currently recorded files.

Returns

The last (chunk) time of the currently recorded files

Return values

-1	no file recorded

Split()

virtual tResult Split ( const char *  strFileName )

pure virtual

Splits Recording.

Parameters

[in]

strFileName

optional parameter of filename where to record. Set empty ("") to use the recorders default.

Remarks

This filename must be a valid path on the host where recorder is running. The filename will override any other previous set filename.

Returns

Standard Result code

Return values

ERR_NOERROR

Splitting of recording successfully set

Start()

virtual tResult Start ( const char *  strFileName )

pure virtual

Starts Recording.

Parameters

[in]

strFileName

optional parameter of filename where to record. Set empty ("") to use the recorders default.

Remarks

This filename must be a valid path on the host where recorder is running. The filename will override any other previous set filename.

Returns

Standard Result code

Return values

ERR_NOERROR

Starting of recording successfully set

Stop()

virtual tResult Stop ( const char *  strFileName )

pure virtual

Stops Recording.

Parameters

[in]

strFileName

optional parameter of filename where to record. Set empty ("") to use the recorders default.

Remarks

This filename must be a valid path on the host where recorder is running. The filename will override any other previous set filename.

Returns

Standard Result code

Return values

ERR_NOERROR

Stopping of recording successfully set