IBStream Class Reference
[Basic Interfaces]

Base class for streams. More...

#include <ibstream.h>

Inheritance diagram for IBStream:
Inheritance graph
[legend]

Public Types

enum  IStreamSeekMode { kIBSeekSet = 0, kIBSeekCur, kIBSeekEnd }

Public Member Functions

virtual tresult read (void *buffer, int32 numBytes, int32 *numBytesRead=0)=0
 Reads binary data from stream.
virtual tresult write (void *buffer, int32 numBytes, int32 *numBytesWritten=0)=0
 Writes binary data to stream.
virtual tresult seek (int64 pos, int32 mode, int64 *result=0)=0
 Sets stream read-write position.
virtual tresult tell (int64 *pos)=0
 Gets current stream read-write position.

Static Public Attributes

static const FUID iid

Detailed Description

Base class for streams.


Member Enumeration Documentation

Enumerator:
kIBSeekSet 

set absolute seek position

kIBSeekCur 

set seek position relative to current position

kIBSeekEnd 

set seek position relative to stream end


Member Function Documentation

virtual tresult read ( void *  buffer,
int32  numBytes,
int32 numBytesRead = 0 
) [pure virtual]

Reads binary data from stream.

Parameters:
buffer : destination buffer
numBytes : amount of bytes to be read
numBytesRead : result - how many bytes have been read from stream (set to 0 if this is of no interest)
virtual tresult write ( void *  buffer,
int32  numBytes,
int32 numBytesWritten = 0 
) [pure virtual]

Writes binary data to stream.

Parameters:
buffer : source buffer
numBytes : amount of bytes to write
numBytesWritten : result - how many bytes have been written to stream (set to 0 if this is of no interest)
virtual tresult seek ( int64  pos,
int32  mode,
int64 result = 0 
) [pure virtual]

Sets stream read-write position.

Parameters:
pos : new stream position (dependent on mode)
mode : value of enum IStreamSeekMode
result : new seek position (set to 0 if this is of no interest)
virtual tresult tell ( int64 pos  )  [pure virtual]

Gets current stream read-write position.

Parameters:
pos : is assigned the current position if function succeeds

Field Documentation

const FUID iid [static]

Reimplemented from FUnknown.

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines
Empty

Copyright ©2013 Steinberg Media Technologies GmbH. All Rights Reserved.