VideoStreamInterface Class Reference

#include <VideoPlayer.h>

Inherited by VideoStream.

Public Member Functions
virtual VideoStreamInterface *	next (void)=0
	only VideoPlayerInterfaces can create these
virtual void	update (void)=0
	Update stream.
virtual void	close (void)=0
	Close and free stream.
virtual Bool	isFrameReady (void)=0
	Is the frame ready to be displayed.
virtual void	frameDecompress (void)=0
	Render current frame in to buffer.
virtual void	frameRender (VideoBuffer *buffer)=0
	Render current frame in to buffer.
virtual void	frameNext (void)=0
	Advance to next frame.
virtual Int	frameIndex (void)=0
	Returns zero based index of current frame.
virtual Int	frameCount (void)=0
	Returns the total number of frames in the stream.
virtual void	frameGoto (Int index)=0
	Go to the spcified frame index.
virtual Int	height (void)=0
	Return the height of the video.
virtual Int	width (void)=0
	Return the width of the video.

Protected Member Functions
virtual	~VideoStreamInterface ()

Friends
class	VideoPlayerInterface

Detailed Description

Video stream interface class.

Definition at line 153 of file VideoPlayer.h.

Constructor & Destructor Documentation

~VideoStreamInterface()

virtual VideoStreamInterface::~VideoStreamInterface ( )

inlineprotectedvirtual

Definition at line 159 of file VideoPlayer.h.

Member Function Documentation

close()

virtual void VideoStreamInterface::close ( void )

pure virtual

Close and free stream.

Implemented in VideoStream.

frameCount()

virtual Int VideoStreamInterface::frameCount ( void )

pure virtual

Returns the total number of frames in the stream.

Implemented in BinkVideoStream, and VideoStream.

frameDecompress()

virtual void VideoStreamInterface::frameDecompress ( void )

pure virtual

Render current frame in to buffer.

Implemented in BinkVideoStream, and VideoStream.

frameGoto()

virtual void VideoStreamInterface::frameGoto ( Int index )

pure virtual

Go to the spcified frame index.

Implemented in BinkVideoStream, and VideoStream.

frameIndex()

virtual Int VideoStreamInterface::frameIndex ( void )

pure virtual

Returns zero based index of current frame.

Implemented in BinkVideoStream, and VideoStream.

frameNext()

virtual void VideoStreamInterface::frameNext ( void )

pure virtual

Advance to next frame.

Implemented in BinkVideoStream, and VideoStream.

frameRender()

virtual void VideoStreamInterface::frameRender ( VideoBuffer * buffer )

pure virtual

Render current frame in to buffer.

Implemented in BinkVideoStream, and VideoStream.

height()

virtual Int VideoStreamInterface::height ( void )

pure virtual

Return the height of the video.

Implemented in BinkVideoStream, and VideoStream.

isFrameReady()

virtual Bool VideoStreamInterface::isFrameReady ( void )

pure virtual

Is the frame ready to be displayed.

Implemented in BinkVideoStream, and VideoStream.

next()

virtual VideoStreamInterface * VideoStreamInterface::next ( void )

pure virtual

only VideoPlayerInterfaces can create these

Returns next open stream

Implemented in VideoStream.

update()

virtual void VideoStreamInterface::update ( void )

pure virtual

Update stream.

Implemented in BinkVideoStream, and VideoStream.

width()

virtual Int VideoStreamInterface::width ( void )

pure virtual

Return the width of the video.

Implemented in BinkVideoStream, and VideoStream.

Friends And Related Symbol Documentation

VideoPlayerInterface

friend class VideoPlayerInterface

friend

Definition at line 155 of file VideoPlayer.h.

---

The documentation for this class was generated from the following file:

• Code/GameEngine/Include/GameClient/VideoPlayer.h