Get frame by timestamp

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

{VIDEOSOURCEID} – three-component source endpoint ID (see Get list of video cameras and information about them). For instance, "SERVER1/DeviceIpint.3/SourceEndpoint.video:0:0".


{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.

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.


crop_x

crop_y

crop_width

crop_height

No

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

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

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

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

Get frame registration time

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

The ENDTIME and BEGINTIME syntax is described in Get archive contents section.


ParameterRequiredDescription
limitNo

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


Sample request:

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

Sample response:

{
  "frames": [
    "20200525T113229.649000",
    "20200525T113229.100000",
    "20200525T113228.588000"
  ],
  "more": true
}


ParameterDescription
frames

An array containing the timestamps of the stored frames.

Time is returned in the UTC format.


more

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

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