#include <mobu-python-api.h>

Class Description

Video Grabber class.

Used to grab video frames generated with the FBRenderer.

Inheritance diagram for FBVideoGrabber:

Public Member Functions
	__reduce__ ()

	__init__ (object arg1)
	Constructor. More...

bool	BeginGrab (FBVideoGrabber arg1)
	BeginGrab. More...

	EndGrab (FBVideoGrabber arg1)
	EndGrab. More...

str	GetLastErrorMsg (FBVideoGrabber arg1)
	GetLastErrorMsg. More...

FBVideoGrabOptions	GetOptions (FBVideoGrabber arg1)
	GetOptions give you a copy of current grabbing options. More...

object	GetStatistics (FBVideoGrabber arg1)
	GetStatistics. More...

	Grab (FBVideoGrabber arg1)
	Grab. More...

object	RenderSnapshot (FBVideoGrabber arg1, object arg2, object arg3, object arg4, object arg5, object arg6, object arg7, object arg8, object arg9, object arg10)
	Render a snapshot of the actual display. More...

	ResetOptions (FBVideoGrabber arg1)
	SetDefaultOptions. More...

	SetOptions (FBVideoGrabber arg1, FBVideoGrabOptions arg2)
	SetOptions. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Additional Inherited Members
Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

ORSDK2018::FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__ ( object arg1 )

Constructor.

Python Docstring:

__init__( (object)arg1) -> None

C++ Signature:

 FBVideoGrabber(HIObject pObject = ((void *) 0))

Parameters

pObject For internal use only.

See the C++ reference

__reduce__ ( )

bool BeginGrab ( FBVideoGrabber arg1 )

BeginGrab.

Python Docstring:

BeginGrab( (FBVideoGrabber)arg1) -> bool

C++ Signature:

bool BeginGrab()

Begin video grabbing session.

Returns: True if we can begin the grab session.

See the C++ reference

EndGrab ( FBVideoGrabber arg1 )

EndGrab.

Python Docstring:

EndGrab( (FBVideoGrabber)arg1) -> None

C++ Signature:

void EndGrab()

Close video grabbing session.

See the C++ reference

str GetLastErrorMsg ( FBVideoGrabber arg1 )

GetLastErrorMsg.

Python Docstring:

GetLastErrorMsg( (FBVideoGrabber)arg1) -> str

C++ Signature:

const char * GetLastErrorMsg()

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

See the C++ reference

FBVideoGrabOptions GetOptions ( FBVideoGrabber arg1 )

GetOptions give you a copy of current grabbing options.

Python Docstring:

GetOptions( (FBVideoGrabber)arg1) -> FBVideoGrabOptions

C++ Signature:

ORSDK2018::FBVideoGrabOptions GetOptions()

Returns: Struct that contain all grabbing options.

See the C++ reference

object GetStatistics ( FBVideoGrabber arg1 )

GetStatistics.

Python Docstring:

GetStatistics( (FBVideoGrabber)arg1) -> object

C++ Signature:

ORSDK2018::FBVideoGrabStats GetStatistics()

Returns: Struct that contain all grabbing statistics.

See the C++ reference

Grab ( FBVideoGrabber arg1 )

Grab.

Python Docstring:

Grab( (FBVideoGrabber)arg1) -> None

C++ Signature:

void Grab()

Grab all specified video frames.

See the C++ reference

object RenderSnapshot	(	FBVideoGrabber	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		object	arg5,
		object	arg6,
		object	arg7,
		object	arg8,
		object	arg9,
		object	arg10
	)

Render a snapshot of the actual display.

Python Docstring:

RenderSnapshot( (FBVideoGrabber)arg1 [, (object)arg2 [, (object)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6 [, (object)arg7 [, (object)arg8 [, (object)arg9 [, (object)arg10]]]]]]]]]) -> object

C++ Signature:

ORSDK2018::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)

Parameters

pWidth
pHeight
pCameraLabel
pTimeCode
pSafeArea
pAxis
pGrid
pFrontPlate
pBackPlate

Returns: An FBimage containing data of the rendered snapshot.

See the C++ reference

ResetOptions ( FBVideoGrabber arg1 )

SetDefaultOptions.

Python Docstring:

ResetOptions( (FBVideoGrabber)arg1) -> None

C++ Signature:

void ResetOptions()

This function reset all grabbing options to the default value.

See the C++ reference

SetOptions	(	FBVideoGrabber	arg1,
		FBVideoGrabOptions	arg2
	)

SetOptions.

Python Docstring:

SetOptions( (FBVideoGrabber)arg1, (FBVideoGrabOptions)arg2) -> None

C++ Signature:

void SetOptions(ORSDK2018::FBVideoGrabOptions * pOptions)

Parameters

pOptions Struct that contain all grabbing options.

See the C++ reference

FBVideoGrabber Class Reference

Class Description

Public Member Functions

Additional Inherited Members

Member Function Documentation