FBVideoGrabber Class Reference

Search for all occurrences

---

Detailed Description

Video Grabber class.

Used to grab video frames generated with the FBRenderer.

Examples

Tasks/JpegRender.py, Rendering/codecExamples.py, Rendering/render.py, Rendering/RenderLayers.py

Inheritance diagram for FBVideoGrabber:

List of all members.

Public Member Functions
	__init__ (object pObject=None)
	Constructor.
	SetOptions (FBVideoGrabOptions pOptions)
	SetOptions.
FBVideoGrabOptions	GetOptions ()
	GetOptions give you a copy of current grabbing options.
	ResetOptions ()
	SetDefaultOptions.
	SetRefreshViewFunc (pThis, function pCallbackFuncPtr)
	SetRefreshViewFunc.
	SetPostRenderFrameCallback (pThis, function pCallbackFuncPtr)
	SetPostRenderFrameCallback.
bool	BeginGrab ()
	BeginGrab.
	Grab ()
	Grab.
	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.
str	GetLastErrorMsg ()
	GetLastErrorMsg.

---

Member Function Documentation

__init__

(

object

pObject = None

)

Search for all occurrences

Constructor.

Parameters:

pObject

For internal use only.

Examples

Tasks/JpegRender.py, Rendering/codecExamples.py, Rendering/render.py, Rendering/RenderLayers.py

Reimplemented from FBComponent.

SetOptions

(

FBVideoGrabOptions

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.

ResetOptions

(

)

Search for all occurrences

SetDefaultOptions.

This function reset all grabbing options to the default value.

SetRefreshViewFunc	(	pThis	,
		function	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.

SetPostRenderFrameCallback	(	pThis	,
		function	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.

Grab

(

)

Search for all occurrences

Grab.

Grab all specified video frames.

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
	)

Search for all occurrences

Render a snapshot of the actual display.

Parameters:

pWidth
pHeight
pCameraLabel
pTimeCode
pSafeArea
pAxis
pGrid
pFrontPlate
pBackPlate

Returns:

An FBimage containing data of the rendered snapshot.

FBVideoGrabStats GetStatistics

(

)

Search for all occurrences

GetStatistics.

Returns:

Struct that contain all grabbing statistics.

str GetLastErrorMsg

(

)

Search for all occurrences

GetLastErrorMsg.

Returns:

If an error occured, this function returns the last error message, otherwise an empty string.