Steinberg::Vst::ReadOnlyBStream Class Reference

Stream representing a Read-Only subsection of its source stream. More...

#include "vstpresetfile.h"

Inheritance diagram for Steinberg::Vst::ReadOnlyBStream:

Public Member Functions
	ReadOnlyBStream (IBStream *sourceStream, TSize sourceOffset, TSize sectionSize)
DECLARE_FUNKNOWN_METHODS tresult PLUGIN_API	read (void *buffer, int32 numBytes, int32 *numBytesRead=nullptr) SMTG_OVERRIDE
	Reads binary data from stream.
tresult PLUGIN_API	write (void *buffer, int32 numBytes, int32 *numBytesWritten=nullptr) SMTG_OVERRIDE
	Writes binary data to stream.
tresult PLUGIN_API	seek (int64 pos, int32 mode, int64 *result=nullptr) SMTG_OVERRIDE
	Sets stream read-write position.
tresult PLUGIN_API	tell (int64 *pos) SMTG_OVERRIDE
	Gets current stream read-write position.
Public Member Functions inherited from Steinberg::FUnknown
virtual tresult PLUGIN_API	queryInterface (const TUID _iid, void **obj)=0
	Query for a pointer to the specified interface.
virtual uint32 PLUGIN_API	addRef ()=0
	Adds a reference and returns the new reference count.
virtual uint32 PLUGIN_API	release ()=0
	Releases a reference and returns the new reference count.

Protected Attributes
IBStream *	sourceStream
TSize	sourceOffset
TSize	sectionSize
TSize	seekPosition

Additional Inherited Members
Public Types inherited from Steinberg::IBStream
enum	IStreamSeekMode { kIBSeekSet , kIBSeekCur , kIBSeekEnd }
Static Public Attributes inherited from Steinberg::IBStream
static const FUID	iid
Static Public Attributes inherited from Steinberg::FUnknown
static const FUID	iid

Detailed Description

Stream representing a Read-Only subsection of its source stream.

Definition at line 258 of file vstpresetfile.h.

Constructor & Destructor Documentation

ReadOnlyBStream()

Steinberg::Vst::ReadOnlyBStream::ReadOnlyBStream	(	IBStream *	sourceStream,
		TSize	sourceOffset,
		TSize	sectionSize
	)

Definition at line 748 of file vstpresetfile.cpp.

~ReadOnlyBStream()

Steinberg::Vst::ReadOnlyBStream::~ReadOnlyBStream ( )

virtual

Definition at line 760 of file vstpresetfile.cpp.

Member Function Documentation

read()

tresult PLUGIN_API Steinberg::Vst::ReadOnlyBStream::read ( void *  buffer, int32  numBytes, int32 *  numBytesRead = nullptr  )

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)

Implements Steinberg::IBStream.

Definition at line 775 of file vstpresetfile.cpp.

seek()

tresult PLUGIN_API Steinberg::Vst::ReadOnlyBStream::seek ( int64  pos, int32  mode, int64 *  result = nullptr  )

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)

Implements Steinberg::IBStream.

Definition at line 815 of file vstpresetfile.cpp.

tell()

tresult PLUGIN_API Steinberg::Vst::ReadOnlyBStream::tell ( int64 *  pos )

virtual

Gets current stream read-write position.

Parameters

pos	: is assigned the current position if function succeeds

Implements Steinberg::IBStream.

Definition at line 837 of file vstpresetfile.cpp.

write()

tresult PLUGIN_API Steinberg::Vst::ReadOnlyBStream::write ( void *  buffer, int32  numBytes, int32 *  numBytesWritten = nullptr  )

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)

Implements Steinberg::IBStream.

Definition at line 805 of file vstpresetfile.cpp.

Member Data Documentation

sectionSize

TSize Steinberg::Vst::ReadOnlyBStream::sectionSize

protected

Definition at line 278 of file vstpresetfile.h.

seekPosition

TSize Steinberg::Vst::ReadOnlyBStream::seekPosition

protected

Definition at line 279 of file vstpresetfile.h.

sourceOffset

TSize Steinberg::Vst::ReadOnlyBStream::sourceOffset

protected

Definition at line 277 of file vstpresetfile.h.

sourceStream

IBStream* Steinberg::Vst::ReadOnlyBStream::sourceStream

protected

Definition at line 276 of file vstpresetfile.h.

---

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

• juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstpresetfile.h
• juce_audio_processors/format_types/VST3_SDK/public.sdk/source/vst/vstpresetfile.cpp