FBVideoIn Class Reference

Basic video input class, supporting webcam and DV device. More...

#include <pyfbsdk.h>

Inheritance diagram for FBVideoIn:

Public Member Functions
	FBVideoIn ()
	Constructor.
int	LiveGetCompressor ()
	Get the current compressor index.
int	LiveGetCompressorCount ()
	Get the compressor count.
str	LiveGetCompressorName (int pCompressorIndex)
	Get the compressor name at a particular index.
int	LiveGetResolutionFR ()
	Get the current resolution and frame rate index.
int	LiveGetResolutionFRCount ()
	Get the number of resolution and frame rate available for the device.
str	LiveGetResolutionFRName (int pIndex)
	Get the resolution and frame rate string description at the specified index.
FBVideoLiveType	LiveGetType ()
	Get the type of the video input device.
bool	LiveSetCompressor (int pCompressorIndex)
	Set the current compressor to be used when recording.
	LiveSetResolutionFR (int pIndex)
	Set the current resolution and frame rate for the device.
Public Member Functions inherited from FBVideo
	FBVideo (str pName)
	Constructor.
Public Member Functions inherited from FBBox
	FBBox (str pName)
	Constructor.
bool	AnimationNodeDestroy (FBAnimationNode pAnimationNode)
	Destroy an animation node.
FBAnimationNode	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.
bool	AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
	Is the animation node user data?
FBAnimationNode	AnimationNodeOutGet ()
str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
FBAnimationNode	GetInConnector (int pIndex)
	Get the animation node input associated with the given index.
int	GetInConnectorCount ()
	Get the number of animation node inputs for this box.
FBAnimationNode	GetOutConnector (int pIndex)
	Get the animation node output associated with the given index.
int	GetOutConnectorCount ()
	Get the number of animation node outputs for this box.
Public Member Functions inherited from FBComponent
	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.

Public Attributes
str	FilePath
	Read Write Property: Location of the generated movie file after a recording session.
bool	Online
	Read Write Property: If true, the device is online and will display the current video feed.
bool	RecordAudio
	Read Write Property: If true, the device will also record audio during a recording session.
bool	Recording
	Read Write Property: If true, the device will record during a recording session.
Public Attributes inherited from FBVideo
bool	KeepOnGPU
	Read Write Property: Don't auto flush from GPU if true. session runtime flag, won't be saved.
Public Attributes inherited from FBBox
bool	Animatable
	Read Write Property: Is the box animatable.
bool	Live
	Read Write Property: Is live?
bool	RecordMode
	Read Write Property: Is recording?
str	UniqueName
	internal Unique name.
Public Attributes inherited from FBComponent
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.
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

Basic video input class, supporting webcam and DV device.

See sample: VideoInput.py.

Constructor & Destructor Documentation

FBVideoIn()

FBVideoIn

(

)

Constructor.

Member Function Documentation

LiveGetCompressor()

int LiveGetCompressor

(

)

Get the current compressor index.

Returns

Index of the current compressor.

LiveGetCompressorCount()

int LiveGetCompressorCount

(

)

Get the compressor count.

Returns

Number of available compressor.

LiveGetCompressorName()

str LiveGetCompressorName

(

int

pCompressorIndex

)

Get the compressor name at a particular index.

Returns

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

LiveGetResolutionFR()

int LiveGetResolutionFR

(

)

Get the current resolution and frame rate index.

Returns

Index of the current resolution and frame rate.

LiveGetResolutionFRCount()

int LiveGetResolutionFRCount

(

)

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

Returns

Number of available resolution and frame rate.

LiveGetResolutionFRName()

str LiveGetResolutionFRName

(

int

pIndex

)

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

Parameters

pIndex

Index of the resolution and frame rate.

Returns

Name of the resolution and frame rate.

LiveGetType()

FBVideoLiveType LiveGetType

(

)

Get the type of the video input device.

Returns

Type of the video input device.

LiveSetCompressor()

bool LiveSetCompressor

(

int

pCompressorIndex

)

Set the current compressor to be used when recording.

Parameters

pCompressorIndex

Index of the compressor.

Returns

True if successful.

LiveSetResolutionFR()

LiveSetResolutionFR

(

int

pIndex

)

Set the current resolution and frame rate for the device.

Parameters

pIndex

Index of the resolution and frame rate.

Member Data Documentation

FilePath

str FilePath

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

Online

bool Online

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

RecordAudio

bool RecordAudio

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

Recording

bool Recording

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