BinkVideoPlayer Class Reference

#include <BinkVideoPlayer.h>

Inherits VideoPlayer.

Public Member Functions
virtual void	init (void)
	Initialize video playback code.
virtual void	reset (void)
	Reset video playback.
virtual void	update (void)
	Services all audio tasks. Should be called frequently.
virtual void	deinit (void)
	Close down player.
	BinkVideoPlayer ()
	~BinkVideoPlayer ()
virtual void	loseFocus (void)
	Should be called when application loses focus.
virtual void	regainFocus (void)
	Should be called when application regains focus.
virtual VideoStreamInterface *	open (AsciiString movieTitle)
	Open video file for playback.
virtual VideoStreamInterface *	load (AsciiString movieTitle)
	Load video file in to memory for playback.
virtual void	notifyVideoPlayerOfNewProvider (Bool nowHasValid)
	Notify the video player that they can now ask for an audio handle, or they need to give theirs up.
virtual void	initializeBinkWithMiles (void)
Public Member Functions inherited from VideoPlayer
	VideoPlayer ()
	~VideoPlayer ()
virtual VideoStreamInterface *	firstStream (void)
	Return the first open/loaded video stream.
virtual void	closeAllStreams (void)
	Close all open streams.
virtual void	addVideo (Video *videoToAdd)
	Add a video to the list of videos we can play.
virtual void	removeVideo (Video *videoToRemove)
	Remove a video to the list of videos we can play.
virtual Int	getNumVideos (void)
	Retrieve info about the number of videos currently listed.
virtual const Video *	getVideo (AsciiString movieTitle)
	Retrieve info about a movie based on internal name.
virtual const Video *	getVideo (Int index)
	Retrieve info about a movie based on index.
virtual const FieldParse *	getFieldParse (void) const
	Return the field parse info.
void	remove (VideoStream *stream)
	remove stream from active list
Public Member Functions inherited from VideoPlayerInterface
virtual	~VideoPlayerInterface ()
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	postProcessLoad ()
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Protected Member Functions
VideoStreamInterface *	createStream (HBINK handle)

Additional Inherited Members
Protected Attributes inherited from VideoPlayer
VecVideo	mVideosAvailableForPlay
VideoStream *	m_firstStream
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name
Static Protected Attributes inherited from VideoPlayer
static const FieldParse	m_videoFieldParseTable []

Detailed Description

Bink video playback code.

Definition at line 106 of file BinkVideoPlayer.h.

Constructor & Destructor Documentation

BinkVideoPlayer()

BinkVideoPlayer::BinkVideoPlayer

(

)

Definition at line 110 of file BinkVideoPlayer.cpp.

~BinkVideoPlayer()

BinkVideoPlayer::~BinkVideoPlayer

(

)

Definition at line 119 of file BinkVideoPlayer.cpp.

Member Function Documentation

createStream()

VideoStreamInterface * BinkVideoPlayer::createStream ( HBINK handle )

protected

Definition at line 187 of file BinkVideoPlayer.cpp.

deinit()

void BinkVideoPlayer::deinit ( void )

virtual

Close down player.

Reimplemented from VideoPlayer.

Definition at line 140 of file BinkVideoPlayer.cpp.

init()

void BinkVideoPlayer::init ( void )

virtual

Initialize video playback code.

Reimplemented from VideoPlayer.

Definition at line 128 of file BinkVideoPlayer.cpp.

initializeBinkWithMiles()

void BinkVideoPlayer::initializeBinkWithMiles ( void )

virtual

Definition at line 283 of file BinkVideoPlayer.cpp.

load()

VideoStreamInterface * BinkVideoPlayer::load ( AsciiString movieTitle )

virtual

Load video file in to memory for playback.

Reimplemented from VideoPlayer.

Definition at line 264 of file BinkVideoPlayer.cpp.

loseFocus()

void BinkVideoPlayer::loseFocus ( void )

virtual

Should be called when application loses focus.

Reimplemented from VideoPlayer.

Definition at line 169 of file BinkVideoPlayer.cpp.

notifyVideoPlayerOfNewProvider()

void BinkVideoPlayer::notifyVideoPlayerOfNewProvider ( Bool nowHasValid )

virtual

Notify the video player that they can now ask for an audio handle, or they need to give theirs up.

Reimplemented from VideoPlayer.

Definition at line 271 of file BinkVideoPlayer.cpp.

open()

VideoStreamInterface * BinkVideoPlayer::open ( AsciiString movieTitle )

virtual

Open video file for playback.

Reimplemented from VideoPlayer.

Definition at line 221 of file BinkVideoPlayer.cpp.

regainFocus()

void BinkVideoPlayer::regainFocus ( void )

virtual

Should be called when application regains focus.

Reimplemented from VideoPlayer.

Definition at line 178 of file BinkVideoPlayer.cpp.

reset()

void BinkVideoPlayer::reset ( void )

virtual

Reset video playback.

Reimplemented from VideoPlayer.

Definition at line 150 of file BinkVideoPlayer.cpp.

update()

void BinkVideoPlayer::update ( void )

virtual

Services all audio tasks. Should be called frequently.

Reimplemented from VideoPlayer.

Definition at line 159 of file BinkVideoPlayer.cpp.

---

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