Extends
Methods
(async) registerScreensaver(screensaverName) → {Promise.<any>}
Register this animation as a screensaver. This is a shorthand method to ManagerLedring#registerScreensaver.
- Overrides:
Parameters:
Name | Type | Description |
---|---|---|
screensaverName |
String
|
The name of the screensaver, as defined in |
Returns:
- Type:
-
Promise.<any>
(async) setProgress(progress) → {Promise.<any>}
Set the current progress
Parameters:
Name | Type | Description |
---|---|---|
progress |
number
|
A progress number between 0 - 1 |
Returns:
- Type:
-
Promise.<any>
(async) start() → {Promise.<any>}
Start the animation.
- Overrides:
Returns:
- Type:
-
Promise.<any>
(async) stop() → {Promise.<any>}
Stop the animation.
- Overrides:
Returns:
- Type:
-
Promise.<any>
(async) unregister() → {Promise.<LedringAnimation>}
Unregister the animation. This is a shorthand method to ManagerLedring#unregisterAnimation.
- Overrides:
Returns:
- Type:
-
Promise.<LedringAnimation>
(async) unregisterScreensaver(screensaverName) → {Promise.<any>}
Unregister this animation as a screensaver. This is a shorthand method to ManagerLedring#unregisterScreensaver.
- Overrides:
Parameters:
Name | Type | Description |
---|---|---|
screensaverName |
String
|
The name of the screensaver, as defined in |
Returns:
- Type:
-
Promise.<any>
(async) updateFrames(frames) → {Promise.<any>}
Update the animation frames.
- Overrides:
Parameters:
Name | Type | Description |
---|---|---|
frames |
Array.<LedringAnimation.Frame>
|
Returns:
- Type:
-
Promise.<any>
Events
.on('finish')
When the animation has finished (duration has been reached)
- Overrides: