Video clip media class. More...

#include <fbvideo.h>

Inheritance diagram for FBVideoClip:

[legend]

Public Member Functions
	FBVideoClip (const char *pName, HIObject pObject=NULL)
	Constructor. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

bool	IsValid ()
	Verifies the validity of the FBVideo object. More...

virtual void	DrawImage (int pX=0, int pY=0, int pW=-1, int pH=-1, int pFrame=-1)
	Draw a frame of the image to the current view. More...

virtual unsigned char *	GetImage (int pFrame=-1)
	Get the current image buffer. More...

virtual void	ImageIncUpdateID ()
	Increase Image update id after modification to trigger internal state refresh. More...

virtual unsigned char *	GetPowerOfTwoImage ()
	Get the current image buffer resized with width and height power of two. More...

int	GetTextureID ()
	Get the texture ID. More...

virtual bool	GetEmbeddedTimecode (int pFrame, FBTimeCode &pTimeCode)
	Get the embedded timecode associated to a video clip frame. More...

Public Member Functions inherited from FBVideo
	FBVideo (const char *pName, HIObject pObject=NULL)
	Constructor. More...

Public Member Functions inherited from FBBox
	FBBox (const char *pName, HIObject pObject=NULL)
	Constructor. More...

virtual FBAnimationNode *	AnimationNodeInCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)
	Creation of IN/OUT Animation Nodes. More...

virtual FBAnimationNode *	AnimationNodeOutCreate (kReference pUserId, const char pName, const char pDataType, bool pIsPublic=false, double pMin=NULL, double pMax=NULL, bool pUserData=false)

virtual bool	EvaluateAnimationNodes (FBEvaluateInfo *pEvaluateInfo)
	Evaluation of non TRS nodes that needs to be evaluated. More...

virtual bool	AnimationNodeNotify (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Notification function for animation thread. More...

virtual bool	ResolveCandidate (FBAnimationNode pAnimationNode, FBEvaluateInfo pEvaluateInfo)
	Function is call when candidate needs to be resolved (like global to local). More...

virtual ECandidateAction	SetGlobalCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a global candidate is set on an animation node. More...

virtual ECandidateAction	SetStdCandidate (FBAnimationNode pAnimationNode, double pData, FBEvaluateInfo *pEvaluateInfo)
	Function is call when a non-global candidate is set on an animation node. More...

virtual bool	FbxStore (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)
	Storage/Retrieval of information into the FBX file format. More...

virtual bool	FbxRetrieve (FBFbxObject *pFbxObject, kFbxObjectStore pStoreWhat)

virtual bool	AnimationNodeDestroy (FBAnimationNode *pAnimationNode)
	Destroy an animation node. More...

virtual bool	AnimationNodeIsUserData (FBAnimationNode *pAnimationNode)
	Is the animation node user data? More...

virtual void	AnimationNodesOutDisableIfNotWritten (FBEvaluateInfo *pEvaluateInfo)
	This call will disable all out animation nodes from being pull by system (animation thread) for given pEvaluateInfo. More...

virtual FBAnimationNode *	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box. More...

virtual FBAnimationNode *	AnimationNodeOutGet ()

virtual const char *	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'. More...

virtual const char *	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'. More...

	IObject_Declare (override)

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

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

virtual FBAnimationNode *	GetOutConnector (int pIndex) const
	Get the animation node output associated with the given index. More...

virtual FBAnimationNode *	GetInConnector (int pIndex) const
	Get the animation node input associated with the given index. More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

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

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyString	Filename
	Read Write Property: Filename of media. More...

FBPropertyString	RelativePath
	Read Only Property: Relative path of media. More...

FBPropertyVideoProxyMode	ProxyMode
	Read Write Property: Proxy mode. More...

FBPropertyVideoStorageMode	StorageMode
	Read Write Property: Storage mode. More...

FBPropertyInt	Width
	Read Only Property: Width of image. More...

FBPropertyInt	Height
	Read Only Property: Height of image. More...

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

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

FBPropertyVideoInterlaceMode	InterlaceMode
	Read Write Property: Interlace mode. More...

FBPropertyVideoFormat	Format
	Read Only Property: Video format. More...

FBPropertyTime	TimeOffset
	Read Write Property: Temporal offset for beginning of video. 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...

FBPropertyDouble	FrameRate
	Read Write Property: Frame rate. More...

FBPropertyDouble	PlaySpeed
	Read Write Property: Playback speed. More...

FBPropertyBool	FreeRunning
	Read Write Property: Is free Running on? More...

FBPropertyBool	Loop
	Read Write Property: Loop video clip? More...

FBPropertyTime	FrameTime
	Read Only Property: Inverse of FPS, time per frame More...

FBPropertyInt	CurrentFrame
	Read Write Property: Current frame. More...

FBPropertyInt	LastFrame
	Read Only Property: Last frame in clip. More...

FBPropertyTime	LastFrameTime
	Read Only Property: Time of last frame More...

FBPropertyTime	CurrentFrameTime
	Read Write Property: Current time in clip. More...

FBPropertyTime	CurrentFrameTimeCode
	Read Only Property: Embedded timecode from current frame in clip. Use the method GetEmbeddedTimecode to get the timecode of a different frame than the current frame. More...

Public Attributes inherited from FBVideo
FBPropertyBool	KeepOnGPU
	Read Write Property: Don't auto flush from GPU if true. session runtime flag, won't be saved. More...

Public Attributes inherited from FBBox
const char *	UniqueName
	internal Unique name. More...

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...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

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

FBPropertyListComponent	Parents
	List: Parents. More...

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

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

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

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Public Types inherited from FBBox
enum	ECandidateAction { eCandidateAccept , eCandidateIntercept , eCandidateInterceptAfterEvaluation }
	Resolving action for candidates. More...

Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

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

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

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

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

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

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

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

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

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

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Video clip media class.

Definition at line 192 of file fbvideo.h.

Constructor & Destructor Documentation

◆ FBVideoClip()

FBVideoClip	(	const char *	pName,
		HIObject	pObject = `NULL`
	)

Constructor.

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.

Member Function Documentation

◆ DrawImage()

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

virtual

Draw a frame of the image to the current view.

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).

◆ FBDelete()

virtual void FBDelete ( )

overridevirtual

Open Reality deletion function.

Reimplemented from FBComponent.

◆ GetEmbeddedTimecode()

virtual bool GetEmbeddedTimecode	(	int	pFrame,
		FBTimeCode &	pTimeCode
	)

virtual

Get the embedded timecode associated to a video clip frame.

Parameters

pFrame	Video clip frame to get timecode for.
pTimeCode	The timecode object being filled by this method.

Returns: True if an embedded timecode is retrieved from the video clip, false otherwise. (Python: If no embedded timecode is retrieved, returns an FBTimeCode object with its time set to FBTime::Infinity).

◆ GetImage()

virtual unsigned char* GetImage ( int pFrame = -1 )

virtual

Get the current image buffer.

Parameters

pFrame Frame to get image for (default=-1).

Returns: Handle to the image buffer specified by the pFrame parameter.

◆ GetPowerOfTwoImage()

virtual unsigned char* GetPowerOfTwoImage ( )

virtual

Get the current image buffer resized with width and height power of two.

Returns: Handle to the image buffer specified by the pFrame parameter.

◆ GetTextureID()

int GetTextureID ( )

Get the texture ID.

Returns: ID of the texture

◆ ImageIncUpdateID()

virtual void ImageIncUpdateID ( )

virtual

Increase Image update id after modification to trigger internal state refresh.

◆ IsValid()

bool IsValid ( )

Verifies the validity of the FBVideo object.

Returns: true if data is valid.

Member Data Documentation

◆ CurrentFrame

FBPropertyInt CurrentFrame

Read Write Property: Current frame.

Definition at line 233 of file fbvideo.h.

◆ CurrentFrameTime

FBPropertyTime CurrentFrameTime

Read Write Property: Current time in clip.

Definition at line 236 of file fbvideo.h.

◆ CurrentFrameTimeCode

FBPropertyTime CurrentFrameTimeCode

Read Only Property: Embedded timecode from current frame in clip. Use the method GetEmbeddedTimecode to get the timecode of a different frame than the current frame.

Definition at line 238 of file fbvideo.h.

◆ Filename

FBPropertyString Filename

Read Write Property: Filename of media.

Definition at line 212 of file fbvideo.h.

◆ Format

FBPropertyVideoFormat Format

Read Only Property: Video format.

Definition at line 221 of file fbvideo.h.

◆ FrameRate

FBPropertyDouble FrameRate

Read Write Property: Frame rate.

Definition at line 227 of file fbvideo.h.

◆ FrameTime

FBPropertyTime FrameTime

Read Only Property: Inverse of FPS, time per frame

Definition at line 232 of file fbvideo.h.

◆ FreeRunning

FBPropertyBool FreeRunning

Read Write Property: Is free Running on?

Definition at line 229 of file fbvideo.h.

◆ Height

FBPropertyInt Height

Read Only Property: Height of image.

Definition at line 217 of file fbvideo.h.

◆ InterlaceMode

FBPropertyVideoInterlaceMode InterlaceMode

Read Write Property: Interlace mode.

Definition at line 220 of file fbvideo.h.

◆ LastFrame

FBPropertyInt LastFrame

Read Only Property: Last frame in clip.

Definition at line 234 of file fbvideo.h.

◆ LastFrameTime

FBPropertyTime LastFrameTime

Read Only Property: Time of last frame

Definition at line 235 of file fbvideo.h.

◆ Loop

FBPropertyBool Loop

Read Write Property: Loop video clip?

Definition at line 230 of file fbvideo.h.

◆ PlaySpeed

FBPropertyDouble PlaySpeed

Read Write Property: Playback speed.

Definition at line 228 of file fbvideo.h.

◆ PowerOfTwoHeight

FBPropertyInt PowerOfTwoHeight

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

Definition at line 219 of file fbvideo.h.

◆ PowerOfTwoWidth

FBPropertyInt PowerOfTwoWidth

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

Definition at line 218 of file fbvideo.h.

◆ ProxyMode

FBPropertyVideoProxyMode ProxyMode

Read Write Property: Proxy mode.

Definition at line 214 of file fbvideo.h.

◆ RelativePath

FBPropertyString RelativePath

Read Only Property: Relative path of media.

Definition at line 213 of file fbvideo.h.

◆ StartFrame

FBPropertyInt StartFrame

Read Write Property: Frame to begin video playback from.

Definition at line 225 of file fbvideo.h.

◆ StopFrame

FBPropertyInt StopFrame

Read Write Property: Frame to end video playback at.

Definition at line 226 of file fbvideo.h.

◆ StorageMode

FBPropertyVideoStorageMode StorageMode

Read Write Property: Storage mode.

Definition at line 215 of file fbvideo.h.

◆ TimeOffset

FBPropertyTime TimeOffset

Read Write Property: Temporal offset for beginning of video.

Definition at line 224 of file fbvideo.h.

◆ Width

FBPropertyInt Width

Read Only Property: Width of image.

Definition at line 216 of file fbvideo.h.

The documentation for this class was generated from the following file:

fbvideo.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBVideoClip()

Member Function Documentation

◆ DrawImage()

◆ FBDelete()

◆ GetEmbeddedTimecode()

◆ GetImage()

◆ GetPowerOfTwoImage()

◆ GetTextureID()

◆ ImageIncUpdateID()

◆ IsValid()

Member Data Documentation

◆ CurrentFrame

◆ CurrentFrameTime

◆ CurrentFrameTimeCode

◆ Filename

◆ Format

◆ FrameRate

◆ FrameTime

◆ FreeRunning

◆ Height

◆ InterlaceMode

◆ LastFrame

◆ LastFrameTime

◆ Loop

◆ PlaySpeed

◆ PowerOfTwoHeight

◆ PowerOfTwoWidth

◆ ProxyMode

◆ RelativePath

◆ StartFrame

◆ StopFrame

◆ StorageMode

◆ TimeOffset

◆ Width