VideoStream Class Reference

#include <VideoPlayer.h>

Inherits VideoStreamInterface.

Inherited by BinkVideoStream.

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

Protected Member Functions
	VideoStream ()
	only VideoPlayer can create these
virtual	~VideoStream ()
Protected Member Functions inherited from VideoStreamInterface
virtual	~VideoStreamInterface ()

Protected Attributes
VideoPlayer *	m_player
	Video player we were created with.
VideoStream *	m_next
	Next open stream.

Friends
class	VideoPlayer

Detailed Description

Definition at line 186 of file VideoPlayer.h.

Constructor & Destructor Documentation

VideoStream()

VideoStream::VideoStream ( )

protected

only VideoPlayer can create these

Definition at line 376 of file VideoPlayer.cpp.

~VideoStream()

VideoStream::~VideoStream ( )

protectedvirtual

Definition at line 387 of file VideoPlayer.cpp.

Member Function Documentation

close()

void VideoStream::close ( void )

virtual

Close and free stream.

Implements VideoStreamInterface.

Definition at line 419 of file VideoPlayer.cpp.

frameCount()

Int VideoStream::frameCount ( void )

virtual

Returns the total number of frames in the stream.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 473 of file VideoPlayer.cpp.

frameDecompress()

void VideoStream::frameDecompress ( void )

virtual

Render current frame in to buffer.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 437 of file VideoPlayer.cpp.

frameGoto()

void VideoStream::frameGoto ( Int index )

virtual

Go to the spcified frame index.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 482 of file VideoPlayer.cpp.

frameIndex()

Int VideoStream::frameIndex ( void )

virtual

Returns zero based index of current frame.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 464 of file VideoPlayer.cpp.

frameNext()

void VideoStream::frameNext ( void )

virtual

Advance to next frame.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 455 of file VideoPlayer.cpp.

frameRender()

void VideoStream::frameRender ( VideoBuffer * buffer )

virtual

Render current frame in to buffer.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 446 of file VideoPlayer.cpp.

height()

Int VideoStream::height ( void )

virtual

Return the height of the video.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 491 of file VideoPlayer.cpp.

isFrameReady()

Bool VideoStream::isFrameReady ( void )

virtual

Is the frame ready to be displayed.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 428 of file VideoPlayer.cpp.

next()

VideoStreamInterface * VideoStream::next ( void )

virtual

Returns next open stream.

Implements VideoStreamInterface.

Definition at line 402 of file VideoPlayer.cpp.

update()

void VideoStream::update ( void )

virtual

Update stream.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 411 of file VideoPlayer.cpp.

width()

Int VideoStream::width ( void )

virtual

Return the width of the video.

Implements VideoStreamInterface.

Reimplemented in BinkVideoStream.

Definition at line 500 of file VideoPlayer.cpp.

Friends And Related Symbol Documentation

VideoPlayer

friend class VideoPlayer

friend

Definition at line 188 of file VideoPlayer.h.

Member Data Documentation

m_next

VideoStream* VideoStream::m_next

protected

Next open stream.

Definition at line 193 of file VideoPlayer.h.

m_player

VideoPlayer* VideoStream::m_player

protected

Video player we were created with.

Definition at line 192 of file VideoPlayer.h.

---

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

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