FBVideoClip Class Reference

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

Inheritance diagram for FBVideoClip:

[legend]

List of all members.

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.
int	GetTextureID ()
	Get the texture ID.
bool	IsValid ()
	Verifies the validity of the FBVideo object.
Public Attributes
int	CurrentFrame
	Read Write Property: Current frame.
FBTime	CurrentFrameTime
	Read Write Property: Current time in clip.
float	FPS
	Read Only Property: Frame rate.
str	Filename
	Read Write Property: Filename of media.
FBVideoFormat	Format
	Read Only Property: Video format.
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 walue superior to height of image.
int	PowerOfTwoWidth
	Read Only Property: Closest power of two walue superior to width of image.
FBVideoProxyMode	ProxyMode
	Read Write Property: Proxy mode.
str	RelativePath
	Read Only Property: Relative path of media.
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.
int	Width
	Read Only Property: Width of image.

---

Constructor & Destructor Documentation

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

(

)

Open Reality deletion function.

See sample: DeleteHierarchy.py.

Reimplemented from FBComponent.

int GetTextureID

(

)

Get the texture ID.

Returns:

ID of the texture

bool IsValid

(

)

Verifies the validity of the FBVideo object.

Returns:

true if data is valid.

---

Member Data Documentation

int CurrentFrame

Read Write Property: Current frame.

FBTime CurrentFrameTime

Read Write Property: Current time in clip.

float FPS

Read Only Property: Frame rate.

str Filename

Read Write Property: Filename of media.

FBVideoFormat Format

Read Only Property: Video format.

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 walue superior to height of image.

int PowerOfTwoWidth

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

FBVideoProxyMode ProxyMode

Read Write Property: Proxy mode.

str RelativePath

Read Only Property: Relative path of media.

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.

int Width

Read Only Property: Width of image.

---