Effects related methods

Functions
void	JBWoprDevice::effectsRegisterDefaultEffect (JBWoprEffectBase *effect)
	Register default effect.
bool	JBWoprDevice::effectsDefaultEffectIsRunning ()
	Check if default effect is running.
void	JBWoprDevice::effectsRegisterEffect (JBWoprEffectBase *effect)
	Register effect.
std::vector< JBWoprEffectBase * >	JBWoprDevice::effectsGetRegisteredEffects ()
	Get a list of registered effects.
JBWoprEffectBase *	JBWoprDevice::effectsGetCurrentEffect ()
	Get current effect.
virtual void	JBWoprDevice::effectsStartCurrentEffect ()
	Start current effect.
virtual void	JBWoprDevice::effectsStopCurrentEffect ()
	Stop current effect.
bool	JBWoprDevice::effectsCurrentEffectIsRunning ()
	Check if current effect is running.
virtual void	JBWoprDevice::effectsStartEffect (JBWoprEffectBase *effect)
	Start effect.
virtual void	JBWoprDevice::effectsStartEffect (const std::string &name)
	Start named effect.
virtual void	JBWoprDevice::effectsStartEffect (const char *name)
	Start named effect.
void	JBWoprMqttDevice::effectsStartCurrentEffect () override
	Effects start current effect.
virtual void	JBWoprMqttDevice::effectsStopCurrentEffect ()
	Stop current effect.
void	JBWoprMqttDevice::effectsStartEffect (JBWoprEffectBase *effect) override
	Effects start effect.
void	JBWoprMqttDevice::effectsStartEffect (const std::string &effect) override
	Effects start effect.
void	JBWoprMqttDevice::effectsStartEffect (const char *effect) override
	Effects start effect.

Detailed Description

Function Documentation

effectsCurrentEffectIsRunning()

bool JBWoprDevice::effectsCurrentEffectIsRunning

(

)

Check if current effect is running.

Returns

True if current effect is running

effectsDefaultEffectIsRunning()

bool JBWoprDevice::effectsDefaultEffectIsRunning

(

)

Check if default effect is running.

Returns

True if default effect is running

effectsGetCurrentEffect()

JBWoprEffectBase * JBWoprDevice::effectsGetCurrentEffect

(

)

Get current effect.

Returns

Current effect

effectsGetRegisteredEffects()

std::vector< JBWoprEffectBase * > JBWoprDevice::effectsGetRegisteredEffects

(

)

Get a list of registered effects.

Returns

Default effects

effectsRegisterDefaultEffect()

void JBWoprDevice::effectsRegisterDefaultEffect

(

JBWoprEffectBase *

effect

)

Register default effect.

Note

If a default effect is registered, it will be started after a timeout set by _config.effectsTimeout after any other effect is done running.

Parameters

effect

Effect to register

effectsRegisterEffect()

void JBWoprDevice::effectsRegisterEffect

(

JBWoprEffectBase *

effect

)

Register effect.

Parameters

effect

Effect to register

effectsStartCurrentEffect() [1/2]

void JBWoprDevice::effectsStartCurrentEffect ( )

virtual

Start current effect.

Reimplemented in JBWoprMqttDevice.

effectsStartCurrentEffect() [2/2]

void JBWoprMqttDevice::effectsStartCurrentEffect ( )

overridevirtual

Effects start current effect.

Reimplemented from JBWoprDevice.

effectsStartEffect() [1/6]

void JBWoprMqttDevice::effectsStartEffect ( const char *  effect )

overridevirtual

Effects start effect.

This method will start the named effect.

Parameters

effect

Effect name

Reimplemented from JBWoprDevice.

effectsStartEffect() [2/6]

void JBWoprDevice::effectsStartEffect ( const char *  name )

virtual

Start named effect.

Parameters

name	Name of effect to start

Reimplemented in JBWoprMqttDevice.

effectsStartEffect() [3/6]

void JBWoprMqttDevice::effectsStartEffect ( const std::string &  effect )

overridevirtual

Effects start effect.

This method will start the name effect.

Parameters

effect

Effect name

Reimplemented from JBWoprDevice.

effectsStartEffect() [4/6]

void JBWoprDevice::effectsStartEffect ( const std::string &  name )

virtual

Start named effect.

Parameters

name	Name of effect to start

Reimplemented in JBWoprMqttDevice.

effectsStartEffect() [5/6]

void JBWoprDevice::effectsStartEffect ( JBWoprEffectBase *  effect )

virtual

Start effect.

Parameters

effect	Effect to start
duration	Duration of effect in milliseconds

Reimplemented in JBWoprMqttDevice.

effectsStartEffect() [6/6]

void JBWoprMqttDevice::effectsStartEffect ( JBWoprEffectBase *  effect )

overridevirtual

Effects start effect.

This method will start the specified effect.

Parameters

effect

Effect

Reimplemented from JBWoprDevice.

effectsStopCurrentEffect() [1/2]

void JBWoprDevice::effectsStopCurrentEffect ( )

virtual

Stop current effect.

Reimplemented in JBWoprMqttDevice.

effectsStopCurrentEffect() [2/2]

void JBWoprMqttDevice::effectsStopCurrentEffect ( )

virtual

Stop current effect.

Reimplemented from JBWoprDevice.