Video clip image media class. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
FBVideoClipImage (str pName) | |
Constructor. | |
![]() | |
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. | |
![]() | |
FBVideo (str pName) | |
Constructor. | |
![]() | |
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. | |
![]() | |
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 | |
bool | ImageSequence |
Read Write Property: Clip is an image sequence? | |
FBVideoResolution | MaxMipMapResolution |
Read Write Property: Maximum MipMap resolution will be loaded into GPU. | |
bool | UseSystemFrameRate |
Read Write Property: Clip is using system frame rate? | |
![]() | |
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. | |
![]() | |
bool | KeepOnGPU |
Read Write Property: Don't auto flush from GPU if true. session runtime flag, won't be saved. | |
![]() | |
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. | |
![]() | |
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. | |
![]() | |
str | ClassGroupName |
ClassGroupName of the object. | |
int | TypeInfo |
TypeInfo. | |
Video clip image media class.
Used for a variety of image types. For DDS images, use the FBVideoClipImageDDS instead.
FBVideoClipImage | ( | str | pName | ) |
Constructor.
pName | Name of image file. |
bool ImageSequence |
Read Write Property: Clip is an image sequence?
FBVideoResolution MaxMipMapResolution |
Read Write Property: Maximum MipMap resolution will be loaded into GPU.
bool UseSystemFrameRate |
Read Write Property: Clip is using system frame rate?