Video Grabber class. More...
#include <pyfbsdk_generated.h>
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. | |
![]() | |
FBComponent () | |
Constructor. | |
str | ClassName () |
Get the class name. | |
DisableObjectFlags (FBObjectFlag pFlags) | |
Disable a specific Object Flags. | |
EnableObjectFlags (FBObjectFlag pFlags) | |
Enable a specific Object Flags. | |
bool | FBCreate () |
Open Reality Creation function. | |
FBDelete () | |
Open Reality deletion function. | |
FBDestroy () | |
Open Reality destruction function. | |
FBObjectFlag | GetObjectFlags () |
Get all Object Flags (concatenated). | |
bool | GetObjectStatus (FBObjectStatus pStatus) |
Check to see if an object status is enabled. | |
FBFileReference | GetOwnerFileReference (p0) |
Get the owner FileReference object. | |
HardSelect () | |
HardSelect. | |
bool | HasObjectFlags (FBObjectFlag pFlags) |
Check whether a specific object flag is enabled. | |
bool | Is (int pTypeId) |
Returns true if object is of type TypeId. | |
bool | ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
ProcessNamespaceHierarchy. | |
bool | ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True) |
ProcessObjectNamespace. | |
int | PropertyAdd (FBProperty pProperty) |
Add a property to the component's property manager. | |
bool | PropertyAddReferenceProperty (FBProperty pReferenceProperty) |
Add a reference property to the component's property manager. | |
FBProperty | PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None) |
Create user or dynamic property. | |
PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags) | |
Get list of properties which have been modified since last loading. | |
PropertyRemove (FBProperty pProperty) | |
Remove a Property from the component's Property manager. | |
SetObjectFlags (FBObjectFlag pFlags) | |
SetObjectFlags. | |
SetObjectStatus (FBObjectStatus pStatus, bool pValue) | |
Enable/Disable a specific Object Status. | |
Additional Inherited Members | |
![]() | |
FBListComponent | Components |
List: List of components. | |
str | LongName |
Read Write Property: Name and namespace for object. | |
str | Name |
Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py. | |
FBListComponent | Parents |
List: Parents. | |
FBManager | PropertyList |
Read Only Property: Manages all of the properties for the component. | |
bool | Selected |
Read Write Property: Selected property. | |
int | TypeInfo |
Contains the Type information of the object. | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
Video Grabber class.
Used to grab video frames generated with the FBRenderer.
See samples: codecExamples.py, render.py, RenderLayers.py, JpegRender.py.
FBVideoGrabber | ( | ) |
Constructor.
bool BeginGrab | ( | ) |
BeginGrab.
Begin video grabbing session.
EndGrab | ( | ) |
EndGrab.
Close video grabbing session.
str GetLastErrorMsg | ( | ) |
GetLastErrorMsg.
FBVideoGrabOptions GetOptions | ( | ) |
GetOptions give you a copy of current grabbing options.
FBVideoGrabStats GetStatistics | ( | ) |
GetStatistics.
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.
ResetOptions | ( | ) |
SetDefaultOptions.
This function reset all grabbing options to the default value.
SetOptions | ( | FBVideoGrabOptions | pOptions | ) |
SetOptions.
pOptions | Struct that contain all grabbing options. |