FBVideoGrabber Class Reference


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.
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.
FBVideoGrabStats GetStatistics ()
 GetStatistics.
str GetLastErrorMsg ()
 GetLastErrorMsg.

Member Function Documentation

__init__ ( object  pObject = None)

Constructor.

Parameters:
pObjectFor internal use only.
Examples
Tasks/JpegRender.py, Rendering/codecExamples.py, Rendering/render.py, Rendering/RenderLayers.py

Reimplemented from FBComponent.

SetOptions ( FBVideoGrabOptions  pOptions)

SetOptions.

Parameters:
pOptionsStruct that contain all grabbing options.
FBVideoGrabOptions GetOptions ( )

GetOptions give you a copy of current grabbing options.

Returns:
Struct that contain all grabbing options.
ResetOptions ( )

SetDefaultOptions.

This function reset all grabbing options to the default value.

SetRefreshViewFunc ( pThis  ,
function  pCallbackFuncPtr 
)

SetRefreshViewFunc.

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

Parameters:
pThisPointer to the callback receiver.
pCallbackFuncPtrPointer to the callback function.
SetPostRenderFrameCallback ( pThis  ,
function  pCallbackFuncPtr 
)

SetPostRenderFrameCallback.

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

Parameters:
pThisPointer to the callback receiver.
pCallbackFuncPtrPointer to the callback function.
bool BeginGrab ( )

BeginGrab.

Begin video grabbing session.

Returns:
True if we can begin the grab session.
Grab ( )

Grab.

Grab all specified video frames.

EndGrab ( )

EndGrab.

Close video grabbing session.

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.

Parameters:
pWidth
pHeight
pCameraLabel
pTimeCode
pSafeArea
pAxis
pGrid
pFrontPlate
pBackPlate
Returns:
An FBimage containing data of the rendered snapshot.
FBVideoGrabStats GetStatistics ( )

GetStatistics.

Returns:
Struct that contain all grabbing statistics.
str GetLastErrorMsg ( )

GetLastErrorMsg.

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

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