Component attached to a Texture that allows real-time OGV video playback. The interface below provides you standard playback control such as play, pause and stop; allows you to seek and retrieve playback information.

See Also

Texture, Handler, VideoBuffer, Asset

Static Variables

Name	Description
`texture`	Parent Texture reference where the active Video component is attached.
Declaration Texture *texture
`quality`	The current Quality of the Video output.
Declaration Quality quality
`handler`	The Handler that manages the scripting functionalities for the active Video.
Declaration Handler handler
`videobuffer`	Reference to the VideoBuffer currently attached to the active Video.
Declaration VideoBuffer *videobuffer

Variables

Name	Description
`speed`	Speed factor that controls the Video playback.
Declaration float speed Range 0.1x to 5.0x
`state`	Active playback State of the Video.
Declaration State state
`auto_play`	Determine wheter or not the Video should start playing as soon a VideoBuffer is attached.
Declaration bool auto_play
`auto_loop`	Controls wether or not the VideoBuffer should loop back when the end of stream is encountered.
Declaration bool auto_loop

Functions

Name	Description
`SetVideoBuffer`	Attach an existing VideoBuffer to the current Video component.
Declaration void SetVideoBuffer( VideoBuffer videobuffer, Quality quality ) Parameters* `videobuffer`: Reference to a VideoBuffer; to disconnect the Asset set to `nil`. `quality`: Determine the quality of the VideoBuffer playback.
`SetCache`	Adjust the frame cache that is used during playback.
Declaration void SetCache( unsigned char cache_size ) Parameters `cache_size`: A value between `1` to `24` representing the amount of frame that should be cached ahead of time.
`Play`	Starts the Video playback.
Declaration bool Play( void ) Return Value `true` if the Video either resume or start playing; else return `false` if it was already playing or cannot be started (in the event that no VideoBuffer is attached).
`Pause`	Pause the current Video playback.
Declaration bool Pause( void ) Return Value `true` if the Video playback pause successfully; else return `false`.
`Stop`	Stop the current Video playback.
Declaration bool Stop( void ) Return Value `true` if the Video stop playing; else return `false` if it was already stopped.
`SeekFast`	Quickly jump to a specific point in time (approximated, fast).
Declaration void SeekFast( float playback_time ) Parameters `playback_time`: Specify the position in time where the Video should jump to (`1.0 = 1sec.`).
`SeekFrameFast`	Helper that directly make the Video jump to a specific frame (approximated, fast).
Declaration void SeekFrameFast( unsigned int frame ) Parameters `frame`: Frame number to jump to.
`Seek`	Jump directly to a specific time (accurate, slow).
Declaration void Seek( float playback_time ) Parameters `playback_time`: Specify the position in time where the Video should jump to (`1.0 = 1sec.`).
`SeekFrame`	Function that allows you to jump directly to a specific frame (accurate, slow).
Declaration void SeekFrame( unsigned int frame ) Parameters `frame`: Frame number to jump to.
`GetPlaybackTime`	Retrieve the current Video playback time.
Declaration float GetPlaybackTime( void ) Return Value The current playback time where `1.0 = 1sec.`.
`GetPlaybackFrame`	Helper that returns the current playback frame number.
Declaration int GetPlaybackFrame( void ) Return Value `-1` if the Video haven't start playing; else return the current frame index number.
`GetCachedFrameCount`	Function to analyze how many frames are currently cached.
Declaration unsigned char GetCachedFrameCount( void ) Return Value The current amount of frames that have successfully been cached.

Events

Callbacks	Description
`OnPlay`	This callback gets called when the Video received the signal to start playing.
Declaration function OnPlay()
`OnResume`	Triggered if the Video was paused and then start playing again.
Declaration function OnResume()
`OnPause`	Triggered when the Video gets paused.
Declaration function OnPause()
`OnStop`	Called when the Video received the stop signal.
Declaration function OnStop()

Quality

Constant values that affect the quality of the output VideoBuffer when converted to a Texture.

kHighColor: Convert the video stream to 16bits.
kTrueColor: Directly output the same image quality encoded in the VideoBuffer.