VideoPlayerInterface Class Reference

#include <VideoPlayer.h>

Inherits SubsystemInterface.

Inherited by VideoPlayer.

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

Additional Inherited Members
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Interface for video playback.

Definition at line 225 of file VideoPlayer.h.

Constructor & Destructor Documentation

~VideoPlayerInterface()

virtual VideoPlayerInterface::~VideoPlayerInterface ( )

inlinevirtual

Definition at line 236 of file VideoPlayer.h.

Member Function Documentation

addVideo()

virtual void VideoPlayerInterface::addVideo ( Video * videoToAdd )

pure virtual

Add a video to the list of videos we can play.

Implemented in VideoPlayer.

closeAllStreams()

virtual void VideoPlayerInterface::closeAllStreams ( void )

pure virtual

Close all open streams.

Implemented in VideoPlayer.

deinit()

virtual void VideoPlayerInterface::deinit ( void )

pure virtual

Close down player.

Implemented in BinkVideoPlayer, and VideoPlayer.

firstStream()

virtual VideoStreamInterface * VideoPlayerInterface::firstStream ( void )

pure virtual

Return the first open/loaded video stream.

Implemented in VideoPlayer.

getFieldParse()

virtual const FieldParse * VideoPlayerInterface::getFieldParse ( void ) const

pure virtual

Return the field parse info.

Implemented in VideoPlayer.

getNumVideos()

virtual Int VideoPlayerInterface::getNumVideos ( void )

pure virtual

Retrieve info about the number of videos currently listed.

Implemented in VideoPlayer.

getVideo() [1/2]

virtual const Video * VideoPlayerInterface::getVideo ( AsciiString movieTitle )

pure virtual

Retrieve info about a movie based on internal name.

Implemented in VideoPlayer.

getVideo() [2/2]

virtual const Video * VideoPlayerInterface::getVideo ( Int index )

pure virtual

Retrieve info about a movie based on index.

Implemented in VideoPlayer.

init()

virtual void VideoPlayerInterface::init ( void )

pure virtual

Initialize video playback.

Implements SubsystemInterface.

Implemented in BinkVideoPlayer, and VideoPlayer.

load()

virtual VideoStreamInterface * VideoPlayerInterface::load ( AsciiString movieTitle )

pure virtual

Load video file in to memory for playback.

Implemented in BinkVideoPlayer, and VideoPlayer.

loseFocus()

virtual void VideoPlayerInterface::loseFocus ( void )

pure virtual

Should be called when application loses focus.

Implemented in BinkVideoPlayer, and VideoPlayer.

notifyVideoPlayerOfNewProvider()

virtual void VideoPlayerInterface::notifyVideoPlayerOfNewProvider ( Bool nowHasValid )

pure virtual

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

Implemented in BinkVideoPlayer, and VideoPlayer.

open()

virtual VideoStreamInterface * VideoPlayerInterface::open ( AsciiString movieTitle )

pure virtual

Open video file for playback.

Implemented in BinkVideoPlayer, and VideoPlayer.

regainFocus()

virtual void VideoPlayerInterface::regainFocus ( void )

pure virtual

Should be called when application regains focus.

Implemented in BinkVideoPlayer, and VideoPlayer.

removeVideo()

virtual void VideoPlayerInterface::removeVideo ( Video * videoToRemove )

pure virtual

Remove a video to the list of videos we can play.

Implemented in VideoPlayer.

reset()

virtual void VideoPlayerInterface::reset ( void )

pure virtual

Reset video playback.

Implements SubsystemInterface.

Implemented in BinkVideoPlayer, and VideoPlayer.

update()

virtual void VideoPlayerInterface::update ( void )

pure virtual

Services all video tasks. Should be called frequently.

Implements SubsystemInterface.

Implemented in BinkVideoPlayer, and VideoPlayer.

---

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

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