Class Scenes

Use the scenes object to retrieve a list of scenes known to your KLF interface and to start one of them.

Scenes

Implements

Disposable

Index

Properties

Connection Scenes

Methods

[dispose] findByName onAddedScene onChangedScene onRemovedScene refreshScenesAsync createScenesAsync

Properties

`Readonly`Connection

Connection: IConnection

`Readonly`Scenes

Scenes: Scene[] = []

The list of scenes objects that correspond to the scenes defined at the KLF 200 interface.

The array index corresponds to the scene ID.

Methods

[dispose]

"[dispose]"(): void
Returns void
Implementation of Disposable.[dispose]
- Defined in scenes.ts:260

findByName

findByName(sceneName: string): undefined | Scene
Finds a scene by its name and returns the scene object.
Parameters
- sceneName: string
  The name of the scene.
Returns undefined | Scene
Returns the scene object if found, otherwise undefined.
- Defined in scenes.ts:445

onAddedScene

onAddedScene(handler: Listener<number>): Disposable
Add an event handler that is called if a scene has been added.
Parameters
- handler: Listener<number>
  The handler that is called if the event is emitted.
Returns Disposable
Call the dispose method of the returned object to remove the handler.
- Defined in scenes.ts:419

onChangedScene

onChangedScene(handler: Listener<number>): Disposable
Add an event handler that is called if a scene has been changed.
Parameters
- handler: Listener<number>
  The handler that is called if the event is emitted.
Returns Disposable
Call the dispose method of the returned object to remove the handler.
- Defined in scenes.ts:397

onRemovedScene

onRemovedScene(handler: Listener<number>): Disposable
Add an event handler that is called if a scene has been removed.
Parameters
- handler: Listener<number>
  The handler that is called if the event is emitted.
Returns Disposable
Call the dispose method of the returned object to remove the handler.
- Defined in scenes.ts:408

refreshScenesAsync

refreshScenesAsync(): Promise<void>
Returns Promise<void>
- Defined in scenes.ts:291

`Static`createScenesAsync

createScenesAsync(Connection: IConnection): Promise<Scenes>
Creates an instance of Scenes.
Parameters
- Connection: IConnection
  The connection that will be used to send and receive commands.
Returns Promise<Scenes>
Returns a new Scenes object that is initialized, already.
- Defined in scenes.ts:282