Recorder

A Recorder object that encapsulates a recorder handle (RECORDER_HANDLE) and exposes higher level recorder functions; the destructor takes care of closing the recorder when the object goes out of scope. More...

#include <EGrabberRecorder.h>

Public Member Functions
	Recorder (const Recorder &)
Recorder &	operator= (const Recorder &)
	Recorder (RecorderLibrary &recorderLibrary, RECORDER_HANDLE handle, RECORDER_CLOSE_MODE closeMode)
	create a Recorder object from a recorder handle (RecorderLibrary::openRecorder) More...
virtual	~Recorder ()
	close a recorder using the mode defined when the recorder was created (RecorderClose) More...
	operator bool () const
	check if the recorder handle is valid More...
void	close ()
	close the recorder using the mode defined when the recorder was created (RecorderClose) More...
void	close (RECORDER_CLOSE_MODE closeMode)
	close the recorder using the given close mode (RecorderClose) More...
std::string	getParameterString (RECORDER_PARAMETER parameter)
	get a recorder parameter (RecorderGetParameterString) More...
void	setParameterString (RECORDER_PARAMETER parameter, const std::string &value)
	set a recorder parameter (RecorderSetParameterString) More...
int64_t	getParameterInteger (RECORDER_PARAMETER parameter)
	get a recorder parameter (RecorderGetParameterInteger) More...
void	setParameterInteger (RECORDER_PARAMETER parameter, int64_t value)
	set a recorder parameter (RecorderSetParameterInteger) More...
void	write (const RECORDER_BUFFER_INFO *info, const void *buffer)
	write to the container synchronously (RecorderWrite) More...
size_t	read (RECORDER_BUFFER_INFO *info, void *buffer, size_t bufferSize)
std::vector< char >	read (RECORDER_BUFFER_INFO *info=0)
size_t	exportImages (const std::string &path, size_t count, uint32_t exportPixelFormat=0)
void	startChapter (const std::string &name="", const std::string &info="")

Detailed Description

A Recorder object that encapsulates a recorder handle (RECORDER_HANDLE) and exposes higher level recorder functions; the destructor takes care of closing the recorder when the object goes out of scope.

Note

the recorder is automatically created by RecorderLibrary::openRecorder

Constructor & Destructor Documentation

Recorder() [1/2]

Recorder

(

const Recorder &

)

Recorder() [2/2]

Recorder ( RecorderLibrary &  recorderLibrary, RECORDER_HANDLE  handle, RECORDER_CLOSE_MODE  closeMode  )

explicit

create a Recorder object from a recorder handle (RecorderLibrary::openRecorder)

~Recorder()

virtual ~Recorder ( )

virtual

close a recorder using the mode defined when the recorder was created (RecorderClose)

Member Function Documentation

operator=()

Recorder& operator=

(

const Recorder &

)

operator bool()

operator bool

(

)

const

check if the recorder handle is valid

close() [1/2]

void close

(

)

close the recorder using the mode defined when the recorder was created (RecorderClose)

close() [2/2]

void close

(

RECORDER_CLOSE_MODE

closeMode

)

close the recorder using the given close mode (RecorderClose)

getParameterString()

std::string getParameterString

(

RECORDER_PARAMETER

parameter

)

get a recorder parameter (RecorderGetParameterString)

setParameterString()

void setParameterString	(	RECORDER_PARAMETER	parameter,
		const std::string &	value
	)

set a recorder parameter (RecorderSetParameterString)

getParameterInteger()

int64_t getParameterInteger

(

RECORDER_PARAMETER

parameter

)

get a recorder parameter (RecorderGetParameterInteger)

setParameterInteger()

void setParameterInteger	(	RECORDER_PARAMETER	parameter,
		int64_t	value
	)

set a recorder parameter (RecorderSetParameterInteger)

write()

void write	(	const RECORDER_BUFFER_INFO *	info,
		const void *	buffer
	)

write to the container synchronously (RecorderWrite)

read() [1/2]

size_t read	(	RECORDER_BUFFER_INFO *	info,
		void *	buffer,
		size_t	bufferSize
	)

read() [2/2]

std::vector<char> read

(

RECORDER_BUFFER_INFO *

info = 0

)

exportImages()

size_t exportImages	(	const std::string &	path,
		size_t	count,
		uint32_t	exportPixelFormat = 0
	)

startChapter()

void startChapter	(	const std::string &	name = "",
		const std::string &	info = ""
	)

---

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

• EGrabberRecorder.h