adtf::services::ant::IRecorder Class Reference

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

#include <recorder_intf.h>

Inherits adtf::ucom::ant::IObject.

Inherited by adtf::services::bat::IRecorder.

Public Types
enum	tState : uint32_t { Closed = 0 , Idle = 1 , Queueing = 2 , Recording = 3 }

Public Member Functions
	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
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 Enumeration Documentation

tState

enum adtf::services::ant::IRecorder::tState : uint32_t

Enumerator
Closed	not initialized.
Idle	waiting for a trigger to start recording.
Queueing	waiting for trigger, items are kept in history buffer.
Recording	recording.

Member Function Documentation

GetCurrentFileName()

virtual tResult adtf::services::ant::IRecorder::GetCurrentFileName ( adtf::base::ant::IString && strFileName ) const

pure virtual

Information interface to get the name of the currently opened file.

Parameters

strFileName

[out] String where to return the filenames to. (comma separated list)

Remarks

It will only return valid values if ERR_NOERROR is returned.

Return values

ERR_NOERROR

State change succeded

GetCurrentState()

virtual IRecorder::tState adtf::services::ant::IRecorder::GetCurrentState ( ) const

pure virtual

Information interface to get the current state of the Recorder.

Remarks

The recorder state may change asynchronously, and may not immediately reflect the effects of a Start() or Stop() command.

It will only return valid values if ERR_NOERROR is returned.

Return values

The	State of the recorder

GetTimeRange()

virtual tResult adtf::services::ant::IRecorder::GetTimeRange ( tTimeStamp & tmFirstItem, tTimeStamp & tmLastItem ) const

pure virtual

Information interface to get the time range of the current opened files.

Parameters

tmFirstItem	[out] (Chunk)Time of the first item
tmLastItem	[out] (Chunk)Time of the last item

Remarks

It will only return valid values if ERR_NOERROR is returned.

Return values

ERR_NOERROR

File is at least opend and information where read.

Split()

virtual tResult adtf::services::ant::IRecorder::Split ( const char * strFileName )

pure virtual

Stops an ongoing recording and immediately starts a new one.

Remarks

This operation is atomic and does not result in a loss of data.

Parameters

[in]

strFileName

The name of the newly recorded file. Can be empty, to use a default.

Returns

Standard result.

Start()

virtual tResult adtf::services::ant::IRecorder::Start ( const char * strFileName )

pure virtual

Starts a new recording.

Parameters

[in]

strFileName

The name of the recorded file. Can be empty, to use a default.

Returns

Standard result.

Stop()

virtual tResult adtf::services::ant::IRecorder::Stop ( const char * strFileName )

pure virtual

Stops an ongoing recording.

Parameters

[in]

strFileName

A new name for the recorded file. The recorded file will be moved to this. Can be empty.

Returns

Standard result.

---

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

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