Skylicht::Audio::IStreamFactory Class Reference

Interface for stream factories. Register a custom factory to CAudioEngine to support different data sources (e.g. ZIP, Network). More...

#include <Stream/IStreamFactory.h>

Inheritance diagram for Skylicht::Audio::IStreamFactory:

Public Member Functions
virtual IStream *	createStreamFromMemory (unsigned char *buffer, int size, bool takeOwnership)=0
	Create an audio stream from a memory buffer.
virtual IStream *	createStreamFromFile (const char *fileName)=0
	Create an audio stream from a file.
virtual IStream *	createOnlineStream ()=0
	Create a stream for dynamic/online data.

Detailed Description

Interface for stream factories. Register a custom factory to CAudioEngine to support different data sources (e.g. ZIP, Network).

// Example: Implementing a factory for ZIP archives using Irrlicht's file system
class CZipAudioStreamFactory : public Audio::CStreamFactory {
public:
    virtual Audio::IStream* createStreamFromFile(const char* fileName) {
        // Create a custom stream that reads from ZIP
        CZipAudioFileStream* file = new CZipAudioFileStream(fileName);
        if (file->isError()) {
            delete file;
            return NULL;
        }
        return file;
    }
};
 
// Registration
CZipAudioStreamFactory* factory = new CZipAudioStreamFactory();
Audio::CAudioEngine::getSoundEngine()->registerStreamFactory(factory);

Member Function Documentation

createOnlineStream()

virtual IStream * Skylicht::Audio::IStreamFactory::createOnlineStream ( )

pure virtual

Create a stream for dynamic/online data.

Returns

Pointer to IStream

Implemented in Skylicht::Audio::CStreamFactory.

createStreamFromFile()

virtual IStream * Skylicht::Audio::IStreamFactory::createStreamFromFile ( const char * fileName )

pure virtual

Create an audio stream from a file.

Parameters

fileName

Path to the file

Returns

Pointer to IStream

Implemented in Skylicht::Audio::CStreamFactory, and Skylicht::CZipAudioStreamFactory.

createStreamFromMemory()

virtual IStream * Skylicht::Audio::IStreamFactory::createStreamFromMemory ( unsigned char * buffer, int size, bool takeOwnership )

pure virtual

Create an audio stream from a memory buffer.

Parameters

buffer	The memory buffer
size	Size in bytes
takeOwnership	If true, the factory/stream will delete the buffer

Returns

Pointer to IStream

Implemented in Skylicht::Audio::CStreamFactory.

---

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

• Stream/IStreamFactory.h