RawFileSink Class Reference

EssenceSink that writes a raw file to the currently open file. More...

Inheritance diagram for RawFileSink:

EssenceSink RefCount IRefCount List of all members.

Public Member Functions

 RawFileSink (FileHandle File)
virtual ~RawFileSink ()
 Clean up.
virtual bool PutEssenceData (UInt8 *const Buffer, size_t BufferSize, bool EndOfItem=true)
 Receive the next "installment" of essence data.
virtual bool EndOfData (void)
 Called once all data exhausted.

Protected Attributes

FileHandle File
 The file to write.
bool EndCalled
 True once EndOfData is called.

Private Member Functions

 RawFileSink ()

Detailed Description

EssenceSink that writes a raw file to the currently open file.

Constructor & Destructor Documentation

RawFileSink (  )  [private]

RawFileSink ( FileHandle  File  )  [inline]

virtual ~RawFileSink (  )  [inline, virtual]

Clean up.

Member Function Documentation

virtual bool PutEssenceData ( UInt8 *const   Buffer,
size_t  BufferSize,
bool  EndOfItem = true 
) [inline, virtual]

Receive the next "installment" of essence data.

This will recieve a buffer containing thhe next bytes of essence data

Buffer The data buffer
BufferSize The number of bytes in the data buffer
EndOfItem This buffer is the last in this wrapping item
True if all is OK, else false
The first call may well fail if the sink has not been fully configured.

If false is returned the caller should make no more calls to this function, but the function should be implemented such that it is safe to do so

Implements EssenceSink.

virtual bool EndOfData ( void   )  [inline, virtual]

Called once all data exhausted.

true if all is OK, else false
This function must also be called from the derived class' destructor in case it is never explicitly called

Implements EssenceSink.

Member Data Documentation

FileHandle File [protected]

The file to write.

bool EndCalled [protected]

True once EndOfData is called.

The documentation for this class was generated from the following file:
Generated on Mon Apr 2 15:21:02 2007 for MXFLib by  doxygen 1.5.1-p1