Detailed Description

Video Grabber class.

Used to grab video frames generated with the FBRenderer.

Definition at line 127 of file fbvideograbber.h.

#include <fbvideograbber.h>

Inheritance diagram for FBVideoGrabber:

Public Member Functions
	FBVideoGrabber (HIObject pObject=NULL)
	Constructor.
void	SetOptions (HFBVideoGrabOptions pOptions)
	SetOptions.
FBVideoGrabOptions	GetOptions ()
	GetOptions give you a copy of current grabbing options.
void	ResetOptions ()
	SetDefaultOptions.
void	SetRefreshViewFunc (void pThis, void(pCallbackFuncPtr)(void *))
	SetRefreshViewFunc.
void	SetPostRenderFrameCallback (void pThis, void(pCallbackFuncPtr)(void *))
	SetPostRenderFrameCallback.
bool	BeginGrab ()
	BeginGrab.
void	Grab ()
	Grab.
void	EndGrab ()
	EndGrab.
HFBImage	RenderSnapshot (int pWidth=-1, int pHeight=-1, bool pCameraLabel=false, bool pTimeCode=false, bool pSafeArea=false, bool pAxis=false, bool pGrid=false, bool pFrontPlate=false, bool pBackPlate=false)
	Render a snapshot of the actual display.
FBVideoGrabStats	GetStatistics ()
	GetStatistics.
FBString	GetLastErrorMsg ()
	GetLastErrorMsg.

Constructor & Destructor Documentation

FBVideoGrabber ( HIObject pObject = NULL )

Constructor.

Parameters:

pObject For internal use only.

Member Function Documentation

void SetOptions ( HFBVideoGrabOptions pOptions )

Search for all occurrences

SetOptions.

Parameters:

pOptions Struct that contain all grabbing options.

FBVideoGrabOptions GetOptions ( )

Search for all occurrences

GetOptions give you a copy of current grabbing options.

Returns:: Struct that contain all grabbing options.

void ResetOptions ( )

Search for all occurrences

SetDefaultOptions.

This function reset all grabbing options to the default value.

void SetRefreshViewFunc	(	void *	pThis,
		void()(void )	pCallbackFuncPtr
	)

Search for all occurrences

SetRefreshViewFunc.

Set the callback function to be called for each frame render.

Parameters:

pThis	Pointer to the callback receiver.
pCallbackFuncPtr	Pointer to the callback function.

void SetPostRenderFrameCallback	(	void *	pThis,
		void()(void )	pCallbackFuncPtr
	)

Search for all occurrences

SetPostRenderFrameCallback.

Set the callback function to be called after each frame is rendered.

Parameters:

pThis	Pointer to the callback receiver.
pCallbackFuncPtr	Pointer to the callback function.

bool BeginGrab ( )

Search for all occurrences

BeginGrab.

Begin video grabbing session.

Returns:: True if we can begin the grab session.

void Grab ( )

Search for all occurrences

Grab.

Grab all specified video frames.

void EndGrab ( )

Search for all occurrences

EndGrab.

Close video grabbing session.

HFBImage RenderSnapshot	(	int	pWidth = `-1`,
		int	pHeight = `-1`,
		bool	pCameraLabel = `false`,
		bool	pTimeCode = `false`,
		bool	pSafeArea = `false`,
		bool	pAxis = `false`,
		bool	pGrid = `false`,
		bool	pFrontPlate = `false`,
		bool	pBackPlate = `false`
	)