ScummVM API documentation
Classes | Public Types | Public Member Functions | List of all members
Gob::VideoPlayer Class Reference

Classes

struct  Properties
 

Public Types

enum  Flags {
  kFlagNone = 0x000000, kFlagUseBackSurfaceContent = 0x000040, kFlagFrontSurface = 0x000080, kFlagNoVideo = 0x000100,
  kFlagOtherSurface = 0x000800, kFlagScreenSurface = 0x400000
}
 
enum  Type {
  kVideoTypeTry = -1, kVideoTypeIMD = 0, kVideoTypePreIMD = 1, kVideoTypeVMD = 2,
  kVideoTypeRMD = 3
}
 

Public Member Functions

 VideoPlayer (GobEngine *vm)
 
void evaluateFlags (Properties &properties)
 
int openVideo (bool primary, const Common::String &file, Properties &properties)
 
bool closeVideo (int slot=0)
 
void closeLiveVideos ()
 
void closeAll ()
 
bool reopenVideo (int slot=0)
 
bool reopenAll ()
 
void pauseVideo (int slot, bool pause)
 
void pauseAll (bool pause)
 
void finishVideoSound (int slot)
 
void waitSoundEnd (int slot)
 
bool play (int slot, Properties &properties)
 
void waitEndFrame (int slot, bool onlySound=false)
 
int32 getExpectedFrameFromCurrentTime (int slot)
 
bool isPlayingLive () const
 
bool isSoundPlaying () const
 
void updateLive (bool force=false, int exceptSlot=-1)
 
bool slotIsOpen (int slot=0) const
 
Common::String getFileName (int slot=0) const
 
uint32 getFrameCount (int slot=0) const
 
uint32 getCurrentFrame (int slot=0) const
 
uint16 getWidth (int slot=0) const
 
uint16 getHeight (int slot=0) const
 
uint16 getDefaultX (int slot=0) const
 
uint16 getDefaultY (int slot=0) const
 
uint32 getFlags (int slot=0) const
 
uint16 getSoundFlags (int slot=0) const
 
uint32 getVideoBufferSize (int slot=0) const
 
bool hasVideo (int slot=0) const
 
const Common::List< Common::Rect > * getDirtyRects (int slot=0) const
 
bool hasEmbeddedFile (const Common::String &fileName, int slot=0) const
 
Common::SeekableReadStream * getEmbeddedFile (const Common::String &fileName, int slot=0)
 
int32 getSubtitleIndex (int slot=0) const
 
void writeVideoInfo (const Common::String &file, uint16 varX, uint16 varY, uint16 varFrames, uint16 varWidth, uint16 varHeight)
 
bool copyFrame (int slot, Surface &dest, uint16 left, uint16 top, uint16 width, uint16 height, uint16 x, uint16 y, int32 transp=-1, bool yAxisReflexion=false) const
 

Member Enumeration Documentation

◆ Flags

enum Gob::VideoPlayer::Flags
Enumerator
kFlagUseBackSurfaceContent 

Use the back surface as a video "base".

kFlagFrontSurface 

Draw directly into the front surface.

kFlagNoVideo 

Only sound.

kFlagOtherSurface 

Draw into a specific sprite.

kFlagScreenSurface 

Draw into a newly created sprite of screen dimensions.

◆ Type

enum Gob::VideoPlayer::Type

Video format.

Enumerator
kVideoTypeTry 

Try any format.

kVideoTypePreIMD 

Early IMD format found in Fascination.

kVideoTypeRMD 

VMD containing "reversed" video.

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