IRecorder Struct Reference

Recorders represent objects which record input data to a persistent storage medium such as a file, database, or cloud storage bucket. Recorders implement the IRecorder interface and may expose additional properties for configuring the storage (such as file type, storage location, etc.). tags. More...

Inheritance diagram for IRecorder:

Collaboration diagram for IRecorder:

Detailed Description

Recorders represent objects which record input data to a persistent storage medium such as a file, database, or cloud storage bucket. Recorders implement the IRecorder interface and may expose additional properties for configuring the storage (such as file type, storage location, etc.). tags.

Public Member Functions
virtual ErrCode INTERFACE_FUNC	startRecording ()=0
	Starts recording data from connected signals to the persistent storage medium. More...
virtual ErrCode INTERFACE_FUNC	stopRecording ()=0
	Stops recording data from connected signals to the persistent storage medium. More...
virtual ErrCode INTERFACE_FUNC	getIsRecording (Bool *isRecording)=0
	Checks whether data from connected signals is currently being recorded to the persistent storage medium. More...
Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC	borrowInterface (const IntfID &intfID, void **obj) const =0
	Returns another interface which is supported by the object without incrementing the reference count. More...
virtual ErrCode INTERFACE_FUNC	dispose ()=0
	Disposes all references held by the object. More...
virtual ErrCode INTERFACE_FUNC	getHashCode (SizeT *hashCode)=0
	Returns hash code of the object. More...
virtual ErrCode INTERFACE_FUNC	equals (IBaseObject *other, Bool *equal) const =0
	Compares object to another object for equality. More...
virtual ErrCode INTERFACE_FUNC	toString (CharPtr *str)=0
	Returns a string representation of the object. More...
Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC	queryInterface (const IntfID &intfID, void **obj)=0
	Returns another interface which is supported by the object and increments the reference count. More...
virtual int INTERFACE_FUNC	addRef ()=0
	Increments the reference count for an interface on an object. More...
virtual int INTERFACE_FUNC	releaseRef ()=0
	Decrements the reference count for an interface on an object. More...

Member Function Documentation

getIsRecording()

virtual ErrCode INTERFACE_FUNC getIsRecording ( Bool *  isRecording )

pure virtual

Checks whether data from connected signals is currently being recorded to the persistent storage medium.

Parameters

isRecording

A pointer to a boolean which is populated with the recording state.

Return values

OPENDAQ_SUCCESS

if the recording status was successfully returned.

startRecording()

virtual ErrCode INTERFACE_FUNC startRecording ( )

pure virtual

Starts recording data from connected signals to the persistent storage medium.

Return values

OPENDAQ_SUCCESS	if the recording successfully started.
OPENDAQ_ERR_INVALIDSTATE	if the recording has already been started and the implementation chooses to treat this scenario as an error.

stopRecording()

virtual ErrCode INTERFACE_FUNC stopRecording ( )

pure virtual

Stops recording data from connected signals to the persistent storage medium.

Return values

OPENDAQ_SUCCESS	if the recording successfully stopped.
OPENDAQ_ERR_INVALIDSTATE	if the recording is not started and the implementation chooses to treat this scenario as an error.