ISDKStream Class Reference

Generic data stream interface. More...

#include <stream_interface.h>

Inherits ISDKComponent.

Public Types
enum	SeekOrigin { kBegin = 0, kCurrent = 1, kEnd = 2 }
	Seek origin for stream seek operations. More...
typedef SDKUInt64	DataSize
	Describes the amount of data.
typedef SDKInt64	SeekSize
	Describes the seek position.
typedef SDKUInt64	Position
	Describes the current position.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	Read (void *buffer, const DataSize &size, DataSize *read_size)=0 throw ()
	Reads the requested amount of data from stream to buffer.
virtual SDKResult SDK_CALLTYPE	Write (const void *buffer, const DataSize &size, DataSize *written_size)=0 throw ()
	Writes the requested amount of data from buffer to stream.
virtual SDKResult SDK_CALLTYPE	Seek (const SeekOrigin &origin, const SeekSize &seek_size, Position *new_position)=0 throw ()
	Sets the current position within the stream.
virtual SDKResult SDK_CALLTYPE	SetSize (const DataSize &new_size)=0 throw ()
	Sets a new size for the stream.
virtual SDKResult SDK_CALLTYPE	Flush ()=0 throw ()
	Writes any buffered data to the underlying device.
virtual SDKResult SDK_CALLTYPE	Clone (SDKStreamSP &cloned_stream)=0 throw ()
	Create a clone of the stream object.
virtual SDKResult SDK_CALLTYPE	CopyTo (const SDKStreamSP &dest_stream, const DataSize &size, DataSize *read_size, DataSize *written_size)=0 throw ()
	Copies the requested amount of data from one stream to another stream.

Detailed Description

Generic data stream interface.

Member Enumeration Documentation

SeekOrigin

enum SeekOrigin

Seek origin for stream seek operations.

Enumerator
kBegin	Seek from stream begin.
kCurrent	Seek from current position.
kEnd	Seek from stream end.

---

The documentation for this class was generated from the following file:

• stream_interface.h