IP Camera
API GUIDE
This document provides a description of protocols and API of
2009.3.13. JVC
1
IP Camera
API GUIDE
This document provides a description of protocols and API of
2009.3.13. JVC
1
Updates
2
Custom Application Software Development Guide
-Getting JPEG from
-Getting
-Getting Alarm from
-Getting or changing
-Pan/Tilt/Zoom/Focus operation of
-Sending Multicast from
-Customization of
3
Content
1.Getting JPEG from
2.Getting
3.API to Search
4.Getting Alarm from
5.Using API that Requires Basic Authentication
6.API for Getting/Changing Parameters of
7.List of Protocols and Port Numbers Used with
8.Customizing
9.FAQ
4
This document describes APIs of
1. Getting JPEG from
1.1. Basic Procedures
1)The client establishes a TCP connection to port number 80.
2)The client sends out API.
Example
GET /api/video?encode=jpeg&framerate=30&boundary=on&ptz_info=off HTTP/1.1<CRLF>
Host: 192.168.0.2<CRLF><CRLF>
Note <CRLF> denotes the line feed code (0x0D, 0x0A).
3)
Example of
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC
encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF>
4)
JPEG files with boundary structure will be sent out continuously after HTTP Response as follows.
5
boundary structure shows file size of each JPEG file. Using the size, reading the whole JPEG data becomes easy.
HTTP Response
JPEG (No. 1) <CRLF>
JPEG (No. 2) <CRLF>
,,,
When ptz_info=on is specified, boundary, pan/tilt/zoom information and JPEG file will be sent out continuously after HTTP Response as follows.
HTTP Response
boundary
pan/tilt/zoom information
JPEG (No. 1)
boundary
pan/tilt/zoom information
JPEG (No. 2)
,,,
Example of Booundary and pan/tilt/zoom information:
6
Range of
Range of
Range of
Details of JPEG file format is explained later.
5) When the client wants to stop current JPEG transmission, the client disconnects TCP80.
1.2. API Format
Structure
Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication is also not necessary.
Example
GET /api/video?encode=jpeg&framerate=30&boundary=on&ptz_info=off HTTP/1.1<CRLF>
Host: 192.168.0.2<CRLF><CRLF>
Parameter value is indicated using =. Do not insert space before and after =.
Example framerate=1
Parameter Description
encode For specifying compression format. For example, specify as encode=jpeg to get JPEG.
framerate For specifying the frame rate. For example, specify as framerate=5 to get at 5 fps. Specify as
30, 25, 15, 10, 7.5, 6, 5, 3, 2, 1, 0,
When the parameter is specified as framerate=0,
7
TCP connection.
boundary To specify streaming format. Specify "on" for server push streaming. If framerate=0 is specified, there is no boundary structure even if boundary=on.
ptz_info To add pan/tilt/zoom information before JPEG data. Specify on or off. Even if ptz_info=off, pan/tilt/zoom information is stored in JPEG comment segemnt.
1.3. Response
When API is successfully received with boundary=on
parameters.
Example of
HTTP/1.1 200 OK<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC
encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF>
When API is successfully received with boundary=off
indicates actual parameters.
Example of
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC
encode=jpeg&framerate=30&framesize=vga&boundary=off&ptz_info=off<CRLF><CRLF>
1.4. Restrictions
8
Access restriction
Restriction by maximum bitrate of
The maximum bitrate of
Number of clients
The maximum number of clients that can get JPEG stream depends on encode settings and requests from client. Refer the instruction manual for detailed information.
1.5. JPEG File Format Sent Out by
JPEG file from
The following information is stored in the comment segment 1. Each item has a fixed length. In
9
Item names and values, excluding the version information that does not include =, are stored in the following format.
fixed length for each item
Example: When width=640, the
2. Getting
2.1. Basic Procedures
1)The client establishes a TCP connection to port number 80.
2)The client sends out API.
Example
10
GET /api/video?encode=mpeg4 HTTP/1.1<CRLF>
Host: 192.168.0.2<CRLF><CRLF>
Note <CRLF> denotes the line feed code (0x0D, 0x0A).
3)
Example of
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC
encode=mpeg4&framerate=15&framesize=vga&ptz_info=off<CRLF><CRLF>
4)
HTTP Response
VOP of
VOP of
,,,
When ptz_info=on is specified, boundary, pan/tilt/zoom information and
HTTP Response
boundary
pan/tilt/zoom information
boundary
pan/tilt/zoom information
11
,,,
Example of Booundary and pan/tilt/zoom information:
Range of
Range of
Range of
Details of
5) When the client wants to stop current
2.2. API Format
Structure
Unlike APIs for getting/setting parameters, Accept line is not required. Basic authentication is also not necessary.
Example
GET /api/video?encode=mpeg4&ptz_info=off HTTP/1.1<CRLF>
Host: 192.168.0.2<CRLF><CRLF>
12
Parameter value is indicated using =. Do not insert space before and after =.
Example encode=mpeg4
Parameter Description
encode For specifying compression format. For example, specify as encode=mpeg4 to get
2.3. Response
When API is successfully received
Example of
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC
encode=mpeg4&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF>
2.4. Restrictions
Access restriction
Restriction by maximum bitrate of
The maximum bitrate of
Number of clients
The maximum number of clients that can get
13
2.5.
Ratio of
First VOP can be
Example of
HTTP Response
VOL
There are VOL, Userdata1, GOV and Userdata2 before each
Data Structure before
14
3. API to Search
Search
Protocol Send udp packet with following text in UDP payload to destination port number 80. Source port number can be any value.
system.id<CRLF>
Response
Response Example of
4. Getting Alarm from
4.1. Procedure
1)The client establishes a TCP connection to port number 32040.
2)When motion is detected from the video image of
peripheral.input_pin.pin(1).status=break<CRLF> peripheral.input_pin.pin(2).status=break<CRLF> video.input(1).detection(motion).status=on<CRLF>
3) The client can disconnect TCP32040 to end the alarm acquisition.
15
4.2. Restrictions
Maximum number of clients
The maximum number of clients that may acquire alarm is 10. When a 11th client establishes TCP connection to port number 32040,
Additionally,
Note: API for getting alarm is not restricted by the access restriction function.
5. Using API that Requires Basic Authentication
Basic authentication is required for APIs which are explained in Section 6. This section provides general explanation of those APIs.
5.1. Procedure
1)The client establishes a TCP connection to port number 80.
2)The client sends API.
API has following structure.
The following is an example of API for Getting subnet mask of
Example
GET /api/param?network.interface.subnetmask HTTP/1.1<CRLF>
Accept: text/plain<CRLF>
Host: 192.168.0.2<CRLF>
Authorization: Basic YWRtaW46anZj<CRLF><CRLF>
Specify the response format by Accept line. Plain text response is returned when this is specified as text/plain. HTML response is returned when text/html is specified. HTML response is returned when Accept is not specified.
These APIs for getting/setting parameters are protected by basic authentication. Authorization line needs to include
16
encoded username and password. There are 3 types of usernames, namely admin, operator and user. Available APIs are different for each username. Join the user name and the password using a colon, Base64 encode this character string and
enter this in the Authorization line. For example, when
User name admin
Password jvc
then the character string joining the user name and the password with a colon is: admin:jvc
Base64 encoding of this string yields YWRtaW46anZj. Enter this in the Authorization line. Default password is as follows. Password of
3)
Example of
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Date: Fri, 13 MAY 2005 08:33:12 GMT<CRLF>
Server: JVC
4) The client disconnects TCP80 to end the use of API.
Note: APIs for getting/setting parameters are not restricted by the access restriction function.
17
6. API for Getting/Changing Parameters of
This section provides description of APIs for getting/changing parameters of
.
6.1. General
(1) Getting parameter
Specify API in GET line according to the format below when getting a parameter from
/api/param?ParamA.ParamB.ParamC
The upper limit of this character string is 1024 bytes.
When acquisition is successfully completed, values will be shown in the body of HTTP response, followed by "&200 OK" message.
Example:
ParamA.ParamB.ParamC=Data&200 OK
When an error occurs, an error code will be returned instead of indicating a value in the body of HTTP response. Example:
ParamA.ParamB.ParamC&401 Unauthorized
(2) Setting parameter
Specify API in GET line according to the format below when setting a parameter for
/api/param?ParamA.ParamB.ParamC=Data
Parameter values are indicated using =. Do not insert space before and after =.
The upper limit of this character string is 1024 bytes.
Response will be in the following format.
ParamA.ParamB.ParamC&200 OK
An error code will be returned when setting is not properly performed. Example:
ParamA.ParamB.ParamC&401 Unauthorized
6.2. Camera
These APIs are related to camera settings. Same functions are shown on the Camera page of the WEB setting page and
18
PTZ Controller of
Saving Changes of Camera Settings
Format /api/param?canera.status=data
Example /api/param?canera.status=save
Example of response canera.status&200 OK
Interpretation Save or cancel changes to camera settings. Specify save or restore. By status=save, changes to camera settings are saved. If not saved, the changes are restored by power off of
Allowed users admin, operator
Getting Camera ID stored in JPEG from
Format /api/param?camera.id
Example of response
Response example when setting field is left blank camera.id=&200 OK
Interpretation Acquire Camera ID comment. This comment is stored in comment segment of JPEG. The Camera ID is used as sender's display name of alarm mail. If you want to set sender's mail address, see "Setting Sender Mail
Address for
Example of response camera.id=Camera01&200 OK
Sender Camera01<somename@somecompany.com>
Allowed users admin, operator, user
Setting Camera ID in JPEG from
Format /api/param?camera.id=data
Example /api/param?camera.id=Camera01
Example when setting as blank /api/param?camera.id=%00
Example of response camera.id&202 Accepted(camera.status=save)
Interpretation Change the camera ID stored in comment segment of JPEG. Maximum size is 40 bytes. To set as blank, specify as %00(0x25, 0x30, 0x30).
To use space, specify as %20(0x25, 0x32, 0x30). If you want to set "Comment In JPEG" for example, specify as follows. /api/param?camera.id=Comment%20In%20JPEG
The Camera ID is used as sender's display name of alarm mail. If you want to set sender's mail address, see "Setting
Sender Mail Address for
Example of setting /api/param?camera.id=Camera01
Sender Camera01<somename@somecompany.com>
The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
19
Allowed users admin, operator
Getting Monitor Type from
Format /api/param?camera.image.monitortype
Example of response camera.image.monitortype=lcd1&200 OK
Interpretation Acquire the monitor type setting. Value is custome, lcd1, lcd2 or crt. When lcd1, lcd2 or crt is set,
enhance band setting and gamma setting are ignored.
Allowed users admin, operator, user
Setting Monitor Type for
Format /api/param?camera.image.monitortype=data
Example of setting a value /api/param?image.monitortype=crt
Example of response camera.image.monitortype&202 Accepted(camera.status=save)
Interpretation Change the monitor type setting. Specify custome, lcd1, lcd2 or crt. Selecting lcd1 or lcd2 can improve image on LCD display. Selecting crt can improve image on CRT monitor. When lcd1, lcd2 or crt is set, enhance band setting and gamma setting are ignored. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Black level from
Format /api/param?camera.image.pedestal
Example of response camera.image.pedestal=50&200 OK
Interpretation Acquire black level setting. Range of pedestal is between 0 to 100, and it is mapped to 3 internal levels. The larger the value, the brighter will be the black.
Allowed users admin, operator, user
Setting Black level for
Format /api/param?camera.image.pedestal=data
Example of setting a value /api/param?camera.image.pedestal=50
Example of 1 step change /api/param?camera.image.pedestal=+
Example of response camera.image.pedestal&202 Accepted(camera.status=save)
Interpretation Change pedestal setting. Specify 0 to 100, "+" or
Allowed users admin, operator
20
Getting Gamma from
Format /api/param?camera.image.gamma
Example of response camera.image.gamma=0.45&200 OK
Interpretation Acquire gamma setting. Value of gamma is 1, 0.55, 0.5, 0.45 or active.
When lcd1, lcd2 or crt is set to monitor type, gamma setting is ignored.
Allowed users admin, operator, user
Setting Gamma for
Format /api/param?camera.image.gamma=data
Example of setting a value /api/param?camera.image.gamma=0.45
Example of 1 step change /api/param?camera.image.gamma=+
Example of response camera.image.gamma&202 Accepted(camera.status=save)
Interpretation Change gamma setting. Specify 1, 0.55, 0.5, 0.45 or active. 1 or 0.55 will show better image quality when LCD monitor is used. 0.45 will show better image quality when CRT monitor is used. "active" will change gamma dynamically according to image brightness. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
When lcd1, lcd2 or crt is set to monitor type, gamma setting is ignored.
Allowed users admin, operator
Getting Active Gamma Level from
Format /api/param?camera.image.gamma.activelevel
Example of response camera.image.gamma.activelevel=0&200 OK
Interpretation Acquire active gamma level setting. Value of active gamma level is from 0 to 100, and 11 steps
internally. Thie setting is valid when gamma setting is "active".
Allowed users admin, operator, user
Setting Active Gamma Level for
Format /api/param?camera.image.gamma.activelevel=data
Example of response camera.image.gamma.activelevel&202
Accepted(camera.status=save)
Interpretation Change active gamma level setting. Specify from 0 to 100. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. Thie setting is valid when gamma
setting is "active".
Allowed users admin, operator
Getting Enhance Band from
21
Format /api/param?camera.image.enhance.band
Example of response camera.image.enhance.band=high&200 OK
Interpretation Acquire enhance band setting. Value of enhance band is high or low.
When lcd1, lcd2 or crt is set to monitor type, enhance band setting is ignored.
Allowed users admin, operator, user
Setting Enhance Band for
Format /api/param?camera.image.enhance.band=data
Example of setting a value /api/param?camera.image.enhance.band=low
Example of response camera.image.enhance.band&202 Accepted(camera.status=save)
Interpretation Change enhance band setting. Specify high or low. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
When lcd1, lcd2 or crt is set to monitor type, enhance band setting is ignored.
Allowed users admin, operator
Getting Enhance from
Format /api/param?camera.image.enhance
Example of response camera.image.enhance=50&200 OK
Interpretation Acquire enhance setting. Range of enhance is between 0 to 100, and it is mapped to 11 internal levels. The larger the value, the sharper will be the image.
Allowed users admin, operator, user
Setting Enhance for
Format /api/param?camera.image.enhance=data
Example of setting a value /api/param?camera.image.enhance=50
Example of 1 step change /api/param?camera.image.enhance=+
Example of response camera.image.enhance&202 Accepted(camera.status=save)
Interpretation Change enhance setting. Specify 0 to 100, "+" or
Allowed users admin, operator
Getting Color Level from
Format /api/param?camera.image.color
Example of response camera.image.color=50&200 OK
Interpretation Acquire color level value. Range of color level is between 0 to 100. The value is mapped to 11 internal
22
levels. The larger the value, the stronger will be the color.
Allowed users admin, operator, user
Setting Color Level for
Format /api/param?camera.image.color=data
Example of setting a value /api/param?camera.image.color=50
Example of 1 step change /api/param?camera.image.color=+
Example of response
camera.image.color&202 Accepted(camera.status=save)
Interpretation Change color level value. Specify 0 to 100, "+" or
Allowed users admin, operator
Getting Stabilizer from
Format /api/param?camera.image.stabilizer
Example of response camera.image.stabilizer=on&200 OK
Interpretation Acquire stabilizer setting. "on" or "off" is returned.
Allowed users admin, operator, user
Setting Stabilizer for
Format /api/param?camera.image.stabilizer=data
Example of setting /api/param?camera.image.stabilizer=on
Example of response
camera.image.stabilizer&202 Accepted(camera.status=save)
Interpretation Change stabilizer setting. Specify "on" or "off". When stabilizer is on, image is zoomed (x 1.3) by EZoom. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Stabilizer Level from
Format /api/param?camera.image.stabilizer.level
Example of response camera.image.stabilizer.level=100&200 OK
Interpretation Acquire stabilizer level. Value from 0 to 100 is returned. The level is 3 steps internally.
Allowed users admin, operator, user
23
Setting Stabilizer Level for
Format /api/param?camera.image.stabilizer.level=data
Example of setting /api/param?camera.image.stabilizer.level=0
Example of setting to strengthen /api/param?camera.image.stabilizer.level=+
Example of response
camera.image.stabilizer.level&202 Accepted(camera.status=save)
Interpretation Change stabilizer level setting. Specify from 0 to 100, "+" or
Allowed users admin, operator
Getting DNR from
Format /api/param?camera.image.dnr
Example of response camera.image.dnr=on&200 OK
Interpretation Acquire DNR (Digital Noise Reduction) setting. "on" or "off" is returned. DNR improves noise in dark image. DNR is valid when AGC is autoM or autoH. In
Allowed users admin, operator, user
Setting DNR for
Format /api/param?camera.image.dnr=data
Example of setting /api/param?camera.image.dnr=on
Example of response
camera.image.dnr&202 Accepted(camera.status=save)
Interpretation Change DNR setting. Specify "on" or "off". DNR improves noise in dark image. DNR is valid when AGC is autoM or autoH. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot. In
Allowed users admin, operator
Getting 3D Noise Reduction from
Format /api/param?camera.image.3ddnr
24
Example of response camera.image.3ddnr=on&200 OK
Interpretation Acquire 3D Noise Reduction setting. "off", "low", "mid", or "high" are returned. This API is available for
Allowed users admin, operator, user
Setting 3D Noise Reduction for
Format /api/param?camera.image.3ddnr=data
Example of setting /api/param?camera.image.3ddnr=on
Example of response
camera.image.dnr&202 Accepted(camera.status=save)
Interpretation Change 3D Noise Reduction setting. Specify "off", "low", "mid", or "high". This API is available for
Allowed users admin, operator
Getting AGC from
Format /api/param?camera.image.brightness
Example of response camera.image.brightnesss=autoL&200 OK
Interpretation Acquire AGC setting. "manual", "autoL", "autoM" or "autoH" is returned.
Allowed users admin, operator, user
Setting AGC for
Format /api/param?camera.image.brightness=data
Example /api/param?camera.image.brightness=auto
Example of response camera.image.brightness&202 Accepted(camera.status=save)
Interpretation Change AGC setting. Specify "manual", "autoL", "autoM" or "autoH". The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Limit of Sense Up from
Format /api/param?camera.image.senseup_limit
Example of response camera.image.senseup_limit=0&200 OK
Interpretation Acquire limit of sense up. 0, 2, 4, 8, 16, 32, 64 or 128 is returned. 0 means sense up is disabled. Other numbers mean frame number of sense up.
Allowed users admin, operator, user
25
Setting Limit of Sense Up for
Format /api/param?camera.image.senseup_limit=data
Example /api/param?camera.image.senseup_limit=4
Example of response camera.image.senseup_limit&202 Accepted(camera.status=save)
Interpretation Change limit of sense up. Specify 0, 2, 4, 8, 16, 32, 64, 128, "+" or
Sense up works when shutter speed is 1/60 or 1/100.
Allowed users admin, operator
Getting ALC priority from
Format /api/param?camera.auto_exposure.priority
Example of response camera.auto_exposure.priority=motion&200 OK
Interpretation Acquire ALC priority. ALC priority decides what is used first for auto exposure. "motion" or "quality" is returned. In case of "motion", AGC is used before using sense up. In case of "quality", sense up is used before using AGC.
Allowed users admin, operator, user
Setting ALC priority for
Format /api/param?camera.auto_exposure.priority=data
Example /api/param?camera.auto_exposure.priority=quality
Example of response camera.auto_exposure.priority&202
Accepted(camera.status=save)
Interpretation Change ALC priority. ALC priority decides what is used first for auto exposure. Specify "motion" or "quality". In case of "motion", AGC is used before using sense up. In case of "quality", sense up is used before using AGC. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Shutter Speed from
Format /api/param?camera.shutter
Example of response camera.shutter=60&200 OK
Interpretation Acquire shutter speed setting. 60, 100, 250, 500, 1000, 2000, 4000, or 10000 is returned. For example, 60 means shutter speed 1/60.
Allowed users admin, operator, user
Setting Shutter Speed for
26
Format /api/param?camera.shutter=data
Example of setting a value /api/param?camera.shutter=60
Example of 1 step change /api/param?camera.shutter=+
Example of response camera.shutter&202 Accepted(camera.status=save)
Interpretation Change shutter speed setting. Specify 60, 100, 250, 500, 1000, 2000, 4000, 10000, "+" or
To set from 250 to 10000, sense up setting must be 0.
Allowed users admin, operator
Getting B&W Mode from
Format /api/param?camera.image.true_daynight
Example of response camera.image.true_daynight=autoM&200 OK
Interpretation Acquire B&W mode. "color", "bw", "autoL", "autoM" or "autoH" is returned.
Allowed users admin, operator, user
Setting B&W Mode for
Format /api/param?camera.image.true_daynight=data
Example /api/param?camera.image.true_daynight=autoM
Example of response
camera.image.true_daynight&202 Accepted(camera.status=save)
Interpretation Change B&W mode. Specify "color", "bw", "autoL", "autoM" or "autoH". IR filter is on when "color" is set. IR filter is off when "bw" is set. IR filter is operated dynamically according to image brightness after autoL/autoM/autoH is set. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Auto Focus mode for B&W switching from
Format /api/param?camera.image.true_daynight.af
Example of response camera.image.true_daynight.af=on&200 OK
Interpretation Acquire auto focus mode for B&W switching. "on" or "off" is returned. When the setting is "on", auto focus works when B&W mode is switched.
Allowed users admin, operator, user
Setting Auto Focus mode for B&W switching for
Format /api/param?camera.image.true_daynight.af=data
27
Example /api/param?camera.image.true_daynight.af=on
Example of response
camera.image.true_daynight.af&202 Accepted(camera.status=save)
Interpretation Change auto focus mode for B&W switching. Specify "on" or "off". When the setting is "on", auto focus works when B&W mode is switched. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Light setting for focus in B&W mode from
Format /api/param?camera.image.true_daynight.light
Example of response camera.image.true_daynight.light=normal&200 OK
Interpretation Acquire light setting for focus in B&W mode. "normal" or "infrared" is returned. When the setting is "infrared", focus at zooming works correctly with infrared light in B&W mode.
Allowed users admin, operator, user
Setting Light for focus in B&W mode for
Format /api/param?camera.image.true_daynight.light=data
Example /api/param?camera.image.true_daynight.af=infrared
Example of response
camera.image.true_daynight.light&202 Accepted(camera.status=save)
Interpretation Change light setting for focus in B&W mode. Specify "normal" or "infrared". When the setting is "infrared", focus at zooming works correctly with infrared light in B&W mode. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Saving Image Settings for Auto Pan and Auto Trace
Format /api/param?canera.motion.auto_pan.image=save
/api/param?canera.motion.auto_trace.image=save
Example of response canera.motion.auto_pan.image&200 OK
canera.motion.auto_trace.image&200 OK
Interpretation Save current image settings for Auto Pan and Auto Trace. Common image settings are used for both of Auto Pan and Auto Trace. Saved settings are iris, BLC and white balance. Saved settings are applied during Auto Pan and Auto Trace.
Allowed users admin, operator
28
Note of Iris Setting: After power on, iris setting of Home position is applied. After moving to preset position, iris setting of the position is applied. During Auto Pan and Auto Trace, iris setting for Auto Pan and Auto Trace is applied. When iris setting is changed by API, the change is temporal. To save current iris setting for preset position, use camera(num).status=save. To save current iris setting for Auto Pan and Auto Trace, use camera.motion.auto_pan.image=save.
Getting Iris from
Format /api/param?camera.iris
Example of response camera.iris=autoM&200 OK
Interpretation Acquire iris setting. When iris is manual, value from 0 to 100 is returned. When iris is auto,"autoL", "autoM" or "autoH" is returned. 100 means full open.
Allowed users admin, operator, user
Setting Iris for
Format /api/param?camera.iris=data
Example to set fixed value /api/param?camera.iris=50
Example to set auto /api/param?camera.iris=autoM
Example to change from auto to maual /api/param?camera.iris=manual
Example of response camera.iris&202 Accepted(camera(num).status=save or
camera.motion.auto_pan.image=save)
Interpretation Change iris setting. Specify 0 to 100 to set fixed value. 100 means full open. Specify "autoL", "autoM" or "autoH" to set auto. Specify "manual" to change from auto to manual. Current manual value is saved to preset position by the API, camera(num).status=save. Current manual value is saved to Auto Pan and Auto Trace by the API, camera.motion.auto_pan.image=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Setting Iris Direction for
Format /api/param?camera.iris.mode=data
Example to open /api/param?camera.iris.mode=open
Example of response camera.iris.mode&200 OK
Interpretation Change direction setting fo iris. Specify "open" or "close".
Allowed users admin, operator
Operating Iris for
Format /api/param?camera.iris.status=data
Example to start /api/param?camera.iris.status=start
29
Example of response camera.iris.status&200 OK
Interpretation Start or stop iris operation. Specify "start" or "stop".
Allowed users admin, operator
Note of White Balance Setting: After power on, White Balance setting of Home position is applied. After moving to preset position, White Balance setting of the position is applied. During Auto Pan and Auto Trace, White Balance setting for Auto Pan and Auto Trace is applied. When White Balance setting is changed by API, the change is temporal. To save current White Balance setting for preset position, use camera(num).status=save. To save current White Balance setting for Auto Pan and Auto Trace, use camera.motion.auto_pan.image=save.
Getting White Balance from
Format /api/param?camera.image.white_balance
Example of response camera.image.white_balance=autoW&200 OK
Interpretation Acquire white balance setting. "autoW", "autoN" or "manual" is returned.
Allowed users admin, operator, user
Setting White Balance for
Format /api/param?camera.image.white_balance=data
Example /api/param?camera.image.white_balance=autoW
Example of response camera.image.white_balance&202 Accepted(camera.status=save or
camera.motion.auto_pan.image=save)
Interpretation Change white balance setting. Specify "autoW", "autoN", "autoFull", "sodium", "manual" or "op_auto". In
Allowed users admin, operator
Getting
Format /api/param?camera.image.white_balance.r
Example of response camera.image.white_balance.r=s85&200 OK
Interpretation Acquire
Allowed users admin, operator, user
30
Setting
Format /api/param?camera.image.white_balance.r=data
Example of response
camera.image.white_balance.r&202 Accepted(camera.status=save or camera.motion.auto_pan.image=save)
Interpretation Change
Allowed users admin, operator
Getting
Format /api/param?camera.image.white_balance.b
Example of response camera.image.white_balance.b=s219&200 OK
Interpretation Acquire
Allowed users admin, operator, user
Setting
Format /api/param?camera.image.white_balance.b=data
Example of response
camera.image.white_balance.b&202 Accepted(camera.status=save)
Interpretation Change
Allowed users admin, operator
Getting Current
Format /api/param?camera.image.autowhite_balance.r
Example of response camera.image.autowhite_balance.r=s85&200 OK
Interpretation Acquire current
"step".
Allowed users admin, operator, user
Getting Current
Format /api/param?camera.image.autowhite_balance.b
31
Example of response camera.image.autowhite_balance.b=s219&200 OK
Interpretation Acquire current
"step".
Allowed users admin, operator, user
Note of Back Light Compensation Setting: After power on, Back Light Compensation setting of Home position is applied. After moving to preset position, Back Light Compensation setting of the position is applied. During Auto Pan and Auto Trace, Back Light Compensation setting for Auto Pan and Auto Trace is applied. When Back Light Compensation setting is changed by API, the change is temporal. To save current Back Light Compensation setting for preset position, use camera(num).status=save. To save current Back Light Compensation setting for Auto Pan and Auto Trace, use camera.motion.auto_pan.image=save.
Getting Back Light Compensation from
Format /api/param?camera.image.blc
Example of response camera.image.blc=off&200 OK
Interpretation Acquire Back Light Compensation setting. "off", "a", "b", "c" or "d" is returned. Refer the instruction manual for detailed information of "a", "b", "c" and "d".
Allowed users admin, operator, user
Setting Back Light Compensation for
Format /api/param?camera.image.blc=data
Format of setting ON /api/param?camera.image.blc=a
Example of response camera.image.blc&202 Accepted(camera.status=save)
Interpretation Change Back Light Compensation setting. Specify "off", "a", "b", "c" or "d". Refer the instruction manual for detailed information of "a", "b", "c" and "d". The change is saved to preset position by the API, camera(num).status=save. The change is saved to Auto Pan and Auto Trace by the API, camera.motion.auto_pan.image=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
6.3. Encoding
These APIs are related to JPEG or
Saving Changes of Encode Settings for
32
Format /api/param?encode(1).status=save
or /api/param?encode(2).status=save
Example of response encode(1).status&200 OK
Interpretation Save changes to encode settings. All JPEG and
are restored by power off of
Allowed users admin, operator
Getting JPEG Frame Size from
Format /api/param?encode(1).framesize
Example of response encode(1).framesize=vga&200 OK
Interpretation Acquire JPEG frame size setting. "vga" or "qvga" is returned.
Allowed users admin, operator, user
Setting JPEG Frame Size for
Format /api/param?encode(1).framesize=data
Example /api/param?encode(1).framesize=qvga
Example of response encode(1).framesize&202 Accepted(encode(1).status=save)
Interpretation Change JPEG frame size. Specify "vga" or "qvga". File size setting is changed automatically when frame size is changed. If frame size is changed from vga to qvga, file size is changed to third part of original size. If frame size is changed from qvga to vga, file size is changed to three times size.
When frame size of JPEG and
The change is saved by the API, encode(1).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting JPEG Rate Control Setting from
Format /api/param?encode(1).cbr_mode
Example of response encode(1).cbr_mode=afs&200 OK
Interpretation Acquire the rate control setting of JPEG. Quantization table is fixed in the case of vfs (VariableFileSize). In the case of afs (AverageFileSize), bit rates are controlled such that the average size of multiple files remains constant.
Allowed users admin, operator, user
Setting JPEG Rate Control for
Format /api/param?encode(1).cbr_mode=data
Example /api/param?encode(1).cbr_mode=vfs
33
Example of response encode(1).cbr_mode&202 Accepted(encode(1).status=save)
Interpretation Change rate control of JPEG. Rate control can be set to vfs or afs. In vfs (VariableFileSize), quantization table is fixed. In afs (AverageFileSize), average file size of multiple JPEGs is controlled to be constant. The change is saved by the API, encode(1).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting JPEG File Size Setting from
Format /api/param?encode(1).quality
Example of response encode(1).quality=40k&200 OK
Interpretation Acquire the file size setting of JPEG. If the response is 40k for example, the setting is 40KB.
Allowed users admin, operator, user
Setting JPEG File Size Setting for
Format /api/param?encode(1).quality=Data
Example /api/param?encode(1).quality=30k
Example of response encode(1).quality&202 Accepted(encode(1).status=save)
Interpretation Change the file size setting of JPEG. The unit of set values is in KB.
When frame size is VGA, setting between the range of 10k to 100k is possible. When frame size is QVGA, setting between the range of 3k to 33k is possible.
When VFS (VariableFileSize) is specified for rate control at the WEB setting page, 7 levels will be available for selection. Each of these choices corresponds to the file sizes as follows.
When rate control is set to vfs and a file size that is not stated above is specified, the closest choice will be displayed on the WEB setting page. The change is saved by the API, encode(1).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting
Format /api/param?encode(2).framesize
34
Example of response encode(2).framesize=vga&200 OK
Interpretation Acquire
Allowed users admin, operator, user
Setting
Format /api/param?encode(2).framesize=data
Example /api/param?encode(2).framesize=qvga
Example of response encode(2).framesize&202 Accepted(encode(1).status=save)
Interpretation Change
When frame size of JPEG and
The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting
Format /api/param?encode(2).bitrate
Example of response encode(2).bitrate=8000000&200 OK
Interpretation Acquire the bitrate setting of
Allowed users admin, operator, user
Setting
Format /api/param?encode(2).bitrate=Data
Example /api/param?encode(2).bitrate=2000000
Example of response encode(2).bitrate&202 Accepted(encode(2).status=save)
Interpretation Change the bitrate setting of
The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting
Format /api/param?encode(2).cbr_mode
Example of response encode(2).cbr_mode=cbr&200 OK
Interpretation Acquire the rate control setting of
Allowed users admin, operator, user
Setting
35
Format /api/param?encode(2).cbr_mode=data
Example /api/param?encode(2).cbr_mode=vbr
Example of response encode(2).cbr_mode&202 Accepted(encode(2).status=save)
Interpretation Change rate control of
The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting
Format /api/param?encode(2).framerate
Example of response encode(2).framerate=15&200 OK
Interpretation Acquire frame rate of
Allowed users admin, operator, user
Setting
Format /api/param?encode(2).framerate=data
Example /api/param?encode(2).framerate=30
Example of response encode(2).framerate&202 Accepted(encode(2).status=save)
Interpretation Change frame rate of
The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting
Format /api/param?encode(2).iframeinterval
Example of response encode(2).iframeinterval=30&200 OK
Interpretation Acquire
Allowed users admin, operator, user
Setting
Format /api/param?encode(2).iframeinterval=data
Example /api/param?encode(2).iframeinterval=30
Example of response encode(2).iframeinterval&202 Accepted(encode(2).status=save)
Interpretation Change
36
210 or 240, real frame rate is as frame rate setting. If
The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting
Format /api/param?encode(2).priority
Example of response encode(2).priority=motion&200 OK
Interpretation Acquire priority of
Allowed users admin, operator, user
Setting
Format /api/param?encode(2).priority=data
Example /api/param?encode(2).priority=motion
Example of response encode(2).priority&202 Accepted(encode(2).status=save)
Interpretation Change priority of
The change is saved by the API, encode(2).status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
6.4. Alarm Setting
The APIs below are related to alarm setting. These are equivalent to the features on the Alarm page of the WEB setting page. Refer to the instruction manual for details on the Alarm page.
Getting On/Off of Alarm Action from
Format /api/param?application.event(Number).status
Example When Getting the on/off status of alarm action No. 1
/api/param?application.event(1).status
Example of response application.event(1).status=on&200 OK
Interpretation Acquire the on/off status of the alarm action for the specified alarm action number. 5 alarm actions and 1 periodic FTP assigned to No.6 are available, so alarm action number can be 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. Either on or off is returned.
Allowed users admin, operator
37
Setting On/Off of Alarm Action, or Enabling Changes to Alarm Action for
Format /api/param?application.event(Number).status=data
Example When setting alarm action No. 1 to off
/api/param?application.event(1).status=off
Example of response application.event(1).status&200 OK
Interpretation Set the alarm action of the specified alarm action number to on/off, or enable changes to the alarm action. 5 alarm actions and 1 periodic FTP assigned to No.6 are available, so alarm action number can be 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. Either on or off will be returned.
Specify "on", "off" or "restart". By "restart", changes to alarm action and alarm trigger are enabled. By "on" after "restart", the alarm action starts working with the changed settings. If "restart" is not set after changes to alarm action and alarm trigger, APIs to get settings of alarm action and alarm trigger return previous values.
Allowed users admin, operator
Getting Alarm Action from
Format /api/param?application.event(Number).action
Example When Getting action of alarm action No. 1
/api/param?application.event(1).action
Example of Response
application.event(1).action=mailto/somebody@somecompany.com/none/Message&200 OK
Interpretation Acquire the alarm action of the specified alarm action number. 5 alarm actions and 1 periodic FTP assigned to No.6 are available, so alarm action number can be 1 to 6. Note that alarm numbers are different from the alarm input pin numbers. A separate API (/api/param?application.event(Number).status) is used to acquire the on/off status of the alarm action.
When no action is specified, response below is returned.
Example of Response application.event(1).action=&200 OK
When sending mail is specified, mailto, mail address, JPEG attaching and the character string to be sent will be returned. When spaces are included in the character string, the character string with spaces will be returned. Segments are indicated by /. If JPEG attaching is on, "object01" is returned, and if JPEG attaching is off, "none" is returned.
Example of Response
application.event(1).action=mailto/somebody@somecompany.com/object01/Message&2
00 OK
When "PrePostRecording + FTP" is specified, recftp, FTP number, and the attached object number will be returned. Segments are indicated by /. The FTP number is fixed as ftp01 at all times. The object number is fixed as object01.
38
Parameters of FTP can be gotten by other APIs, application.ftp and application.object.
Example of Response application.event(1).action=recftp/ftp01/object01&200 OK
When sending via TCP is specified, tcpto, IP address, port number and the character string to be sent will be returned. Segments are indicated by /.
Example of Response
application.event(1).action=tcpto/10.0.0.100/20000/Message&200 OK
When sending via UDP is specified, udpto, IP address, port number and the character string to be sent will be returned. Segments are indicated by /.
Example of Response
application.event(1).action=udpto/10.0.0.100/20000/Message&200 OK
When alarm output is specified, pinout, distinction between make/break (m1 or b1) and output time (millisecond) will be returned. Segments are indicated by /.
Example of Response application.event(1).action=pinout/m1/1500&200 OK
When preset position is specified, position number will be returned.
Example of Response when position number is 2
application.event(1).action=camera.position(2).status/goto&200 OK
When B&W mode is specified, true_daynight/bw, true_daynight/color, true_daynight/autoH, true_daynight/autoM or
true_daynight/autoL will be returned.
Example of Response when B&W mode is bw
application.event(1).action=camera.image.true_daynight/bw&200 OK
Alarm action of event number 6 is periodic FTP. Response to the API has ftpto, FTP number, and the attached object number. Segments are indicated by /. The FTP number is fixed as ftp01 at all times. The object number is fixed as object01. Parameters of FTP can be gotten by another API, application.ftp.
Example of Response application.event(6).action=ftpto/ftp01/object01&200 OK
Allowed users admin, operator
Setting Alarm Action for
Format /api/param?application.event(Number).action=Data
Example When setting action of Alarm No. 1
39
/api/param?application.event(1).action=mailto/somebody@somecompany.com/none/Me
ssage
Example of Response
application.event(1).action&202 Accepted(application.event(1).status=restart)
Interpretation Set the alarm action of the specified alarm number. Up to 5 alarm actions can be specified, and therefore the number of alarm(number) can also be set between the range of 1 to 5. Note that alarm numbers are different from the alarm input pin numbers. A separate API (/api/param?application.event(Number).status=off) is used to set the alarm action to off.
The action will be activated by setting the alarm trigger. The API for setting the alarm trigger is /api/param?application.event(Number).trigger.
The changes to settings of alarm action become valid by /api/param?application.event(Number).status=restart.
Specify mailto, mail address, JPEG attach and the character string to be sent when sending via mail. Segments are indicated by /. The maximum number of characters for the mail address is 95. To attach JPEG, specify object01. If none is specified instead of object01, JPEG is not attached to the mail. Number of the character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.
space & / < > # % " { } | \ ^ [ ] `
For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.", specify as "This%20is%20alarm.". %09 and %0D are not available.
Setting Example
/api/param?application.event(1).action=mailto/somebody@somecompany.com/object0
1/Alarm%20ON
The character string "Alarm from
Specify recftp, FTP number and the object for PrePostRecording+FTP. The FTP number is fixed as ftp01 at all times. The object is fixed as object01. Parameters of FTP can be set by other APIs, application.ftp and application.object. Ensure to set the FTP server (/api/param?application.ftp.host, /api/param?application.object.framerate etc.) before setting PrePostRecording+FTP.
Setting Example /api/param?application.event(1).action=ftpto/ftp01/object01
Specify tcpto, IP address, port number and the character string to be sent when sending via TCP. Segments are indicated by /. The number of character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.
space & / < > # % " { } | \ ^ [ ] `
For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.", specify as "This%20is%20alarm.". %09 and %0D are not available.
40
Setting Example
/api/param?application.event(1).action=tcpto/10.0.0.100/20000/Message
Specify udpto, IP address, port number and the character string to be sent when sending via UDP. Segments are indicated by /. The number of character string is from 1 to 127 bytes. To use following characters, specify by hexadecimal number after %.
space & / < > # % " { } | \ ^ [ ] `
For example, specify 3 characters %20 when inserting a space in the character string. For example, to send the character string "This is alarm.", specify as "This%20is%20alarm.". %09 and %0D are not available.
Setting Example
/api/param?application.event(1).action=udpto/10.0.0.100/20000/Message
Specify pinout, distinction between make/break (m1 or b1) and the time (millisecond) when alarm output is specified. Segments are indicated by /. The time is 0 or from 100 to 5000. When the time is 0, alarm output does not come back to previous state.
Setting Example /api/param?application.event(1).action=pinout/m1/1500
Specify preset position number when preset position is specified.
Setting Example
/api/param?application.event(1).action=camera.position(2).status/goto
Specify true_daynight/bw, true_daynight/color, true_daynight/autoH, true_daynight/autoM or true_daynight/autoL
when B&W mode is specified.
Setting Example
/api/param?application.event(1).action=camera.image.true_daynight/bw
Alarm action of event number 6 is periodic FTP. Event 1 to 5 can not be set to periodic FTP. Parameters of FTP can be set by another API, application.ftp.
Allowed users admin, operator
Getting Alarm Filter Setting from
Format /api/param?application.event(Number).filter(WeekOfDay).status
Example When Getting Setting of Sunday filter of Alarm No. 1
/api/param?application.event(1).filter(sunday).status
Example of Response application.event(1).filter(sunday).status=off&200 OK
41
Interpretation Acquire filter setting of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. When the filter is enabled, on will be returned. When the filter is disabled, off will be returned.
Allowed users admin, operator
Setting Alarm Filter for
Format /api/param?application.event(Number).filter(WeekOfDay).status=data
Example When setting Sunday filter of Alarm No. 1
/api/param?application.event(1).filter(sunday).status=on
Example of Response
application.event(1).filter(sunday).status&202 Accepted(application.event(1).status=restart)
Interpretation Set filter setting of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. Specify on to enable the filter, off to disable the filter.
The changes to filter of alarm action is saved by /api/param?application.event(Number).status=restart.
Allowed users admin, operator
Getting Alarm Filter Time from
Format /api/param?application.event(Number).filter(WeekOfDay).time
Example When Getting Time of Sunday filter of Alarm No. 1
/api/param?application.event(1).filter(sunday).time
Example of Response
Interpretation Acquire filter time of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. Start time and end time is returned in the format like
Allowed users admin, operator
Setting Alarm Filter Time for
42
Format /api/param?application.event(Number).filter(WeekOfDay).time=data
Example When setting Sunday filter time of Alarm No. 1
Example of Response
application.event(1).filter(sunday).time&202 Accepted(application.event(1).status=restart)
Interpretation Set filter time of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay.
Specify start time and end time in the format like
The changes to filter of alarm action is saved by /api/param?application.event(Number).status=restart.
Allowed users admin, operator
Getting Alarm Filter Type from
Format /api/param?application.event(Number).filter(WeekOfDay).type
Example When Getting Type of Sunday filter of Alarm No. 1
/api/param?application.event(1).filter(sunday).type
Example of Response application.event(1).filter(sunday).type=mask&200 OK
Interpretation Acquire filter type of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay. "mask" or "unmask" is returned. When the setting is mask, alarm action is disabled during the filter time. When the setting is unmask, alarm action is enabled during the filter time.
Allowed users admin, operator
Setting Alarm Filter Type for
Format /api/param?application.event(Number).filter(WeekOfDay).type=data
Example When setting Sunday filter type of Alarm No. 1 to be unmask
/api/param?application.event(1).filter(sunday).type=unmask
Example of Response
application.event(1).filter(sunday).type&202 Accepted(application.event(1).status=restart)
Interpretation Set filter type of the alarm action for the specified alarm number. Up to 5 alarm actions can be
43
specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
Specify sunday, monday, tuesday, wednesday, thursday, friday or saturday for WeekOfDay.
Specify mask or unmask. When the setting is mask, alarm action is disabled during the filter time. When the setting is unmask, alarm action is enabled during the filter time.
The changes to filter of alarm action is saved by /api/param?application.event(Number).status=restart.
Allowed users admin, operator
Getting Alarm Trigger from
Format /api/param?application.event(Number).trigger
Example When Getting Trigger of Alarm No. 1
/api/param?application.event(1).trigger
Example of Response application.event(1).trigger=m1&200 OK
Interpretation Acquire Trigger of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
When only 1 Trigger is set:
m1 will be returned in the case of make for alarm input 1. b1 will be returned in the case of break for alarm input 1. m2 will be returned in the case of make for alarm input 2. b2 will be returned in the case of break for alarm input 2. v1 will be returned for motion detection of video.
ncbws will be returned for IR filter OFF. ncbwe will be returned for IR filter ON. efans will be returned for fan stop.
camera.position(num).status will be returned for preset position. "num" is from 0 to 99.
Example of Response application.event(1).trigger=v1&200 OK
When a combination of 2 Triggers are set, responses such as m1(10)b2 will be returned. The example indicates that trigger will be activated when break is invoked at alarm input 2 within 10 seconds after make is invoked at alarm input 1.
Example of Response application.event(1).trigger=m1(100)b2&200 OK
Allowed users admin, operator
Setting Alarm Trigger for
44
Format /api/param?application.event(Number).trigger=data
Example When setting Trigger of Alarm No. 1
/api/param?application.event(1).trigger=m1
Example of Response
application.event(1).trigger&202 Accepted(application.event(1).status=restart)
Interpretation Set Trigger of the alarm action for the specified alarm number. Up to 5 alarm actions can be specified, and periodic FTP is assigned to event No.6, therefore the number of alarm(number) can be set between the range of 1 to 6. Note that alarm numbers are different from the alarm input pin numbers.
The changes to settings of alarm action become valid by /api/param?application.event(Number).status=restart. When setting only 1 Trigger:
specify m1 in the case of Make for alarm input 1. specify b1 in the case of Break for alarm input 1. specify m2 in the case of Make for alarm input 2. specify b2 in the case of Break for alarm input 2. specify v1 for motion detection of video. specify ncbws for IR Filter OFF.
specify ncbwe for IR Filter ON. specify efans for fan stop.
specify camera.position(num).status for preset position. "num" is from 0 to 99.
Setting Example /api/param?application.event(1).trigger=v1
Interval can be set to periodic ftp assigned to event(6). Set "i1500" for interval 1500 seconds.
Setting Example /api/param?application.event(6).trigger=i1500
When setting Trigger upon combining 2 alarm inputs, specify as m1(50)b2. The example above indicates that trigger will be activated when break is invoked at alarm input 2 within 50 seconds after make is invoked at alarm input 1. Additionally, combination is only allowed for alarm inputs and not motion detect. And same alarm can not be combined. For example, m1(50)m1 is not available.
Setting Example /api/param?application.event(1).trigger=m1(100)b2
Allowed users admin, operator
6.5. Alarm Environment Setting
The APIs below are related to alarm environment setting. These are equivalent to the features on the Alarm Environment page of the WEB setting page. Refer to the instruction manual for details on the Alarm Environment page.
Getting SMTP Server Address Setting from
Format /api/param?application.smtp.host
45
Example of Response application.smtp.host=192.168.0.200&200 OK
Response example when setting field is left blank application.smtp.host=&200 OK
Interpretation Acquire the address setting of the SMTP server.
Allowed users admin, operator, user
Setting SMTP Server Address for
Format /api/param?application.smtp.host=data
Example /api/param?application.smtp.host=192.168.0.200
Example of Response application.smtp.host&200 OK
Interpretation Change the address setting of the SMTP server. Specify the IP address or FQDN. The maximum FQDN size is 63 bytes. Specify as 0.0.0.0 when the SMTP server is not set. It is also possible to leave the setting field blank as follows. /api/param?application.smtp.host=%00
Allowed users admin, operator
Getting SMTP Server Port Number Setting from
Format /api/param?application.smtp.port
Example of Response application.smtp.port=25&200 OK
Interpretation Acquire the port number setting of the SMTP server.
Allowed users admin, operator, user
Setting SMTP Server Port Number for
Format /api/param?application.smtp.port=data
Example /api/param?application.smtp.port=25
Example of Response application.smtp.port&200 OK
Interpretation Change the port number setting of the SMTP server.
Allowed users admin, operator
Getting Sender Mail Address Setting from
Format /api/param?application.smtp.mailfrom
Example of Response application.smtp.mailfrom=somebody@somecompany.com&200 OK
Interpretation Acquire sender mail address setting. POP user name is used as local part of sender mail address when sender mail address setting is blank. When POP user name is also blank, the
Allowed users admin, operator, user
46
Setting Sender Mail Address for
Format /api/param?application.smtp.mailfrom=data
Example /api/param?application.smtp.mailfrom=somebody@somecompany.com
Example of Response application.smtp.mailfrom&200 OK
Interpretation Change sender mail address setting. Maximum text number of sender mail address is 96. Alphanumeric and followings are available.
! # $ % & ' * +
POP user name is used as local part of sender mail address when sender mail address setting is blank. When POP user name is also blank, the
Allowed users admin, operator
Getting "POP before SMTP" Setting from
Format /api/param?application.smtp.type
Example of Response application.smtp.type=pbs&200 OK
Interpretation Acquire the "POP before SMTP" setting. "simple" is returned when this is set to off. "pbs" is returned when this is set to on.
Allowed users admin, operator, user
Setting "POP before SMTP" for
Format /api/param?application.smtp.type=data
Example /api/param?application.smtp.type=pbs
Example of Response application.event.smtp.type&200 OK
Interpretation Change the "POP before SMTP" setting. Specify as "simple" when setting to off and "pbs" when
setting to on.
Allowed users admin, operator
Getting POP Server Address Setting from
Format /api/param?application.pop.host
Example of Response application.pop.host=192.168.0.200&200 OK
Response example when setting field is left blank application.pop.host=&200 OK
Interpretation Acquire the address setting of the POP server.
Allowed users admin, operator, user
Setting POP Server Address for
Format /api/param?application.pop.host=data
47
Example /api/param?application.pop.host=192.168.0.200
Example of Response application.pop.host&200 OK
Interpretation Change the address setting of the POP server. Specify the IP address or FQDN. The maximum FQDN size is 63 bytes. Specify as 0.0.0.0 when the POP server is not set. It is also possible to leave the setting field blank as follows. /api/param?application.pop.host=%00
Allowed users admin, operator
Getting POP Server Port Number Setting from
Format /api/param?application.pop.port
Example of Response application.pop.port=110&200 OK
Interpretation Acquire the port number setting of the POP server.
Allowed users admin, operator, user
Setting POP Server Port Number for
Format /api/param?application.pop.port=data
Example /api/param?application.pop.port=110
Example of Response application.pop.port&200 OK
Interpretation Change the port number setting of the POP server.
Allowed users admin, operator
Getting POP Server User Name Setting from
Format /api/param?application.pop.user
Example of Response application.pop.user=somename&200 OK
Response example when setting field is left blank application.pop.user=&200 OK
Interpretation Acquire the user name setting of the POP server. The user name is used as local part of sender mail address when sender mail address setting is blank. When the user name is blank, the
Example of Response application.pop.user=somename&200 OK
Example of Mail Address somename@somecompany.com
Allowed users admin, operator, user
Setting POP Server User Name for
Format /api/param?application.pop.user=data
Example /api/param?application.pop.user=somename
Example of Response application.pop.user&200 OK
Interpretation Change the user name setting of the POP server. The maximum user name size is 64 bytes. Set as follows when this is to be left blank.
48
/api/param?application.pop.user=%00
The user name is used as local part of sender mail address when sender mail address setting is blank. When the user name is blank, the
Example of setting /api/param?application.pop.user=somename
Example of Mail Address somename@somecompany.com
Following characters must not be used in user name.
space ( ) < > [ ] : ; ?? ,(comma)
Allowed users admin, operator
Setting POP Server Password for
Format /api/param?application.pop.password=data
Example /api/param?application.pop.password=someword
Example of Response application.pop.password&200 OK
Interpretation Change the password setting of the POP server. The maximum password size is 32 bytes. Set as follows when this is to be left blank. /api/param?application.pop.password=%00
Allowed users admin, operator
(Note: There is no API for reading passwords.)
Getting FTP Server Address Setting from
Format /api/param?application.ftp.host
Example of Response application.ftp.host=192.168.0.200&200 OK
Response example when setting field is left blank application.ftp.host=&200 OK
Interpretation Acquire the FTP server address setting used for FTP transmission via alarm.
Allowed users admin, operator, user
Setting FTP Server Address for
Format /api/param?application.ftp.host=data
Example /api/param?application.ftp.host=10.0.0.200
Example of Response application.ftp.host&200 OK
Interpretation Change the FTP server address setting used for FTP transmission via alarm. Specify the IP address or FQDN. The maximum FQDN size is 63 bytes. Specify as 0.0.0.0 when the FTP server is not set. It is also possible to leave the setting field blank as follows. /api/param?application.ftp.path=%00
Allowed users admin, operator
Getting FTP Server Path Setting from
49
Format /api/param?application.ftp.path
Example of Response application.ftp.path=subdir1&200 OK
Response example when setting field is left blank application.ftp.path=&200 OK
Interpretation Acquire the FTP server directory setting used for FTP transmission via alarm.
Allowed users admin, operator, user
Setting FTP Server Path for
Format /api/param?application.ftp.path=data
Example /api/param?application.ftp.path=subdir1
Example of Response application.ftp.path&200 OK
Interpretation Change the FTP server directory setting used for FTP transmission. It is possible to set FTP transmission to a directory under the FTP server home directory by specifying that directory name. Use %2F to segment the directory. ("2F" is ASCII code of "/".) The maximum directory name size is 63 bytes.
Example /api/param?application.ftp.path=subdir1%2Fsubdir2
By leaving the setting blank as follows, FTP transmission will be set to the FTP server home directory.
/api/param?application.ftp.path=%00
Allowed users admin, operator
Getting FTP Server User Name Setting from
Format /api/param?application.ftp.user
Example of Response application.ftp.user=somename&200 OK
Response example when setting field is left blank application.ftp.user=&200 OK
Interpretation Acquire the FTP server user name setting used for FTP transmission via alarm.
Allowed users admin, operator
Setting FTP Server User Name for
Format /api/param?application.ftp.user=data
Example /api/param?application.ftp.user=somename
Example of Response application.ftp.user&200 OK
Interpretation Change the FTP server user name setting used for FTP transmission via alarm. The maximum user name size is 32 bytes. Set as follows when this setting is to be left blank.
/api/param?application.ftp.user=%00
Allowed users admin, operator
Setting FTP Server Password for
Format /api/param?application.ftp.password=data
50
Example /api/param?application.ftp.password=someword
Example of Response application.ftp.password&200 OK
Interpretation Change the FTP server password setting used for FTP transmission via alarm. The maximum password size is 32 bytes. Set as follows when this setting is to be left blank.
/api/param?application.ftp.password=%00
Allowed users admin, operator
(There is no API for Getting passwords.)
Getting File Naming of Periodic FTP from
Format /api/param?application.ftp.naming
Example of Response application.ftp.naming=default&200 OK
Interpretation Acquire file naming of periodic FTP. "default", "type1" or "type2" is returned. When default is set, the file name is as
Example
When type1 is set, the file name is as ***YYYMMDDHHMMSSNNN.jpg. "***" can be gotten by another API, /api/param?application.ftp.naming_option.
File Name Example Camera_20060207201315001.jpg
When type2 is set, the file name is as ***.jpg. "***" can be gotten by another API, /api/param?application.ftp.naming_option.
File Name Example Camera.jpg
Allowed users admin, operator
Setting File Naming of Periodic FTP for
Format /api/param?application.ftp.naming=data
Example /api/param?application.ftp.naming=type1
Example of Response application.ftp.naming&200 OK
Interpretation Change file naming of periodic FTP. Specify "default", "type1" or "type2". When default is set, the file name is as
Example
When type1 is set, the file name is as ***YYYYMMDDHHMMSSNNN.jpg. "***" can be set by another API, /api/param?application.ftp.naming_option.
File Name Example Camera_20060207201315001.jpg
When type2 is set, the file name is as ***.jpg. "***" can be set by another API, /api/param?application.ftp.naming_option.
File Name Example Camera.jpg
Allowed users admin, operator
51
Getting User Define Name of File Naming from
Format /api/param?application.ftp.naming_option
Example of Response application.ftp.naming_option=abc&200 OK
Interpretation Acquire user define name for file naming of periodic FTP. The maximum size is 16 bytes. When /api/param?application.ftp.naming_option is set to "type1", the file name is as ***YYYMMDDHHMMSSNNN.jpg,
and "***" can be gotten by this API.
File Name Example Camera_20060207201315001.jpg
When /api/param?application.ftp.naming_option is set to "type2", the file name is as ***.jpg and "***" can be gotten
by this API.
File Name Example Camera.jpg
Allowed users admin, operator
Setting User Define Name of File Naming for
Format /api/param?application.ftp.naming_option=data
Example of Response application.ftp.naming_option&200 OK
Interpretation Change user define name for file naming of periodic FTP. The maximum size is 16 bytes. When /api/param?application.ftp.naming_option is set to "type1", the file name is as ***YYYMMDDHHMMSSNNN.jpg,
and "***" can be set by this API.
File Name Example Camera_20060207201315001.jpg
When /api/param?application.ftp.naming_option is set to "type2", the file name is as ***.jpg and "***" can be set by
this API.
File Name Example Camera.jpg
Allowed users admin, operator
Getting Parameters of Pre/Post Recording from
Format
To get Frame Rate /api/param?application.object.framerate
To get Pre Duration /api/param?application.object.prerec
To get Post Duration /api/param?application.object.postrec
Example of Response
For Frame Rate application.object.framerate=10&200 OK
For Pre Duration /api/param?application.object.prerec=2&200 OK
For Post Duration /api/param?application.object.postrec=2&200 OK
Interpretation Acquire parameters for PrePost + ftp. These parameters are used when recftp is set as an alarm action.
Allowed users admin, operator, user
52
Setting Parameters of Pre/Post Recording for
Format
To set Frame Rate /api/param?application.object.framerate=5
To set Pre Duration /api/param?application.object.prerec=3
To set Post Duration /api/param?application.object.postrec=3
Example of Response
For Frame Rate application.object.framerate&200 OK
For Pre Duration /api/param?application.object.prerec&200 OK
For Post Duration /api/param?application.object.postrec&200 OK
Interpretation Change parameters for PrePost + ftp. These parameters are used when recftp is set as an alarm action. Specify 30, 15, 10, 7.5, 6, 5, 3, 2, or 1 for frame rate. Maximum Pre/Post duration is 60 seconds. Setting zero to Pre and Post duration is invalid.
Allowed users admin, operator
Getting Alarm Output Time Setting from
Format /api/param?peripheral.output_pin.pin(Number).duration
Example /api/param?peripheral.output_pin.pin(1).duration
Example of Response peripheral.output_pin.pin(1).duration=500&200 OK
Interpretation Acquire the current alarm output duration in millisecond. Specify 1 or 2 to Number. When returned value is 0, it means infinite output.
Allowed users admin, operator, user
Setting Alarm Output Time for
Format /api/param?peripheral.input_pin.pin(Number).duration=data
Example /api/param?peripheral.input_pin.pin(1).duration=50
Example of response peripheral.input_pin.pin(1).duration&200 OK
Interpretation Change the alarm output duration in millisecond. Specify 1 or 2 to Number. Specify 0, or 100 to 5000 for the duration. When 0 is set, output duration becomes infinite.
Allowed users admin, operator
Getting Alarm Output Status from
Format /api/param?peripheral.output_pin.pin(Number).status
Example of Response peripheral.output_pin.pin(1).status=make&200 OK
Interpretation Acquire the current alarm output status. Specify 1 or 2 to Number. Either make or break will be
returned.
53
Allowed users admin, operator, user
Changing Alarm Output of
Format /api/param?peripheral.output_pin.pin(Number).status=data
Example /api/param?peripheral.output_pin.pin(1).status=break
Example of Response peripheral.output_pin.pin(1).status&200 OK
Interpretation Change the alarm output. Specify 1 or 2 to Number. Specify "make" or "break" to data.
When the alarm output time is zero, alarm output is changed as this API specifies. When the alarm output time is not zero, alarm output is changed as this API specifies, then alarm output is changed again after the alarm output time.
Allowed users admin, operator
6.6. PTZ
The APIs below are related to pan/tilt/zoom control. These are equivalent to the features on the PTZ page of the WEB setting page and PTZ Controller of
(1) Settings for PTZ Control
Getting Auto Return Mode from
Format /api/param?camera.motion.auto_return.mode
Example of response camera.motion.auto_return.mode=home&200 OK
Interpretation Acquire Auto Return mode. "home", "auto_pan", "auto_patrol(0)", "auto_patrol(1)", "auto_patrol(2)", "auto_trace", "auto_tracking(1)" or "auto_tracking(2)" will be returned. "auto_tracking(1)" means auto tracking, and "auto_tracking(2)" means Intelligent tracking.
Allowed users admin, operator, user
Setting Auto Return Mode for
Format /api/param?camera.motion.auto_return.mode=data
Example of Response camera.motion.auto_return.mode&202
Accepted(camera.status=save)
Interpretation Change Auto Return mode. Specify "home", "auto_pan", "auto_patrol(0)", "auto_patrol(1)", "auto_patrol(2)", "auto_trace", "auto_tracking(1)" or "auto_tracking(2)". "auto_tracking(1)" means auto tracking, and "auto_tracking(2)" means Intelligent tracking. In
Allowed users admin, operator
54
Getting Timeout of Auto Return from
Format /api/param?camera.motion.auto_return.timeout
Example of response camera.motion.auto_return.timeout=60&200 OK
Interpretation Acquire timeout of Auto Return in seconds.
Allowed users admin, operator, user
Setting Timeout of Auto Return for
Format /api/param?camera.motion.auto_return.timeout=data
Example of Response camera.motion.auto_return.timeout&202
Accepted(camera.status=save)
Interpretation Change timeout of Auto Return in seconds. Specify 60, 120, 180, 300, 600, 1200, 1800 or 3600. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Auto Return Status from
Format /api/param?camera.motion.auto_return.status
Example of response camera.motion.auto_return.status=on&200 OK
Interpretation Acquire status of Auto Return. "on" or "off" will be returned.
Allowed users admin, operator, user
Setting Auto Return Status for
Format /api/param?camera.motion.auto_return.status=data
Example of Response camera.motion.auto_return.status&202
Accepted(camera.status=save)
Interpretation Change status of Auto Return. Specify "on" or "off" to change the status. Specify "start" or "stop" for manual operation. "on" or "off" is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Current Operation Status of Auto Tracking from
Format /api/param?camera.motion.auto_tracking(1).status
/api/param?camera.motion.auto_tracking(2).status
Example of response camera.motion.auto_tracking(1).status=on&200 OK
Interpretation Acquire current operation status of Auto tracking or Intelligent tracking. "auto_tracking(1)" means auto tracking, and "auto_tracking(2)" means Intelligent tracking. "moving" or "stop" will be returned.
Allowed users admin, operator, user
55
Start/Stop of Auto Tracking for
Format /api/param?camera.motion.auto_tracking(1).status=data
/api/param?camera.motion.auto_tracking(2).status=data
Example of Response camera.motion.auto_tracking(1).status&200 OK
Interpretation Start or stop Auto tracking or Intelligent tracking. Specify "start" or "stop". When auto tracking is started, the camera moves to home position, then starts Auto Tracking. Motion detection is disabled during Auto Tracking. When Intelligent tracking is started, the camera waits for API that specifies target. By API for specifying target, the camera starts Intelligent tracking. In
Allowed users admin, operator
Specify target for Intelligent Tracking for
Example to specify position (10, 20)
Example to specify position (10, 20) and color (255, 0, 0)
Example of Response camera.motion.auto_tracking(2).target&200 OK
Interpretation Specify target of Intelligent tracking. In
Allowed users admin, operator
Getting Detection Level of Auto Tracking from
Format /api/param?camera.motion.auto_tracking(1).level
/api/param?camera.motion.auto_tracking(2).level
Example of response camera.motion.auto_tracking(1).level=50&200 OK
Interpretation Acquire detection level of Auto Tracking. Or acquire detection level of starting Intelligent tracking by Auto Return. Value from 0 to 100 will be returned. 100 is most sensitive. The level is 11 steps internally.
Allowed users admin, operator, user
Setting Detection Level of Auto Tracking for
Format /api/param?camera.motion.auto_tracking(1).level=data
/api/param?camera.motion.auto_tracking(2).level=data
56
Example of Response camera.motion.auto_tracking(1).level&202
Accepted(camera.status=save)
Interpretation Change detection level of Auto Tracking. Or change detection level of starting Intelligent tracking by Auto Return. Specify from 0 to 100. 100 is most sensitive. The level is 11 steps internally.The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Restart Time of Auto Tracking from
Format /api/param?camera.motion.auto_tracking(1).restarttime
/api/param?camera.motion.auto_tracking(2).restarttime
Example of response camera.motion.auto_tracking(1).restarttime=10&200 OK
Interpretation Acquire restart time of Auto Tracking or Intelligent tracking in seconds. In case of Auto tracking, if there is no motion, the camera goes to home position after the restart time, and restarts Auto Tracking. In case of Intelligent tracking, if the camera loses the target, the camera goes to home position after the restart time, and restarts Intelligent Tracking. "off", 10, 20, 30, 40, 50, 60 or 120 will be returned.
Allowed users admin, operator, user
Setting Restart Time of Auto Tracking for
Format /api/param?camera.motion.auto_tracking(1).restarttime=data
/api/param?camera.motion.auto_tracking(2).restarttime=data
Example of Response camera.motion.auto_tracking(1).restarttime&202
Accepted(camera.status=save)
Interpretation Change restart time of Auto Tracking or Intelligent tracking in seconds. Specify "off", 10, 20, 30, 40, 50, 60 or 120. In case of Auto tracking, if there is no motion, the camera goes to home position after the restart time, and restarts Auto Tracking. In case of Intelligent tracking, if the camera loses the target, the camera goes to home position after the restart time, and restarts Intelligent Tracking. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Detection Area of Intelligent Tracking from
Format /api/param?camera.motion.auto_tracking(2).area
Example of response
camera.motion.auto_tracking(2).area=FFFFFFFFFFFFFFFFFFFFFFFF&200 OK
Interpretation Acquire detection area of Intelligent Tracking when it is started by Auto Return. The meaning of value is same as motion detection area. In
Allowed users admin, operator, user
57
Setting Detection Area of Intelligent Tracking for
Format /api/param?camera.motion.auto_tracking(2).area=data
Example of Response camera.motion.auto_tracking(2).area&202
Accepted(camera.status=save)
Interpretation Change detection area of Intelligent Tracking when it is started by Auto Return. In
Allowed users admin, operator
Getting Tracking Zoom setting of Intelligent Tracking from
Format /api/param?camera.motion.auto_tracking(2).zoom
Example of response camera.motion.auto_tracking(2).zoom=on&200 OK
Interpretation Acquire tracking zoom setting of Intelligent Tracking. In
Allowed users admin, operator, user
Setting Tracking Zoom of Intelligent Tracking for
Format /api/param?camera.motion.auto_tracking(2).zoom=data
Example of Response camera.motion.auto_tracking(2).zoom&202
Accepted(camera.status=save)
Interpretation Change tracking zoom setting of Intelligent Tracking. In
Allowed users admin, operator
Getting Zoom Limit of Intelligent Tracking from
Format /api/param?camera.motion.auto_tracking(2).zoom_limit
Example of response camera.motion.auto_tracking(2).zoom_limit=10&200 OK
Interpretation Acquire zoom limit of Intelligent Tracking. In
Allowed users admin, operator, user
58
Setting Zoom Limit of Intelligent Tracking for
Format /api/param?camera.motion.auto_tracking(2).zoom_limit=data
Example of Response camera.motion.auto_tracking(2).zoom_limit&202
Accepted(camera.status=save)
Interpretation Change zoom limit of Intelligent Tracking. In
Allowed users admin, operator
Getting Maximum Zoom of Intelligent Tracking from
Format /api/param?camera.motion.auto_tracking(2).max_zoom
Example of response camera.motion.auto_tracking(2).max_zoom=21.37&200 OK
Interpretation Acquire maximum zoom of Intelligent Tracking. In
Allowed users admin, operator, user
Setting Maximum Zoom of Intelligent Tracking for
Format /api/param?camera.motion.auto_tracking(2).max_zoom=data
Example of Response camera.motion.auto_tracking(2).max_zoom&202
Accepted(camera.status=save)
Interpretation Change maximum zoom of Intelligent Tracking. In
Allowed users admin, operator
Getting Threshold of Intelligent Tracking from
Format /api/param?camera.motion.auto_tracking(2).threshold.hsv
/api/param?camera.motion.auto_tracking(2).threshold.yuv
Example of response
Interpretation Acquire threshold of Intelligent Tracking. 2 APIs for getting HSV threshold and YUV threshold are availble. In case of HSV, H is from 0 to 180, S/V is from 0 to 255. In case of RGB, R/G/B is from 0 to 255.
Allowed users admin, operator, user
Setting Threshold of Intelligent Tracking for
59
Example of Response camera.motion.auto_tracking(2).threshold.hsv&202
Accepted(camera.status=save)
Interpretation Change threshold of Intelligent Tracking. In
Allowed users admin, operator
Getting Dead Zone of Intelligent Tracking from
Format /api/param?camera.motion.auto_tracking(2).dead_zone
Example of response
Interpretation Acquire dead zone of Intelligent Tracking. In
Allowed users admin, operator, user
Setting Dead Zone of Intelligent Tracking for
Format /api/param?camera.motion.auto_tracking(2).dead_zone=data
Example of Response camera.motion.auto_tracking(2).dead_zone&202
Accepted(camera.status=save)
Interpretation Change dead zone of Intelligent Tracking. In
Allowed users admin, operator
Getting Upper Limit of EZoom from
Format /api/param?camera.motion.zoom.digitallimit
Example of response camera.motion.zoom.digitallimit=2&200 OK
Interpretation Acquire upper limit of EZoom. 1, 2, 4, 8, 16 or 32 will be returned.
Allowed users admin, operator, user
Setting Upper Limit of EZoom for
Format /api/param?camera.motion.zoom.digitallimit=data
Example of Response camera.motion.zoom.digitallimit&202
Accepted(camera.status=save)
60
Interpretation Change upper limit of EZoom. Specify 1, 2, 4, 8, 16 or 32. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting On/Off of Pan Limit from
Format /api/param?camera.motion.pan.limit.status
Example of response camera.motion.pan.limit.status=off&200 OK
Interpretation Acquire On/Off of Pan Limit. "on" or "off" will be returned.
Allowed users admin, operator, user
Setting On/Off of Pan Limit for
Format /api/param?camera.motion.pan.limit.status=data
Example of Response camera.motion.pan.limit.status&202
Accepted(camera.status=save)
Interpretation Change On/Off of Pan Limit. Specify "on" or "off". The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Left Side of Pan Limit from
Format /api/param?camera.motion.pan.limit.left
Example of response camera.motion.pan.limit.left=90.00&200 OK
Interpretation Acquire left side of Pan Limit in degrees.
Allowed users admin, operator, user
Setting Left Side of Pan Limit for
Format /api/param?camera.motion.pan.limit.left=present
Example of Response camera.motion.pan.limit.left&200 OK
Interpretation Set current pan position as left side of Pan Limit.
Allowed users admin, operator
Getting Right Side of Pan Limit from
Format /api/param?camera.motion.pan.limit.right
Example of response camera.motion.pan.limit.right=90.00&200 OK
Interpretation Acquire right side of Pan Limit in degrees.
Allowed users admin, operator, user
61
Setting Right Side of Pan Limit for
Format /api/param?camera.motion.pan.limit.right=present
Example of Response camera.motion.pan.limit.right&200 OK
Interpretation Set current pan position as right side of Pan Limit.
Allowed users admin, operator
Moving to Left/Right Side of Pan Limit for
Format /api/param?camera.motion.pan.status=data
Example to move ot left side /api/param?camera.motion.pan.status=goto_leftlimit
Example of Response camera.motion.pan.status&200 OK
Interpretation Move to left/right side of Pan Limit. Specify goto_leftlimit or goto_rightlimit.
Allowed users admin, operator
Getting Tilt Limit from
Format /api/param?camera.motion.tilt.limit.upper
Example of response camera.motion.tilt.limit.upper=5&200 OK
Interpretation Acquire Tilt Limit in degrees.
Allowed users admin, operator, user
Setting Tilt Limit for
Format /api/param?camera.motion.tilt.limit.upper=data
Example to set horizontal /api/param?camera.motion.tilt.limit.upper=5
Example of Response camera.motion.tilt.limit.upper&202
Accepted(camera.status=save)
Interpretation Set Tilt Limit. Specify from 0 to 15. 5 is horizontal. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Speed of Going to Preset Position from
Format /api/param?camera.motion.position.speed
Example of response camera.motion.position.speed=100&200 OK
Interpretation Acquire speed of going to preset position. Value from 0 to 100 is returned. 100 is fastest. The speed is 4 steps internally. The speed is applied also to preset position of auto patrol.
Allowed users admin, operator, user
Setting Speed of Going to Preset Position for
62
Format /api/param?camera.motion.position.speed=data
Example to set horizontal /api/param?camera.motion.position.speed=100
Example of Response camera.motion.position.speed&202 Accepted(camera.status=save)
Interpretation Set speed of going to preset position. Specify from 0 to 100. 5 is horizontal. 100 is fastest. The speed is 4 steps internally. The speed is applied also to preset position of auto patrol. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Auto Flip Setting from
Format /api/param?camera.motion.tilt.auto_flip
Example of response camera.motion.tilt.auto_flip=full_digital&200 OK
Interpretation Acquire setting of auto flip. off, full_digital, half, full or full_reverse is returned. off : Auto Flip function does not activate.
full_digital : This is Digital Flip on Web page. The top/bottom and left/right of the image flips when the object has passed the bottom of the camera, at the position of 135 degrees.
half : Thi is Mode1 on Web page. When the camera faces bottom, it rotates 180 degrees horizontally and stops. In this case, the operating direction of the camera is the same as that of the Pan/Tilt lever.
full : This is Mode2 on Web page. When the camera faces bottom, it rotates 180 degrees horizontally and the operating direction of the camera is opposite that of the Tilt lever. Select this mode if you wish to operate continuously. Once operation stops, the direction will return to normal.
full_reverse : This is Mode3 on Web page. When the camera faces bottom, it rotates 180 degrees horizontally and the operating direction of the camera is opposite that of the Tilt lever. However, the operating direction will return to normal 10 seconds after the operation has stopped.
Allowed users admin, operator, user
Setting Auto Flip for
Format /api/param?camera.motion.tilt.auto_flip=data
Example to set horizontal /api/param?camera.motion.tilt.auto_flip=full_digital
Example of Response camera.motion.tilt.auto_flip&202 Accepted(camera.status=save)
Interpretation Set auto flip mode. Specify off, full_digital, half, full or full_reverse. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Current Status of Digital Flip from
Format /api/param?camera.motion.tilt.auto_flip.full_digital.status
Example of response camera.motion.tilt.auto_flip.full_digital.status=off&200 OK
63
Interpretation Acquire current status of digital flip. "on" or "off" is returned. When off is returned, the image is not reversed. When onn is returned, the image is reversed.
Allowed users admin, operator, user
(2) PTZ Control
Getting Pan Position from
Format /api/param?camera.motion.pan
Example of response camera.motion.pan=45.00&200 OK
Interpretation Acquire current pan position in degrees. Value from 0.00 to 359.99 is returned.
Allowed users admin, operator, user
Moving to Specified Pan Position for
Format /api/param?camera.motion.pan=data
Example to move to absolute 90 degrees /api/param?camera.motion.pan=90.00
Example to move to relative 45 degrees /api/param?camera.motion.pan=+45.00
Example of Response camera.motion.pan&200 OK
Interpretation Move to specified pan position. To move to absolute position, specify from 0.00 to 359.99.
Allowed users admin, operator
Pan Operation for
Format /api/param?camera.motion.pan.status=data
Example to start pan /api/param?camera.motion.pan.status=start
Example of Response camera.motion.pan.status&200 OK
Interpretation Start or stop pan operation. Specify start or stop.
Allowed users admin, operator
Setting Direction of Pan Operation for
Format /api/param?camera.motion.pan.mode=data
Example to set to left /api/param?camera.motion.pan.mode=left
Example of Response camera.motion.pan.mode&200 OK
Interpretation Set direction of pan operation. Specify left or right.
Allowed users admin, operator
Setting Speed of Pan Operation for
Format /api/param?camera.motion.pan.speed=data
Example to set maximum speed /api/param?camera.motion.pan.speed=100
64
Example of Response camera.motion.pan.speed&200 OK
Interpretation Set speed of pan operation. Specify 0 to 100. The speed is 8 steps internally.
Allowed users admin, operator
Getting Pan Operation Status from
Format /api/param?camera.motion.pan.status
Example of Response camera.motion.pan.status=moving&200 OK
Interpretation Acquire current pan status. "moving" or "stop" is returned.
Allowed users admin, operator, user
Getting Status of Variable Pan/Tilt Speed from
Format /api/param?camera.motion.variable_pantiltspeed.status
Example of Response camera.motion.variable_pantiltspeed.status=on&200 OK
Interpretation Acquire current setting of variable pan/tilt speed. "on" or "off" is returned.
Allowed users admin, operator, user
Setting Status of Variable Pan/Tilt Speed for
Format /api/param?camera.motion.variable_pantiltspeed.status=data
Example to set on /api/param?camera.motion.variable_pantiltspeed.status=on
Example of Response camera.motion.variable_pantiltspeed.status&202
Accepted(camera.status=save)
Interpretation Set status of variable pan/tilt speed. Specify on or off. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Tilt Position from
Format /api/param?camera.motion.tilt
Example of response camera.motion.tilt=45.00&200 OK
Interpretation Acquire current tilt position in degrees. Value from 0.00 to 190.00 is returned. 0.00 means
Allowed users admin, operator, user
Moving to Specified Tilt Position for
Format /api/param?camera.motion.tilt=data
Example to move to absolute 5 degrees /api/param?camera.motion.tilt=5.00
Example to move to relative 45 degrees /api/param?camera.motion.tilt=+45.00
65
Example of Response camera.motion.tilt&200 OK
Interpretation Move to specified tilt position. To move to absolute position, specify from 0.00 to 190.00. 0.00 means
Allowed users admin, operator
Tilt Operation for
Format /api/param?camera.motion.tilt.status=data
Example to start pan /api/param?camera.motion.tilt.status=start
Example of Response camera.motion.tilt.status&200 OK
Interpretation Start or stop tilt operation. Specify start or stop.
Allowed users admin, operator
Setting Direction of Tilt Operation for
Format /api/param?camera.motion.tilt.mode=data
Example to set to up /api/param?camera.motion.tilt.mode=up
Example of Response camera.motion.tilt.mode&200 OK
Interpretation Set direction of tilt operation. Specify up or down.
Allowed users admin, operator
Setting Speed of Tilt Operation for
Format /api/param?camera.motion.tilt.speed=data
Example to set maximum speed /api/param?camera.motion.tilt.speed=100
Example of Response camera.motion.tilt.speed&200 OK
Interpretation Set speed of tilt operation. Specify 0 to 100. The speed is 8 steps internally.
Allowed users admin, operator
Getting Tilt Operation Status from
Format /api/param?camera.motion.tilt.status
Example of Response camera.motion.tilt.status=moving&200 OK
Interpretation Acquire current tilt status. "moving" or "stop" is returned.
Allowed users admin, operator, user
Getting Zoom Position from
Format /api/param?camera.motion.zoom
Example of response camera.motion.zoom=45.00&200 OK
66
Interpretation Acquire current zoom position. Value from 0.00 to 99.99 is returned. 0.00 means Wide edge and
99.99 means Tele edge.
Allowed users admin, operator, user
Moving to Specified Zoom Position for
Format /api/param?camera.motion.zoom=data
Example to move to absolute 50.00 /api/param?camera.motion.zoom=50.00
Example to move to relative 5 Tele /api/param?camera.motion.zoom=+5.00
Example to move to relative 5
Example of Response camera.motion.zoom&200 OK
Interpretation Move to specified zoom position. To move to absolute position, specify from 0.00 to 99.99. 0.00
means Wide edge and 99.99 means Tele edge.
Allowed users admin, operator
Zoom Operation for
Format /api/param?camera.motion.zoom.status=data
Example to start zoom /api/param?camera.motion.zoom.status=start
Example of Response camera.motion.zoom.status&200 OK
Interpretation Start or stop zoom operation. Specify start or stop.
Allowed users admin, operator
Setting Direction of Zoom Operation for
Format /api/param?camera.motion.zoom.mode=data
Example to set to Tele /api/param?camera.motion.zoom.mode=in
Example of Response camera.motion.zoom.mode&200 OK
Interpretation Set direction of zoom operation. Specify in or out.
Allowed users admin, operator
Setting Speed of Zoom Operation for
Format /api/param?camera.motion.zoom.speed=data
Example to set maximum speed /api/param?camera.motion.zoom.speed=100
Example of Response camera.motion.zoom.speed&200 OK
Interpretation Set speed of zoom operation. Specify 0 to 100. The speed is 4 steps internally.
Allowed users admin, operator
Getting Zoom Operation Status from
67
Format /api/param?camera.motion.zoom.status
Example of Response camera.motion.zoom.status=moving&200 OK
Interpretation Acquire current zoom status. "moving" or "stop" is returned.
Allowed users admin, operator, user
Moving Specified Position to Center for
Example of Response camera.motion.clickoncenter&200 OK
Example to move (160, 120) to center (pixel)
Example to move (160, 120) to center (percentage)
Interpretation Moving specified position to center of image. In
Allowed users admin, operator
Getting Focus Position from
Format /api/param?camera.focus
Example of response camera.focus=45.00&200 OK
Interpretation Acquire current focus position. When focus is set to manual, value from 0.00 to 99.99 is returned. 0.00 means Near edge and 99.99 means Far edge. When zoom is Wide edge, focus can be from 0.00 to 99.99. When zoom is Tele edge, focus can be from 0.00 to about 78. When focus is set to auto, easy_auto is returned.
Allowed users admin, operator, user
Moving to Specified Focus Position for
Format /api/param?camera.focus=data
Example of Response camera.focus&200 OK
Interpretation Change focus. To move to absolute position, specify from 0.00 to 99.99. 0.00 means Near edge and
68
99.99 means Far edge. Specify easy_auto for auto focus. Specify op_auto for one push auto focus. Specify manual for changing from auto to manual. Auto focus works after pan/tilt/zoom operation. Auto focus does not work after moving absolute/relative position of pan/tilt/zoom.
Allowed users admin, operator
Focus Operation for
Format /api/param?camera.focus.status=data
Example to start zoom /api/param?camera.focus.status=start
Example of Response camera.focus.status&200 OK
Interpretation Start or stop focus operation. Specify start or stop.
Allowed users admin, operator
Setting Direction of Focus Operation for
Format /api/param?camera.focus.mode=data
Example to set to Far /api/param?camera.focus.mode=far
Example of Response camera.focus.mode&200 OK
Interpretation Set direction of focus operation. Specify far or near.
Allowed users admin, operator
Setting Speed of Focus Operation for
Format /api/param?camera.focus.speed=data
Example to set maximum speed /api/param?camera.focus.speed=100
Example of Response camera.focus.speed&200 OK
Interpretation Set speed of focus operation. Specify 0 to 100. The speed is 4 steps internally.
Allowed users admin, operator
(3) Preset Position
Getting Current Preset Position from
Format /api/param?camera.status
Example of response camera.status=3&200 OK
Interpretation Acquire current preset position after moving to preset position. "none" is returned after moved from
preset position.
Allowed users admin, operator, user
Getting Status of Specified Preset Position from
Format /api/param?camera.position(number).status
69
Example of response camera.position(3).status=unregistered&200 OK
Interpretation Acquire current status of specified preset position. Specify from 0 to 99 as position number.
"unregistered" or "registered" is returned.
Allowed users admin, operator, user
Register Current Position as Preset Position for
Format /api/param?camera.position(number).status=save
Example of Response camera.position(3).status&200 OK
Interpretation Save current position as preset position. Specify from 0 to 99 as position number. Iris, BLC and white balance settings are saved also as preset position data. After moving to preset position, those settings are restored. Caution: Though Moving to tilt position over 90 degrees is possible when auto flip mode is digital flip, registering tilt position over 90 degrees as preset position is not allowed. Registering digital zoomed position as preset position is not allowed.
Allowed users admin, operator
Initialize Preset Position for
Format /api/param?camera.position(number).status=initialize
Example of Response camera.position(3).status&200 OK
Interpretation Initialize specified preset position. Specify from 0 to 99 as position number. Position number 0 is home position and it is registered with default settings when initilized. Other positions are unregistered by initializing.
Allowed users admin, operator
Moving to Preset Position for
Format /api/param?camera.position(number).status=goto
Example of Response camera.position(3).status&200 OK
Interpretation Move to specified preset position. Specify from 0 to 99 as position number.
Allowed users admin, operator
Getting Title of Preset Position from
Format /api/param?camera.position(number).comment
Example of response camera.position(3).comment=entrance&200 OK
Interpretation Acquire title of specified preset position. Specify from 0 to 99 as position number.
Allowed users admin, operator, user
Setting Title to Preset Position for
Format /api/param?camera.position(number).comment=data
70
Example of Response camera.position(3).status&200 OK
Interpretation Set tilte to specified preset position. Specify from 0 to 99 as position number. Maximum characters is 32. To erase title, specify %00, i.e. 0x25 0x30 0x30 in binary data. Use %20 to set space.
Allowed users admin, operator
(4) Auto Pan
Getting Status of Auto Pan from
Format /api/param?camera.motion.auto_pan.status
Example of response camera.motion.auto_pan.status=moving&200 OK
Interpretation Acquire current status of auto pan. "moving" of "stop" is returned.
Allowed users admin, operator, user
Start/Stop of Auto Pan for
Format /api/param?camera.motion.auto_pan.status=data
Example to start auto pan /api/param?camera.motion.auto_pan.status=start
Example to stop auto pan /api/param?camera.motion.auto_pan.status=stop
Example to move to start position of auto pan
/api/param?camera.motion.auto_pan.status=goto_start
Example to move to end position of auto pan
/api/param?camera.motion.auto_pan.status=goto_end
Example of Response camera.motion.auto_pan.status&200 OK
Interpretation Start/stop auto pan. Specify start, stop, goto_start or goto_end.
Allowed users admin, operator
Getting Direction of Auto Pan from
Format /api/param?camera.motion.auto_pan.mode
Example of response camera.motion.auto_pan.mode=left&200 OK
Interpretation Acquire direction of auto pan. "left", "right" or "return" is returned.
Allowed users admin, operator, user
Setting Direction of Auto Pan for
Format /api/param?camera.motion.auto_pan.mode=data
Example to set to Left /api/param?camera.motion.auto_pan.mode=left
Example of Response camera.motion.auto_pan.mode&202 Accepted(camera.status=save)
Interpretation Set direction of auto pan. Specify "left", "right" or "return". The change is saved by the API,
71
camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Speed of Auto Pan from
Format /api/param?camera.motion.auto_pan.speed
Example of response camera.motion.auto_pan.speed=50&200 OK
Interpretation Acquire speed of auto pan. Value from 0 to 100 is returned. The speed is 3 steps internally.
Allowed users admin, operator, user
Setting Speed of Auto Pan for
Format /api/param?camera.motion.auto_pan.speed=data
Example to set maximum speed /api/param?camera.motion.auto_pan.speed=100
Example of Response camera.motion.auto_pan.speed&202 Accepted(camera.status=save)
Interpretation Set speed of auto pan. Specify 0 to 100. The speed is 3 steps internally. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Setting Current Position as Start Position of Auto Pan for
Format /api/param?camera.motion.auto_pan.start_point=present
Example of Response camera.motion.auto_pan.start_point&200 OK
Interpretation Set current position as start position of auto pan. Pan/tilt/zoom/focus positions are saved. Caution: Though Moving to tilt position over 90 degrees is possible when auto flip mode is digital flip, select tilt position under 90 degrees as start position of auto pan.
Allowed users admin, operator
Setting Current Position as End Position of Auto Pan for
Format /api/param?camera.motion.auto_pan.end_point=present
Example of Response camera.motion.auto_pan.end_point&200 OK
Interpretation Set current position as end position of auto pan.
Allowed users admin, operator
(5) Auto Trace
Getting Status of Auto Trace from
Format /api/param?camera.motion.auto_trace.status
72
Example of response camera.motion.auto_trace.status=moving&200 OK
Interpretation Acquire current status of auto trace. "moving" of "stop" is returned.
Allowed users admin, operator, user
Start/Stop of Auto Trace for
Format /api/param?camera.motion.auto_trace.status=data
Example to start auto trace /api/param?camera.motion.auto_trace.status=start
Example to stop auto trace /api/param?camera.motion.auto_trace.status=stop
Example of Response camera.motion.auto_trace.status&200 OK
Interpretation Start/stop auto trace. Specify start or stop. When start is specified during auto trace, auto trace is stopped and restarted.
Allowed users admin, operator
Start/Stop of Auto Trace Recording for
Format /api/param?camera.motion.auto_trace.record.status=data
Example to start auto trace recording
/api/param?camera.motion.auto_trace.record.status=start
Example to stop auto trace recording
/api/param?camera.motion.auto_trace.record.status=stop
Example of Response camera.motion.auto_trace.record.status&200 OK
Interpretation Start/stop auto trace recording. Specify start or stop. Maximum duration of the recording is 30 seconds, and limited number of commands can be recorded. When the duration or command number is over, error response is returned to pan/tilt/zoom/focus command as below.
206 Partial Content, auto_trace(timeout)
206 Partial Content, auto_trace(memoryfull)
If stop is specified after those limitations, "206 Partial Content" is returned. After the stop commad, normal response is returned to pan/tilt/zoom/focus command.
Caution: Though Moving to tilt position over 90 degrees is possible when auto flip mode is digital flip, that operation is disabled during auto trace recording. Select tilt position under 90 degrees as start position of auto trace recording.
Allowed users admin, operator
Getting Status of Auto Trace Recording from
Format /api/param?camera.motion.auto_trace.record.status
Example of response camera.motion.auto_trace.record.status=on&200 OK
Interpretation Acquire current status of auto trace recording. "on" is returned during the recording.
Allowed users admin, operator, user
73
6.7. Auto Patrol
The APIs below are related to auto patrol. These are equivalent to the features on the Auto Patrol page of the WEB setting page. Refer to the instruction manual for details on the Auto Patrol page.
Start/Stop of Auto Patrol for
Format /api/param?camera.motion.auto_patrol(number).status=data
Example to start auto patrol mode 1
/api/param?camera.motion.auto_patrol(0).status=start
Example of Response camera.motion.auto_patrol(0).status&200 OK
Interpretation Start/stop a mode of auto patrol. Auto patrol mode is from 0 to 2. Specify start or stop.
Caution: When a mode is started, auto patrol mode of Auto Return is changed to the specified mode if auto patrol is registered as Auto Return.
Allowed users admin, operator
Getting Status of Auto Patrol from
Format /api/param?camera.motion.auto_patrol(number).status
Example of response camera.motion.auto_patrol(0).status=moving&200 OK
Interpretation Acquire current status of a mode of auto patrol. Auto patrol mode is from 0 to 2. "moving" or "stop" is
returned.
Allowed users admin, operator, user
Getting Preset Postion Number of Auto Patrol from
Format /api/param?camera.motion.auto_patrol(number1).position(number2)
Example to get preset position number of patrol nuber 3 in mode 1
/api/param?camera.motion.auto_patrol(0).position(3)
Example of response camera.motion.auto_patrol(0).position(3)=5&200 OK
Interpretation Acquire preset position number of specified patrol number in a mode of auto patrol. Auto patrol mode is from 0 to 2. Patrol number is from 0 to 99. Preset position number from 0 to 99 is returned.
Allowed users admin, operator, user
Setting Preset Postion Number of Auto Patrol for
Format /api/param?camera.motion.auto_patrol(number1).position(number2)=data
Example of Response camera.motion.auto_patrol(0).position(3)&202
Accepted(camera.motion.auto_patrol.status=save)
74
Interpretation Set preset position number of specified patrol number in a mode of auto patrol. Auto patrol mode is from 0 to 2. Patrol number is from 0 to 99. Specify preset position number from 0 to 99. The change is saved by the API, camera.motion.auto_patrol.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Duration of Auto Patrol from
Format /api/param?camera.motion.auto_patrol(number1).position(number2).duration
Example to get duration of patrol nuber 3 in mode 1
/api/param?camera.motion.auto_patrol(0).position(3).duration
Example of response camera.motion.auto_patrol(0).position(3).duration=30&200 OK
Interpretation Acquire duration of specified patrol number in a mode of auto patrol. Auto patrol mode is from 0 to 2. Patrol number is from 0 to 99. 0, 10, 20, 30, 45, 60, or 120 is returned. 0 means skip. 10 means 10 seconds.
Allowed users admin, operator, user
Setting Duarion of Auto Patrol for
Format
/api/param?camera.motion.auto_patrol(number1).position(number2).duration=data
Example of Response camera.motion.auto_patrol(0).position(3).duration&202
Accepted(camera.motion.auto_patrol.status=save)
Interpretation Set duration of specified patrol number in a mode of auto patrol. Auto patrol mode is from 0 to 2. Patrol number is from 0 to 99. Specify 0, 10, 20, 30, 45, 60, or 120. 0 means skip. 10 means 10 seconds. The change is saved by the API, camera.motion.auto_patrol.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Saving Preset Position Number/Duarion of Auto Patrol for
Format /api/param?camera.motion.auto_patrol(number).status=save
Example of Response camera.motion.auto_patrol(0).status&202
Accepted(camera.motion.auto_patrol.status=save)
Interpretation Save preset position number and duration of specified mode of auto patrol. Auto patrol mode is
from 0 to 2.
Allowed users admin, operator
6.8. Privacy Masking
The APIs below are related to privacy masking. These are equivalent to the features on the Privacy Masking page of the
75
WEB setting page. Refer to the instruction manual for details on the Privacy Masking page.
Getting Whole Status of Privacy Masking from
Format /api/param?camera.private_mask.status
Example of response camera.private_mask.status=on&200 OK
Interpretation Acquire the whole status of privacy masking. "on" or "off" is returned. When this status is off, all
privacy masking areas disappear.
Allowed users admin, operator, user
Setting Whole Status of Privacy Masking for
Format /api/param?camera.private_mask.status=data
Example of Response camera.private_mask.status&202 Accepted(camera.status=save)
Interpretation Change the whole status of privacy masking. When this status is off, all privacy masking areas disappear. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Status of a Privacy Masking Area from
Format /api/param?camera.private_mask.area(number).status
Example of response camera.private_mask.area(number).status=on&200 OK
Interpretation Acquire each status of privacy masking area. "on" or "off" is returned. Specify from 0 to 7 as area
number.
Allowed users admin, operator, user
Setting Status of a Privacy Masking Area for
Format /api/param?camera.private_mask.area(number).status=data
Example of Response camera.private_mask.area(number).status&202
Accepted(camera.status=save)
Interpretation Change each status of privacy masking area. Specify from 0 to 7 as area number. Specify "on" or "off". The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Privacy Masking Brightness from
Format /api/param?camera.private_mask.color
Example of response camera.private_mask.color=ffffff&200 OK
Interpretation Acquire the brightness of privacy masking. RGB values are returned as hexadecimal number. For
76
exmaple, ffffff is white, 808080 is gray, 000000 is black. The brightness is 11 steps internally.
Allowed users admin, operator, user
Setting Privacy Masking Brightness for
Format /api/param?camera.private_mask.color=data
Example of Response camera.private_mask.color&202 Accepted(camera.status=save)
Interpretation Change the brightness of privacy masking. Specify RGB values by hexadecimal number. For exmaple, ffffff for white, 808080 for gray, 000000 for black.The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Allowed users admin, operator
Start/Save Editing of Privacy Masking for
Format /api/param?camera.private_mask.area(number).status=data
Example to start editing /api/param?camera.private_mask.area(0).status=edit
Example to save editing /api/param?camera.private_mask.area(0).status=save
Example to clear setting /api/param?camera.private_mask.area(0).status=clear
Example to quit editing without save
/api/param?camera.private_mask.area(0).status=exit
Example of Response camera.private_mask.area(0).status&200 OK
Interpretation Start editing of a privacy masking area. Specify from 0 to 7 as area number. Specify "edit", "save", "clear" or "exit". When editing is started, zoom is changed to Wide edge, and pan/tilt positions are restored if the privacy masking area has settings. Pan/tilt position of the privacy masking area can be changed by pan/tilt APIs.
Allowed users admin, operator
Setting Width of Privacy Masking Area for
Format /api/param?camera.private_mask.width=data
Example to expand the width 1 step /api/param?camera.private_mask.width=+
Example of Response camera.private_mask.width&200 OK
Interpretation Change the width of editing privacy masking area. Specify + or
is required.
Allowed users admin, operator
Setting Height of Privacy Masking Area for
Format /api/param?camera.private_mask.height=data
Example to expand the height 1 step /api/param?camera.private_mask.height=+
Example of Response camera.private_mask.height&200 OK
77
Interpretation Change the height of editing privacy masking area. Specify + or
is required.
Allowed users admin, operator
6.9. Motion Detect
The APIs below are related to motion detection. These are equivalent to the features on the Motion Detection page of the WEB setting page. Refer to the instruction manual for details on the Motion Detection page.
Getting Motion Detect On/Off Status from
Format /api/param?camera.detection.status
Example of response camera.detection.status=on&200 OK
Interpretation Acquire the on/off status of motion detect.
Allowed users admin, operator, user
Setting Motion Detect to On/Off for
Format /api/param?camera.detection.status=data
Example of Response camera.detection.status&202 Accepted(camera.status=save)
Interpretation Change the on/off status of motion detect. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Caution: Motion detect does not work during auto tracking.
Allowed users admin, operator
Getting Motion Detect Sensitivity from
Format /api/param?camera.detection.level
Example of response camera.detection.level=20&200 OK
Interpretation Acquire the motion detect sensitivity. A value between 0 to 100 will be returned. The larger the value, the higher will be the sensitivity.
Allowed users admin, operator, user
Setting Motion Detect Sensitivity for
Format /api/param?camera.detection.level=data
Example of response camera.detection.level&202 Accepted(camera.status=save)
Interpretation Change the motion detect sensitivity. Specify a value between 0 to 100. The larger the value, the higher will be the sensitivity. The sensitivity is 11 steps internally. The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
78
Allowed users admin, operator
Getting Motion Detect Mask from
Format /api/param?camera.detection.area
Example of response camera.detection.area=000102030405060708090001&200 OK
Interpretation Acquire the mask of motion detect. 24 ASCII characters will be returned.
The screen of
10000000 00000000 00000000 ,,,
Storage in bytes will begin from the LSB and represented in a hexadecimal value as shown below. 01 00 00 00 00 00 00 00 00 00
The hexadecimal value denotes the 24 ASCII characters acquired via this API that are expressed in ASCII codes. For example, the following character string will be returned when only the top left and bottom right blocks are masked. camera.detection.area=010000000000000000000080
Allowed users admin, operator, user
Setting Motion Detect Mask for
Format /api/param?camera.detection.area=data
Example /api/param?camera.detection.area=000102030405060708090001
Example of response camera.detection.area&202 Accepted(camera.status=save)
Interpretation Change the motion detect mask. Specify using a 24 ASCII character string. Refer to the item on "Getting Motion Detect Mask from
Allowed users admin, operator
6.10. Network Basics
The APIs below are related to the basics of networks. These are equivalent to the features on the Basic page of the WEB setting page. Refer to the instruction manual for details on the Basic page.
Enabling Network Setting Changes
Format /api/param?network.interface.status=restart
Example of Response network.interface.status&200 OK
79
Interpretation Changes of following network parameters become valid by this API.
DHCP, IP Address, Subnet Mask, TTL, MTU, TOS, Negotiation, IPv6
Changes are not reflected in the actions until this API is used. APIs to get settings of those parameters return previous values until this API is used. When this API is issued,
Allowed user admin
Getting DHCP Setting from
Format /api/param?network.interface.dhcp.status
Example of Response network.interface.dhcp.status=off&200 OK
Interpretation Acquire the current DHCP setting.
Allowed users admin, operator, user
Setting DHCP for
Format /api/param?network.interface.dhcp.status=data
Example /api/param?network.interface.dhcp.status=on
Example of Response
network.interface.dhcp.status&202 Accepted(network.interface.status=restart)
Interpretation Change the DHCP setting. Specify "on" or "off". To validate the change, use
"network.interface.status=restart" API that reboots
Allowed user admin
Getting IP Address from
Format /api/param?network.interface.ip
Example of Response network.interface.ip=192.168.0.2&200 OK
Interpretation Acquire the current IP address.
Allowed users admin, operator, user
Setting IP Address for
Format /api/param?network.interface.ip=data
Example /api/param?network.interface.ip=192.168.0.2
Example of Response
network.interface.ip&202 Accepted(network.interface.status=restart)
Interpretation Change the IP address. To validate the change, use "network.interface.status=restart" API that reboots
Allowed user admin
80
Getting Subnet Mask from
Format /api/param?network.interface.subnetmask
Example of Response network.interface.subnetmask=255.255.255.0&200 OK
Interpretation Acquire the current subnet mask.
Allowed users admin, operator, user
Setting Subnet Mask for
Format /api/param?network.interface.subnetmask=data
Example /api/param?network.interface.subnetmask=255.0.0.0
Example of Response
network.interface.subnetmask&202 Accepted(network.interface.status=restart)
Interpretation Change the subnet mask. To validate the change, use "network.interface.status=restart" API that reboots
Allowed user admin
Getting Default Gateway from
Format /api/param?network.gateway(version)
Example to get default gateway of IPv4 /api/param?network.gateway(ipv4)
Example of Response network.gateway(ipv4)=192.168.0.254&200 OK
Interpretation Acquire the current default gateway. Specify ipv4 or ipv6.
Allowed users admin, operator, user
Setting Default Gateway for
Format /api/param?network.gateway(ipv4)=data
Example /api/param?network.gateway(ipv4)=192.168.0.254
Example of Response network.gateway&200 OK
Interpretation Change the default gateway. To set static default gateway, disable DHCP. Default gateway can not be changed when DHCP is enabled. Specify IP address in same segment with
Allowed user admin
Getting Host Name from
Format /api/param?network.hostname
Example of Response network.hostname=localhost&200 OK
81
Interpretation Acquire the current host name.
Allowed users admin, operator, user
Setting Host Name for
Format /api/param?network.hostname=data
Example /api/param?network.hostname=somename
Example of Response network.hostname&200 OK
Interpretation Change the host name. Characters that may be used for the host name are alphanumerics, hyphens
Specify as %00 when the host name setting is to be left blank.
Example when leaving field blank /api/param?network.hostname=%00
Allowed user admin
Getting DNS Server On/Off Status from
Format /api/param?network.dns.status
Example of Response network.dns.status=off&200 OK
Interpretation Acquire the on/off status of the DNS server. Either on or off will be returned.
Allowed users admin, operator, user
Setting DNS Server Status to On/Off, or Validate Changes for
Format /api/param?network.dns.status=data
Example /api/param?network.dns.status=on
Example of Response network.dns.status&200 OK
Interpretation Change status of DNS server setting, or validate changes to DNS server settings. Specify "on", "off"
or "restart". Changes of DNS server settings become valid by "restart".
Allowed users admin, operator
Getting DNS Server IP Address from
Format /api/param?network.dns.ip
Example of Response network.dns.ip=10.0.0.150&200 OK
Interpretation Acquire IP address of DNS server.
Allowed users admin, operator, user
Setting DNS Server IP Address for
Format /api/param?network.dns.ip=data
82
Example /api/param?network.dns.ip=10.0.0.150
Example of Response
network.dns.ip&202 Accepted(network.dns.status=restart)
Interpretation Change IP address of DNS server. To validate the change, use "network.dns.status=restart" API.
Allowed users admin, operator
Getting IPv6 status from
Format /api/param?network.interface.ipv6.status
Example of Response network.interface.ipv6.status=off&200 OK
Interpretation Acquire IPv6 status. "on" or "off" is returned. In
Allowed users admin, operator, user
Setting IPv6 status for
Format /api/param?network.interface.ipv6.status=data
Example /api/param?network.interface.ipv6.status=on
Example of Response
network.interface.ipv6.status&202 Accepted(network.dns.status=restart)
Interpretation Change IPv6 status. In
"network.interface.status=restart" API that reboots
Allowed users admin, operator
Getting Link Local Address of IPv6 from
Format /api/param?network.interface.ipv6.link_local(Number) Exampleto get first link local address /api/param?network.interface.ipv6.link_local(1)
Example of Response
network.interface.ipv6.link_local(1)=fe80::280:88ff:fe41:400c&200 OK
Interpretation Acquire the link local address of IPv6. In
Allowed users admin, operator, user
Getting Global Address of IPv6 from
Format /api/param?network.interface.ipv6.global(Number)
Exampleto get first global address /api/param?network.interface.ipv6.global(1)
Example of Response when no global address is set network.interface.ipv6.global(1)=&200
OK
83
Interpretation Acquire the global address of IPv6. Specify from 1 to 8 for Number, and get addresses from 1 till vacant address is returned. In
Allowed users admin, operator, user
Getting MAC Address from
Format /api/param?network.interface.mac
Example of Response network.interface.mac=008088001AEF&200 OK
Interpretation Acquire the MAC address. A
Allowed users admin, operator, user
6.11. Network Details
The APIs below are related to network details. These are equivalent to the features on the Details page of the WEB setting page. Refer to the instruction manual for details on the Details page.
Getting TOS Value of JPEG from
Format /api/param?network.interface.dscp.video.jpeg
Example of Response network.interface.dscp.video.jpeg=56&200 OK
Interpretation Acquire TOS that includes DHCP field for JPEG.
Allowed users admin, operator, user
Setting TOS Value of JPEG for
Format /api/param?network.interface.dscp.video.jpeg=data
Example /api/param?network.interface.dscp.video.jpeg=56
Example of Response
network.interface.dscp.video.jpeg&202
Accepted(network.interface.status=restart)
Interpretation Change TOS that includes DHCP field for JPEG. The range of set value is between 0 to 255 though MSB 6 bits in the value is valid. To validate the change, use "network.interface.status=restart" API.
Allowed user admin
Getting TOS Value of
Format /api/param?network.interface.dscp.video.mpeg
Example of Response network.interface.dscp.video.mpeg=56&200 OK
Interpretation Acquire TOS that includes DHCP field for
84
Allowed users admin, operator, user
Setting TOS Value of
Format /api/param?network.interface.dscp.video.mpeg=data
Example /api/param?network.interface.dscp.video.mpeg=56
Example of Response
network.interface.dscp.video.mpeg&202
Accepted(network.interface.status=restart)
Interpretation Change TOS that includes DHCP field for
Allowed user admin
Getting Unicast TTL Value from
Format /api/param?network.interface.ttl.unicast
Example of Response network.interface.ttl.unicast=16&200 OK
Interpretation Acquire TTL of unicast.
Allowed users admin, operator, user
Setting Unicast TTL for
Format /api/param?network.interface.ttl.unicast=data
Example /api/param?network.interface.ttl.unicast=56
Example of Response
network.interface.ttl.unicast&202 Accepted(network.interface.status=restart)
Interpretation Change TTL of unicast. The range of set value is between 1 to 255. To validate the change, use
"network.interface.status=restart" API.
Allowed user admin
Getting Multicast TTL Value from
Format /api/param?network.interface.ttl.multicast
Example of Response network.interface.ttl.multicast=16&200 OK
Interpretation Acquire TTL of multicast.
Allowed users admin, operator, user
Setting Multicast TTL for
Format /api/param?network.interface.ttl.multicast=data
Example /api/param?network.interface.ttl.multicast=56
85
Example of Response
network.interface.ttl.multicast&202 Accepted(network.interface.status=restart)
Interpretation Change TTL of multicast. The range of set value is between 1 to 255. To validate the change, use "network.interface.status=restart" API.
Allowed user admin
Getting MTU Value
Format /api/param?network.interface.mtu
Example of Response network.interface.mtu=1420&200 OK
Interpretation Acquire the MTU value.
Allowed users admin, operator, user
Setting MTU Value for
Format /api/param?network.interface.mtu=data
Example /api/param?network.interface.mtu=1500
Example of Response
network.interface.mtu&202 Accepted(network.interface.status=restart)
Interpretation Change the MTU value. The range of set value is between 1280 to 1500. To validate the change, use "network.interface.status=restart" API.
Allowed user admin
Getting Network Negotiation Setting from
Format /api/param?network.interface.negotiation
Example of Response network.interface.negotiation=auto&200 OK
Interpretation Acquire the network Negotiation setting. Either auto, 100full, 100half, 10full or 10half will be
returned.
Allowed users admin, operator, user
Setting Network Negotiation for
Format /api/param?network.interface.negotiation=data
Example /api/param?network.interface.negotiation=auto
Example of Response
network.interface.negotiation&202 Accepted(network.interface.status=restart)
Interpretation Change the network Negotiation setting. Specify auto, 100full, 100half, 10full or 10half. To validate
the change, use "network.interface.status=restart" API.
Allowed user admin
86
6.12. Protocol
The APIs below are related to protocol. These are equivalent to the features on the Protocol page of the WEB setting page. Refer to the instruction manual for details on the Protocol page.
Getting Port Number of HTTP from
Format /api/param?network.http.port
Example of Response network.http.port=80&200 OK
Interpretation Acquire port number of HTTP server in
Allowed users admin, operator
Setting Port Number of HTTP for
Format /api/param?network.http.port=data
Example of Response network.http.port&202
Accepted(network.http(configuration).status=restart)
Interpretation Change port number of HTTP server in
Allowed users admin, operator
Getting Status of VSIP from
Format /api/param?network.vsip_server.status
Example of Response network.vsip_server.status=on&200 OK
Interpretation Acquire status of VSIP server in
is not available.
Allowed users admin, operator
Setting Status of VSIP for
Format /api/param?network.vsip_server.status=data
Example /api/param?network.vsip_server.status=on
Example of Response network.vsip_server.status&200 OK
Interpretation Change status of VSIP server in
"on" for interoperability with Nextiva products from Verint Systems Inc.
Allowed users admin, operator
Getting Port Number of VSIP from
87
Format /api/param?network.vsip_server.port
Example of Response network.vsip_server.port=5510&200 OK
Interpretation Acquire port number of VSIP server in
Allowed users admin, operator
Setting Port Number of VSIP for
Format /api/param?network.vsip_server.port=data
Example of Response network.vsip_server.port&202
Accepted(network.vsip_server.status=restart)
Interpretation Change port number of VSIP server in
Allowed users admin, operator
Getting Status of AMX Discovery Protocol from
Format /api/param?network.amx.beacon.status
Example of Response network.amx.beacon.status=on&200 OK
Interpretation Acquire status of AMX Discovery Protocol in
Allowed users admin, operator
Setting Status of AMX Discovery Protocol for
Format /api/param?network.amx.beacon.status=data
Example /api/param?network.amx.beacon.status=on
Example of Response network.amx.beacon.status&200 OK
Interpretation Change status of AMX Discovery Protocol in
available. Specify "on" for interoperability with AMX products.
Allowed users admin, operator
Getting Mode of JPEG streaming from
Format /api/param?network.http(streaming).priority
Example of Response network.http(streaming).priority=clientnumber&200 OK
Interpretation Acquire mode of JPEG streaming. "framerate" or "clientnumber" is returned. This API is available for
Allowed users admin, operator
Setting Mode of JPEG streaming for
88
Format /api/param?network.http(streaming).priority=data
Example /api/param?network.http(streaming).priority=clientnumber
Example of Response network.http(streaming).priority&202
Accepted(network.http(configuration).status=restart)
Interpretation Change mode of JPEG streaming. Specify "framerate" or "clientnumber". This API is available for
though requested JPEG framerate from clients is not kept. In case of "framerate",
Allowed users admin, operator
6.13. Multicast Streaming
The APIs below are related to manual streaming. These are equivalent to the features on the Streaming page of the WEB setting page. Refer to the instruction manual for details on the Streaming page.
Getting Status of JPEG Multicast Streaming from
Format /api/param?network.destination(1).status
Example of Response network.destination(1).status=off&200 OK
Interpretation Acquire status of JPEG multicast streaming. Either on or off will be returned.
Allowed users admin, operator
Setting Status of JPEG Multicast Streaming, or Save Changes for
Format /api/param?network.destination(1).status=data
Example /api/param?network.destination(1).status=start
Example of Response network.destination(1).status&200 OK
Interpretation Start/stop JPEG multicast streaming, or save changes to multicast streaming settings. Specify "start", "stop" or "save". Changes of multicast streaming settings become valid by "save".
Multicast stream is RTP compliant.
If power becomes off during multicast streaming, the streaming starts automatically after power on.
Allowed users admin, operator
Getting JPEG Multicast Address from
Format /api/param?network.destination(1).host
Example of Response network.destination(1).host=225.0.1.1&200 OK
Interpretation Acquire JPEG multicast address.
89
Allowed users admin, operator
Setting JPEG Multicast Address for
Format /api/param?network.destination(1).host=data
Example /api/param?network.destination(1).host=225.0.1.1
Example of Response
network.destination(1).host&202 Accepted(network.destination(1).host=save)
Interpretation Change JPEG multicast address. Specify from 224.0.0.0 to 239.255.255.255. To validate the change, use "network.destination(1).host=save" API. After the save, start streaming by "network.destination(1).host=start" API.
Allowed user admin
Getting JPEG Multicast Port Number from
Format /api/param?network.destination(1).port
Example of Response network.destination(1).port=49152&200 OK
Interpretation Acquire JPEG multicast port number.
Allowed users admin, operator
Setting JPEG Multicast Port Number for
Format /api/param?network.destination(1).port=data
Example /api/param?network.destination(1).port=49152
Example of Response
network.destination(1).port&202 Accepted(network.destination(1).host=save)
Interpretation Change JPEG multicast port number. Specify from 2 to 65534. To validate the change, use
"network.destination(1).host=save" API. After the save, start streaming by "network.destination(1).host=start" API.
Allowed user admin
Getting Frame Rate of JPEG Multicast from
Format /api/param?network.destination(1).framerate
Example of Response network.destination(1).framerate=10&200 OK
Interpretation Acquire JPEG multicast frame rate.
Allowed users admin, operator
Setting Frame Rate of JPEG Multicast for
Format /api/param?network.destination(1).framerate=data
Example /api/param?network.destination(1).framerate=30
90
Example of Response
network.destination(1).framerate&202
Accepted(network.destination(1).host=save)
Interpretation Change JPEG multicast frame rate. Specify 30, 25, 15, 10, 7.5, 6, 5, 3, 2, 1,
Allowed user admin
Getting Status of
Format /api/param?network.destination(2).status
Example of Response network.destination(2).status=off&200 OK
Interpretation Acquire status of
Allowed users admin, operator
Setting Status of
Format /api/param?network.destination(2).status=data
Example /api/param?network.destination(2).status=start
Example of Response network.destination(2).status&200 OK
Interpretation Start/stop
Multicast stream is RTP compliant. Marker bit of RTP header is 1 when the RTP packet has last data of VOP. If power becomes off during multicast streaming, the streaming starts automatically after power on.
Allowed users admin, operator
Getting
Format /api/param?network.destination(2).host
Example of Response network.destination(2).host=225.0.1.2&200 OK
Interpretation Acquire
Allowed users admin, operator
Setting
Format /api/param?network.destination(2).host=data
Example /api/param?network.destination(2).host=225.0.1.2
Example of Response
network.destination(2).host&202 Accepted(network.destination(2).host=save)
91
Interpretation Change
Allowed user admin
Getting
Format /api/param?network.destination(2).port
Example of Response network.destination(2).port=59152&200 OK
Interpretation Acquire
Allowed users admin, operator
Setting
Format /api/param?network.destination(1).port=data
Example /api/param?network.destination(1).port=59152
Example of Response
network.destination(1).port&202 Accepted(network.destination(1).host=save)
Interpretation Change
Allowed user admin
6.14. Access Restrictions
The APIs below are related to access restrictions. These are equivalent to the features on the Access Restrictions page of the WEB setting page. Refer to the instruction manual for details on the Access Restrictions page.
Getting Deny/Allow Setting of Client Restrictions from
Format /api/param?network.access_control(stream_out).logic
Example of Response network.access_control(stream_out).logic=deny&200 OK
Interpretation Acquire the deny/allow setting of client restrictions. Either deny or allow will be returned. These
restrictions are applied to getting
Allowed users admin, operator
Setting Client Restriction to Deny/Allow for
Format /api/param?network.access_control(stream_out).logic=data
Example /api/param?network.access_control(stream_out).logic=deny
Example of Response network.access_control(stream_out).logic&200 OK
92
Interpretation Change the deny/allow setting of client restrictions. Specify as deny or allow. These restrictions are
applied to getting
Allowed user admin
Getting IP Address Setting of Restricted Client from
Format /api/param?network.access_control(stream_out).host(Number)
Example When Getting the first IP address
/api/param?network.access_control(stream_out).host(1)
Example of Response network.access_control(stream_out).host(1)=10.0.0.100&200 OK
Interpretation Acquire the IP address setting of the restricted client. Setting is possible up to 10 items. Specify a value between 1 to 10 for the number. The following will be returned if subnet mask was specified.
Example of Response 2
network.access_control(stream_out).host(1)=10.0.0.0/24&200 OK
The above example indicates that the range is between 10.0.0.0 to 10.0.0.255. There are also cases when FQDN instead of IP address is set.
Example of Response 3
network.access_control(stream_out).host(1)=somedivision.somecompany.com&200 OK
Allowed users admin, operator
Setting IP Address of Restricted Client for
Format /api/param?network.access_control(stream_out).host(Number)=data
Example When setting the first IP address
/api/param?network.access_control(stream_out).host(1)=10.0.0.100
Example of Response network.access_control(stream_out).host(1)&200 OK
Interpretation Change the IP address setting of client restriction. Setting is possible up to 10 items. Specify a value between 1 to 10 for the number. A range of IP address may be specified if the subnet mask is also specified. For example, set as follows to specify a range between 10.0.0.0 to 10.0.0.255.
Example /api/param?network.access_control(stream_out).host(1)=10.0.0.0/24
It is also possible to set using FQDN instead of IP address. Set as follows if the setting is to be left blank.
Example /api/param?network.access_control(stream_out).host(1)=%00
Allowed user admin
6.15. Time
The APIs below are related to time. These are equivalent to the features on the Time page of the WEB setting page. Refer to the instruction manual for details on the Time page.
93
Getting On/Off of SNTP Client from
Format /api/param?network.ntp.status
Example of Response network.ntp.status=off&200 OK
Interpretation Acquire the on/off status of SNTP client. Either on or off will be returned.
Allowed users admin, operator, user
Setting On/Off of SNTP Client, or Validate Changes for
Format /api/param?network.ntp.status=data
Example /api/param?network.ntp.status=on
Example of Response network.ntp.status&200 OK
Interpretation Change the on/off status of SNTP client, or validate changes to settings. Specify "on", "off" or "restart". as on or off. IP address of NTP server and access interval are validated by "restart".
Allowed users admin, operator
Getting NTP Server Address from
Format /api/param?network.ntp.host
Example of Response network.ntp.host=10.0.0.100&200 OK
Interpretation Acquire IP address of NTP server. Either the IP address or FQDN will be returned.
Allowed users admin, operator, user
Setting NTP Server Address for
Format /api/param?network.ntp.host=data
Example /api/param?network.ntp.host=10.0.0.100
Example of Response network.ntp.host&202 Accepted(network.ntp.status=restart)
Interpretation Change IP address of NTP server. Specify IP address or FQDN. To validate the change, use
"network.ntp.status=restart " API.
Allowed users admin, operator
Getting Access Interval to NTP Server from
Format /api/param?network.ntp.interval
Example of Response network.ntp.interval=10&200 OK
Interpretation Acquire the interval for accessing the NTP server. Unit can be gotten by "network.ntp.unit" API.
Allowed users admin, operator, user
Setting Access Interval to NTP Server for
94
Format /api/param?network.ntp.interval=data
Example /api/param?network.ntp.interval=60
Example of Response
network.ntp.interval&202 Accepted(network.ntp.status=restart)
Interpretation Change the interval for accessing the NTP server. Unit can be set by "network.ntp.unit" API. Specify
Allowed users admin, operator
Getting Access Interval Unit of NTP from
Format /api/param?network.ntp.unit
Example of Response network.ntp.unit=hour&200 OK
Interpretation Acquire the unit of interval for accessing the NTP server. "min", "hour" or "day" is returned.
Allowed users admin, operator, user
Setting Access Interval Unit of SNTP for
Format /api/param?network.ntp.unit=data
Example /api/param?network.ntp.unit=day
Example of Response
network.ntp.unit&202 Accepted(network.ntp.status=restart)
Interpretation Change the unit of interval for accessing the NTP server. Specify "min", "hour" or "day". To validate the change, use "network.ntp.status=restart" API.
Allowed users admin, operator
Getting Time from
Format /api/param?system.date
Example of Response system.date=20050614171537&200 OK
Interpretation Acquire the time from the
Allowed users admin, operator, user
Setting Time for
Format /api/param?system.date=data
Example /api/param?system.date=20050614171537
Example of Response system.date&200 OK
Interpretation Change the time of the
95
hour, minute and second. Specify year in a
decimal numbers.
Allowed user admin
Getting Timezone from
Format /api/param?system.timezone
Example of Response system.timezone=Pacific&200 OK
Interpretation Acquire the timezone from
returned.
96
Allowed users admin, operator, user
Setting Timezone for
Format /api/param?system.timezone=data
Example /api/param?system.timezone=Pacific
Example of Response system.timezone&202 Accepted(system.status=restart)
Interpretation Change the timezone of
Allowed user admin
6.16. Password
The APIs below are related to passwords. These are equivalent to the features on the Password page of the WEB setting page. Refer to the instruction manual for details on the Password page.
Setting Password for
Format /api/param?system.password.data1=data2
Example /api/param?system.password.admin=someword
Example of Response system.password.admin&200 OK
Interpretation Change the
Example when setting admin password: /api/param?system.password.admin=word1
Example when setting operator password: /api/param?system.password.operator=word2
Example when setting user password: /api/param?system.password.user=word3
97
There is no API for Getting passwords.
Allowed user admin
6.17. Maintenance
The APIs below are related to maintenance. These are equivalent to the features on the Maintenance page of the WEB setting page. Refer to the instruction manual for details on the Maintenance page.
Initialization
Format /api/param?system.status=initialize
Example of Response system.status&200 OK
Interpretation Restore all
Allowed user admin
Firmware Update
Version upgrading is not possible using API. To do so, use the Version Upgrade feature on the Maintenance page of the WEB setting page.
Getting Status of Auto Cleaning from
Format /api/param?camera.motion.pan.auto_cleaning.status
Example of Response camera.motion.pan.auto_cleaning.status=off&200 OK
Interpretation Acquire status of auto cleaning. "on" or "off" is returned.
Allowed users admin, operator, user
Setting Auto Cleaning for
Format /api/param?camera.motion.pan.auto_cleaning.status=data
Example of Response camera.motion.pan.auto_cleaning.status&202
Accepted(camera.status=save)
Interpretation Change status of auto cleaning. Specify on or off. To save the change, use "camera.status=save" API.
Allowed user admin
Getting Time of Auto Cleaning from
Format /api/param?camera.motion.pan.auto_cleaning.time
Example of Response camera.motion.pan.auto_cleaning.time=235959&200 OK
98
Interpretation Acquire time of auto cleaning. Time is returned in format of hhmmss.
Allowed users admin, operator, user
Setting Time of Auto Cleaning for
Format /api/param?camera.motion.pan.auto_cleaning.time=data
Example of Response camera.motion.pan.auto_cleaning.time&202
Accepted(camera.status=save)
Interpretation Change time of auto cleaning. Specify time in format of hhmmss. To save the change, use "camera.status=save" API.
Allowed user admin
6.18. Getting Status
The APIs below are related to status acquisition. These are equivalent to the features on the Operation page of the WEB setting page. Refer to the instruction manual for details on the Operation page.
Getting Sending Status
Format /api/param?system.session
Response Return the total transmission bit rate, and status of each sending operation. Transmission is not carried out in the following examples.
system.session=&200 OK
system.session.total_bitrate=0k&200 OK
system.session.sending_count=0&200 OK
system.session.sending_max=20&200 OK
In the examples below, 1 JPEG stream of TCP is being sent.
system.session=&200 OK system.session.total_bitrate=388k&200 OK system.session.sending_count=2&200 OK system.session.sending_max=20&200 OK system.session.sending(01).bitrate=326k&200 OK system.session.sending(01).to.ip=10.0.0.100&200 OK system.session.sending(01).to.port=1536&200 OK system.session.sending(01).to.protocol=tcp_passive&200 OK system.session.sending(01).to.session=http&200 OK system.session.sending(01).from.encode=jpeg&200 OK
99
system.session.sending(01).from.framerate=1&200 OK
system.session.sending(01).from.framesize=vga&200 OK
In case of
Interpretation Acquire the sending status of
Allowed users admin, operator, user
Getting Log
Format /api/param?system.log
Response Return the following information. These information will be initialized upon turning off the power of
Number of seconds after startup, Alarm input, Motion detect, Error
Response examples
Interpretation Acquire the
Allowed user admin
6.19. Getting Settings
The APIs below are related to the acquisition of settings. These are equivalent to the features on the Settings page of the WEB setting page. Refer to the instruction manual for details on the Settings page.
Getting Model Name
Format /api/param?system.model
Example of Response
Interpretation Acquire the model name.
Allowed users admin, operator, user
Getting Firmware Revisions of Streaming Manager
100
Format /api/param?system.software.revision(net)
Example of Response
Interpretation Acquire firmware revisions of streaming manager.
Allowed users admin, operator, user
Getting Firmware Revisions of PTZ Controller
Format /api/param?system.software.revision(sys)
Example of Response
Interpretation Acquire firmware revisions of ptz controller.
Allowed users admin, operator, user
Getting Firmware Revisions of Image Processor
Format /api/param?system.software.revision(cam)
Example of Response
Interpretation Acquire firmware revisions of image processor.
Allowed users admin, operator, user
Getting Firmware Revisions of Lens
Format /api/param?system.software.revision(lens)
Example of Response
Interpretation Acquire firmware revisions of lens.
Allowed users admin, operator, user
6.20. Others
These are APIs of features not found on the WEB setting page.
Restart
Format /api/param?system.status=restart
Example of Response system.status&200 OK
Interpretation Restarts
Allowed users admin
Getting Alarm Input Status from
Format /api/param?peripheral.input_pin.pin(Number).status
Example of Response peripheral.input_pin.pin(1).status=make&200 OK
101
Interpretation Acquire the current alarm input status. Specify 1 or 2 to Number. Either make or break will be
returned.
Allowed users admin, operator, user
Getting Mode of FTP Server from
Format /api/param?application.ftp.mode
Example of Response application.ftp.mode=active&200 OK
Interpretation Acquire the mode of FTP server that is used by alarm action. Either active or passive is returned. active mode: Standard mode of FTP server. Also called PORT mode. TCP connection for data is established from 20
port of FTP server to 10020 port of
passive mode: TCP connection for data is established from
Allowed users admin, operator, user
Setting Mode of FTP Server for
Format /api/param?application.ftp.mode=data
Example /api/param?application.ftp.mode=active
Example of Response application.ftp.mode&200 OK
Interpretation Change the mode of FTP server that is used by alarm action. Set active or passive. Default is active. active mode: Standard mode of FTP server. Also called PORT mode. TCP connection for data is established from 20
port of FTP server to 10020 port of
passive mode: TCP connection for data is established from
Allowed user admin, operator
Getting Control Port Number of FTP Server from
Format /api/param?application.ftp.port
Example of Response application.ftp.port=21&200 OK
Interpretation Acquire port number for control of FTP server that is used by alarm action. Port number for data plus one is the port number for control.
Allowed users admin, operator, user
Setting Control Port Number of FTP Server for
Format /api/param?application.ftp.port=data
Example /api/param?application.ftp.port=21
Example of Response application.ftp.port&200 OK
102
Interpretation Change port number for control of FTP server that is used by alarm action. Default is 21. Port number
for data plus one is the port number for control.
Allowed user admin, operator
7. List of Protocols and Port Numbers Used with
8. Customizing
The
for customized viewer.
8.1. List of ActiveX
How to download ActiveX controls:
i) Please input URL below in Internet Explorer???s url form.
103
Ex.) When IP address of
http://192.168.0.2/v686.cab
ii) Download dialog box is showed. Please click save button and copy to some folder in the PC.
8.2. Properties of ActiveX
JPEG
PTZ Control Client
105
8.3. Method of ActiveX Control
JPEG
PTZ Control Client
106
8.4. How to use ActiveX Control by HTML
If write the next code in <Body> of HTML source code, It comes to be able to use ActiveX in HTML.
JPEG Viewer
<OBJECT ID="MPEG4Viewer" WIDTH = 640
HEIGHT= 480
PTZ Control Client
<OBJECT ID="PTZCtrl"
WIDTH = 1
HEIGHT= 1
CODEBASE="./v686.cab#version=1,0,0,9"
How to get CLASSID and ODEBASE
(i) CLASSID
CLASSID of ActiveX is described in the set up information file (Extension *. inf) included in the cabinet file (Extension *.cab) that stores ActiveX downloaded in Chapter 8.1.
107
CLASSID is possible to confirm it by defrosting the cabinet file, and opening the set up information file with the text editor.
(ii) CODEBASE
The cabinet file name of CODEBASE becomes a cabinet file name that contains ActiveX that wants to be used.
The version becomes the version of the main body of ActiveX (Extension *. ocx) stored in the cabinet file.
The method of examining the version has the following two.
-It acquires it from FileVersion described in the set up information file.
-It
8.5. HTML Sample
Sample code for functions below:
-Client of
-Playback of JPEG (Protocol: TCP, Display Size: VGA, Framerate: 15fps)
-Play/Pause of Playback
-Capture of still picture
-Digital PTZ Control (Up, Down, Left, Right,
Sample code
<!DOCTYPE HTML PUBLIC
<HEAD>
<META
</HEAD>
<SCRIPT LANGUAGE=JAVASCRIPT>
// *************** JPEG Viewer ***************
function play_click(play_btn, ip, http_port)
{
if(play_btn.value == "Play"){ JPEGViewer.IP = ip.value; JPEGViewer.HttpPort = http_port.value; JPEGViewer.Play();
play_btn.value = "Stop";
}
else{
JPEGViewer.Stop();
108
play_btn.value = "Play";
}
}
function capture_click()
{
JPEGViewer.Capture();
}
// *************** PTZ Control ***************
var f_init = 0;
function PTControl(num){ if (f_init == 0)
InitPTZCtrl();
PTZCtrl.ManualCtrl(num);
}
function ZoomControl(num){ if (f_init == 0)
InitPTZCtrl();
PTZCtrl.ZoomCtrl(num);
}
function InitPTZCtrl(){ PTZCtrl.OpPassword = "jvc"; PTZCtrl.IP = myForm.IP.value;
PTZCtrl.HttpPort = myForm.HTTP_PORT.value; PTZCtrl.UserLevel = 1; //operator PTZCtrl.MODEL = 0;
PTZCtrl.Initialize(); f_init = 1;
}
function mouse_up(){ PTZCtrl.Stop();
}
function close_window(){ PTZCtrl.Destroy();
}
</SCRIPT>
<BODY
WIDTH = 640
HEIGHT= 480
109
WIDTH = 1
HEIGHT= 1
<FORM NAME="myForm"> <table>
<tr>
<td>
<INPUT TYPE="TEXT" NAME="IP" VALUE="192.168.0.2"> HTTP Port
<INPUT TYPE="TEXT" NAME="HTTP_PORT" VALUE="80"> </td>
</tr>
<tr>
<td>
JPEG Viewer
<INPUT TYPE="BUTTON" NAME="PLAY_BTN" style="width:70px" VALUE="Play" onclick="play_click(PLAY_BTN, IP, HTTP_PORT)">
<INPUT TYPE="BUTTON" NAME="CAPTURE_BTN" style="width:70px" VALUE="Capture" onclick="capture_click()">
</td>
</tr>
<tr>
<td>
PTZ Control </td>
</tr>
</table>
<INPUT TYPE="BUTTON" VALUE="Up" STYLE="width:40px;top:630px;left:61px;position:absolute" onmousedown="PTControl(8)" onmouseup="mouse_up()" onmouseout="mouse_up()">
<INPUT TYPE="BUTTON" VALUE="Left" STYLE="width:40px;top:650px;left:41px;position:absolute" onmousedown="PTControl(4)" onmouseup="mouse_up()" onmouseout="mouse_up()">
<INPUT TYPE="BUTTON" VALUE="Right" STYLE="width:40px;top:650px;left:81px;position:absolute" onmousedown="PTControl(6)" onmouseup="mouse_up()" onmouseout="mouse_up()">
<INPUT TYPE="BUTTON" VALUE="Down" STYLE="width:40px;top:670px;left:61px;position:absolute" onmousedown="PTControl(2)" onmouseup="mouse_up()" onmouseout="mouse_up()">
<INPUT TYPE="BUTTON" NAME="TELE_BTN" VALUE="+"
110
STYLE="width:40px;top:635px;left:134px;position:absolute" onmousedown="ZoomControl(0)" onmouseup="mouse_up()" onmouseout="mouse_up()">
<INPUT TYPE="BUTTON" NAME="WIDE_BTN"
</FORM>
</BODY>
</HTML>
8.6. Notes
-Enable the
-Start Multicast stream on
-Set unique Multicast address and port number to each Multicast stream if multiple multicast streams are required in the system.
-Reload of ActiveX control is required to change Multicast property.
9. FAQ
(1) Low Frame rate due to long delay of network
- Causes of Low Frame Rate
During transmission via TCP,
- Countermeasure
This problem can be avoided by receiving via multicast. Multicast uses UDP and Ack does not exist. As such, the sender will be able to continue sending without being affected by network delays.
111