Mohawk::RivenVideo Class Reference

#include <riven_video.h>

Inheritance diagram for Mohawk::RivenVideo:

Public Member Functions
	RivenVideo (MohawkEngine_Riven *vm, uint16 code)
void	load (uint16 id)
void	close ()
void	play ()
void	playBlocking (int32 endTime=-1)
bool	endOfVideo () const
bool	isLooping () const
bool	isEnabled () const
uint16	getId () const
uint16	getSlot () const
int	getCurFrame () const
uint32	getFrameCount () const
uint32	getTime () const
uint32	getDuration () const
void	moveTo (uint16 x, uint16 y)
void	setLooping (bool loop)
void	enable ()
void	disable ()
void	seek (uint32 time)
void	pause (bool isPaused)
void	stop ()
bool	isPlaying () const
void	setVolume (int volume)
bool	needsUpdate () const
void	drawNextFrame ()

Detailed Description

A video monitored by the VideoManager

Member Function Documentation

load()

void Mohawk::RivenVideo::load

(

uint16

id

)

Load the video from the archive

close()

void Mohawk::RivenVideo::close

(

)

Free resources allocated for the movie, but allow to load it again later

play()

void Mohawk::RivenVideo::play

(

)

Start playing the video

playBlocking()

void Mohawk::RivenVideo::playBlocking

(

int32

endTime = -1

)

Play the video until it completes or reaches the specified timestamp

endOfVideo()

bool Mohawk::RivenVideo::endOfVideo

(

)

const

Has the video reached its end?

isLooping()

bool Mohawk::RivenVideo::isLooping ( ) const

inline

Is the video looping?

isEnabled()

bool Mohawk::RivenVideo::isEnabled ( ) const

inline

Is the video enabled? (Drawing to the screen)

getId()

uint16 Mohawk::RivenVideo::getId ( ) const

inline

Get the ID of the video

getSlot()

uint16 Mohawk::RivenVideo::getSlot ( ) const

inline

Get the slot used by the video in the video manager

getCurFrame()

int Mohawk::RivenVideo::getCurFrame

(

)

const

Get the current frame of the video

getFrameCount()

uint32 Mohawk::RivenVideo::getFrameCount

(

)

const

Get the frame count of the video

getTime()

uint32 Mohawk::RivenVideo::getTime

(

)

const

Get the current time position of the video

getDuration()

uint32 Mohawk::RivenVideo::getDuration

(

)

const

Get the duration of the video

moveTo()

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

inline

Move the video to the specified coordinates

setLooping()

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

inline

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

enable()

void Mohawk::RivenVideo::enable

(

)

Enable the video

disable()

void Mohawk::RivenVideo::disable

(

)

Disable the video

seek()

void Mohawk::RivenVideo::seek

(

uint32

time

)

Seek to the given time

pause()

void Mohawk::RivenVideo::pause

(

bool

isPaused

)

Pause the video

stop()

void Mohawk::RivenVideo::stop

(

)

Stop playing the video

isPlaying()

bool Mohawk::RivenVideo::isPlaying

(

)

const

Is the video playing?

setVolume()

void Mohawk::RivenVideo::setVolume

(

int

volume

)

Set the volume of the video

needsUpdate()

bool Mohawk::RivenVideo::needsUpdate

(

)

const

Checks if a video is playing and is waiting to display the next frame

drawNextFrame()

void Mohawk::RivenVideo::drawNextFrame

(

)

Draw the next frame to the system screen

---

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

• engines/mohawk/riven_video.h