CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

iStream Struct Reference

A stream. More...

#include <codec.h>

Inheritance diagram for iStream:

iBase iAudioStream iVideoStream List of all members.

Public Methods

virtual void GetStreamDescription (csStreamDescription &desc)=0
 Retrieve descriptive stream information. More...

virtual bool GotoFrame (uint32 frameindex)=0
 Next frame to be examined at frameindex. More...

virtual bool GotoTime (uint32 timeindex)=0
 Next frame to be examined is the frame at timeindex. More...

virtual bool SetPlayMethod (bool bTimeSynced)=0
 When NextFrame is called either the next frame is read based on frameindex or the next frame at timeindex (bTimeSynced = true). More...

virtual void NextFrame ()=0
 Call this in your main loop between BeginDraw and EndDraw. More...


Detailed Description

A stream.

Definition at line 176 of file codec.h.


Member Function Documentation

virtual void iStream::GetStreamDescription csStreamDescription   desc [pure virtual]
 

Retrieve descriptive stream information.

virtual bool iStream::GotoFrame uint32    frameindex [pure virtual]
 

Next frame to be examined at frameindex.

Note that <frame> does not necessarily mean a video frame. It is the datachunk a stream is separated into by the underlying protocol/format like RIFF for instance.

virtual bool iStream::GotoTime uint32    timeindex [pure virtual]
 

Next frame to be examined is the frame at timeindex.

virtual void iStream::NextFrame   [pure virtual]
 

Call this in your main loop between BeginDraw and EndDraw.

This will examine the next frame (either time or index based).

virtual bool iStream::SetPlayMethod bool    bTimeSynced [pure virtual]
 

When NextFrame is called either the next frame is read based on frameindex or the next frame at timeindex (bTimeSynced = true).


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14