Vsdk::SpeechEnhancement::Engine

#include <Engine.hpp>

Inheritance diagram for Vsdk::SpeechEnhancement::Engine:

Classes
struct	SpeechEnhancerInfo

Public Member Functions
	~Engine ()
auto	speechEnhancer (std::string const &name) -> std::shared_ptr< SpeechEnhancer >
auto	speechEnhancersInfo () const -> std::unordered_map< std::string, SpeechEnhancerInfo > const &
	Gets available speech enhancers info.

Static Public Member Functions
template<class T , typename... Args>
static auto	make (Args &&... args) -> std::shared_ptr< Engine >
	Gets or constructs a shared SpeechEnhancement::Engine instance of type T with args.

Protected Member Functions
	Engine (char const *name, std::string const &configPath)
	Engine (char const *name, nlohmann::json config)
	Engine (char const *name, char const *configPath)
	Specialization used to avoid overload collisions, forwards to Engine(char const*, std::string const &);
virtual auto	makeSpeechEnhancer (std::string name) -> SpeechEnhancer *=0
void	setEnhancerInfo (std::string const &name, SpeechEnhancerInfo info)

Constructor & Destructor Documentation

Engine() [1/3]

Engine::Engine ( char const * name, std::string const & configPath )

protected

Parameters

name	Name of the configuration object in vsdk.json
configPath	Path to a vsdk.json formatted file

Engine() [2/3]

Engine::Engine ( char const * name, nlohmann::json config )

protected

Parameters

name	Name of the configuration object in vsdk.json
config	A vsdk.json formatted JSON configuration object

Engine() [3/3]

Engine::Engine ( char const * name, char const * configPath )

protected

Specialization used to avoid overload collisions, forwards to Engine(char const*, std::string const &);

Parameters

name	Name of the configuration object in vsdk.json
configPath	Path to a vsdk.json formatted file

~Engine()

Engine::~Engine

(

)

Member Function Documentation

make()

template<class T , typename... Args>

static auto Vsdk::SpeechEnhancement::Engine::make ( Args &&... args ) -> std::shared_ptr<Engine>

static

Gets or constructs a shared SpeechEnhancement::Engine instance of type T with args.

Note

If an engine of this type exists, a shared instance will be returned instead.

speechEnhancer()

auto Engine::speechEnhancer

(

std::string const &

name

)

-> std::shared_ptr<SpeechEnhancer>

speechEnhancersInfo()

auto Engine::speechEnhancersInfo

(

)

const -> std::unordered_map<std::string, SpeechEnhancerInfo> const &

Gets available speech enhancers info.

makeSpeechEnhancer()

virtual auto Vsdk::SpeechEnhancement::Engine::makeSpeechEnhancer ( std::string name ) -> SpeechEnhancer *

protectedpure virtual

setEnhancerInfo()

void Engine::setEnhancerInfo ( std::string const & name, Engine::SpeechEnhancerInfo info )

protected

Note

If info.name.empty() then removes entry