Download OpenAPI specification:Download
HTTP protocol is supported by all Arecont Vision cameras and is supported by almost all third party software systems or plug-ins that support standard IP video over HTTP. Developers would find it easy and quick to locate technical resources to help integrate Arecont cameras using HTTP protocol. Camera performance in terms of frame rate is somewhat slower via HTTP than via TFTP but is comparable to other multi-megapixel products available on the market.
open a continuous mjpeg stream from the camera
| res | string Enum:"full" "half" The resolution MJPEGs you want to return |
| x0 | integer <int32> Left coordinate, used to offset the image. This value should be divisible by 32 if |
| y0 | integer <int32> Top coordinate, used to offset the image. This value should be divisible by 32 if |
| x1 | integer <int32> Right coordinate, used to offset the image. This value should be divisible by 32 if |
| y1 | integer Bottom coordinate, used to offset the image. This value should be divisible by 32 if |
| doublescan | integer [ 0 .. 1 ] Effectively a boolean that determines whether or not the camera should delay image output until a new image is available. |
| fps | integer [ 0 .. 30 ] Get or set the camera framerate. values over the camera's famerate will return the camera's maximum framerate (model dependent). |
| quality | integer [ 1 .. 21 ] The compression quality of the jpeg image |
| ver | string Enum:"HTTP/1.0" "HTTP/1.1" Arecont Vision cameras support both HTTP/1.0 and HTTP/1.1 protocols as defined by RFC-1945 and RFC2068, respectively. While HTTP/1.0 is simple, it closes the transmission after each image, forcing the client to incur a round trip delay; this limits the speed of image transmission when you request individual images rather than an mjpeg stream. However, HTTP/1.0 is reliable and supported by all HTTP implementations, albeit with limited speed. By default, Arecont Vision cameras are use HTTP/1.0 protocol regardless of the HTTP version used by the client. Use HTTP/1.1 if you want faster full duplex communication and image delivery. |
| channel | string Value:"scaled" Request down-scaled images. Because you preset downscaled image settings (through the UI or the /set endpoint), this parameter does not require size information. |
| sd | string Enum:"on" "off" Use to request images/video recorded on the SD card. |
Returns a stream
Pull JPEG frames individually from the camera.
| res | string Enum:"full" "half" The resolution MJPEGs you want to return |
| x0 | integer <int32> Left coordinate, used to offset the image. This value should be divisible by 32 if |
| y0 | integer <int32> Top coordinate, used to offset the image. This value should be divisible by 32 if |
| x1 | integer <int32> Right coordinate, used to offset the image. This value should be divisible by 32 if |
| y1 | integer Bottom coordinate, used to offset the image. This value should be divisible by 32 if |
| doublescan | integer [ 0 .. 1 ] Effectively a boolean that determines whether or not the camera should delay image output until a new image is available. |
| quality | integer [ 1 .. 21 ] The compression quality of the jpeg image |
| ID | integer >= 1 Ignored by the camera, but you might set random IDs to force browsers to refresh a frame. Some browsers might display a cached image if a previous URL is reused without modifying the ID field |
Returns an image
Pull H.264 frames from cameras. The first frame or the stream is always an IDR (Intra) frame followed by multiple P (Inter) frames. The default number of P-frames is 50, and can be modified via register 3:21 using one of the following HTTP commands —
http://camera_ip/set?keyframeinterval=(0..100) http://camera_ip/setreg?page=3®=21&val=(number of P-frames)
You can get your current P-frame setting from http://camera_ip/getreg?page=3®=21
| res | string Enum:"full" "half" The resolution MJPEGs you want to return |
| x0 | integer <int32> Left coordinate, used to offset the image. This value should be divisible by 32 if |
| y0 | integer <int32> Top coordinate, used to offset the image. This value should be divisible by 32 if |
| x1 | integer <int32> Right coordinate, used to offset the image. This value should be divisible by 32 if |
| y1 | integer Bottom coordinate, used to offset the image. This value should be divisible by 32 if |
| qp | string [ 16 .. 36 ] The quantization parameter for the H.264 encoder. Sets the target qp. Lower qp indicates a higher quality image. This paramaeter is ignored if your request includes the bitrate parameter. |
| doublescan | integer [ 0 .. 1 ] Effectively a boolean that determines whether or not the camera should delay image output until a new image is available. |
| ssn | integer [ 1 .. 65535 ] Stream identifier — distinguishes multiple streams from one another. Use a unique ssn for each stream with a unique image size, quality and/or frame rate. Each camera supports up to eight simultaneous non-identical streams. Each client must have a unique (ip:ssn) |
| iframe | integer [ 0 .. 1 ] Effectively a boolean (0 or 1). Set to 1 will force the camera to return an Intra frame (I-frame) with a corresponding SPS and PPS as an IDR slice, so that the stream is decodable from this point. When opening a new stream (as when changing the image size and/or frame rate) the I-frame is sent automatically regardless of the input value of http://camera_ip/set?keyframeinterval=(0..100) When the on-camera counter of P-frames fills up, the camera will return an I-frame even if iframe in the request is set to 0. To find out whether an I-frame was received, check the HTTP Content Type. |
| bitrate | integer [ 1 .. 65535 ] Sets a constant bitrate in kilobits per second. If this parameter is present in the request, the QP parameter is ignored, and the camera adjusts quantization parameters automatically to maintain the specified bitrate. |
| intra_period | integer [ 0 .. 255 ] Valid when requesting a non-zero bitrate and periodically requesting |
Returns a stream according to the parameters in your request.
Each frame sent by the camera may contain multiple zero bytes at the end. A Unit Delimiter (UD) is not used. Although this does not contradict the ITU-T H.264 standard (ISO/IEC 14496-10), some decoders may delay decoded frames by one due to the absence of the UD. If this presents a problem, replace all zero bytes at the end with the UD, a sequence of the following five bytes — 0x00 0x00 0x01 0x09 0x10. The number of zero bytes at the end of a frame may be significant (up to a few hundred bytes). Replacing them with the UD will also reduce the stream size
Pull a continuous H.264 video stream with boundary-separated frames.
| res | string Enum:"full" "half" The resolution MJPEGs you want to return |
| x0 | integer <int32> Left coordinate, used to offset the image. This value should be divisible by 32 if |
| y0 | integer <int32> Top coordinate, used to offset the image. This value should be divisible by 32 if |
| x1 | integer <int32> Right coordinate, used to offset the image. This value should be divisible by 32 if |
| y1 | integer Bottom coordinate, used to offset the image. This value should be divisible by 32 if |
| qp | string [ 16 .. 36 ] The quantization parameter for the H.264 encoder. Sets the target qp. Lower qp indicates a higher quality image. This paramaeter is ignored if your request includes the bitrate parameter. |
| doublescan | integer [ 0 .. 1 ] Effectively a boolean that determines whether or not the camera should delay image output until a new image is available. |
| ssn | integer [ 1 .. 65535 ] Stream identifier — distinguishes multiple streams from one another. Use a unique ssn for each stream with a unique image size, quality and/or frame rate. Each camera supports up to eight simultaneous non-identical streams. Each client must have a unique (ip:ssn) |
| bitrate | integer [ 1 .. 65535 ] Sets a constant bitrate in kilobits per second. If this parameter is present in the request, the QP parameter is ignored, and the camera adjusts quantization parameters automatically to maintain the specified bitrate. |
| fps | integer [ 0 .. 30 ] Get or set the camera framerate. values over the camera's famerate will return the camera's maximum framerate (model dependent). |
| ver | string Enum:"HTTP/1.0" "HTTP/1.1" Arecont Vision cameras support both HTTP/1.0 and HTTP/1.1 protocols as defined by RFC-1945 and RFC2068, respectively. While HTTP/1.0 is simple, it closes the transmission after each image, forcing the client to incur a round trip delay; this limits the speed of image transmission when you request individual images rather than an mjpeg stream. However, HTTP/1.0 is reliable and supported by all HTTP implementations, albeit with limited speed. By default, Arecont Vision cameras are use HTTP/1.0 protocol regardless of the HTTP version used by the client. Use HTTP/1.1 if you want faster full duplex communication and image delivery. |
| channel | string Value:"scaled" Request down-scaled images. Because you preset downscaled image settings (through the UI or the /set endpoint), this parameter does not require size information. |
| sd | string Enum:"on" "off" Use to request images/video recorded on the SD card. |
Returns a stream according to the parameters in your request.
open a continuous mjpeg stream from a sensor belonging to a multisensor camera.
| channel required | integer [ 1 .. 4 ] The ID of the channel you want to return information for. If you do not specify the channel, the camera will transmit the next available image from any of the enabled channels. |
| res | string Enum:"full" "half" The resolution MJPEGs you want to return |
| x0 | integer <int32> Left coordinate, used to offset the image. This value should be divisible by 32 if |
| y0 | integer <int32> Top coordinate, used to offset the image. This value should be divisible by 32 if |
| x1 | integer <int32> Right coordinate, used to offset the image. This value should be divisible by 32 if |
| y1 | integer Bottom coordinate, used to offset the image. This value should be divisible by 32 if |
| doublescan | integer [ 0 .. 1 ] Effectively a boolean that determines whether or not the camera should delay image output until a new image is available. |
| fps | integer [ 0 .. 30 ] Get or set the camera framerate. values over the camera's famerate will return the camera's maximum framerate (model dependent). |
| quality | integer [ 1 .. 21 ] The compression quality of the jpeg image |
| ver | string Enum:"HTTP/1.0" "HTTP/1.1" Arecont Vision cameras support both HTTP/1.0 and HTTP/1.1 protocols as defined by RFC-1945 and RFC2068, respectively. While HTTP/1.0 is simple, it closes the transmission after each image, forcing the client to incur a round trip delay; this limits the speed of image transmission when you request individual images rather than an mjpeg stream. However, HTTP/1.0 is reliable and supported by all HTTP implementations, albeit with limited speed. By default, Arecont Vision cameras are use HTTP/1.0 protocol regardless of the HTTP version used by the client. Use HTTP/1.1 if you want faster full duplex communication and image delivery. |
| channel | string Value:"scaled" Request down-scaled images. Because you preset downscaled image settings (through the UI or the /set endpoint), this parameter does not require size information. |
| ssn | integer [ 1 .. 65535 ] Stream identifier — distinguishes multiple streams from one another. Use a unique ssn for each stream with a unique image size, quality and/or frame rate. Each camera supports up to eight simultaneous non-identical streams. Each client must have a unique (ip:ssn) |
| ID | integer >= 1 Ignored by the camera, but you might set random IDs to force browsers to refresh a frame. Some browsers might display a cached image if a previous URL is reused without modifying the ID field |
| sd | string Enum:"on" "off" Use to request images/video recorded on the SD card. |
Returns a stream
Pull JPEG frames individually from the camera.
| channel required | integer [ 1 .. 4 ] The ID of the channel you want to return information for. If you do not specify the channel, the camera will transmit the next available image from any of the enabled channels. |
| res | string Enum:"full" "half" The resolution MJPEGs you want to return |
| x0 | integer <int32> Left coordinate, used to offset the image. This value should be divisible by 32 if |
| y0 | integer <int32> Top coordinate, used to offset the image. This value should be divisible by 32 if |
| x1 | integer <int32> Right coordinate, used to offset the image. This value should be divisible by 32 if |
| y1 | integer Bottom coordinate, used to offset the image. This value should be divisible by 32 if |
| doublescan | integer [ 0 .. 1 ] Effectively a boolean that determines whether or not the camera should delay image output until a new image is available. |
| quality | integer [ 1 .. 21 ] The compression quality of the jpeg image |
| ID | integer >= 1 Ignored by the camera, but you might set random IDs to force browsers to refresh a frame. Some browsers might display a cached image if a previous URL is reused without modifying the ID field |
| ssn | integer [ 1 .. 65535 ] Stream identifier — distinguishes multiple streams from one another. Use a unique ssn for each stream with a unique image size, quality and/or frame rate. Each camera supports up to eight simultaneous non-identical streams. Each client must have a unique (ip:ssn) |
Returns an image
Return settings for a single channel in a multi-sensor camera. In general, you should use only one query parameter at a time.
| channel required | integer [ 1 .. 4 ] The ID of the channel you want to get or set information for. |
| brightness | integer [ -50 .. 50 ] Sets brightness for the camera or channel. |
| sharpness | integer [ 0 .. 4 ] Sets sharpness for the camera or channel. |
| saturation | integer [ 0 .. 6 ] Sets color saturation for the camera or channel. |
| blue | integer [ -10 .. 10 ] Sets blue balance for the camera or channel. |
| red | integer [ -10 .. 10 ] Sets red balance for the camera or channel. |
| illum | string Enum:"auto" "indoor" "outdoor" "mlx" Sets illumination for the camera or channel. |
| freq | integer [ 50 .. 60 ] Mains frequency in Hz, used for indoor lighting compensation. |
| lowlight | string Enum:"highspeed" "speed" "balance" "quality" "moonlight" Exposure (low light) mode. |
| shortexposures | integer [ 1 .. 80 ] Shutter time in high-speed exposure mode, set in milliseconds. |
| autoexp | string Enum:"on" "off" Auto exposure mode |
| exposure | string Enum:"auto" "on" "off" Auto exposure mode |
| kneepoint | integer [ 1 .. 100 ] Custom mode setting |
| analoggain | integer [ 1 .. 100 ] Custom mode setting |
| maxkneegain | integer [ 1 .. 100 ] Custom mode setting |
| maxexptime | integer [ 1 .. 100 ] Custom mode setting |
| maxdigitalgain | integer [ 1 .. 100 ] Custom mode setting |
| mdmode | string Enum:"on" "off" Get or set motion alarm settings |
| motiondetect | string Enum:"on" "off" Get or set motion detection settings |
| mdtotalzones | integer Set regular (64) or extended motion detection mode (1024). 4k cameras support motion detection in extended mode either. |
| mdlevelthreshold | integer [ 2 .. 31 ] Motion detection zone threshold |
| mdlevelthreshold | integer [ 1 .. 255 ] Motion detection zone detail |
| mdprivacymask | integer Motion detection privacy mask |
| mdlevelthreshold | boolean Motion detection zone result |
| pmask | string Enum:"on" "off" Get or set the privacy mask. Use |
| pmaskleft | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| pmasktop | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| pmaskright | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| pmaskbottom | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| streamip | string <ipv4> ^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the multicast IP address. |
| rtpport | integer [ 0 .. 65535 ] Get or set the multicast port. |
| sapip | string <ipv4> ^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the multicast SAP IP address. |
| vertical_shift | integer Shift sensors vertically. |
| pan | integer Set a pan value. |
| tilt | integer Set a tilt value. |
| zoom | string or integer Set zoom moving steps. |
| ptz | string or integer Use to engage, record, or save a preset. |
| switcher | boolean Run this command to detect a pan module collision with another module and if module 2 is in home.
|
Returns the parameters specified in the query.
Set parameters for a single channel in a multi-sensor camera. In general, you should use only one query parameter at a time.
| channel required | integer [ 1 .. 4 ] The ID of the channel you want to get or set information for. |
| brightness | integer [ -50 .. 50 ] Sets brightness for the camera or channel. |
| sharpness | integer [ 0 .. 4 ] Sets sharpness for the camera or channel. |
| saturation | integer [ 0 .. 6 ] Sets color saturation for the camera or channel. |
| blue | integer [ -10 .. 10 ] Sets blue balance for the camera or channel. |
| red | integer [ -10 .. 10 ] Sets red balance for the camera or channel. |
| illum | string Enum:"auto" "indoor" "outdoor" "mlx" Sets illumination for the camera or channel. |
| freq | integer [ 50 .. 60 ] Mains frequency in Hz, used for indoor lighting compensation. |
| lowlight | string Enum:"highspeed" "speed" "balance" "quality" "moonlight" Exposure (low light) mode. |
| shortexposures | integer [ 1 .. 80 ] Shutter time in high-speed exposure mode, set in milliseconds. |
| autoexp | string Enum:"on" "off" Auto exposure mode |
| exposure | string Enum:"auto" "on" "off" Auto exposure mode |
| kneepoint | integer [ 1 .. 100 ] Custom mode setting |
| analoggain | integer [ 1 .. 100 ] Custom mode setting |
| maxkneegain | integer [ 1 .. 100 ] Custom mode setting |
| maxexptime | integer [ 1 .. 100 ] Custom mode setting |
| maxdigitalgain | integer [ 1 .. 100 ] Custom mode setting |
| mdmode | string Enum:"on" "off" Get or set motion alarm settings |
| motiondetect | string Enum:"on" "off" Get or set motion detection settings |
| mdtotalzones | integer Set regular (64) or extended motion detection mode (1024). 4k cameras support motion detection in extended mode either. |
| mdlevelthreshold | integer [ 2 .. 31 ] Motion detection zone threshold |
| mdlevelthreshold | integer [ 1 .. 255 ] Motion detection zone detail |
| mdprivacymask | integer Motion detection privacy mask |
| mdlevelthreshold | boolean Motion detection zone result |
| pmask | string Enum:"on" "off" Get or set the privacy mask. Use |
| pmaskleft | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| pmasktop | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| pmaskright | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| pmaskbottom | integer [ 0 .. 1023 ] Get, set, or erace a privacy mask block (32 x 32 pixels per block). |
| streamip | string <ipv4> ^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the multicast IP address. |
| rtpport | integer [ 0 .. 65535 ] Get or set the multicast port. |
| sapip | string <ipv4> ^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the multicast SAP IP address. |
| vertical_shift | integer Shift sensors vertically. |
| pan | integer Set a pan value. |
| tilt | integer Set a tilt value. |
| zoom | string or integer Set zoom moving steps. |
| ptz | string or integer Use to engage, record, or save a preset. |
Returns the parameters specified in the query.
Return settings from the camera. In general, you should use only one of the following parameters at a time.
| day_binning | string Enum:"on" "off" Enables or disables day binning mode for supported cameras. |
| night_binning | string Enum:"on" "off" Enables or disables day binning mode for supported cameras. |
| daynight | string Enum:"auto" "day" "night" "dual" Sets day/night mode. Cameras default to |
| upscaling | string Enum:"on" "off" Scales monocrome images to the same size as color images. If upscaling is disabled, the ratio is 1.6 between color images and monochrome images. |
| channelenable | string [ 1 .. 15 ] The channels you want to enable. |
| brightness | integer [ -50 .. 50 ] Sets brightness for the camera or channel. |
| sharpness | integer [ 0 .. 4 ] Sets sharpness for the camera or channel. |
| saturation | integer [ 0 .. 6 ] Sets color saturation for the camera or channel. |
| blue | integer [ -10 .. 10 ] Sets blue balance for the camera or channel. |
| red | integer [ -10 .. 10 ] Sets red balance for the camera or channel. |
| illum | string Enum:"auto" "indoor" "outdoor" "mlx" Sets illumination for the camera or channel. |
| freq | integer [ 50 .. 60 ] Mains frequency in Hz, used for indoor lighting compensation. |
| lowlight | string Enum:"highspeed" "speed" "balance" "quality" "moonlight" Exposure (low light) mode. |
| shortexposures | integer [ 1 .. 80 ] Shutter time in high-speed exposure mode, set in milliseconds. |
| autoexp | string Enum:"on" "off" Auto exposure mode |
| exposure | string Enum:"auto" "on" "off" Auto exposure mode |
| expwndleft | integer >= 0 The exposure window for the sensor. |
| expwndtop | integer >= 0 The exposure window for the sensor. |
| expwndwidth | integer >= 0 The exposure window for the sensor. |
| expwndheight | integer >= 0 The exposure window for the sensor. |
| sensorleft | integer >= 0 Sensor cropping, from the left. |
| sensortop | integer >= 0 Sensor cropping from the top. |
| sensorwidth | integer >= 0 Sensor cropping based on width. Both sides are equally cropped by half the value. |
| sensorheight | integer >= 0 Sensor cropping based on height. The top and bottom are equally cropped by half the value, centering the image. |
| imgleft | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgtop | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgwidth | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgheight | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgquality | integer [ 1 .. 26 ] Image setting, used as the implcit perameter list in img.jpg image requests. |
| imgres | string Enum:"full" "half" Image setting, used as the implcit perameter list in img.jpg image requests. |
| mac | string Returns the MAC address of the camera. |
| model | string Enum:"fullname" "releasename" "lpn" "internal" Returns the camera's model number. |
| fwversion | boolean Returns the camera's firmware version. |
| procversion | boolean Returns the image processor version. |
| netversion | boolean Returns the network processor version. |
| revision | boolean Returns the PCB version. |
| kneepoint | integer [ 1 .. 100 ] Custom mode setting |
| analoggain | integer [ 1 .. 100 ] Custom mode setting |
| maxkneegain | integer [ 1 .. 100 ] Custom mode setting |
| maxexptime | integer [ 1 .. 100 ] Custom mode setting |
| maxdigitalgain | integer [ 1 .. 100 ] Custom mode setting |
| webserverport | integer [ 0 .. 65535 ] The port for the camera's web server. |
| admin | string or string Get or set the admin-level password. |
| viewer | string or string Get or set the viewer-level password. |
| maxsensorwidth | integer Get the maximum sensor width. |
| maxsensorheight | integer Get the maximum sensor height. |
| mdmode | string Enum:"on" "off" Get or set motion alarm settings |
| motiondetect | string Enum:"on" "off" Get or set motion detection settings |
| mdtotalzones | integer Set regular (64) or extended motion detection mode (1024). 4k cameras support motion detection in extended mode either. |
| auxin | boolean Get auxin. |
| auxout | string Enum:"on" "off" Get or set auxiliary audio out. |
| cropping | string Enum:"on" "off" Get or set flexible cropping. |
| 1080p_mode | string Enum:"on" "off" Get or set 1080p mode — used in 10xx5 models only. |
| pmask | string Enum:"on" "off" Get or set the privacy mask. Use |
| focus | string or integer Get or set focus moving steps. After setting focus/zoom, the new focus becomes valid after the next frame. |
| zoom | string or integer Set zoom moving steps. |
| focusleft | integer >= 0 |
| focustop | integer >= 0 |
| focusright | integer >= 0 |
| focusbottom | integer >= 0 |
| focuswindow | Array of integer 4 items Get or set the four sides of the focus window. |
| af_dn | string Enum:"on" "off" Get or set autofocus after enabling the day-night switch. |
| af_zoom | string Enum:"on" "off" Get or set autofocus after zoom. |
| casino_mode | string Enum:"on" "off" Get or set casino mode (1080p models only) |
| netopt | integer [ 0 .. 10 ] Get or set network related settings. Integers correspond to the bits you want to enable or disable. bit 0 = DHCP IP assignment; bit 1 = BOOTP IP assignment; bit 2 = RARP IP assignment; bit 3 = IP lock; bit 4 = NTP time requester; bit 5 = PSIA discovery multicast server; bit 6 = RTP multicast server; bit 7 = MTU enable/disable; bit 8 = PSIA discovery zeroconfig server; bit 9 = IPv6 stack enable; bit 10 = DHCPv6 enable |
| multicast_rec | string Enum:"on" "off" Get or set the multicast reception setting. |
| en_multicast | integer [ 0 .. 1 ] Enable multicast announcement.
|
| fps | integer [ 0 .. 30 ] Get or set the camera framerate. values over the camera's famerate will return the camera's maximum framerate (model dependent). |
| qp | string [ 16 .. 36 ] The quantization parameter for the H.264 encoder. Sets the target qp. Lower qp indicates a higher quality image. This paramaeter is ignored if your request includes the bitrate parameter. |
| qp_max | string [ 16 .. 36 ] Get or set the maximum allowed QP value — i.e. the lowest allowable quality. |
| ratelimit_mode | boolean Get or set variable bitrate limit mode. |
| ratelimit | string [ 0 .. 65535 ] Get or set a variable bitrate limit. |
| bitrate | integer [ 1 .. 65535 ] Sets a constant bitrate in kilobits per second. If this parameter is present in the request, the QP parameter is ignored, and the camera adjusts quantization parameters automatically to maintain the specified bitrate. |
| keyframeinterval | integer [ 0 .. 200 ] Default: 50 Get or set the key frame interval.
|
| rtspport | integer [ 0 .. 65535 ] Default: 554 Get or set the RTSP port. |
| spacialfilter | integer [ 0 .. 100 ] Get or set the low-light noise filter. |
| name | string [ 0 .. 32 ] characters Get or set the camera name. |
| mtu | integer [ 512 .. 1500 ] Get or set the MTU size. |
| ip | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the camera's IP address. |
| subnetmask | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the camera's subnet mask. |
| gateway | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the camera's default gateway. |
| eth_negotiation | string Enum:"auto" "fixed" When set to auto, auto negotiation is enabled. Connected devices will first share their transmission capabilities, such as speed and duplex mode, and then choose the highest performance transmission mode they both support. When set to fixed, the camera uses a transmission speed of 100Mb and full duplex mode. |
| features | integer Returns an integer for enabled features. Integers that are not returned are not enabled. |
| audioinput | string Enum:"mic" "linein" The source of audio input. |
| linein_volume | integer [ 0 .. 45 ] Volume of line-in audio. |
| mic_boost | integer [ 0 .. 2 ] Volume of microphone-in audio. |
| piris | string Enum:"on" "off" Enable/disable P-iris |
| pirispos | integer [ 0 .. 255 ] The position P-iris closes to |
| ir | string Enum:"on" "alwayson" "off" Infrafred light control. |
| make | string Get the make of the camera. |
| white_balance | string Enum:"on" "off" White balance control. |
| wbwndctrl | string Enum:"on" "off" White balance window control. |
| wbwndleft | integer >= 0 White balance window left start value. Maximum values depend on your sensor size. |
| wbwndtop | integer >= 0 White balance window top start value. Maximum values depend on your sensor size. |
| wbwndwidth | integer >= 0 White balance window width, beginning from the |
| wbwndheight | integer >= 0 White balance window height, beginning from the |
| ntpserver_ip | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ NTP server address. |
| enclosure | string Value:"code" Returns the camera's model name. Provide |
| gamma | integer [ 0 .. 100 ] Gamma for single sensor and Surroundvideo1 cameras. |
| gamma2 | integer [ 0 .. 100 ] Gamma for the second sensor in dual sensor cameras. |
| bandwidthsaving | string Enum:"on" "off" Bandwidth saving mode settings. |
| lowpower | string Enum:"on" "off" Low power mode settings. |
| motion_compensation | string Enum:"on" "off" Motion compensation settings. |
| adjustable_ir | string Enum:"adaptive" "preset" "disabled" Adjustable IR light settings. |
| irwidepos | integer [ 0 .. 7 ] The adjustable intensity of wide IR lights. |
| irtelpos | integer [ 0 .. 7 ] The adjustable intensity of tele IR lights. |
| irpos_chan1 | integer [ 0 .. 32 ] Controls IR intensity on LED board 1 of FLEX model cameras. |
| irpos_chan2 | integer [ 0 .. 32 ] Controls IR intensity on LED board 2 of FLEX model cameras. |
| snapstream | string Enum:"on" "off" Snapstream on/off setting. |
| sensorcount | integer Returns the sensor count. Use the sensor count to determine the channels you want to get or set when |
| scaling | string Enum:"on" "off" Enable or disable down-scaling. |
| scaling | string Set scaling size as |
| sd_codec | string Enum:"jpeg" "h264" The codec used for video recorded to the camera's SD card. |
| sd_fps | integer [ 0 .. 30 ] The framerate for video recorded to the camera's SD card. |
| sd_recording | string Enum:"on" "off" Enables/disables continuous local recording. |
| sd_networkfail | string Enum:"on" "off" Enables/disables local recording on network failure events. |
| sd_motionalarm | string Enum:"on" "off" Enables/disables local recording on motion events. |
| sd_ioalarm | string Enum:"on" "off" Enables/disables local recording on I/O alarm events. |
| sd_stampspan | boolean Returns timestamps for recorded video. |
| sd_imgleft | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgright | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgtop | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgbottom | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgres | string Enum:"full" "half" Determine whether to record SD images at full or half resolution. |
| qos_enabled | integer [ 0 .. 1 ] Arecont Vision cameras support RFC 2474 “Definition of the Differentiated services field (DS field) in the IPv4 and IPv6 headers”, which is widely adopted by router manufacturers to implement quality of service (QoS) mechanism. Enable or disable quality of service (QOS). |
| qos_video | integer [ 0 .. 63 ] In Arecont Vision cameras, Per-Hop Behavior (PHB) type Assured Forwarding (AF) is the default PHB for video streaming over RTP. The recommended default Differentiated Services Code Point (DSCP) of AF is 34, which means low drop. |
| qos_default | integer [ 0 .. 63 ] In Arecont Vision cameras, Per-Hop Behavior (PHB) type Assured Forwarding (AF) is the default PHB for video streaming over RTP. The recommended default Differentiated Services Code Point (DSCP) of AF is 34, which means low drop. All other traffic uses default PHB with DSCP value 0. |
| ipv6enabled | boolean Enable/disable IPv6. |
| ipv6address | string <ipv6> The IPv6 address for the camera. |
| ipv6prefixlen | string The IPv6 prefix. |
| ipv6dhcp | string Enum:"on" "off" Enable/disable DHCP for IPv6. |
| ipv6addresstype | string Enum:"dhcp" "manual" IPv6 address type. Use |
| ipv6acceptrouters | boolean IPv6 accept routers setting. |
| equalbright | string Enum:"on" "off" Equalize brightness across sensors in a multisensor camera. |
| equalcolor | string Enum:"on" "off" Equalize color across sensors in a multisensor camera. |
| vertical_alignment | string Enum:"on" "off" Align sensors in a multisensor camera. |
| piris_ref_channel | integer Set the P-iris reference channel for a multi-channel camera. |
| exp_ref_channel | integer or string Set the exposure reference for a multi-channel camera. |
| pan | integer Set a pan value. |
| tilt | integer Set a tilt value. |
| ptz | string or integer Use to engage, record, or save a preset. |
| switcher | boolean Run this command to detect a pan module collision with another module and if module 2 is in home.
|
Returns the parameters specified in the query.
Set camera settings.
| day_binning | string Enum:"on" "off" Enables or disables day binning mode for supported cameras. |
| night_binning | string Enum:"on" "off" Enables or disables day binning mode for supported cameras. |
| daynight | string Enum:"auto" "day" "night" "dual" Sets day/night mode. Cameras default to |
| upscaling | string Enum:"on" "off" Scales monocrome images to the same size as color images. If upscaling is disabled, the ratio is 1.6 between color images and monochrome images. |
| channelenable | string [ 1 .. 15 ] The channels you want to enable. |
| brightness | integer [ -50 .. 50 ] Sets brightness for the camera or channel. |
| sharpness | integer [ 0 .. 4 ] Sets sharpness for the camera or channel. |
| saturation | integer [ 0 .. 6 ] Sets color saturation for the camera or channel. |
| blue | integer [ -10 .. 10 ] Sets blue balance for the camera or channel. |
| red | integer [ -10 .. 10 ] Sets red balance for the camera or channel. |
| illum | string Enum:"auto" "indoor" "outdoor" "mlx" Sets illumination for the camera or channel. |
| freq | integer [ 50 .. 60 ] Mains frequency in Hz, used for indoor lighting compensation. |
| lowlight | string Enum:"highspeed" "speed" "balance" "quality" "moonlight" Exposure (low light) mode. |
| shortexposures | integer [ 1 .. 80 ] Shutter time in high-speed exposure mode, set in milliseconds. |
| autoexp | string Enum:"on" "off" Auto exposure mode |
| exposure | string Enum:"auto" "on" "off" Auto exposure mode |
| expwndleft | integer >= 0 The exposure window for the sensor. |
| expwndtop | integer >= 0 The exposure window for the sensor. |
| expwndwidth | integer >= 0 The exposure window for the sensor. |
| expwndheight | integer >= 0 The exposure window for the sensor. |
| sensorleft | integer >= 0 Sensor cropping, from the left. |
| sensortop | integer >= 0 Sensor cropping from the top. |
| sensorwidth | integer >= 0 Sensor cropping based on width. Both sides are equally cropped by half the value. |
| sensorheight | integer >= 0 Sensor cropping based on height. The top and bottom are equally cropped by half the value, centering the image. |
| imgleft | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgtop | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgwidth | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgheight | integer >= 0 Image setting, used as the implcit perameter in img.jpg image requests. |
| imgquality | integer [ 1 .. 26 ] Image setting, used as the implcit perameter list in img.jpg image requests. |
| imgres | string Enum:"full" "half" Image setting, used as the implcit perameter list in img.jpg image requests. |
| kneepoint | integer [ 1 .. 100 ] Custom mode setting |
| analoggain | integer [ 1 .. 100 ] Custom mode setting |
| maxkneegain | integer [ 1 .. 100 ] Custom mode setting |
| maxexptime | integer [ 1 .. 100 ] Custom mode setting |
| maxdigitalgain | integer [ 1 .. 100 ] Custom mode setting |
| admin | string or string Get or set the admin-level password. |
| viewer | string or string Get or set the viewer-level password. |
| maxsensorwidth | integer Get the maximum sensor width. |
| maxsensorheight | integer Get the maximum sensor height. |
| mdmode | string Enum:"on" "off" Get or set motion alarm settings |
| motiondetect | string Enum:"on" "off" Get or set motion detection settings |
| mdtotalzones | integer Set regular (64) or extended motion detection mode (1024). 4k cameras support motion detection in extended mode either. |
| auxin | boolean Get auxin. |
| auxout | string Enum:"on" "off" Get or set auxiliary audio out. |
| cropping | string Enum:"on" "off" Get or set flexible cropping. |
| 1080p_mode | string Enum:"on" "off" Get or set 1080p mode — used in 10xx5 models only. |
| pmask | string Enum:"on" "off" Get or set the privacy mask. Use |
| focus | string or integer Get or set focus moving steps. After setting focus/zoom, the new focus becomes valid after the next frame. |
| zoom | string or integer Set zoom moving steps. |
| focusleft | integer >= 0 |
| focustop | integer >= 0 |
| focusright | integer >= 0 |
| focusbottom | integer >= 0 |
| focuswindow | Array of integer 4 items Get or set the four sides of the focus window. |
| af_dn | string Enum:"on" "off" Get or set autofocus after enabling the day-night switch. |
| af_zoom | string Enum:"on" "off" Get or set autofocus after zoom. |
| casino_mode | string Enum:"on" "off" Get or set casino mode (1080p models only) |
| netopt | integer [ 0 .. 10 ] Get or set network related settings. Integers correspond to the bits you want to enable or disable. bit 0 = DHCP IP assignment; bit 1 = BOOTP IP assignment; bit 2 = RARP IP assignment; bit 3 = IP lock; bit 4 = NTP time requester; bit 5 = PSIA discovery multicast server; bit 6 = RTP multicast server; bit 7 = MTU enable/disable; bit 8 = PSIA discovery zeroconfig server; bit 9 = IPv6 stack enable; bit 10 = DHCPv6 enable |
| multicast_rec | string Enum:"on" "off" Get or set the multicast reception setting. |
| en_multicast | integer [ 0 .. 1 ] Enable multicast announcement.
|
| fps | integer [ 0 .. 30 ] Get or set the camera framerate. values over the camera's famerate will return the camera's maximum framerate (model dependent). |
| qp | string [ 16 .. 36 ] The quantization parameter for the H.264 encoder. Sets the target qp. Lower qp indicates a higher quality image. This paramaeter is ignored if your request includes the bitrate parameter. |
| qp_max | string [ 16 .. 36 ] Get or set the maximum allowed QP value — i.e. the lowest allowable quality. |
| ratelimit_mode | boolean Get or set variable bitrate limit mode. |
| ratelimit | string [ 0 .. 65535 ] Get or set a variable bitrate limit. |
| bitrate | integer [ 1 .. 65535 ] Sets a constant bitrate in kilobits per second. If this parameter is present in the request, the QP parameter is ignored, and the camera adjusts quantization parameters automatically to maintain the specified bitrate. |
| keyframeinterval | integer [ 0 .. 200 ] Default: 50 Get or set the key frame interval.
|
| rtspport | integer [ 0 .. 65535 ] Default: 554 Get or set the RTSP port. |
| spacialfilter | integer [ 0 .. 100 ] Get or set the low-light noise filter. |
| name | string [ 0 .. 32 ] characters Get or set the camera name. |
| mtu | integer [ 512 .. 1500 ] Get or set the MTU size. |
| ip | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the camera's IP address. |
| subnetmask | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the camera's subnet mask. |
| gateway | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ Get or set the camera's default gateway. |
| webserverport | integer [ 0 .. 65535 ] The port for the camera's web server. |
| eth_negotiation | string Enum:"auto" "fixed" When set to auto, auto negotiation is enabled. Connected devices will first share their transmission capabilities, such as speed and duplex mode, and then choose the highest performance transmission mode they both support. When set to fixed, the camera uses a transmission speed of 100Mb and full duplex mode. |
| features | integer Returns an integer for enabled features. Integers that are not returned are not enabled. |
| audioinput | string Enum:"mic" "linein" The source of audio input. |
| linein_volume | integer [ 0 .. 45 ] Volume of line-in audio. |
| mic_boost | integer [ 0 .. 2 ] Volume of microphone-in audio. |
| piris | string Enum:"on" "off" Enable/disable P-iris |
| pirispos | integer [ 0 .. 255 ] The position P-iris closes to |
| ir | string Enum:"on" "alwayson" "off" Infrafred light control. |
| white_balance | string Enum:"on" "off" White balance control. |
| wbwndctrl | string Enum:"on" "off" White balance window control. |
| wbwndleft | integer >= 0 White balance window left start value. Maximum values depend on your sensor size. |
| wbwndtop | integer >= 0 White balance window top start value. Maximum values depend on your sensor size. |
| wbwndwidth | integer >= 0 White balance window width, beginning from the |
| wbwndheight | integer >= 0 White balance window height, beginning from the |
| ntpserver_ip | string^([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])\\.([01]?\\d\\d?|2[0-4]\\d|25[0-5])$ NTP server address. |
| gamma | integer [ 0 .. 100 ] Gamma for single sensor and Surroundvideo1 cameras. |
| gamma2 | integer [ 0 .. 100 ] Gamma for the second sensor in dual sensor cameras. |
| bandwidthsaving | string Enum:"on" "off" Bandwidth saving mode settings. |
| lowpower | string Enum:"on" "off" Low power mode settings. |
| motion_compensation | string Enum:"on" "off" Motion compensation settings. |
| adjustable_ir | string Enum:"adaptive" "preset" "disabled" Adjustable IR light settings. |
| irwidepos | integer [ 0 .. 7 ] The adjustable intensity of wide IR lights. |
| irtelpos | integer [ 0 .. 7 ] The adjustable intensity of tele IR lights. |
| irpos_chan1 | integer [ 0 .. 32 ] Controls IR intensity on LED board 1 of FLEX model cameras. |
| irpos_chan2 | integer [ 0 .. 32 ] Controls IR intensity on LED board 2 of FLEX model cameras. |
| snapstream | string Enum:"on" "off" Snapstream on/off setting. |
| sensorcount | integer Returns the sensor count. Use the sensor count to determine the channels you want to get or set when |
| scaling | string Enum:"on" "off" Enable or disable down-scaling. |
| scaling | string Set scaling size as |
| sd_codec | string Enum:"jpeg" "h264" The codec used for video recorded to the camera's SD card. |
| sd_fps | integer [ 0 .. 30 ] The framerate for video recorded to the camera's SD card. |
| sd_recording | string Enum:"on" "off" Enables/disables continuous local recording. |
| sd_networkfail | string Enum:"on" "off" Enables/disables local recording on network failure events. |
| sd_motionalarm | string Enum:"on" "off" Enables/disables local recording on motion events. |
| sd_ioalarm | string Enum:"on" "off" Enables/disables local recording on I/O alarm events. |
| sd_stampspan | boolean Returns timestamps for recorded video. |
| sd_imgleft | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgright | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgtop | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgbottom | integer Select a region of video that you want ot record to the SD card. You should set this parameter before you turn on local recording. |
| sd_imgres | string Enum:"full" "half" Determine whether to record SD images at full or half resolution. |
| qos_enabled | integer [ 0 .. 1 ] Arecont Vision cameras support RFC 2474 “Definition of the Differentiated services field (DS field) in the IPv4 and IPv6 headers”, which is widely adopted by router manufacturers to implement quality of service (QoS) mechanism. Enable or disable quality of service (QOS). |
| qos_video | integer [ 0 .. 63 ] In Arecont Vision cameras, Per-Hop Behavior (PHB) type Assured Forwarding (AF) is the default PHB for video streaming over RTP. The recommended default Differentiated Services Code Point (DSCP) of AF is 34, which means low drop. |
| qos_default | integer [ 0 .. 63 ] In Arecont Vision cameras, Per-Hop Behavior (PHB) type Assured Forwarding (AF) is the default PHB for video streaming over RTP. The recommended default Differentiated Services Code Point (DSCP) of AF is 34, which means low drop. All other traffic uses default PHB with DSCP value 0. |
| ipv6enabled | boolean Enable/disable IPv6. |
| ipv6address | string <ipv6> The IPv6 address for the camera. |
| ipv6prefixlen | string The IPv6 prefix. |
| ipv6dhcp | string Enum:"on" "off" Enable/disable DHCP for IPv6. |
| ipv6addresstype | string Enum:"dhcp" "manual" IPv6 address type. Use |
| ipv6acceptrouters | boolean IPv6 accept routers setting. |
| equalbright | string Enum:"on" "off" Equalize brightness across sensors in a multisensor camera. |
| equalcolor | string Enum:"on" "off" Equalize color across sensors in a multisensor camera. |
| vertical_alignment | string Enum:"on" "off" Align sensors in a multisensor camera. |
| piris_ref_channel | integer Set the P-iris reference channel for a multi-channel camera. |
| exp_ref_channel | integer or string Set the exposure reference for a multi-channel camera. |
| pan | integer Set a pan value. |
| tilt | integer Set a tilt value. |
| ptz | string or integer Use to engage, record, or save a preset. |
Returns the parameters set in the request.