FBVideoClip Class Reference

#include <mobu-python-api.h>

Class Description

See the C++ reference

Inheritance diagram for FBVideoClip:

Public Member Functions
	__reduce__ ()
	__init__ (object arg1, str arg2)
	Constructor. More...
	DrawImage (FBVideoClip arg1, object arg2, object arg3, object arg4, object arg5, object arg6)
	Draw a frame of the image to the current view. More...
	FBDelete (FBVideoClip arg1)
	Open Reality deletion function. More...
bool	IsValid (FBVideoClip arg1)
	Verifies the validity of the FBVideo object. More...
int	GetTextureID (FBVideoClip arg1)
	Get the texture ID. More...
FBTimeCode	GetEmbeddedTimecode (FBVideoClip arg1, object arg2)
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
FBPropertyInt	CurrentFrame
	Read Write Property: Current frame. More...
FBPropertyTime	CurrentFrameTime
	Read Write Property: Current time in clip. More...
FBPropertyTime	CurrentFrameTimeCode
	Read Only Property: Embedded timecode from current frame in clip. More...
ORSDK2018::FBPropertyString	Filename
	Read Write Property: Filename of media. More...
ORSDK2018::FBPropertyString	RelativePath
	Read Only Property: Relative path of media. More...
FBPropertyVideoFormat	Format
	Read Only Property: Video format. More...
FBPropertyTime	FrameTime
	Read Only Property: Inverse of FPS, time per frame More...
FBPropertyBool	FreeRunning
	Read Write Property: Is free Running on? More...
FBPropertyInt	Height
	Read Only Property: Height of image. More...
FBPropertyVideoInterlaceMode	InterlaceMode
	Read Write Property: Interlace mode. More...
FBPropertyInt	LastFrame
	Read Only Property: Last frame in clip. More...
FBPropertyTime	LastFrameTime
	Read Only Property: Time of last frame More...
FBPropertyBool	Loop
	Read Write Property: Loop video clip? More...
FBPropertyDouble	PlaySpeed
	Read Write Property: Playback speed. More...
FBPropertyInt	PowerOfTwoHeight
	Read Only Property: Closest power of two value superior to height of image. More...
FBPropertyInt	PowerOfTwoWidth
	Read Only Property: Closest power of two value superior to width of image. More...
FBPropertyVideoProxyMode	ProxyMode
	Read Write Property: Proxy mode. More...
FBPropertyInt	StartFrame
	Read Write Property: Frame to begin video playback from. More...
FBPropertyInt	StopFrame
	Read Write Property: Frame to end video playback at. More...
FBPropertyVideoStorageMode	StorageMode
	Read Write Property: Storage mode. More...
FBPropertyTime	TimeOffset
	Read Write Property: Temporal offset for beginning of video. More...
FBPropertyInt	Width
	Read Only Property: Width of image. More...
FBPropertyDouble	FrameRate
	Read Write Property: Frame rate. 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,
		str	arg2
	)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None 

C++ Signature:

 FBVideoClip(const char * pName, HIObject pObject = ((void *) 0)) 

Parameters

pName	Name of video media.
pObject	Internal parent object(default=NULL).

Warning

The pName parameter must point to a valid media file, otherwise the object will not be valid. Use the method 'IsValid()' to confirm the object status.

See the C++ reference

__reduce__

(

)

DrawImage	(	FBVideoClip	arg1,
		object	arg2,
		object	arg3,
		object	arg4,
		object	arg5,
		object	arg6
	)

Draw a frame of the image to the current view.

Python Docstring:

DrawImage( (FBVideoClip)arg1 [, (object)arg2 [, (object)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6]]]]]) -> None 

C++ Signature:

void DrawImage(int pX = 0, int pY = 0, int pW = -1, int pH = -1, int pFrame = -1) 

Parameters

pX	X position of image (default=0).
pY	Y position of image (default=0).
pW	Width of image (default=-1).
pH	Height of image (default=-1).
pFrame	Frame to draw (default=-1).

See the C++ reference

FBDelete

(

FBVideoClip

arg1

)

Open Reality deletion function.

Python Docstring:

FBDelete( (FBVideoClip)arg1) -> None 

C++ Signature:

void FBDelete() 

See the C++ reference

FBTimeCode GetEmbeddedTimecode	(	FBVideoClip	arg1,
		object	arg2
	)

Python Docstring:

GetEmbeddedTimecode( (FBVideoClip)arg1, (object)arg2) -> FBTimeCode 

int GetTextureID

(

FBVideoClip

arg1

)

Get the texture ID.

Python Docstring:

GetTextureID( (FBVideoClip)arg1) -> int 

C++ Signature:

int GetTextureID() 

Returns

ID of the texture

See the C++ reference

bool IsValid

(

FBVideoClip

arg1

)

Verifies the validity of the FBVideo object.

Python Docstring:

IsValid( (FBVideoClip)arg1) -> bool 

C++ Signature:

bool IsValid() 

Returns

true if data is valid.

See the C++ reference

Member Data Documentation

FBPropertyInt CurrentFrame

Read Write Property: Current frame.

See the C++ reference

FBPropertyTime CurrentFrameTime

Read Write Property: Current time in clip.

See the C++ reference

FBPropertyTime CurrentFrameTimeCode

Read Only Property: Embedded timecode from current frame in clip.

See the C++ reference

ORSDK2018::FBPropertyString Filename

Read Write Property: Filename of media.

See the C++ reference

FBPropertyVideoFormat Format

Read Only Property: Video format.

See the C++ reference

FBPropertyDouble FrameRate

Read Write Property: Frame rate.

See the C++ reference

FBPropertyTime FrameTime

Read Only Property: Inverse of FPS, time per frame

See the C++ reference

FBPropertyBool FreeRunning

Read Write Property: Is free Running on?

See the C++ reference

FBPropertyInt Height

Read Only Property: Height of image.

See the C++ reference

FBPropertyVideoInterlaceMode InterlaceMode

Read Write Property: Interlace mode.

See the C++ reference

FBPropertyInt LastFrame

Read Only Property: Last frame in clip.

See the C++ reference

FBPropertyTime LastFrameTime

Read Only Property: Time of last frame

See the C++ reference

FBPropertyBool Loop

Read Write Property: Loop video clip?

See the C++ reference

FBPropertyDouble PlaySpeed

Read Write Property: Playback speed.

See the C++ reference

FBPropertyInt PowerOfTwoHeight

Read Only Property: Closest power of two value superior to height of image.

See the C++ reference

FBPropertyInt PowerOfTwoWidth

Read Only Property: Closest power of two value superior to width of image.

See the C++ reference

FBPropertyVideoProxyMode ProxyMode

Read Write Property: Proxy mode.

See the C++ reference

ORSDK2018::FBPropertyString RelativePath

Read Only Property: Relative path of media.

See the C++ reference

FBPropertyInt StartFrame

Read Write Property: Frame to begin video playback from.

See the C++ reference

FBPropertyInt StopFrame

Read Write Property: Frame to end video playback at.

See the C++ reference

FBPropertyVideoStorageMode StorageMode

Read Write Property: Storage mode.

See the C++ reference

FBPropertyTime TimeOffset

Read Write Property: Temporal offset for beginning of video.

See the C++ reference

FBPropertyInt Width

Read Only Property: Width of image.

See the C++ reference