Murl::Audio::IFactory Interface Referenceabstract
The factory used to create and destroy audio renderers. More...
#include "murl_audio_i_factory.h"
Inheritance diagram for Murl::Audio::IFactory:
Public Member Functions | |
virtual Bool | Init ()=0 |
Initialize the factory. More... | |
virtual Bool | DeInit ()=0 |
Deinitialize the factory. More... | |
virtual IRenderer * | CreateDefaultRenderer ()=0 |
Create a default audio renderer. More... | |
virtual IRenderer * | CreateRenderer (const String &className)=0 |
Create a audio renderer from the set of registered renderers. More... | |
virtual IRenderer * | CreateRenderer (const IRenderer::ClassInfo &classInfo)=0 |
Create a audio renderer from the set of registered renderers. More... | |
virtual Bool | DestroyRenderer (IRenderer *&renderer)=0 |
Destroy a previously created audio renderer. More... | |
Public Member Functions inherited from Murl::Audio::IFactoryRegistry | |
virtual Bool | RegisterRendererClass (const IRenderer::ClassInfo &classInfo)=0 |
Register a audio renderer class. More... | |
virtual Bool | UnregisterRendererClass (const IRenderer::ClassInfo &classInfo)=0 |
Unregister a previously registered audio renderer class. More... | |
virtual SInt32 | GetRegisteredRendererClassInfoIndex (const IRenderer::ClassInfo &classInfo) const =0 |
Query the index of a registered audio renderer class, by its ClassInfo structure. More... | |
virtual SInt32 | GetRegisteredRendererClassInfoIndex (const String &className) const =0 |
Query the index of a registered audio renderer class, by its class name. More... | |
virtual UInt32 | GetNumberOfRegisteredRendererClassInfos () const =0 |
Get the total number of registered audio renderer classes. More... | |
virtual const IRenderer::ClassInfo * | GetRegisteredRendererClassInfo (UInt32 index) const =0 |
Get the ClassInfo structure of a registered audio renderer class. More... | |
Detailed Description
The factory used to create and destroy audio renderers.
Use the Audio::IFactoryRegistry base interface for managing registered renderer classes.
Member Function Documentation
◆ Init()
|
pure virtual |
Initialize the factory.
- Returns
- true if successful.
◆ DeInit()
|
pure virtual |
Deinitialize the factory.
- Returns
- true if successful.
◆ CreateDefaultRenderer()
|
pure virtual |
Create a default audio renderer.
- Returns
- The newly created renderer, or null if failed.
◆ CreateRenderer() [1/2]
Create a audio renderer from the set of registered renderers.
- Parameters
-
className The class name of the renderer to create.
- Returns
- The newly created renderer, or null if failed.
◆ CreateRenderer() [2/2]
|
pure virtual |
Create a audio renderer from the set of registered renderers.
- Parameters
-
classInfo The ClassInfo structure of the renderer to create.
- Returns
- The newly created renderer, or null if failed.
◆ DestroyRenderer()
Destroy a previously created audio renderer.
- Parameters
-
renderer A reference to a pointer holding the renderer to destroy.
- Returns
- true if successful.
The documentation for this interface was generated from the following file:
- murl_audio_i_factory.h