Main Page | Class Hierarchy | Alphabetical List | Data Structures | File List | Data Fields | Globals | Related Pages | Examples

vetCodec_MOVParameters Class Reference

Inheritance diagram for vetCodec_MOVParameters:

vetCodecParameters vetFilterParameters

Public Member Functions

 vetCodec_MOVParameters ()
 Default constructor, call reset().
 vetCodec_MOVParameters (const char *filename, int stream=0, long frameIndex=0)
 Full constructor, call reset() and set parameters.
 ~vetCodec_MOVParameters ()
 Default destructor.
void reset ()
 Reset all parameters: filename, current stream, frame index.
void setStream (int stream=0)
 set current stream (it's not applied really, but must call load(stream) of vetCodec_MOV class).
void setFileName (const char *filename)
 set current stream (it's not applied really, but must call load(filename, stream) of vetCodec_MOV class).
void setFrameIndex (long index=0)
 set current frame index (it's not applied really, but must call setFrameIndex(index) of vetCodec_MOV class).
VETRESULT saveToStreamXML (FILE *fp)
 Serialize class to XML format. Class' tag is <vetCodec_MOVParameters>.
VETRESULT loadFromStreamXML (FILE *fp)
 Deserialize class from XML format. Class' tag must be <vetCodec_MOVParameters>.

Protected Attributes

char fileName [128]
long frameIndex
int stream

Friends

class vetCodec_MOV

Detailed Description

Definition at line 57 of file vetCodec_MOV.h.


Constructor & Destructor Documentation

vetCodec_MOVParameters::vetCodec_MOVParameters const char *  filename,
int  stream = 0,
long  frameIndex = 0
 

Full constructor, call reset() and set parameters.

Parameters:
[in] filename pointer to NULL terminated string [max 128].
[in] stream movie's stream to load (default=0, first stream)
[in] frameIndex stream position (default=0, first frame)

Definition at line 919 of file vetCodec_MOV.cpp.

References reset(), setFileName(), setFrameIndex(), and setStream().


Member Function Documentation

int vetCodec_MOVParameters::loadFromStreamXML FILE *  fp  )  [virtual]
 

Deserialize class from XML format. Class' tag must be <vetCodec_MOVParameters>.

Parameters:
[in] fp input stream's pointer
Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else.

Implements vetCodecParameters.

Definition at line 974 of file vetCodec_MOV.cpp.

References fileName, frameIndex, stream, and VETRET_OK.

int vetCodec_MOVParameters::saveToStreamXML FILE *  fp  )  [virtual]
 

Serialize class to XML format. Class' tag is <vetCodec_MOVParameters>.

Parameters:
[in] fp output stream's pointer
Returns:
VETRET_OK if everything is fine, VETRET_INTERNAL_ERR else.

Implements vetCodecParameters.

Definition at line 950 of file vetCodec_MOV.cpp.

References fileName, frameIndex, stream, VETRET_INTERNAL_ERR, VETRET_OK, and VETRET_PARAM_ERR.

void vetCodec_MOVParameters::setFileName const char *  filename  ) 
 

set current stream (it's not applied really, but must call load(filename, stream) of vetCodec_MOV class).

Parameters:
[in] stream movie's filename to load (NULL Terminated string, max 128)

Definition at line 934 of file vetCodec_MOV.cpp.

References fileName.

Referenced by vetCodec_MOV::load(), and vetCodec_MOVParameters().

void vetCodec_MOVParameters::setFrameIndex long  index = 0  ) 
 

set current frame index (it's not applied really, but must call setFrameIndex(index) of vetCodec_MOV class).

Parameters:
[in] frameIndex stream position (default=0, first frame)

Definition at line 939 of file vetCodec_MOV.cpp.

References frameIndex.

Referenced by vetCodec_MOVParameters().

void vetCodec_MOVParameters::setStream int  stream = 0  ) 
 

set current stream (it's not applied really, but must call load(stream) of vetCodec_MOV class).

Parameters:
[in] stream movie's stream to load (default=0, first stream)

Definition at line 944 of file vetCodec_MOV.cpp.

References stream.

Referenced by vetCodec_MOV::load(), and vetCodec_MOVParameters().


The documentation for this class was generated from the following files:
Generated on Tue Jan 24 11:59:25 2006 for VETLib by  doxygen 1.4.4