Methods
registerScreensaver
(async) registerScreensaver(screensaverName): Promise.<any>Register this animation as a screensaver. This is a shorthand method to ManagerLedring#registerScreensaver.
Parameters
Name | Type | Description |
---|---|---|
screensaverName
|
string | The name of the screensaver, as defined in |
Returns
start
(async) start(): Promise.<any>Start the animation.
Returns
stop
(async) stop(): Promise.<any>Stop the animation.
Returns
unregister
(async) unregister(): Promise.<LedringAnimation>Unregister the animation. This is a shorthand method to ManagerLedring#unregisterAnimation.
Returns
unregisterScreensaver
(async) unregisterScreensaver(screensaverName): Promise.<any>Unregister this animation as a screensaver. This is a shorthand method to ManagerLedring#unregisterScreensaver.
Parameters
Name | Type | Description |
---|---|---|
screensaverName
|
string | The name of the screensaver, as defined in |
Returns
updateFrames
(async) updateFrames(frames): Promise.<any>Update the animation frames.
Parameters
Name | Type | Description |
---|---|---|
frames
|
Array.<LedringAnimation.Frame> |
Returns
Type Definitions
Frame
FrameProperties
Name | Type | Description |
---|---|---|
r
|
number | between 0 and 255. |
g
|
number | between 0 and 255. |
b
|
number | between 0 and 255. |
Events
finish
.on('finish')This event is fired when the animation has finished (duration has been reached).
start
.on('start')This event is fired when the animation has started.
stop
.on('stop')This event is fired when the animation has stopped.