#include <mobu-python-api.h>

Class Description

Basic video input class, supporting webcam and DV device.

Inheritance diagram for FBVideoIn:

Public Member Functions
	__reduce__ ()

	LiveSetCompressor (FBVideoIn arg1, object arg2)
	Set the current compressor to be used when recording. More...

	__init__ (object arg1)
	Constructor. More...

int	LiveGetCompressor (FBVideoIn arg1)
	Get the current compressor index. More...

int	LiveGetCompressorCount (FBVideoIn arg1)
	Get the compressor count. More...

str	LiveGetCompressorName (FBVideoIn arg1, object arg2)
	Get the compressor name at a particular index. More...

	LiveSetResolutionFR (FBVideoIn arg1, object arg2)
	Set the current resolution and frame rate for the device. More...

int	LiveGetResolutionFR (FBVideoIn arg1)
	Get the current resolution and frame rate index. More...

int	LiveGetResolutionFRCount (FBVideoIn arg1)
	Get the number of resolution and frame rate available for the device. More...

str	LiveGetResolutionFRName (FBVideoIn arg1, object arg2)
	Get the resolution and frame rate string description at the specified index. More...

FBVideoLiveType	LiveGetType (FBVideoIn arg1)
	Get the type of the video input device. More...

Public Member Functions inherited from FBVideo
	__reduce__ ()

	__init__ (object arg1, str arg2)
	Constructor. More...

Public Member Functions inherited from FBBox
	__reduce__ ()

bool	AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
	Destroy an animation node. More...

	__init__ (object arg1, str arg2)
	Constructor. More...

object	AnimationNodeInGet (FBBox arg1)
	Get the (IN/OUT) animation node for this box. More...

bool	AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
	Is the animation node user data? More...

object	AnimationNodeOutGet (FBBox arg1)

int	GetOutConnectorCount (FBBox arg1)
	Get the number of animation node outputs for this box. More...

int	GetInConnectorCount (FBBox arg1)
	Get the number of animation node inputs for this box. More...

object	GetOutConnector (FBBox arg1, object arg2)
	Get the animation node output associated with the given index. More...

object	GetInConnector (FBBox arg1, object arg2)
	Get the animation node input associated with the given index. 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__ (...)

Public Attributes
FBPropertyBool	Online
	Read Write Property: If true, the device is online and will display the current video feed. More...

FBPropertyBool	Recording
	Read Write Property: If true, the device will record during a recording session. More...

FBPropertyBool	RecordAudio
	Read Write Property: If true, the device will also record audio during a recording session. More...

ORSDK2018::FBPropertyString	FilePath
	Read Write Property: Location of the generated movie file after a recording session. More...

Public Attributes inherited from FBVideo
FBPropertyBool	KeepOnGPU
	Read Write Property: Don't auto flush from GPU if true. More...

Public Attributes inherited from FBBox
FBPropertyBool	Animatable
	Read Write Property: Is the box animatable. More...

FBPropertyBool	Live
	Read Write Property: Is live? More...

FBPropertyBool	RecordMode
	Read Write Property: Is recording? More...

const char *	UniqueName
	internal Unique name. More...

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:

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

Parameters

pObject Internal parent object.

See the C++ reference

__reduce__ ( )

int LiveGetCompressor ( FBVideoIn arg1 )

Get the current compressor index.

Python Docstring:

LiveGetCompressor( (FBVideoIn)arg1) -> int

C++ Signature:

int LiveGetCompressor()

Returns: Index of the current compressor.

See the C++ reference

int LiveGetCompressorCount ( FBVideoIn arg1 )

Get the compressor count.

Python Docstring:

LiveGetCompressorCount( (FBVideoIn)arg1) -> int

C++ Signature:

int LiveGetCompressorCount()

Returns: Number of available compressor.

See the C++ reference

str LiveGetCompressorName	(	FBVideoIn	arg1,
		object	arg2
	)

Get the compressor name at a particular index.

Python Docstring:

LiveGetCompressorName( (FBVideoIn)arg1, (object)arg2) -> str

C++ Signature:

const char * LiveGetCompressorName(int pCompressorIndex)

Returns: Name of the compressor. If the pCompressorIndex is higher than the number of compressor, the function will return NULL.

See the C++ reference

int LiveGetResolutionFR ( FBVideoIn arg1 )

Get the current resolution and frame rate index.

Python Docstring:

LiveGetResolutionFR( (FBVideoIn)arg1) -> int

C++ Signature:

int LiveGetResolutionFR()

Returns: Index of the current resolution and frame rate.

See the C++ reference

int LiveGetResolutionFRCount ( FBVideoIn arg1 )

Get the number of resolution and frame rate available for the device.

Python Docstring:

LiveGetResolutionFRCount( (FBVideoIn)arg1) -> int

C++ Signature:

int LiveGetResolutionFRCount()

Returns: Number of available resolution and frame rate.

See the C++ reference

str LiveGetResolutionFRName	(	FBVideoIn	arg1,
		object	arg2
	)

Get the resolution and frame rate string description at the specified index.

Python Docstring:

LiveGetResolutionFRName( (FBVideoIn)arg1, (object)arg2) -> str

C++ Signature:

const char * LiveGetResolutionFRName(int pIndex)

Parameters

pIndex Index of the resolution and frame rate.

Returns: Name of the resolution and frame rate.

See the C++ reference

FBVideoLiveType LiveGetType ( FBVideoIn arg1 )

Get the type of the video input device.

Python Docstring:

LiveGetType( (FBVideoIn)arg1) -> FBVideoLiveType

C++ Signature:

FBVideoLiveType LiveGetType()

Returns: Type of the video input device.

See the C++ reference

LiveSetCompressor	(	FBVideoIn	arg1,
		object	arg2
	)

Set the current compressor to be used when recording.

Python Docstring:

LiveSetCompressor( (FBVideoIn)arg1, (object)arg2) -> None

C++ Signature:

bool LiveSetCompressor(int pCompressorIndex)

Parameters

pCompressorIndex Index of the compressor.

Returns: True if successful.

See the C++ reference

LiveSetResolutionFR	(	FBVideoIn	arg1,
		object	arg2
	)

Set the current resolution and frame rate for the device.

Python Docstring:

LiveSetResolutionFR( (FBVideoIn)arg1, (object)arg2) -> None

C++ Signature:

void LiveSetResolutionFR(int pIndex)

Parameters

pIndex Index of the resolution and frame rate.

See the C++ reference

Member Data Documentation

ORSDK2018::FBPropertyString FilePath

Read Write Property: Location of the generated movie file after a recording session.

See the C++ reference

FBPropertyBool Online

Read Write Property: If true, the device is online and will display the current video feed.

See the C++ reference

FBPropertyBool RecordAudio

Read Write Property: If true, the device will also record audio during a recording session.

See the C++ reference

FBPropertyBool Recording

Read Write Property: If true, the device will record during a recording session.

See the C++ reference

FBVideoIn Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation