BinkVideoStream Class Reference

#include <BinkVideoPlayer.h>

Inherits VideoStream.

Public Member Functions
virtual void	update (void)
	Update bink 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.
Public Member Functions inherited from VideoStream
virtual VideoStreamInterface *	next (void)
	Returns next open stream.
virtual void	close (void)
	Close and free stream.

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

Protected Attributes
HBINK	m_handle
	Bink streaming handle;.
Char *	m_memFile
	Pointer to memory resident file.
Protected Attributes inherited from VideoStream
VideoPlayer *	m_player
	Video player we were created with.
VideoStream *	m_next
	Next open stream.

Friends
class	BinkVideoPlayer

Detailed Description

Definition at line 69 of file BinkVideoPlayer.h.

Constructor & Destructor Documentation

BinkVideoStream()

BinkVideoStream::BinkVideoStream ( )

protected

only BinkVideoPlayer can create these

Definition at line 302 of file BinkVideoPlayer.cpp.

~BinkVideoStream()

BinkVideoStream::~BinkVideoStream ( )

protectedvirtual

Definition at line 312 of file BinkVideoPlayer.cpp.

Member Function Documentation

frameCount()

Int BinkVideoStream::frameCount ( void )

virtual

Returns the total number of frames in the stream.

Reimplemented from VideoStream.

Definition at line 415 of file BinkVideoPlayer.cpp.

frameDecompress()

void BinkVideoStream::frameDecompress ( void )

virtual

Render current frame in to buffer.

Reimplemented from VideoStream.

Definition at line 343 of file BinkVideoPlayer.cpp.

frameGoto()

void BinkVideoStream::frameGoto ( Int index )

virtual

Go to the spcified frame index.

Reimplemented from VideoStream.

Definition at line 424 of file BinkVideoPlayer.cpp.

frameIndex()

Int BinkVideoStream::frameIndex ( void )

virtual

Returns zero based index of current frame.

Reimplemented from VideoStream.

Definition at line 406 of file BinkVideoPlayer.cpp.

frameNext()

void BinkVideoStream::frameNext ( void )

virtual

Advance to next frame.

Reimplemented from VideoStream.

Definition at line 397 of file BinkVideoPlayer.cpp.

frameRender()

void BinkVideoStream::frameRender ( VideoBuffer * buffer )

virtual

Render current frame in to buffer.

Reimplemented from VideoStream.

Definition at line 352 of file BinkVideoPlayer.cpp.

height()

Int BinkVideoStream::height ( void )

virtual

Return the height of the video.

Reimplemented from VideoStream.

Definition at line 433 of file BinkVideoPlayer.cpp.

isFrameReady()

Bool BinkVideoStream::isFrameReady ( void )

virtual

Is the frame ready to be displayed.

Reimplemented from VideoStream.

Definition at line 334 of file BinkVideoPlayer.cpp.

update()

void BinkVideoStream::update ( void )

virtual

Update bink stream.

Reimplemented from VideoStream.

Definition at line 325 of file BinkVideoPlayer.cpp.

width()

Int BinkVideoStream::width ( void )

virtual

Return the width of the video.

Reimplemented from VideoStream.

Definition at line 442 of file BinkVideoPlayer.cpp.

Friends And Related Symbol Documentation

BinkVideoPlayer

friend class BinkVideoPlayer

friend

Definition at line 71 of file BinkVideoPlayer.h.

Member Data Documentation

m_handle

HBINK BinkVideoStream::m_handle

protected

Bink streaming handle;.

Definition at line 75 of file BinkVideoPlayer.h.

m_memFile

Char* BinkVideoStream::m_memFile

protected

Pointer to memory resident file.

Definition at line 76 of file BinkVideoPlayer.h.

---

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

• Code/GameEngineDevice/Include/VideoDevice/Bink/BinkVideoPlayer.h
• Code/GameEngineDevice/Source/VideoDevice/Bink/BinkVideoPlayer.cpp