mx::IFileWriter Class Reference
[Component Interfaces]

Encodes the concept of a file writer writing a potentially segmented byte stream into one or multiple files. More...

#include <IFileWriter.h>

Inheritance diagram for mx::IFileWriter:

mx::ISupportsFileSpecification mx::ISegmentedStreamReceiver mx::IInterface mx::IStreamReceiver mx::ISupportsShuttingDown mx::IErrorState mx::IInterface mx::FileWriter List of all members.

Public Member Functions

virtual void writeSingleConcatenatedFile ()=0
 Tells the writer to produce a single file.
virtual void setSegmentSeparator (const mxmString &separator)=0
 Sets the separator string for concatenated write mode, see writeSingleConcatenatedFile().
virtual void writeIndividualFiles (int num)=0
 Tells the writer to produce individual files for the stream segments.

Detailed Description

Encodes the concept of a file writer writing a potentially segmented byte stream into one or multiple files.

In the multiple file case, each stream segment is written to a new, individual file. The files are automatically numbered.

Author:
[khe] Kai Hergenroether


Member Function Documentation

virtual void mx::IFileWriter::writeIndividualFiles int  num  )  [pure virtual]
 

Tells the writer to produce individual files for the stream segments.

Parameters:
num If set to 1, all segments get written to the same one file. If set to num > 1, the segments are written to a set of num files, that cyclically get overwritten and are automatically numbered. Otherwise, the segments get written to an automatically numbered sequence of files, with no limitations on the number of files other than the precision of the counter's integer precision (default).

Implemented in mx::FileWriter.

virtual void mx::IFileWriter::writeSingleConcatenatedFile  )  [pure virtual]
 

Tells the writer to produce a single file.

This is the default behavior.

If set via setSegmentSeparator(), subsequent stream segments will be separated by a separator string.

Implemented in mx::FileWriter.


The documentation for this class was generated from the following file:
Generated on Fri Jun 29 17:21:05 2007 for MxPEG SDK by  doxygen 1.4.6