Titanic::AVISurface Class Reference

Public Member Functions
	AVISurface (const CResourceKey &key)
virtual bool	play (uint flags, CGameObject *obj)
virtual bool	play (int startFrame, int endFrame, uint flags, CGameObject *obj)
virtual bool	play (int startFrame, int endFrame, int initialFrame, uint flags, CGameObject *obj)
virtual void	stop ()
virtual void	pause ()
virtual void	resume ()
virtual bool	isPlaying () const
virtual void	setPlaying (bool playingFlag)
virtual bool	handleEvents (CMovieEventList &events)
void	setVideoSurface (CVideoSurface *surface)
uint	getWidth () const
uint	getHeight () const
void	setFrame (int frameNumber)
int	getFrame () const
bool	addEvent (int *frameNumber, CGameObject *obj)
void	setFrameRate (double rate)
Graphics::ManagedSurface *	getSecondarySurface ()
const CMovieRangeInfoList *	getMovieRangeInfo () const
Graphics::ManagedSurface *	duplicateTransparency () const
bool	isNextFrame ()
bool	playCutscene (const Rect &r, uint startFrame, uint endFrame)
uint	getBitDepth () const
bool	isReversed () const

Public Attributes
CSoundManager *	_soundManager
bool	_hasAudio

Protected Member Functions
bool	startAtFrame (int frameNumber)
virtual void	seekToFrame (uint frameNumber)

Member Function Documentation

startAtFrame()

bool Titanic::AVISurface::startAtFrame ( int  frameNumber )

protected

Start playback at the specified frame

seekToFrame()

virtual void Titanic::AVISurface::seekToFrame ( uint  frameNumber )

protectedvirtual

Seeks to a given frame number in the video

play() [1/3]

virtual bool Titanic::AVISurface::play ( uint  flags, CGameObject *  obj  )

virtual

Start playing the loaded AVI video

play() [2/3]

virtual bool Titanic::AVISurface::play ( int  startFrame, int  endFrame, uint  flags, CGameObject *  obj  )

virtual

Start playing the loaded AVI video

play() [3/3]

virtual bool Titanic::AVISurface::play ( int  startFrame, int  endFrame, int  initialFrame, uint  flags, CGameObject *  obj  )

virtual

Start playing the loaded AVI video

stop()

virtual void Titanic::AVISurface::stop ( )

virtual

Stop the currently playing video

pause()

virtual void Titanic::AVISurface::pause ( )

virtual

Pauses video playback

resume()

virtual void Titanic::AVISurface::resume ( )

virtual

Resumes the video if it's paused

isPlaying()

virtual bool Titanic::AVISurface::isPlaying ( ) const

inlinevirtual

Return true if a video is currently playing

setPlaying()

virtual void Titanic::AVISurface::setPlaying ( bool  playingFlag )

inlinevirtual

Sets whether the video is playing (versus paused)

handleEvents()

virtual bool Titanic::AVISurface::handleEvents ( CMovieEventList &  events )

virtual

Handle any movie events relevant for the frame

setVideoSurface()

void Titanic::AVISurface::setVideoSurface

(

CVideoSurface *

surface

)

Set the video surface the AVI Surface will render on

getWidth()

uint Titanic::AVISurface::getWidth

(

)

const

Get the width of the video

getHeight()

uint Titanic::AVISurface::getHeight

(

)

const

Get the height of the video

setFrame()

void Titanic::AVISurface::setFrame

(

int

frameNumber

)

Set the current frame

getFrame()

int Titanic::AVISurface::getFrame ( ) const

inline

Gets the current frame

addEvent()

bool Titanic::AVISurface::addEvent	(	int *	frameNumber,
		CGameObject *	obj
	)

Add a movie event

setFrameRate()

void Titanic::AVISurface::setFrameRate

(

double

rate

)

Set the frame rate

getSecondarySurface()

Graphics::ManagedSurface* Titanic::AVISurface::getSecondarySurface

(

)

Returns the surface for the secondary video track frame, if present

getMovieRangeInfo()

const CMovieRangeInfoList* Titanic::AVISurface::getMovieRangeInfo ( ) const

inline

Get a reference to the movie range info list

duplicateTransparency()

Graphics::ManagedSurface* Titanic::AVISurface::duplicateTransparency

(

)

const

Duplicates the transparency mask for the frame, if the movie includes it

isNextFrame()

bool Titanic::AVISurface::isNextFrame

(

)

Returns true if it's time for the next

playCutscene()

bool Titanic::AVISurface::playCutscene	(	const Rect &	r,
		uint	startFrame,
		uint	endFrame
	)

Plays an interruptable cutscene

Returns

True if the cutscene was not interrupted

getBitDepth()

uint Titanic::AVISurface::getBitDepth

(

)

const

Returns the pixel depth of the movie in bits

isReversed()

bool Titanic::AVISurface::isReversed ( ) const

inline

Returns true if the movie is to play backwards

---

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

• engines/titanic/support/avi_surface.h