This plugin class reads and writes sounds via libsndfile. More...

#include <SndFile.h>

Inheritance diagram for SndFile:

Public Member Functions
	SndFile ()
	Creates a new libsndfile plugin.

virtual std::shared_ptr< IReader >	createReader (std::string filename)
	Creates a reader for a file to be read. More...

virtual std::shared_ptr< IReader >	createReader (std::shared_ptr< Buffer > buffer)
	Creates a reader for a file to be read from memory. More...

virtual std::shared_ptr< IWriter >	createWriter (std::string filename, DeviceSpecs specs, Container format, Codec codec, unsigned int bitrate)
	Creates a new file writer. More...

Static Public Member Functions
static void	registerPlugin ()
	Registers this plugin.

Detailed Description

This plugin class reads and writes sounds via libsndfile.

Member Function Documentation

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

virtual

Creates a reader for a file to be read.

Parameters

filename Path to the file to be read.

Exceptions

Exception Thrown if the file specified cannot be read.

Implements IFileInput.

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

virtual

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

Parameters

buffer The in-memory file buffer.

Exceptions

Exception Thrown if the file specified cannot be read.

Implements IFileInput.

virtual std::shared_ptr<IWriter> SndFile::createWriter	(	std::string	filename,
		DeviceSpecs	specs,
		Container	format,
		Codec	codec,
		unsigned int	bitrate
	)

virtual

Creates a new file writer.

Parameters

filename	The path to the file to be written.
specs	The file's audio specification.
format	The file's container format.
codec	The codec used for encoding the audio data.
bitrate	The bitrate for encoding.

Exceptions

Exception Thrown if the file specified cannot be written.

Implements IFileOutput.

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