new _CameraArchive()

Kameraarchiv.
Darf nicht direkt instanziert werden. Eine Instanz der Klasse wird von der Methode HomeServerConnector._Connection#getCameraArchive erzeugt.

Example

var ca = conn.getCameraArchive("CA@KameraArchiv", function(err, data) {}); 

Methods

destroy()

Gibt das Objekt frei und hebt ein eventuell vorhandes Abonnement auf.

Example

ca.destroy(); 

getKey() → String

Liefert den Schlüssel des Objekts zurück.

Example

var object_key = ca.getKey(); 
Returns

String 

getList(callback)

Ruft eine Liste der Bilder im Kameraarchiv ab. Für jedes Bild wird der Zeitstempel und die Bild-ID zurückgeliefert.

Example

Abruf der Bilder-Liste.

ca.getList(function(err, items) {});

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._CameraArchive~getListCallback

getMeta(callback)

Ruft die Meta-Daten ab.

Example

Abruf der Meta-Daten.

ca.getMeta(function(err, data) {}); 

Parameter

Name Type Optional Description

callback

function()

 

HomeServerConnector._CameraArchive~getMetaCallback

getPicture(pictureID, callback)

Ruft ein Bild aus dem Archiv anhand der BILD-ID ab.

Example

Abruf eines Bildes.

ca.getPicture(123, function(err, pictureId, dataUrl) {});

Parameters

Name Type Optional Description

pictureID

Number

 

Eindeutige ID des Bildes. Die Methode getList() liefert alle möglichen IDs.

callback

function()

 

HomeServerConnector._CameraArchive~getPictureCallback

Abstract types

inner

getListCallback(err, items)

Example

Abruf der Bilder-Liste.

ca.getList(function(err, items) {}); 

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

items

Array

 

Liste mit den Bildern des Kameraarchivs. Jeder Eintrag enthält die folgenden Felder:

Struktur

[
   {
      "ts":     Number,
      "pic_id": Number
   }
]

Erklärung

  • ts - Unix-Zeitstempel (in Sekunden, Millisekunden als Kommawert) des Eintrags.
  • pic_id - ID des Bilds. Wird für einen Abruf mittels getPicture() benötigt.
inner

getMetaCallback(err, data)

Example

Abruf der Meta-Daten.

ca.getMeta(function(err, data) {}); 

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

data

Object

 

Meta-Informationen

Struktur

{
  "keys":          Array of String, 
  "caption":       String,
  "description":   String,
  "tags":          Array of String,
  "size":          Number,
  "size_in_bytes": Number,
  "space":         Number,

  "stat": {
      "first":     Number,
      "last":      Number,
      "count":     Number
  }
}

Erklärung

  • keys - Liste mit Schlüsseln (z.B.: ["CA:7", "CA@MeinArchiv"]). Enthält mindestens einen Eintrag.
  • caption - Bezeichnung des Objekts.
  • description - Beschreibung des Objekts.
  • tags - Liste von Tags (z.B.: ["Hof", "Garten"]).
  • size - Größe des Ringpuffers.
  • size_in_bytes - Max. Größe des Archivs in Bytes.
  • space - Größe der archivierten Bilder in Bytes.
  • stat - Objekt, enthält Informationen über den Inhalt des Archivs.
    • first - Unix-Zeitstempel (in Sekunden, Millisekunden als Kommawert) des ältesten Eintrags im Archiv.
    • last - Unix-Zeitstempel (in Sekunden, Millisekunden als Kommawert) des jüngsten Eintrags im Archiv.
    • count - Anzahl der Einträge im Archiv.
inner

getPictureCallback(err, pictureID, dataUrl)

Example

Abruf eines Bildes.

ca.getPicture(123, function(err, pictureId, dataUrl) {});

Parameters

Name Type Optional Description

err

(Object or undefined)

 

Fehler-Objekt

pictureID

String

 

Bild-ID

dataUrl

String

 

Ein String im Data-URL-Format. Beschreibung und Format siehe: Data-URL Wiki-Page.