Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section


Column
width35%


Panel
borderColor#CCCCCC
bgColor#FFFFFF
titleBGColor#F0F0F0
borderStylesolid
titleOn page:
Table of Contents



Column

...



내보내기 시작

POST http://IP Address:port/prefix/export/archive/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} – archive export.아카이브 내보내
POST http://IP Address:port/prefix/export/live/{VIDEOSOURCEID}/{BEGINTIME}/{ENDTIME} – live video export.실시간 비디오 내보내기

Tip

{VIDEOSOURCEID} – the three-component source endpoint 세 구성 요소 소스 엔드포인트 ID (see 비디오 카메라 목록 및 정보 가져오기 참조). For instance, 예: "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".


Info
titleNote

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

The ENDTIME and BEGINTIME syntax is described in 아카이브 내용 가져오기.

시간대에서 YYYYMMDDTHHMMSS 형식으로 시간을 설정합니다. 만약 BEGINTIME이 ENDTIME보다 크면, 값이 자동으로 교환됩니다. 프레임 내보내기의 경우 BEGINTIME과 ENDTIME은 동일해야 합니다.

ENDTIME과 BEGINTIME 구문은 아카이브 내용 가져오기 섹션에 설명되어 있습니다.


파라미터필수설명
waittimeoutNo

프레임이 도착할 때까지 대기하는 시간(밀리초 단위)입니다. 기본값은 10000입니다. 만약 이 값이 기준 프레임 간격보다 짧으면, 내보내기가 수행되지 않습니다.

값은 최소 30000 이상으로 설정하는 것이 권장됩니다.

archiveNo내보내기할 아카이브의 이름은
ParameterRequiredDescription
waittimeoutNo

Wait timeout in milliseconds required for a frame to arrive. The default value is 10000. 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 30000

archiveNoName of the archive in the hosts/SERVER1/MultimediaStorage.AliceBlue/MultimediaStorage format MultimediaStorage 형식이어야 합니다 (see Get archive contents 참조). If the value is not specified, the default archive will be used for export만약 값이 지정되지 않으면, 기본 아카이브가 내보내기 작업에 사용됩니다.

샘플 요청Sample request:

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

Request body example요청 본문 예시:

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

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

초기 POST요청 본문에 전달되는 지원되는 매개변수는 다음과 같습니다.

파라미터포맷설명예시ParameterFormatDescriptionExample
formatString

Mandatory parameter. Available values are 필수 매개변수입니다. 사용 가능한 값은 mp4,   mkv, avi, exe, jpg and pdf. It sets the format of output export container, pdf입니다. 출력 내보내기 컨테이너의 형식을 설정합니다.


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 file)바이트 단위로 최대 내보내기 파일 크기입니다. 크기 제한을 초과하면 새 파일이 생성됩니다. 내보내기 결과는 여러 파일로 수집됩니다. 기본값은 0이며 이 경우 하나의 파일로 내보내집니다.

"maxfilesize": 1e+6
"maxfilesize": 1000000
vc, acNumber

A compression quality level for video and audio respectively. Allowed values are from 0 to 6 (6 means the worst). Default value is 0비디오와 오디오에 대한 압축 품질 수준입니다. 허용되는 값은 0에서 6까지이며 (6은 가장 낮은 품질을 의미함), 기본값은 0입니다.


freq Number

Frame rate of the output stream. Default value is 0. Available values:출력 스트림의 프레임 속도입니다. 기본값은 0입니다. 사용 가능한 값은 다음과 같습니다.

  1. 0original원본
  2. 1half of original원본의 절반
  3. 2quarter of original원본의 4분의 1
  4. 3one-eighth of original원본의 8분의 1

tsformatString

A time stamp format template. Any string can be generated on the basis of 타임스탬프 형식 템플릿입니다.  http://www.boost.org/doc/libs/1_55_0/doc/html/date_time/date_time_io.html. Default value is 을 기준으로 어떤 문자열이든 생성할 수 있습니다. 기본값은 %Y-%b-%d %H:%M:%S 입니다.

Attention! The Server does not check the format of the input string주의! 서버는 입력 문자열의 형식을 검증하지 않습니다.

"tsformat": "%B %Y",
cropareaArea

A frame area for export (default value is 내보내기 위한 프레임 영역 (기본값은 [[0, 0], [1,1]]the entire frame전체 프레임).

Image example이미지 예시:


Code Block
"croparea": [
        [
            0.3,
            0.3
        ],
        [
            0.8,
            0.8
        ]
    ]


maskspaceArea

마스킹을 위한 프레임 영역은 좌표로 설정됩니다. 기본적으로 프레임은 마스킹되지 않습니다.

영역은 최소 3개의 앵커 포인트와 1개의 터미널 포인트 (하나의 앵커 포인트와 일치)가 필요합니다. 기준 점은 왼쪽 상단 모서리입니다. 여러 개의 다각형을 지정할 수 있습니다.

이미지 예시

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

The area is specified by at least 3 anchor points + 1 terminal point (coincides with one of the anchor 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
        ]
    ]
]


colorString

Text color of a comment and a time stamp. It is set in the #FFFFFF web format주석과 타임스탬프의 텍스트 색상입니다. #FFFFFF 웹 형식으로 설정됩니다.

"color": "#e31e1e",
comment StringA comment코멘트
Parameters relevant for PDF export onlyPDF 내보내기와 관련된 매개변수만 해당:
snapshotplaceAreaFrame location on the page페이지에서의 프레임 위치
commentplaceAreaComment location on the page페이지에서의 코멘 위치
tsplaceAreaTime stamp location on the page페이지에서의 타임스탬프 위치
layoutNumber

Page layout. Available values are 0 (portrait), 1 (landscape)

이지 레이아웃. 사용 가능한 값은 0 (세로) 및 1 (가로)입니다.


샘플 응답Sample response:

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

Possible error codes가능한 오류 코드:

Error code오류 코드Description설명
400Incorrect request

잘못된 요청

500Server internal error

...

서버 내부 오류

내보내기 상태 가져오기

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

Tip

 id is the value from the Location field (here 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3)

Sample request샘플 요청:

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

Sample response샘플 응:

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


Parameter파라미터Description설명
state

Current state of export. Available values:
0 – export is not yet in perform
1 – export is performed
2 – export is completed
3 – export error
4 – not enough space to complete the operation
5 – the file with the given name already exists
6 – no data to export

progressProgress of export session in the range from 0 to 1
errorDescription of error (if any)
filesList of files created as the result of the export

...

내보내기 현재 상태. 사용 가능한 값은 다음과 같습니다.
0 – 내보내기가 아직 수행되지 않음
1 – 내보내기가 수행됨
2 – 내보내기 완료
3 – 내보내기 오류
4 – 작업 완료할 공간 부족
5 – 주어진 이름의 파일이 이미 존재함
6 – 내보낼 데이터가 없음

progress내보내기 세션의 진행 상황은 0에서 1 사이의 범위로 표시됩니다.
error오류 설명 (있을 경우)
files내보내기 결과로 생성된 파일 목록

파일 다운로드

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

Tip

 id is the value from the Location field (here id는 Location 필드의 값입니다 (여기서 예시는 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3).


Parameter파라미터Required필수Description설명
nameYes

Name of file from the files field

files 필드에서 파일 이름입니다.

샘플 요청Sample request:

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

Info
titleNote

On the Server the exported file is saved to the folder 서버에서 내보낸 파일은 C:\ProgramData\AxxonSoft\AxxonOne\Export\{ID}

Export completion

폴더에 저장됩니다.

내보내기 완료

이 요청은 서버에서 생성된 파일을 삭제합니다This 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 (here id는 Location 필드의 값입니다 (여기서 예시는 3dc15b75-6463-4eb1-ab2d-0eb0a8f54bd3).

Sample request샘플 요청:

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