Go to documentation repository
Documentation for Axxon Next 4.5.0. Documentation for other versions of Axxon Next is available too.
Rozpoczęcie eksportu
Eksport może zostać zainicjalizowany poprzez jedno z następujących zapytań POST:
POST http://IP-Address:port/prefix/export/archive/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} - eksport archiwum.
POST http://IP-Address:port/prefix/export/live/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} - eksport wideo na żywo.
{VIDEOSOURCEID} - trójczęściowe ID źródłowego punktu końcowego (zobacz: Pozyskaj listę źródeł wideo (kamer)). Przykład: "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".
Note
BEGINTIME oraz ENDTIME określają czas w formacie YYYYMMDDTHHMMSS strefy czasowej UTC+0. Jeśli BEGINTIME jest większe od ENDTIME, wartości zostaną zamienione. Aby eksportowanie stopklatek mogło funkcjonować, BEGINTIME musi posiadać tę samą wartość, co ENDTIME.
Składnia dla ENDTIME oraz BEGINTIME jest głębiej opisana w sekcji Pozyskaj zawartość archiwum.
Parametr | Wymagany | Opis |
---|---|---|
waittimeout | Nie | Czas oczekiwania w milisekundach na dostarczenie ramki. Domyślna wartość: 10. Jeśli wartość parametru jest mniejsza niż interwał czasowy dla ramek, eksport nie zostanie przeprowadzony. Zalecana jest wartość nie mniejsza niż 30. |
archive | Nie | Nazwa archiwum w formacie hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage (zobacz: Pozyskaj zawartość archiwum). |
BEGINTIME oraz ENDTIME określają czas w formacie YYYYMMDDTHHMMSS. Jeśli BEGINTIME jest większe od ENDTIME, wartości zostaną zamienione. Aby eksportowanie stopklatek było możliwe, wartość BEGINTIME musi być taka sama, co ENDTIME.
Przykładowe zapytanie:
POST http://127.0.0.1:80/export/archive/Server1/DeviceIpint.1/SourceEndpoint.video:0:0/20200415T085456.908/20200415T085501.908?waittimeout=30
Wspierane parametry wysyłane w body początkowego zapytania POST:
Parametr | Format | Opis | Przykład |
---|---|---|---|
format | String | Obowiązkowy parametr. Dostępne wartości: mp4, mkv, avi, exe, jpg, pdf. Określa format końcowy eksportowanych plików. | |
maxfilesize | Number | Maksymalna wielkość pliku eksportu (w bajtach). Jeśli wielkość zostanie przekroczona, utworzony zostanie następny plik. Rezultatem eksportu jest grupa plików. Domyślna wartość: 0 (pojedynczy plik). | "maxfilesize": 1e+6 "maxfilesize": 1000000 |
vc, ac | Number | Poziom jakości kompresji, odpowiednio dla audio oraz wideo. Dozwolone wartości: od 0 do 6 (6 to najgorsza). Domyślna wartość: 0. | |
freq | Number | Klatki na sekundę eksportowanego strumienia. Domyślna wartość: 0. Dostępne wartości:
| |
tsformat | String | Znacznik czasu szablonu formatu. Dowolny string może być wygenerowany na podstawie http://www.boost.org/doc/libs/1_55_0/doc/html/date_time/date_time_io.html. Domyślna wartość: %Y-%b-%d %H:%M:%S. Uwaga! Serwer nie sprawdza formatu dla parametru input (string). | "tsformat": "%B %Y", |
croparea | Area | Obszar dla eksportowanej stopklatki (domyślna wartość: [[0, 0], [1,1]] – cały obszar). Przykład na obrazie: | "croparea": [ [ 0.3, 0.3 ], [ 0.8, 0.8 ] ] |
maskspace | Area | Zamaskowany obszar stopklatki, ustalony jako koordynaty. Domyślnie stopklatka nie jest maskowana. Obszar jest ustalany przez co najmniej 3 punkty węzłowe + 1 punkt końcowy (jako jeden z punktów węzłowych). Punkt referencyjny znajduje się w lewym górnym rogu. Istnieje możliwość sprecyzowania wielu poligonów. Przykład obrazu: | "maskspace": [ [ [ 0.2, 0.2 ], [ 0.3, 0.7 ], [ 0.5, 0.5 ], [ 0.2, 0.2 ] ] ] |
color | String | Kolor tekstu komentarza oraz znacznika czasu. Jest ustalony w formacie Web #FFFFFF. | "color": "#e31e1e", |
comment | String | Komentarz. | |
Parametry odnoszące się jedynie do eksportu w formacie PDF: | |||
snapshotplace | Area | Lokalizacja stopklatki na stronie. | |
commentplace | Area | Lokalizacja komentarza na stronie. | |
tsplace | Area | Znacznik czasu lokalizacji na stronie. | |
layout | Number | Układ strony. Możliwe wartości: 0 (portret), 1 (krajobraz). |
Przykładowy JSON:
{ "format": "mp4", "vc": 4, "comment": "сomment" }
Przykładowa odpowiedź:
HTTP/1.1 202 Accepted Connection: Close Location: /export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3 Cache-Control: no-cache
Możliwe kody błędu:
Kod błędu | Opis |
---|---|
400 | Niepoprawne żądanie. |
500 | Wewnętrzny błąd serwera. |
Pozyskaj status eksportu
GET http://IP-Address:port/export/{id}/status
id to wartość z pola Location (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)
Przykładowe zapytanie:
GET http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3/status
Przykładowa odpowiedź:
{ "id": "38e3e286-c07c-490f-a452-e4b541b958c4", "state": 2, "progress": 1.000000000e+00, "error": "", "files": [ "Server1_DeviceIpint.10[20190903T050000-20190903T050100].mp4" ], "filesFriendly": [ "Server1_10.RHCP[20190903T050000-20190903T050100].mp4" ] }
Parametr | Opis |
---|---|
state | Obecny stan eksportu. Możliwe wartości: 1 – eksport w trakcie; 2 – eksport zakończony; 3 – błąd eksportu; 4 – niewystarczające miejsce na dysku do zakończenia operacji. |
progress | Stopień ukończenia procesu eksportu w zasięgu od 0 do 1. |
error | Opis błędu (jeśli zaistniał). |
files | Lista plików utworzonych jako rezultat operacji eksportu. |
Pobierz plik
GET http://IP- Address:port/prefix/export/{id}/file
id to wartość z pola Location (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)
Parametr | Wymagany | Opis |
---|---|---|
name | Tak | Nazwa pliku z pola files. |
Przykładowe zapytanie:
GET http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3/file?name=Server1_DeviceIpint.10[20190903T050000-20190903T050100].mp4
Note
Na Serwerze wyeksportowany plik jest zapisywany do folderu C:\ProgramData\AxxonSoft\AxxonNext\Export\{ID}
Zakończenie eksportu
Żądanie to usuwa wcześniej utworzony na Serwerze plik.
DELETE http://IP-Address:port/prefix/export/{id}
id to wartość z pola Location (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)
Przykładowe zapytanie:
DELETE http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3