FBVideo Class Reference


Detailed Description

Video media class.

Similar to the FBModel class, the FBVideo class serves as a general media class for images, video clips and video memory, as well as the possibility of custom formats and custom live cards.

Warning:
To have a valid FBVideo object, it must be constructed with a string pointing to a valid media file. After the creation, the method 'IsValid()' should be used to confirm the object's status. An invalid object cannot be used or interact with any other application object. The only property that can be read and modified is its 'Filename'. To make convert an invalid FBVideo object into a valid one, simply change its Filename property to point to a supported media file.
Examples
Tasks/DeleteUnusedMedia.py
Inheritance diagram for FBVideo:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.

Public Attributes

FBPropertyBase KeepOnGPU
 Read Write Property: Don't auto flush from GPU if true.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of video media.
pObjectInternal 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.
Examples
Tasks/DeleteUnusedMedia.py

Reimplemented from FBBox.

Reimplemented in FBVideoClip, and FBVideoClipImage.


Member Data Documentation

FBPropertyBase KeepOnGPU

Read Write Property: Don't auto flush from GPU if true.

session runtime flag, won't be saved.


FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo
FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo FBVideo