Versions Compared

Old Version 1

changes.mady.by.user Yulia Morozova

Saved on

compared with

New Version Current

changes.mady.by.user Alina Luchkina

Saved on

Key

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

...

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

Get frame by timestamp

GET http://IPaddressIP-address:port/prefix/archive/media/{VIDEOSOURCEID}/{STARTTIME} – gets frame by its STARTTIME. Frame is returned in JPEG format.

Tip
SERVER1
  • Server1/DeviceIpint.3/SourceEndpoint.video:0:0".
Tip
  • {STARTTIME} − time in ISO format. Set the timezone to UTC+0. 


ParameterRequiredDescription
thresholdNo

If there is no frame at a given time, then the first frame from the [STARTTIME; STARTTIME + threshold] range is returned, where threshold is specified in milliseconds.

If there is no frame in the specified range, then there will be a 404 Not Found error in the response.

w

h

No

w – frame width, h – frame height.

Info
titleNote

If h and w values are more than size of original frame, the frame will be received with original size.

Zooming out of width and height is available only discretely − in 2, 4, 8 times, etc. If specified sizes are not corresponding to 1/2, 1/4 etc. of original frame size, the frame will be received with size divisible by the original frame size close to specified values.


left

top

right

bottom

crop_x

crop_y

crop_width

crop_height

No

crop_xleft – horizontal indent from the upper left corner. Possible values are 0 to 1. The default is 0.

crop_ytop – vertical indent from the upper left corner. Possible values are 0 to 1. The default is 0.

crop_widthright – the ratio of the original image width. Possible values are 0 to 1. The default is 1.

crop_heightbottom – the ratio of the original image hight. Possible values are 0 to 1. The default is 1.

Sample request: 1:

GET http://127.0.0.1:80/archive/media/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0/20210910T092100

Query result:
Image Added

Sample request: 2:

GET http://127.0.0.1:80/archive/media/SERVER1/DeviceIpint.1/SourceEndpoint.video:0:0/20210910T092200?archive=hosts/SERVER1/MultimediaStorage.AntiqueWhite/MultimediaStorage

Query result:
Image Added

Get frame registration time

GET http://IPaddressIP-address:port/prefix/archive/contents/frames/{VIDEOSOURCEID}/{ENDTIME}/{BEGINTIME} – getting the time of frames registration in the archive.

...

ParameterRequiredDescription
limitNo

The default value of limit parameter is 250. This parameter is optional for server Server and it can return fewer search results.

...

GET http://127.0.0.1:80/archive/contents/frames/SERVER1Server1/DeviceIpint.2/SourceEndpoint.video:0:0/past/future?limit=3

...

ParameterDescription
frames

An array containing the timestamps of the stored frames.

Info
titleNote

Time is returned in the UTC format.


more

true − the server Server returned all frames from the specified range.

false − the server Server did not return all frames because the limit was exceeded (limit parameter).