eGrabber Recorder Reference  24.04.0.8
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
RecorderLibrary

A Recorder library object that loads and unloads the Recorder Library and exposes its low-level functions. More...

#include <EGrabberRecorder.h>

Public Member Functions

 RecorderLibrary (const std::string &path=getDefaultPath())
 
virtual ~RecorderLibrary ()
 
void initLibrary ()
 
void closeLibrary ()
 
Recorder openRecorder (const std::string &path, RECORDER_OPEN_MODE mode, RECORDER_CLOSE_MODE closeMode=RECORDER_CLOSE_MODE_TRIM, uint32_t *fileVersion=0)
 Open a recorder and return a Recorder object that wraps the opened recorder handle. More...
 

Static Public Member Functions

static std::string getDefaultPath ()
 

Public Attributes

FnRecorderOpen open
 
FnRecorderClose close
 
FnRecorderSetParameterString setParameterString
 
FnRecorderGetParameterString getParameterString
 
FnRecorderSetParameterInteger setParameterInteger
 
FnRecorderGetParameterInteger getParameterInteger
 
FnRecorderRead read
 
FnRecorderWrite write
 
FnRecorderExport exportImages
 
FnRecorderStartChapter startChapter
 

Detailed Description

A Recorder library object that loads and unloads the Recorder Library and exposes its low-level functions.

Constructor & Destructor Documentation

◆ RecorderLibrary()

RecorderLibrary ( const std::string &  path = getDefaultPath())
inlineexplicit

◆ ~RecorderLibrary()

virtual ~RecorderLibrary ( )
inlinevirtual

Member Function Documentation

◆ initLibrary()

void initLibrary ( )
inline

◆ closeLibrary()

void closeLibrary ( )
inline

◆ openRecorder()

Recorder openRecorder ( const std::string &  path,
RECORDER_OPEN_MODE  mode,
RECORDER_CLOSE_MODE  closeMode = RECORDER_CLOSE_MODE_TRIM,
uint32_t *  fileVersion = 0 
)
inline

Open a recorder and return a Recorder object that wraps the opened recorder handle.

◆ getDefaultPath()

static std::string getDefaultPath ( )
inlinestatic

Member Data Documentation

◆ open

FnRecorderOpen open

◆ close

FnRecorderClose close

◆ setParameterString

FnRecorderSetParameterString setParameterString

◆ getParameterString

FnRecorderGetParameterString getParameterString

◆ setParameterInteger

FnRecorderSetParameterInteger setParameterInteger

◆ getParameterInteger

FnRecorderGetParameterInteger getParameterInteger

◆ read

FnRecorderRead read

◆ write

FnRecorderWrite write

◆ exportImages

FnRecorderExport exportImages

◆ startChapter

FnRecorderStartChapter startChapter

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