Video clip media class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBVideoClip:

[legend]

Public Member Functions
	FBVideoClip (str pName)
	Constructor.

	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.

	FBDelete ()
	Open Reality deletion function.

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

int	GetTextureID ()
	Get the texture ID.

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

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
int	CurrentFrame
	Read Write Property: Current frame.

FBTime	CurrentFrameTime
	Read Write Property: Current time in clip.

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

FBTime	CustomEmbeddedStartTimecode
	Read Write Property:The custom timecode of the first frame of the video. To be effective, the ShowEmbeddedTimecode and UseCustomEmbeddedStartTimecode properties must be active.

str	Filename
	Read Write Property: Filename of media.

FBVideoFormat	Format
	Read Only Property: Video format.

float	FrameRate
	Read Write Property: Frame rate.

FBTime	FrameTime
	Read Only Property: Inverse of FPS, time per frame

bool	FreeRunning
	Read Write Property: Is free Running on?

int	Height
	Read Only Property: Height of image.

FBVideoInterlaceMode	InterlaceMode
	Read Write Property: Interlace mode.

int	LastFrame
	Read Only Property: Last frame in clip.

FBTime	LastFrameTime
	Read Only Property: Time of last frame

bool	Loop
	Read Write Property: Loop video clip?

float	PlaySpeed
	Read Write Property: Playback speed.

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

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

FBVideoProxyMode	ProxyMode
	Read Write Property: Proxy mode.

str	RelativePath
	Read Only Property: Relative path of media.

bool	ShowEmbeddedTimecode
	Read Write Property: True if the video clip is showing its embedded timecode (real, if available, or custom), false if showing a timecode starting at 00:00:00:00 (00).

int	StartFrame
	Read Write Property: Frame to begin video playback from.

int	StopFrame
	Read Write Property: Frame to end video playback at.

FBVideoStorageMode	StorageMode
	Read Write Property: Storage mode.

FBTime	TimeOffset
	Read Write Property: Temporal offset for beginning of video.

bool	UseCustomEmbeddedStartTimecode
	Read Write Property: True if the video clip is using the custom embedded start timecode value, false if it is using the real embedded timecode, if available.

int	Width
	Read Only Property: Width of image.

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

Video clip media class.

See sample: VideoClip.py.

Constructor & Destructor Documentation

◆ FBVideoClip()

FBVideoClip ( str pName )

Constructor.

Parameters

pName Name of video media.

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

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.

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

FBDelete ( )

Open Reality deletion function.

See sample: DeleteHierarchy.py.

◆ GetEmbeddedTimecode()

bool GetEmbeddedTimecode	(	int	pFrame,
		FBTimeCode	pTimeCode
	)

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

◆ GetTextureID()

int GetTextureID ( )

Get the texture ID.

Returns: ID of the texture

◆ IsValid()

bool IsValid ( )

Verifies the validity of the FBVideo object.

Returns: true if data is valid.

Member Data Documentation

◆ CurrentFrame

int CurrentFrame

Read Write Property: Current frame.

◆ CurrentFrameTime

FBTime CurrentFrameTime

Read Write Property: Current time in clip.

◆ CurrentFrameTimeCode

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

◆ CustomEmbeddedStartTimecode

FBTime CustomEmbeddedStartTimecode

Read Write Property:The custom timecode of the first frame of the video. To be effective, the ShowEmbeddedTimecode and UseCustomEmbeddedStartTimecode properties must be active.

◆ Filename

str Filename

Read Write Property: Filename of media.

◆ Format

FBVideoFormat Format

Read Only Property: Video format.

◆ FrameRate

float FrameRate

Read Write Property: Frame rate.

◆ FrameTime

FBTime FrameTime

Read Only Property: Inverse of FPS, time per frame

◆ FreeRunning

bool FreeRunning

Read Write Property: Is free Running on?

◆ Height

int Height

Read Only Property: Height of image.

◆ InterlaceMode

FBVideoInterlaceMode InterlaceMode

Read Write Property: Interlace mode.

◆ LastFrame

int LastFrame

Read Only Property: Last frame in clip.

◆ LastFrameTime

FBTime LastFrameTime

Read Only Property: Time of last frame

◆ Loop

bool Loop

Read Write Property: Loop video clip?

◆ PlaySpeed

float PlaySpeed

Read Write Property: Playback speed.

◆ PowerOfTwoHeight

int PowerOfTwoHeight

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

◆ PowerOfTwoWidth

int PowerOfTwoWidth

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

◆ ProxyMode

FBVideoProxyMode ProxyMode

Read Write Property: Proxy mode.

◆ RelativePath

str RelativePath

Read Only Property: Relative path of media.

◆ ShowEmbeddedTimecode

bool ShowEmbeddedTimecode

Read Write Property: True if the video clip is showing its embedded timecode (real, if available, or custom), false if showing a timecode starting at 00:00:00:00 (00).

◆ StartFrame

int StartFrame

Read Write Property: Frame to begin video playback from.

◆ StopFrame

int StopFrame

Read Write Property: Frame to end video playback at.

◆ StorageMode

FBVideoStorageMode StorageMode

Read Write Property: Storage mode.

◆ TimeOffset

FBTime TimeOffset

Read Write Property: Temporal offset for beginning of video.

◆ UseCustomEmbeddedStartTimecode

bool UseCustomEmbeddedStartTimecode

Read Write Property: True if the video clip is using the custom embedded start timecode value, false if it is using the real embedded timecode, if available.

◆ Width

int Width

Read Only Property: Width of image.

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FBVideoClip()

Member Function Documentation

◆ DrawImage()

◆ FBDelete()

◆ GetEmbeddedTimecode()

◆ GetTextureID()

◆ IsValid()

Member Data Documentation

◆ CurrentFrame

◆ CurrentFrameTime

◆ CurrentFrameTimeCode

◆ CustomEmbeddedStartTimecode

◆ Filename

◆ Format

◆ FrameRate

◆ FrameTime

◆ FreeRunning

◆ Height

◆ InterlaceMode

◆ LastFrame

◆ LastFrameTime

◆ Loop

◆ PlaySpeed

◆ PowerOfTwoHeight

◆ PowerOfTwoWidth

◆ ProxyMode

◆ RelativePath

◆ ShowEmbeddedTimecode

◆ StartFrame

◆ StopFrame

◆ StorageMode

◆ TimeOffset

◆ UseCustomEmbeddedStartTimecode

◆ Width