GET http://IP-Address:port/prefix/live/media/snapshot/{VIDEOSOURCEID}

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

ParameterRequiredDescription

w

h

No

w – frame width, h – frame height

Note

  • 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 height. Possible values are 0 to 1. The default is 1

Note

By default, the snapshot update period is 30 seconds. To change this value, create the NGP_SNAPSHOT_TIMEOUT system variable and set the required value in milliseconds (see Creating system variable).

Sample request:

  • To get a snapshot in the original resolution:
    GET http://IP-Address:port/prefix/live/media/snapshot/Server1/DeviceIpint.23/SourceEndpoint.video:0:0
  • To get a snapshot in 640*480 resolution:
    GET http://IP-Address:port/prefix/live/media/snapshot/Server1/DeviceIpint.23/SourceEndpoint.video:0:0?w=640&h=480
  • To get the right lower particle of a snapshot:
    GET http://IP-Address:port/prefix/live/media/snapshot/Server1/DeviceIpint.23/SourceEndpoint.video:0:0?crop_x=0.5&crop_y=0.5&crop_width=0.5&crop_height=0.5
  • To get the right lower particle of a snapshot in 640*480 resolution:
    GET http://IP-Address:port/prefix/live/media/snapshot/Server1/DeviceIpint.23/SourceEndpoint.video:0:0?w=640&h=480&crop_x=0.5&crop_y=0.5&crop_width=0.5&crop_height=0.5
  • No labels