Steinberg::IBStream Class Reference

#include <ibstream.h>

Inheritance diagram for Steinberg::IBStream:

List of all members.

Public Types
	kIBSeekSet = 0
	set absolute seek position
	kIBSeekCur
	set seek position relative to current position
	kIBSeekEnd
	set seek position relative to stream end
enum	IStreamSeekMode { kIBSeekSet = 0, kIBSeekCur, kIBSeekEnd }
Public Member Functions
virtual tresult PLUGIN_API	read (void *buffer, int32 numBytes, int32 *numBytesRead=0)=0
virtual tresult PLUGIN_API	write (void *buffer, int32 numBytes, int32 *numBytesWritten=0)=0
virtual tresult PLUGIN_API	seek (int64 pos, int32 mode, int64 *result=0)=0
virtual tresult PLUGIN_API	tell (int64 *pos)=0
Static Public Attributes
static const FUID	iid

---

Detailed Description

Base class for streams.

• read / write binary data into/from stream
• get/set stream read-write position (read and write position is the same)

Definition at line 50 of file ibstream.h.

---

Member Enumeration Documentation

enum Steinberg::IBStream::IStreamSeekMode

Enumerator:

kIBSeekSet	set absolute seek position
kIBSeekCur	set seek position relative to current position
kIBSeekEnd	set seek position relative to stream end

Definition at line 53 of file ibstream.h.

---

Member Function Documentation

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

Read binary from stream.

Parameters:

	buffer	: destination buffer
	numBytes	: amount of bytes to be read
	numBytesRead	: result - how many bytes have been read from stream (can be 0 if this is of no interest)

Implemented in Steinberg::Vst::FileStream.

virtual tresult PLUGIN_API Steinberg::IBStream::seek	(	int64	pos,
		int32	mode,
		int64 *	result = 0
	)			[pure virtual]

Set stream read-write position.

Parameters:

	pos	: new stream position (dependent on mode)
	mode	: value of enum IStreamSeekMode
	result	: new seek position (can be 0 if this is of no interest)

Implemented in Steinberg::Vst::FileStream.

virtual tresult PLUGIN_API Steinberg::IBStream::tell

(

int64 *

pos

)

[pure virtual]

Get current stream read-write position.

Parameters:

pos

: Is assigned the current position if function succeeds

Implemented in Steinberg::Vst::FileStream.

virtual tresult PLUGIN_API Steinberg::IBStream::write	(	void *	buffer,
		int32	numBytes,
		int32 *	numBytesWritten = 0
	)			[pure virtual]

Write binary to stream.

Parameters:

	buffer	: source buffer
	numBytes	: amount of bytes to write
	numBytesWritten	: result - how many bytes have been written to stream (can be 0 if this is of no interest)

Implemented in Steinberg::Vst::FileStream.

---

Member Data Documentation

const FUID Steinberg::IBStream::iid [static]

Reimplemented from Steinberg::FUnknown.

Definition at line 83 of file ibstream.h.

---

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

• ibstream.h

---

Copyright ©2008 Steinberg Media Technologies. All Rights Reserved.