HomeServerConnector. _Scene
Methods
new _Scene()
Szene.
Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode
HomeServerConnector._Connection#getScene erzeugt.
Example
var sc = conn.getScene("SC@MyScene", function(err, data) {});
Methods
call(callback)
Ruft die Szene ab.
Example
sc.call(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
destroy()
Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.
Example
sc.destroy();
getActors(callback)
Abrufen einer Liste mit Daten zu jedem in der Szene verwendeten KO. Jeder Eintrag in der Liste enthält die Daten zu einem KO.
Example
sc.getActors(function(err, actors) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
getKey() → String
Liefert den Schlüssel des Objekts zurück.
Example
var object_key = sc.getKey();
- Returns
-
String
getMeta(callback)
Ruft die Meta-Daten ab.
Example
Abruf der Meta-Daten.
sc.getMeta(function(err, data) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
learn(callback)
Lernt die Szene neu ein.
Example
sc.learn(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
listNext(callback)
Setzen aller KO in der Szene auf den nächst-größeren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.
Example
sc.listNext(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
listPrevious(callback)
Setzen aller KO in der Szene auf den nächst-kleineren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.
Example
sc.listPrevious(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
offsetMinus(callback)
Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert vermindert.
Example
sc.offsetMinus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
offsetPlus(callback)
Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert erhöht.
Example
sc.offsetPlus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
callback |
function() |
|
Abstract types
callCallback(err)
Example
sc.call(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
getActorsCallback(err, data)
Example
sc.getActors(function(err, actors) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
data |
Array |
|
Daten der Szene
Struktur
ErklärungListe von Objekten:
|
getMetaCallback(err, data)
Example
Abruf der Meta-Daten.
sc.getMeta(function(err, data) {});
Parameters
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
data |
Object |
|
Meta-Informationen
Struktur
Erklärung
|
learnCallback(err)
Example
sc.learn(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
listNextCallback(err)
Example
Setzen aller KO in der Szene auf den nächst-größeren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.
sc.listNext(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
listPreviousCallback(err)
Example
Setzen aller KO in der Szene auf den nächst-kleineren der im Experte im Feld 'Liste' (beim KO) angegebenen Werte.
sc.listPrevious(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
offsetMinusCallback(err)
Example
Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert vermindert.
sc.offsetMinus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |
offsetPlusCallback(err)
Example
Der Wert aller KO in der Szene wird um den im Experte im Feld 'Schrittgröße' (beim KO) angegebenen Wert erhöht.
sc.offsetPlus(function(err) {});
Parameter
Name | Type | Optional | Description |
---|---|---|---|
err |
(Object or undefined) |
|
Fehler-Objekt |