FBVideoGrabber Class Reference

FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber

Inheritance diagram for FBVideoGrabber:

[legend]

List of all members.

---

Detailed Description

Video Grabber class.

Used to grab video frames generated with the FBRenderer.

See samples: codecExamples.py, render.py, RenderLayers.py, JpegRender.py.

Public Member Functions
	FBVideoGrabber ()
	Constructor.
bool	BeginGrab ()
	BeginGrab.
	EndGrab ()
	EndGrab.
str	GetLastErrorMsg ()
	GetLastErrorMsg.
FBVideoGrabOptions	GetOptions ()
	GetOptions give you a copy of current grabbing options.
FBVideoGrabStats	GetStatistics ()
	GetStatistics.
	Grab ()
	Grab.
FBImage	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.
	ResetOptions ()
	SetDefaultOptions.
	SetOptions (FBVideoGrabOptions pOptions)
	SetOptions.

---

Constructor & Destructor Documentation

FBVideoGrabber

(

)

Constructor.

---

Member Function Documentation

bool BeginGrab

(

)

BeginGrab.

Begin video grabbing session.

Returns:

True if we can begin the grab session.

EndGrab

(

)

EndGrab.

Close video grabbing session.

str GetLastErrorMsg

(

)

GetLastErrorMsg.

Returns:

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

FBVideoGrabOptions GetOptions

(

)

GetOptions give you a copy of current grabbing options.

Returns:

Struct that contain all grabbing options.

See sample: JpegRender.py.

FBVideoGrabStats GetStatistics

(

)

GetStatistics.

Returns:

Struct that contain all grabbing statistics.

Grab

(

)

Grab.

Grab all specified video frames.

FBImage 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.

Returns:

An FBimage containing data of the rendered snapshot.

ResetOptions

(

)

SetDefaultOptions.

This function reset all grabbing options to the default value.

SetOptions

(

FBVideoGrabOptions

pOptions

)

SetOptions.

Parameters:

pOptions

Struct that contain all grabbing options.

---