5.8.2 api camera snapshot

Funkce /api/camera/snapshot umožňuje stažení obrázku z interní nebo externí IP kamery připojené k interkomu. Pomocí parametrů lze specifikovat zdroj obrázku, rozlišení apod.

Funkce je součástí služby Camera a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Kamera – sledování.

Pro tuto funkci lze použít metody GET nebo POST.

Parametry požadavku:

Parametr	Popis
width	Povinný parametr specifikující horizontální rozlišení JPEG snímku v pixelech.
height	Povinný parametr specifikující vertikální rozlišení JPEG snímku v pixelech. Výška a šířka snímku musí odpovídat jedné z podporovaných variant (viz funkce api/camera/caps).
source	Volitelný parametr definující zdroj videa (internal – interní kamera, external – externí IP kamera). Pokud parametr není uveden, je zvolen výchozí zdroj videa uvedený v konfiguračním webovém rozhraní v sekci Hardware / Kamera / Společné nastavení.
fps	Volitelný parametr definující snímkovou frekvenci. Pokud je parametr nastaven na hodnotu >= 1, interkom odesílá s nastavenou snímkovou frekvencí obrázky metodou http server push.
time	Volitelný parametr definující čas snímku v paměti vrátníku. Hodnoty time musí být v rozsahu paměti vrátníku, tedy <-30, 0> sekund. Pokud je tento parametr použit společně s parametrem fps, je parametr fps ignorován a funkce vrátí pouze jeden snímek.

Odpověď je ve formátu image/jpeg příp. multipart/x-mixed-replace (pro fps >= 1). V případě chybných parametrů požadavku, funkce vrací informaci ve formátu application/json.

Příklad:

 GET /api/camera/snapshot?width=640&height=480&source=internal
 
 # následující příkaz vrátí snímek zachycený 5 sekund před voláním funkce
 GET /api/camera/snapshot?width=640&height=480&source=internal&time=-5

Upozornění

2N^® IP Style a další 2N IP interkomy podporující vyšší rozlišení vrací statický obrázek (tj. pokud není zadán parametr fps) v maximálním rozlišení 1280 x 960. V případě, že je vyžadováno vyšší rozlišení, je vrácen obrázek stále v rozlišení 1280 x 960.