Inheritance diagram for FBVideoClip:

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.
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 walue superior to width of image.
FBPropertyBase	PowerOfTwoHeight
	Read Only Property: Closest power of two walue 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	FPS
	Read Only 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`
	)

Search for all occurrences

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.

Reimplemented from FBVideo.

FBDelete ( )

Search for all occurrences

Open Reality deletion function.

Examples: Tasks/DeleteHierarchy.py

Reimplemented from FBComponent.

bool IsValid ( )

Search for all occurrences

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

Search for all occurrences

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