Detailed Description
Video Grabber class.
Used to grab video frames generated with the FBRenderer.
Definition at line 128 of file fbvideograbber.h.
#include <fbvideograbber.h>
List of all members.
Public Member Functions |
| FBVideoGrabber (HIObject pObject=NULL) |
| Constructor.
|
void | SetOptions (FBVideoGrabOptions *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.
|
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.
|
const char * | GetLastErrorMsg () |
| GetLastErrorMsg.
|
Constructor & Destructor Documentation
Constructor.
- Parameters:
-
pObject | For internal use only. |
Member Function Documentation
SetOptions.
- Parameters:
-
pOptions | Struct that contain all grabbing options. |
GetOptions give you a copy of current grabbing options.
- Returns:
- Struct that contain all grabbing options.
SetDefaultOptions.
This function reset all grabbing options to the default value.
void SetRefreshViewFunc |
( |
void * |
pThis, |
|
|
void(*)(void *) |
pCallbackFuncPtr |
|
) |
| |
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 |
|
) |
| |
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. |
BeginGrab.
Begin video grabbing session.
- Returns:
- True if we can begin the grab session.
Grab.
Grab all specified video frames.
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.
GetStatistics.
- Returns:
- Struct that contain all grabbing statistics.
const char* GetLastErrorMsg |
( |
| ) |
|
GetLastErrorMsg.
- Returns:
- If an error occured, this function returns the last error message, otherwise an empty string.
The documentation for this class was generated from the following file:
FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber
FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber FBVideoGrabber