Mohawk::VideoEntry Class Reference

#include <video.h>

Inheritance diagram for Mohawk::VideoEntry:

Public Member Functions
	operator bool () const
bool	isOpen () const
void	close ()
bool	endOfVideo () const
uint16	getX () const
uint16	getY () const
bool	isLooping () const
bool	isEnabled () const
const Audio::Timestamp &	getStart () const
const Common::Path &	getFileName () const
int	getID () const
int	getCurFrame () const
uint32	getFrameCount () const
uint32	getTime () const
Audio::Timestamp	getDuration () const
Common::Rational	getRate () const
void	setX (uint16 x)
void	setY (uint16 y)
void	moveTo (uint16 x, uint16 y)
void	center ()
void	setStart (const Audio::Timestamp &time)
void	setLooping (bool loop)
void	setEnabled (bool enabled)
void	setBounds (const Audio::Timestamp &startTime, const Audio::Timestamp &endTime)
void	seek (const Audio::Timestamp &time)
void	setRate (const Common::Rational &rate)
void	pause (bool isPaused)
void	start ()
void	stop ()
bool	isPlaying () const
int	getVolume () const
void	setVolume (int volume)
void	loadSubtitles (const Common::Path &fname)

Detailed Description

A video monitored by the VideoManager

Member Function Documentation

operator bool()

Mohawk::VideoEntry::operator bool ( ) const

inline

Convenience implicit cast to bool

isOpen()

bool Mohawk::VideoEntry::isOpen ( ) const

inline

Is the video open?

close()

void Mohawk::VideoEntry::close

(

)

Close the video

endOfVideo()

bool Mohawk::VideoEntry::endOfVideo

(

)

const

Has the video reached its end?

getX()

uint16 Mohawk::VideoEntry::getX ( ) const

inline

Get the X position of where the video is displayed

getY()

uint16 Mohawk::VideoEntry::getY ( ) const

inline

Get the Y position of where the video is displayed

isLooping()

bool Mohawk::VideoEntry::isLooping ( ) const

inline

Is the video looping?

isEnabled()

bool Mohawk::VideoEntry::isEnabled ( ) const

inline

Is the video enabled? (Drawing to the screen)

getStart()

const Audio::Timestamp& Mohawk::VideoEntry::getStart ( ) const

inline

Get the start time of the video bounds

getFileName()

const Common::Path& Mohawk::VideoEntry::getFileName ( ) const

inline

Get the file name of the video, or empty if by ID

getID()

int Mohawk::VideoEntry::getID ( ) const

inline

Get the ID of the video, or -1 if by file name

getCurFrame()

int Mohawk::VideoEntry::getCurFrame

(

)

const

Get the current frame of the video

getFrameCount()

uint32 Mohawk::VideoEntry::getFrameCount

(

)

const

Get the frame count of the video

getTime()

uint32 Mohawk::VideoEntry::getTime

(

)

const

Get the current time position of the video

getDuration()

Audio::Timestamp Mohawk::VideoEntry::getDuration

(

)

const

Get the duration of the video

getRate()

Common::Rational Mohawk::VideoEntry::getRate

(

)

const

Get the current playback rate of the videos

setX()

void Mohawk::VideoEntry::setX ( uint16  x )

inline

Move the x position of the video

setY()

void Mohawk::VideoEntry::setY ( uint16  y )

inline

Move the y position of the video

moveTo()

void Mohawk::VideoEntry::moveTo ( uint16  x, uint16  y  )

inline

Move the video to the specified coordinates

center()

void Mohawk::VideoEntry::center

(

)

Center the video on the screen

setStart()

void Mohawk::VideoEntry::setStart ( const Audio::Timestamp &  time )

inline

Set the start time when using video bounds

setLooping()

void Mohawk::VideoEntry::setLooping ( bool  loop )

inline

Set the video to loop (true) or not (false)

setEnabled()

void Mohawk::VideoEntry::setEnabled ( bool  enabled )

inline

Set the video's enabled status

setBounds()

void Mohawk::VideoEntry::setBounds	(	const Audio::Timestamp &	startTime,
		const Audio::Timestamp &	endTime
	)

Set the bounds of the video

This automatically seeks to the start time

seek()

void Mohawk::VideoEntry::seek

(

const Audio::Timestamp &

time

)

Seek to the given time

setRate()

void Mohawk::VideoEntry::setRate

(

const Common::Rational &

rate

)

Set the playback rate

pause()

void Mohawk::VideoEntry::pause

(

bool

isPaused

)

Pause the video

start()

void Mohawk::VideoEntry::start

(

)

Start playing the video

stop()

void Mohawk::VideoEntry::stop

(

)

Stop playing the video

isPlaying()

bool Mohawk::VideoEntry::isPlaying

(

)

const

Is the video playing?

getVolume()

int Mohawk::VideoEntry::getVolume

(

)

const

Get the volume of the video

setVolume()

void Mohawk::VideoEntry::setVolume

(

int

volume

)

Set the volume of the video

loadSubtitles()

void Mohawk::VideoEntry::loadSubtitles ( const Common::Path &  fname )

inline

Load the subtitles

---

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

• engines/mohawk/video.h