hyperion.ng
Public Slots | Signals | Public Member Functions | List of all members
EffectEngine Class Reference
Inheritance diagram for EffectEngine:

Public Slots

int runEffect (const QString &effectName, int priority, int timeout=-1, const QString &origin="System")
 Run the specified effect on the given priority channel and optionally specify a timeout.
 
int runEffect (const QString &effectName, const QJsonObject &args, int priority, int timeout=-1, const QString &pythonScript="", const QString &origin="System", unsigned smoothCfg=0, const QString &imageData="")
 Run the specified effect on the given priority channel and optionally specify a timeout.
 
void channelCleared (int priority)
 Clear any effect running on the provided channel.
 
void allChannelsCleared ()
 Clear all effects.
 

Signals

void effectListUpdated ()
 Emit when the effect list has been updated.
 

Public Member Functions

 EffectEngine (Hyperion *hyperion)
 
const std::list< EffectDefinition > & getEffects () const
 
const std::list< ActiveEffectDefinition > & getActiveEffects ()
 
const std::list< EffectSchema > & getEffectSchemas ()
 Get available schemas from EffectFileHandler. More...
 
bool saveEffect (const QJsonObject &obj, QString &resultMsg)
 Save an effect with EffectFileHandler. More...
 
bool deleteEffect (const QString &effectName, QString &resultMsg)
 Delete an effect by name. More...
 
void cacheRunningEffects ()
 Get all init data of the running effects and stop them.
 
void startCachedEffects ()
 Start all cached effects, origin and smooth cfg is default.
 

Member Function Documentation

§ deleteEffect()

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

Delete an effect by name.

Parameters
[in]effectNameThe effect name to delete
[out]resultMsgThe message on error
Returns
True on success else false

§ getEffectSchemas()

const std::list< EffectSchema > & EffectEngine::getEffectSchemas ( )

Get available schemas from EffectFileHandler.

Returns
all schemas

§ saveEffect()

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

Save an effect with EffectFileHandler.

Parameters
objThe effect args
[out]resultMsgThe feedback message
Returns
True on success else false

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