ibstream.h

Go to the documentation of this file.

 //-----------------------------------------------------------------------------
// Project     : SDK Core
//
// Category    : SDK Core Interfaces
// Filename    : pluginterfaces/base/ibstream.h
// Created by  : Steinberg, 01/2004
// Description : Interface for reading/writing streams
//
//-----------------------------------------------------------------------------
// This file is part of a Steinberg SDK. It is subject to the license terms
// in the LICENSE file found in the top-level directory of this distribution
// and at www.steinberg.net/sdklicenses. 
// No part of the SDK, including this file, may be copied, modified, propagated,
// or distributed except according to the terms contained in the LICENSE file.
//-----------------------------------------------------------------------------
 
#pragma once
 
#include "funknown.h"
 
namespace Steinberg {
 
//------------------------------------------------------------------------
class IBStream: public FUnknown
{
public:
    enum IStreamSeekMode
    {
        kIBSeekSet = 0, 
        kIBSeekCur,     
        kIBSeekEnd      
    };
 
//------------------------------------------------------------------------
    virtual tresult PLUGIN_API read (void* buffer, int32 numBytes, int32* numBytesRead = nullptr) = 0;
    
    virtual tresult PLUGIN_API write (void* buffer, int32 numBytes, int32* numBytesWritten = nullptr) = 0;
    
    virtual tresult PLUGIN_API seek (int64 pos, int32 mode, int64* result = nullptr) = 0;
    
    virtual tresult PLUGIN_API tell (int64* pos) = 0;
//------------------------------------------------------------------------
    static const FUID iid;
};
 
DECLARE_CLASS_IID (IBStream, 0xC3BF6EA2, 0x30994752, 0x9B6BF990, 0x1EE33E9B)
 
//------------------------------------------------------------------------
class ISizeableStream: public FUnknown
{
public:
//------------------------------------------------------------------------
    virtual tresult PLUGIN_API getStreamSize (int64& size) = 0;
    virtual tresult PLUGIN_API setStreamSize (int64 size) = 0;
 
//------------------------------------------------------------------------
    static const FUID iid;
};
DECLARE_CLASS_IID (ISizeableStream, 0x04F9549E, 0xE02F4E6E, 0x87E86A87, 0x47F4E17F)
 
//------------------------------------------------------------------------
} // namespace Steinberg