Page History

...

Section

Column

width	35%

Panel

borderColor	#CCCCCC
bgColor	#FFFFFF
titleBGColor	#F0F0F0
borderStyle	solid
title	On page:

Table of Contents

Column

Export start

Rozpoczęcie eksportu

Eksport może zostać zainicjalizowany poprzez jedno z następujących zapytań POSTExport is initiated using one of the following POST requests:
POST http://IP-Address:port/prefix/export/archive/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} - archive exporteksport archiwum.
POST http://IP-Address:port/prefix/export/live/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} - live video exporteksport wideo na żywo.

Tip
{VIDEOSOURCEID} - three-component source endpoint ID (see trójczęściowe ID źródłowego punktu końcowego (zobacz: Pozyskaj listę źródeł wideo (kamer)). For instance, Przykład: "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".

Info

title	Note

BEGINTIME and ENDTIME set time in the YYYYMMDDTHHMMSS format in the UTC+0 time zone. If BEGINTIME is greater than ENDTIME, then the values will swap. BEGINTIME must be equal to ENDTIME for snapshot export.

The ENDTIME and BEGINTIME syntax is described in Pozyskaj zawartość archiwum section.

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
Parameter	Required	Description
waittimeout	No	Wait timeout in milliseconds required for a frame to arrive. The default value is 10. If the parameter value is less than the reference frames interval, then the export will not be performed. It is recommended to set the value not less than 30.
archive	No	Name of the archive in the hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage format (see zobacz: Pozyskaj zawartość archiwum).

BEGINTIME and ENDTIME set time in the YYYYMMDDTHHMMSS format. If BEGINTIME is greater than ENDTIME, then the values will swap. BEGINTIME must be equal to ENDTIME for snapshot export. 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 zapytanieSample request:

POST http://127.0.0.1:80/export/archive/Server1/DeviceIpint.1/SourceEndpoint.video:0:0/20200415T085456.908/20200415T085501.908?waittimeout=30

Supported parameters that are sent in the body of initial POST request:

Wspierane parametry wysyłane w body początkowego zapytania POST:

ParametrParameter

Format

DescriptionOpis

ExamplePrzykład

format

String

Mandatory parameter. Available values are Obowiązkowy parametr. Dostępne wartości: mp4, mkv, avi, exe, jpg and , pdf. It sets the format of output export containerOkreśla format końcowy eksportowanych plików.

maxfilesize

Number

Maximum export file size (in bytes). A new file will be created when the size limit is exceeded. Export results in the collection of files. Default value is 0 (as a result, a single fileMaksymalna 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

A compression quality level for video and audio respectively. Allowed values are from 0 to 6 (6 means the worst). Default value is 0Poziom jakości kompresji, odpowiednio dla audio oraz wideo. Dozwolone wartości: od 0 do 6 (6 to najgorsza). Domyślna wartość: 0.

freq

Number

Frame rate of the output stream. Default value is 0. Available valuesKlatki na sekundę eksportowanego strumienia. Domyślna wartość: 0. Dostępne wartości:

0 – originalpierwotne
1 – half of originalpołowa pierwotnych
2 - quarter of originaljedna czwarta pierwotnych
3 – one-eighth of originaljedna ósma pierwotnych

tsformat

String

A time stamp format template. Any string can be generated on the basis of 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. Default value is Domyślna wartość: %Y-%b-%d %H:%M:%S.

Attention! The Server does not check the format of the input stringUwaga! Serwer nie sprawdza formatu dla parametru input (string).

"tsformat": "%B %Y",

croparea

Area

A snapshot area for export (default value is Obszar dla eksportowanej stopklatki (domyślna wartość: [[0, 0], [1,1]] – the entire snapshotcały obszar).

Image examplePrzykład na obrazie:

Code Block
"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

A snapshot area for masking, set in coordinates. By default a snapshot is not masked.

The area is specified by at least 3 nodal points + 1 terminal point (coincides with one of the nodal points). The reference point is the upper left corner. You can specify multiple polygons.

Image example:

Code Block
"maskspace": [ [ [ 0.2, 0.2 ], [ 0.3, 0.7 ], [ 0.5, 0.5 ], [ 0.2, 0.2 ] ] ]

color

String

Text color of a comment and a time stamp. It is set in the #FFFFFF web formatKolor tekstu komentarza oraz znacznika czasu. Jest ustalony w formacie Web #FFFFFF.

"color": "#e31e1e",

comment

String

A commentKomentarz.

Parameters relevant to PDF export format onlyParametry odnoszące się jedynie do eksportu w formacie PDF:

snapshotplace

Area

Snapshot location on the pageLokalizacja stopklatki na stronie.

commentplace

Area

Comment location on the pageLokalizacja komentarza na stronie.

tsplace

Area

Time stamp location on the pageZnacznik czasu lokalizacji na stronie.

layout

Number

Page layout. Available values are Układ strony. Możliwe wartości: 0 (portraitportret), 1 (landscapekrajobraz).

Sample Przykładowy JSON:

Code Block
{ "format": "mp4", "vc": 4, "comment": "сomment" }

Sample responsePrzykładowa odpowiedź:

Code Block
HTTP/1.1 202 Accepted Connection: Close Location: /export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3 Cache-Control: no-cache

Possible error codesMożliwe kody błędu:

Error codeKod błędu	DescriptionOpis
400	Incorrect requestNiepoprawne żądanie.
500	Server internal errorWewnętrzny błąd serwera.

...

Pozyskaj status eksportu

GET http://IP-Address:port/export/{id}/status

Tip
id is the value from the Location field id to wartość z pola Location (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)

Sample requestPrzykładowe zapytanie:

GET http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3/status

Sample responsePrzykładowa odpowiedź:

Code Block

{
  "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"
  ]
}

ParameterParametr	DescriptionOpis
stateCurrent	state of export. Available valuesObecny stan eksportu. Możliwe wartości: 1 – export is performedeksport w trakcie; 2 – export is completedeksport zakończony; 3 – export errorbłąd eksportu; 4 – not enough space to complete the operationniewystarczające miejsce na dysku do zakończenia operacji.
progress	Progress of export session in the range from 0 to Stopień ukończenia procesu eksportu w zasięgu od 0 do 1.
errorDescription	of error (if anyOpis błędu (jeśli zaistniał).
files	List of files created as the export result.

...

Lista plików utworzonych jako rezultat operacji eksportu.

Pobierz plik

GET http://IP- Address:port/prefix/export/{id}/file

Tip
id is the value from the Location field id to wartość z pola Location (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)

ParameterParametr	RequiredWymagany	DescriptionOpis
name	Yes	Name of file from the files field.	Tak	Nazwa pliku z pola files.

Przykładowe zapytanieSample request:

GET http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3/file?name=Server1_DeviceIpint.10[20190903T050000-20190903T050100].mp4

Info

title	Note

On the Server, the exported file is saved to the folder CNa Serwerze wyeksportowany plik jest zapisywany do folderu C:\ProgramData\AxxonSoft\AxxonNext\Export\{ID}

Export completion

Zakończenie eksportu

Żądanie to usuwa wcześniej utworzony na Serwerze plikThis request deletes the created file on the Server.

DELETE http://IP-Address:port/prefix/export/{id}

Tip
id is the value from the Location field id to wartość z pola Location (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)

Sample requestPrzykładowe zapytanie:

DELETE http://127.0.0.1:80/export/3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3

Page tree

Versions Compared

Old Version 1

New Version 2

Key

Export start

Rozpoczęcie eksportu

Pozyskaj status eksportu

Pobierz plik

Export completion

Zakończenie eksportu