Audaspace  1.3.0
A high level audio library.
Public Member Functions | List of all members
IFileInput Interface Referenceabstract

The IFileInput interface represents a file input plugin that can create file input readers from filenames or buffers. More...

#include <IFileInput.h>

Inheritance diagram for IFileInput:
Inheritance graph
[legend]

Public Member Functions

virtual std::shared_ptr< IReadercreateReader (std::string filename)=0
 Creates a reader for a file to be read. More...
 
virtual std::shared_ptr< IReadercreateReader (std::shared_ptr< Buffer > buffer)=0
 Creates a reader for a file to be read from memory. More...
 

Detailed Description

The IFileInput interface represents a file input plugin that can create file input readers from filenames or buffers.

Member Function Documentation

◆ createReader() [1/2]

virtual std::shared_ptr<IReader> IFileInput::createReader ( std::shared_ptr< Buffer buffer)
pure virtual

Creates a reader for a file to be read from memory.

Parameters
bufferThe in-memory file buffer.
Returns
The reader that reads the file.
Exceptions
ExceptionThrown if the file specified cannot be read.

Implemented in SndFile, and FFMPEG.

◆ createReader() [2/2]

virtual std::shared_ptr<IReader> IFileInput::createReader ( std::string  filename)
pure virtual

Creates a reader for a file to be read.

Parameters
filenamePath to the file to be read.
Returns
The reader that reads the file.
Exceptions
ExceptionThrown if the file specified cannot be read.

Implemented in SndFile, and FFMPEG.


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