Class Scenes

ReadonlyConnection

ReadonlyScenes

findByName

• findByName(sceneName): 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.

onAddedScene

• onAddedScene(handler): 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.

onChangedScene

• onChangedScene(handler): 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.

onRemovedScene

• onRemovedScene(handler): 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.

refreshScenesAsync

• refreshScenesAsync(): Promise<void>

• Returns Promise<void>

StaticcreateScenesAsync

• createScenesAsync(Connection): 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.