CrystalSpace

Public API Reference

Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

iStreamFormat Struct Reference

Stream format. More...

#include <ivideo/codec.h>

Inheritance diagram for iStreamFormat:

iBase List of all members.

Public Member Functions

virtual void GetCaps (csStreamFormatCap &caps)=0
 Retrieve the decoder capabilities.
virtual iStreamIteratorGetStreamIterator ()=0
 Get an iterator to enumerate the streams.
virtual bool Load (iFile *pVideoData)=0
 Load the videodata from the following source.
virtual void NextFrame ()=0
 Call this in your main loop between BeginDraw and EndDraw.
virtual void Select (iAudioStream *pAudio, iVideoStream *pVideo)=0
 Choose a video and audio stream to be played when calling NextFrame.
virtual void Unload ()=0
 Unload this video.

Detailed Description

Stream format.

Definition at line 138 of file codec.h.


Member Function Documentation

virtual void iStreamFormat::GetCaps csStreamFormatCap caps  )  [pure virtual]
 

Retrieve the decoder capabilities.

virtual iStreamIterator* iStreamFormat::GetStreamIterator  )  [pure virtual]
 

Get an iterator to enumerate the streams.

virtual bool iStreamFormat::Load iFile pVideoData  )  [pure virtual]
 

Load the videodata from the following source.

virtual void iStreamFormat::NextFrame  )  [pure virtual]
 

Call this in your main loop between BeginDraw and EndDraw.

This will decode the next frame from the video and draw it to the rectangle set in SetRect (). This is an convenience function only. You achieve the same results by calling this explicitly for the streams to play.

virtual void iStreamFormat::Select iAudioStream pAudio,
iVideoStream pVideo
[pure virtual]
 

Choose a video and audio stream to be played when calling NextFrame.

virtual void iStreamFormat::Unload  )  [pure virtual]
 

Unload this video.

All streams become invalid. This is automatically called by Load (). Prior to the final DecRef of this plugin you have to call this yourself.


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