EffectFileHandler Class Reference

Inheritance diagram for EffectFileHandler:

Public Slots
void	handleSettingsUpdate (const settings::type &type, const QJsonDocument &config)
	Handle settings update from Hyperion Settingsmanager emit. More...

Signals
void	effectListChanged ()
	Emits whenever the data changes for an effect.

Public Member Functions
const std::list< EffectDefinition > &	getEffects () const
	Get all available effects.
const std::list< EffectSchema > &	getEffectSchemas ()
	Get all available schemas.
bool	saveEffect (const QJsonObject &obj, QString &resultMsg)
	Save an effect. More...
bool	deleteEffect (const QString &effectName, QString &resultMsg)
	Delete an effect by name. More...

Static Public Member Functions
static EffectFileHandler *	getInstance ()

Static Public Attributes
static EffectFileHandler *	efhInstance

Friends
class	HyperionDaemon

Member Function Documentation

deleteEffect()

bool EffectFileHandler::deleteEffect	(	const QString &	effectName,
		QString &	resultMsg
	)

Delete an effect by name.

Parameters

[in]	effectName	The effect name to delete
[out]	resultMsg	The message on error

Returns

True on success else false

handleSettingsUpdate

void EffectFileHandler::handleSettingsUpdate ( const settings::type &  type, const QJsonDocument &  config  )

slot

Handle settings update from Hyperion Settingsmanager emit.

Parameters

type	settingyType from enum
config	configuration object

saveEffect()

bool EffectFileHandler::saveEffect	(	const QJsonObject &	obj,
		QString &	resultMsg
	)

Save an effect.

Parameters

	obj	The effect args
[out]	resultMsg	The feedback message

Returns

True on success else false

---

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

• include/effectengine/EffectFileHandler.h
• libsrc/effectengine/EffectFileHandler.cpp