FBVideoClip Class Reference


Detailed Description

Inheritance diagram for FBVideoClip:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.
 FBDelete ()
 Open Reality deletion function.
bool IsValid ()
 Verifies the validity of the FBVideo object.
 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.
str GetImage (int pFrame=-1)
 Get the current image buffer.
 ImageIncUpdateID ()
 Increase Image update id after modification to trigger internal state refresh.
str GetPowerOfTwoImage ()
 Get the current image buffer resized with width and height power of two.
int GetTextureID ()
 Get the texture ID.

Public Attributes

FBPropertyString Filename
 Read Write Property: Filename of media.
FBPropertyString RelativePath
 Read Only Property: Relative path of media.
FBPropertyVideoProxyMode ProxyMode
 Read Write Property: Proxy mode.
FBPropertyVideoStorageMode StorageMode
 Read Write Property: Storage mode.
FBPropertyBase Width
 Read Only Property: Width of image.
FBPropertyBase Height
 Read Only Property: Height of image.
FBPropertyBase PowerOfTwoWidth
 Read Only Property: Closest power of two value superior to width of image.
FBPropertyBase PowerOfTwoHeight
 Read Only Property: Closest power of two value superior to height of image.
FBPropertyVideoInterlaceMode InterlaceMode
 Read Write Property: Interlace mode.
FBPropertyVideoFormat Format
 Read Only Property: Video format.
FBPropertyBase TimeOffset
 Read Write Property: Temporal offset for beginning of video.
FBPropertyBase StartFrame
 Read Write Property: Frame to begin video playback from.
FBPropertyBase StopFrame
 Read Write Property: Frame to end video playback at.
FBPropertyBase FrameRate
 Read Write Property: Frame rate.
FBPropertyBase PlaySpeed
 Read Write Property: Playback speed.
FBPropertyBase FreeRunning
 Read Write Property: Is free Running on?.
FBPropertyBase Loop
 Read Write Property: Loop video clip?.
FBPropertyBase FrameTime
 Read Only Property: Inverse of FPS, time per frame.
FBPropertyBase CurrentFrame
 Read Write Property: Current frame.
FBPropertyBase LastFrame
 Read Only Property: Last frame in clip.
FBPropertyBase LastFrameTime
 Read Only Property: Time of last frame.
FBPropertyBase CurrentFrameTime
 Read Write Property: Current time in clip.

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
Samples/Story/VideoClip.py

Reimplemented from FBVideo.

Reimplemented in FBVideoClipImage.

FBDelete ( )

Open Reality deletion function.

Examples
Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

bool IsValid ( )

Verifies the validity of the FBVideo object.

Returns:
true if data is valid.
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:
pXX position of image (default=0).
pYY position of image (default=0).
pWWidth of image (default=-1).
pHHeight of image (default=-1).
pFrameFrame to draw (default=-1).
str GetImage ( int  pFrame = -1)

Get the current image buffer.

Parameters:
pFrameFrame to get image for (default=-1).
Returns:
Handle to the image buffer specified by the pFrame parameter.
ImageIncUpdateID ( )

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

str GetPowerOfTwoImage ( )

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

Returns:
Handle to the image buffer specified by the pFrame parameter.
int GetTextureID ( )

Get the texture ID.

Returns:
ID of the texture

Member Data Documentation

Read Write Property: Filename of media.

Read Only Property: Relative path of media.

FBPropertyVideoProxyMode ProxyMode

Read Write Property: Proxy mode.

FBPropertyVideoStorageMode StorageMode

Read Write Property: Storage mode.

FBPropertyBase Width

Read Only Property: Width of image.

FBPropertyBase Height

Read Only Property: Height of image.

FBPropertyBase PowerOfTwoWidth

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

FBPropertyBase PowerOfTwoHeight

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

FBPropertyVideoInterlaceMode InterlaceMode

Read Write Property: Interlace mode.

FBPropertyVideoFormat Format

Read Only Property: Video format.

FBPropertyBase TimeOffset

Read Write Property: Temporal offset for beginning of video.

FBPropertyBase StartFrame

Read Write Property: Frame to begin video playback from.

FBPropertyBase StopFrame

Read Write Property: Frame to end video playback at.

FBPropertyBase FrameRate

Read Write Property: Frame rate.

FBPropertyBase PlaySpeed

Read Write Property: Playback speed.

FBPropertyBase FreeRunning

Read Write Property: Is free Running on?.

FBPropertyBase Loop

Read Write Property: Loop video clip?.

FBPropertyBase FrameTime

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

FBPropertyBase CurrentFrame

Read Write Property: Current frame.

FBPropertyBase LastFrame

Read Only Property: Last frame in clip.

FBPropertyBase LastFrameTime

Read Only Property: Time of last frame.

FBPropertyBase CurrentFrameTime

Read Write Property: Current time in clip.


FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip
FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip FBVideoClip