yodaRT.activity.Activity. LightClient

Extends

Methods

play(uri, args, optionsopt) → {Promise.<void>}

play the given light effect

Parameters:
Name Type Attributes Description
uri string

the light resource uri.

args object

the args.

options object <optional>
Name Type Attributes Description
zIndex number <optional>

number of layers to play. default minimum layer

shouldResume boolean <optional>
Returns:
Type:
Promise<void>

stop(uriopt) → {Promise.<void>}

stop the given light effect and clear from the recovery queue

Parameters:
Name Type Attributes Description
uri string <optional>

the light resource uri.

Returns:
Type:
Promise<void>