Spinning Topp Logo BlackTopp Studios
inc
Public Member Functions | List of all members
Mezzanine::Audio::iDecoderFactory Class Referenceabstract

This is an interface class for factories that create decoders. More...

#include <decoderfactory.h>

Public Member Functions

 iDecoderFactory ()
 Class constructor.
 
virtual ~iDecoderFactory ()
 Class destructor.
 
virtual iDecoderCreateDecoder (Resource::DataStreamPtr Stream)=0
 Creates a new iDecoder for use. More...
 
virtual Audio::Encoding GetSupportedEncoding () const =0
 Gets the encoding supported by decoders made by this factory. More...
 

Detailed Description

This is an interface class for factories that create decoders.

Definition at line 56 of file decoderfactory.h.

Member Function Documentation

virtual iDecoder* Mezzanine::Audio::iDecoderFactory::CreateDecoder ( Resource::DataStreamPtr  Stream)
pure virtual

Creates a new iDecoder for use.

Parameters
StreamA smart pointer to the stream containing audio data.
Returns
Returns the newly created iDecoder, or NULL if there was a failure.
virtual Audio::Encoding Mezzanine::Audio::iDecoderFactory::GetSupportedEncoding ( ) const
pure virtual

Gets the encoding supported by decoders made by this factory.

Returns
Returns an Audio::Encoding value representing the encoding supported by this factory.

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