JVC VN-V686UAPI User Manual
IP Camera
VN-V686U
API GUIDE
This document provides a description of protocols and API of VN-V686.
Refer Readme file in the CD-ROM for updated information.
2008.6.19. JVC
LST0652-001A
1
Updates
Version Date Updates
1.00 2007/12/13 First release.
1.01 2008/4/25 Limitation of Registering Preset Position is added.
Fixed auto patrol number for auto return.
Fixed api text for getting status of a privacy masking
area.
1.02 2008/6/19 - Boundary option is added to JPEG request API.
- Status of Intelligent tracking is added to JPEG format
and MPEG-4 stream.
- APIs for Intelligent tracking are added.
- APIs to get current red/blue gain of auto white balance
are added.
- API to get status of digital flip is added.
- Properties and methods are added to embedded
viewer.
- Version of ActiveX is changed.
2
Custom Application Software Development Guide
VN-V686 can be used from a custom application software by utilizing the API and protocols for
VN-V686. The following operations are possible.
●
Getting JPEG from VN-V686.
●
Getting MPEG-4 from VN-V686.
●
Getting Alarm from VN-V686.
●
Getting or changing VN-V686 settings.
●
Pan/Tilt/Zoom/Focus operation of VN-V686.
●
Sending Multicast from VN-V686.
●
Customization of VN-V686's built-in viewer.
3
Content
1. Getting JPEG from VN-V686 via HTTP
2. Getting MPEG-4 from VN-V686 via HTTP
3. API to Search VN-V686
4. Getting Alarm from VN-V686 via TCP
5. Using API that Requires Basic Authentication
6. API for Getting/Changing Parameters of VN-V686
7. List of Protocols and Port Numbers Used with VN-V686
8. Customizing VN-V686's Built-in Viewer
9. FAQ
4
1. Getting JPEG from VN-V686 via HTTP
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) VN-V686 returns HTTP response.
Example
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-type: multipart/x-mixed-replace;boundary=-foo<CRLF>
Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF>
Server: JVC VN-V686 Network Camera<CRLF>
x-vnv25_response:
encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF>
4) VN-V686 sends out JPEG data after returning HTTP response.
JPEG files with boundary structure will be sent out continuously after HTTP Response as follows. Content-Length
in boundary structure shows file size of each JPEG file. Using the size, reading the whole JPEG data becomes easy.
5
HTTP Response
-foo<CRLF>
Content-Type: image/jpeg<CRLF>
Content-Length: 31614<CRLF><CRLF>
JPEG (No. 1)
JPEG (No. 1) <CRLF>
-foo<CRLF>
Content-Type: image/jpeg<CRLF>
Content-Length: 32756<CRLF><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.
Example of Booundary and pan/tilt/zoom information:
--foo<CRLF>
Content-Type: image/jpeg<CRLF>
Content-Length: 31200<CRLF>
X-Puls-Pan: 0<CRLF>
X-Puls-Tilt: 0<CRLF>
X-Posi-Zoom: 0<CRLF><CRLF>
Range of
X-Puls-Pan is from 0 to 35999.
Range of X
-Puls-Tilt is from 0 to 19000. 0 corresponds to -5 degrees and 19000 corresponds to 185
degrees. 500 and 18500 mean horizontal.
Range of
X-Posi-Zoom is from 0 to 9999.
Details of JPEG file format is explained later.
5) When the client wants to stop current JPEG transmission, the client disconnects TCP80.
VN-V686 does not accept further API via current TCP that is used for JPEG transmission. To change parameter,
disconnect current TCP to stop the JPEG transmission, connect new TCP, and send API with new parameter.
6
,,,
HTTP Response
boundary
pan/tilt/zoom information
JPEG (No. 1)
boundary
pan/tilt/zoom information
JPEG (No. 2)
,,,
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 framerate=-
5 to get at 1/5 fps, or in other words, 1 frame in 5 seconds. Selection range is as follows.
30, 25, 15, 10, 7.5, 6, 5, 3, 2, 1, 0, -2, -3, -5, -10, -15, -20, -30, -60
When the parameter is specified as framerate=0, VN-V686 sends 1 frame of JPEG data, and disconnect the 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
VN-V686 will return 200 OK. The x-vnv686_response line indicates actual parameters.
Example
7
GET APIspace space HTTP/1.1
Host: space IP Address of VN-V686
0x0D 0x0A 0x0D 0x0A
0x0D 0x0A
HTTP/1.1 200 OK<CRLF>
Content-Type: multipart/x-mixed-replace;boundary=--foo<CRLF>
Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF>
Server: JVC VN-V686 Network Camera<CRLF>
x-vnv686_response:
encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF>
When API is successfully received with boundary=off
VN-V686 will return 200 OK. Content-Length shows file size of first JPEG. The x-vnv686_response line indicates
actual parameters.
Example
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Length: 27616<CRLF>
Content-Type: image/jpeg<CRLF>
Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF>
Server: JVC VN-V686 Network Camera<CRLF>
x-vnv686_response:
encode=jpeg&framerate=30&framesize=vga&boundary=off&ptz_info=off<CRLF><CRLF>
1.4. Restrictions
Access restriction
VN-V686 has access restriction feature that enables to deny access from a specific IP address. If JPEG is requested
from the IP address of access restriction, VN-V686 disconnects the TCP connection after API is sent.
Restriction by maximum bitrate of VN-V686
The maximum bitrate of VN-V686 is about 20 Mbps.
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 VN-V686
JPEG file from VN-V686 is JFIF compliant and consist of the following.
8
FFD8
Start Code
FFE0
Application Segment
FFFE
Comment Segment 1
FFFE
Comment Segment 2 (reserved)
FFC4
DHT Huffman Table
FFDB
DQT Quantization Table
FFDD
DRI Restart Interval
FFC0
SOF Frame Information
FFDA
Data Start Segment
FFD9
End Code
The following information is stored in the comment segment 1. Each item has a fixed length.
Item Size Example Note
Version Information
9 JVC V1.0
Indicates the version of information stored in the comment
segment.
File Size
18 size = 123456
Indicates JPEG size in bytes.
Width
13 width = 640
Width of JPEG.
Height
14 height = 480
Height of JPEG.
Model Name
18 type = VN-V686U
Name of model that created the JPEG.
(reserved) 12 reverse = 0 (reserved)
Time Stamp
70 Timestamp =
2007101413050912
3UTC
Indicates the time when the JPEG is created. This is made
up of the year/month/day, hour/minute/second, millisecond
and timezone code.
(reserved) 13 alarm = 00000000 (reserved)
Camera ID
50 camera = input01
Stores camera information set at VN-V686.
Motion Detect Setting
11 motion = 1
Specified as 1 when the motion detect is ON.
Motion Detect Result
7 md = 1
Specified as 1 if motion is detected at the time when JPEG
is created.
Pan position 13 pan = 123.45 Indicates pan position in degrees from 0.00 to
359.99.
Tilt position 14 Tilt = 123.45 Indicates tilt position in degrees from 0.00 to
190.00. 0.00 corresponds to -5 degrees and 190.00
corresponds to 185 degrees. 5.00 and 185.00 mean
horizontal.
Zoom position 13 zoom = 12.34 Indicates zoom position from 0.00 to 99.99. EZoom
starts from about 90.89.
Preset Posision
Number
15 position = 99 Indicates preset position number after moving to
preset position. In other cases, position = NA.
Stabilizer status 15 stabilizer = 0 Indicates status of stabilizer. 1 means that stabilizer is
on.
Fan status 8 fan = 0 Indicates status of fan. 1 means error.
Intelligent tracking
status
17 track_status = 0 Indicates status of Intelligent tracking. 0 means
completed, 1 means waiting for specifying target, 2 means
tracking, and 3 means losing.
9
Target position of
Intelligent tracking
30 track_area =
90,420-150,460
Indicates position of Intelligent tracking target. The
numbers are top left position and bottom right position.
Item names and values, excluding the version information that does not include =, are stored in the following format.
Example: When width=640, the 13-byte area will be written as follows.
2. Getting MPEG-4 from VN-V686 via HTTP
2.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=mpeg4 HTTP/1.1<CRLF>
Host: 192.168.0.2<CRLF><CRLF>
Note <CRLF> denotes the line feed code (
0x0D, 0x0A
).
3) VN-V686 returns HTTP response.
Example
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Type: video/mp4v-es<CRLF>
Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF>
Server: JVC VN-V686 Network Camera<CRLF>
x-vnv686_response:
encode=mpeg4&framerate=15&framesize=vga&ptz_info=off<CRLF><CRLF>
4) VN-V686 sends out MPEG-4 data after returning HTTP response.
10
name =space space value (stuffed with 0x00)
fixed length for each item
w i d t h = 6 4 0 0x00 0x00
HTTP Response and MPEG-4 stream sent out by VN-V686 are as follows.
When ptz_info=on is specified, boundary, pan/tilt/zoom information and MPEG-4 VOP will be sent out continuously
after HTTP Response are as follows.
Example of Booundary and pan/tilt/zoom information:
--foo<CRLF>
Content-Type: image/jpeg<CRLF>
Content-Length: 5914<CRLF>
X-Puls-Pan: 0<CRLF>
X-Puls-Tilt: 0<CRLF>
X-Posi-Zoom: 0<CRLF><CRLF>
Range of
X-Puls-Pan is from 0 to 35999.
Range of X
-Puls-Tilt is from 0 to 19000. 0 corresponds to -5 degrees and 19000 corresponds to 185
degrees. 500 and 18500 mean horizontal.
Range of
X-Posi-Zoom is from 0 to 9999.
11
HTTP Response
VOP of MPEG-4 (No. 1)
VOP of MPEG-4 (No. 2)
,,,
HTTP Response
boundary
pan/tilt/zoom information
MPEG-4 VOP (No. 1)
boundary
pan/tilt/zoom information
MPEG-4 VOP (No. 2)
,,,
Details of MPEG-4 stream is explained later.
5) When the client wants to stop current MPEG-4 transmission, the client disconnects TCP80.
VN-V686 does not accept further API via current TCP that is used for JPEG transmission. To change parameter,
disconnect current TCP to stop the MPEG-4 transmission, connect new TCP, and send API with new parameter.
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>
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 MPEG-4.
ptz_info To add pan/tilt/zoom information before MPEG-4 VOP data. Specify on or off. Even if ptz_info=off,
pan/tilt/zoom information is stored in JPEG comment segemnt.
2.3. Response
When API is successfully received
VN-V686 will return 200 OK. The x-vnv686_response line indicates actual parameter.
Example
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Type: video/mp4v-es<CRLF>
Date: Tue, 02 Oct 2007 07:33:12 GMT<CRLF>
12
GET APIspace space HTTP/1.1
Host: space IP Address of VN-V686
0x0D 0x0A 0x0D 0x0A
0x0D 0x0A
Server: JVC VN-V686 Network Camera<CRLF>
x-vnv686_response:
encode=mpeg4&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF>
MPEG-4 framerate can be changed by Web page or API. When MPEG-4 framerate is changed, the framerate of
current stream is changed also.
2.4. Restrictions
Access restriction
VN-V686 has access restriction feature that enables to deny access from a specific IP address. If MPEG-4 is
requested from the IP address of access restriction, VN-V686 disconnects the TCP connection after API is sent.
Restriction by maximum bitrate of VN-V686
The maximum bitrate of VN-V686 is about 20 Mbps.
Number of clients
The maximum number of clients that can get MPEG-4 stream depends on encode settings and JPEG clients. Refer the
instruction manual for detailed information.
2. MPEG-4 Stream Format Sent Out by VN-V686
MPEG-4 stream from VN-V686 is MPEG-4 Part 2(ISO/IEC 14496-2) compliant, level 3 of simple profile. It is a
sequence of I-VOPs, or I-VOPs and P-VOPs.
I-VOP: Intra frame compressed data
P-VOP: Inter frame compressed data with previous frame
Ratio of I-VOP and P-VOP depends on I-Frame interval setting. Encode page of Web has the setting.
First VOP can be I-VOP or P-VOP. If client want to decode from I-VOP, please skip P-VOP and wait first I-VOP.
Example of MPEG-4 stream
13
HTTP Response
P-VOP
P-VOP
P-VOP
There are VOL, Userdata1, GOV and Userdata2 before each I-VOP.
Data Structure before I-VOP
Item Note
VOL VOL of MPEG-4 Video
Userdata1
Reserved
GOV GOV of MPEG-4 Video
Userdata2
Userdata
Data Structure of Userdata2
Item Example Note
Start Code 0x000001B2 Start code of userdata in MPEG-4 Video
Product Name type = VN-V686U Product Name
Timestamp Timestamp =
20070319161455123UTC
Year, Month, Day, Hour, Minute, Second,
Millisedond, and Time zone
Camera ID camera = Camera01 Camera ID that user can define
Preset Position
Number
position = 0 Indicates preset position number after moving to
preset position. In other cases, position = NA.
Fan status fan = 0 Indicates status of fan. 1 means error.
Intelligent tracking
status
track_status = 0 Indicates status of Intelligent tracking. 0 means
completed, 1 means waiting for specifying target, 2 means
tracking, and 3 means losing.
3. API to Search VN-V686
VN-V686 in LAN can be searched by broadcast packet that includes this API.
Search VN-V686 in LAN
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 VN-V686 that received this packet sends udp packet to the source port number of the search packet.
UDP payload of response packet has model name, IP address, and subnet mask. VN-V686 waits 0-0.7 second before
sending response to avoid too many responses are sent in short period from many VN-V686s.
14
VOL
I-VOP
P-VOP
Response Example system.id=VN-V686U(192.168.0.2/24)&200 OK<CRLF>
4. Getting Alarm from VN-V686
4.1. Procedure
1) The client establishes a TCP connection to port number 32040.
2) When motion is detected from the video image of VN-V686, or when there are changes to the alarm input (make
or break), VN-V686 will send out alarm information in the following format. The first 2 lines indicate the current
alarm input status (make or break). The following 1 line indicates whether motion has been detected.
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.
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, VN-V686 disconnects the TCP connection.
Additionally, VN-V686 will also check whether the TCP connection is maintained at regular intervals. VN-V686 will
disconnect the TCP connection if syn exchange is not performed in 10 minutes.
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.
15
The following is an example of API for Getting subnet mask of VN-V686.
Example
GET /api/param?network.interface.subnetmask HTTP/1.1<CRLF>
Accept: text/plain<CRLF>
Host: 192.168.0.2<CRLF>
Authorization: Basic YWRtaW46dm4tdjY4Ng==<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
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 vn-v686
then the character string joining the user name and the password with a colon is:
admin:vn-v686
Base64 encoding of this string yields YWRtaW46dm4tdjY4Ng==. Enter this in the Authorization line. Default
password for each username is vn-v686.
3) VN-V686 returns a response to the client. In the following example, current subnet mask is 255.0.0.0. In addition,
255.0.0.0 is followed by & and 200 OK, indicating that getting parameter is successful.
Example
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Length: 80<CRLF>
Content-type: text/plain<CRLF>
16
GET space API Characters
space HTTP/1.1 0x0D 0x0A
Accept: text/plain (or text/html)space
0x0D 0x0A
Host: space IP Address of VN-V686 0x0D 0x0A
Authorization: Basic space Encoded User Name and Password 0x0D 0x0A 0x0D 0x0A
Date: Fri, 13 MAY 2005 07:33:12 GMT<CRLF>
Server: JVC VN-V686 API Server<CRLF>
network.interface.subnetmask=255.0.0.0&200 OK<CRLF>
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.
6. API for Getting/Changing Parameters of VN-V686
This section provides description of APIs for getting/changing parameters of VN-V686. Make use of the API
explained in this section in the way as mentioned in Section 5
.
6.1. General
(1) Getting parameter
●
Specify API in GET line according to the format below when getting a parameter from VN-V686.
/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 VN-V686.
/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
17
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 PTZ Controller of built-in viewer. Refer to the instruction manual for details on the Camera page and PTZ
Controller.
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 VN-V686. By status=restore,
changes to camera settings are restored.
Allowed users admin, operator
Getting Camera ID stored in JPEG from VN-V686
Format
/api/param?camera.id
Example of response
camera.id=VN-V686&200 OK
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, s
ee "
Setting Sender
Mail Address for VN-V686".
Example of response
camera.id=Camera01&200 OK
Sender Camera
01<somename@somecompany.com>
Allowed users admin, operator, user
Setting Camera ID in JPEG from VN-V686
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.
18
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, s
ee
"
Setting Sender Mail Address for VN-V686".
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.
Allowed users admin, operator
Getting Monitor Type from VN-V686
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 VN-V686
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 VN-V686
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 VN-V686
Format
/api/param?camera.image.pedestal=data
19
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 "-". The value is mapped to 3 internal levels. It
becomes brighter 1 step by specifying "+", darker 1 step by specifying "-". 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 Gamma from VN-V686
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 VN-V686
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 VN-V686
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 VN-V686
Format
/api/param?camera.image.gamma.activelevel=data
20
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 VN-V686
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 VN-V686
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 VN-V686
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 VN-V686
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 "-". The value is mapped to 11 internal levels. It
21
becomes sharper 1 step by specifying "+", softer 1 step by specifying "-". 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 Color Level from VN-V686
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 levels. The larger the value, the stronger will be the color.
Allowed users admin, operator, user
Setting Color Level for VN-V686
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 "-". The value is mapped to 11 internal levels.
The larger the value, the stronger will be the color. It becomes stronger 1 step by specifying "+", softer 1 step by
specifying "-". 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 from VN-V686
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 VN-V686
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
22
reboot.
Allowed users admin, operator
Getting Stabilizer Level from VN-V686
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
Setting Stabilizer Level for VN-V686
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 "-". "+" or "-" changes the level 1 step.
The level 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
Getting DNR from VN-V686
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.
Allowed users admin, operator, user
Setting DNR for VN-V686
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.
Allowed users admin, operator
23
Getting AGC from VN-V686
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 VN-V686
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 VN-V686
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
Setting Limit of Sense Up for VN-V686
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 "-". 0 means sense up is
disabled. It becomes bigger 1 step by specifying "+", smaller 1 step by specifying "-". The change is saved by the
API, camera.status=save. If the change is not saved, the setting is restored by reboot.
Sense up works when shutter speed is 1/60 or 1/100.
Allowed users admin, operator
Getting ALC priority from VN-V686
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
24
"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 VN-V686
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 VN-V686
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 VN-V686
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
1/60 for example, specify 60. It becomes shorter 1 step by specifying "+", longer 1 step by specifying "-". The
change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.
To set from 250 to 10000, sense up setting must be 0.
Allowed users admin, operator
Getting B&W Mode from VN-V686
Format
/api/param?camera.image.true_daynight
Example of response
camera.image.true_daynight=autoM&200 OK
25
Interpretation Acquire B&W mode. "color", "bw", "autoL", "autoM" or "autoH" is returned.
Allowed users admin, operator, user
Setting B&W Mode for VN-V686
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 VN-V686
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 VN-V686
Format
/api/param?camera.image.true_daynight.af=data
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 VN-V686
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.
26
Allowed users admin, operator, user
Setting Light for focus in B&W mode for VN-V686
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
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 VN-V686
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
27
Setting Iris for VN-V686
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 VN-V686
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 VN-V686
Format
/api/param?camera.iris.status=data
Example to start
/api/param?camera.iris.status=start
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 VN-V686
Format
/api/param?camera.image.white_balance
Example of response
camera.image.white_balance=autoW&200 OK
28
Interpretation Acquire white balance setting. "autoW", "autoN" or "manual" is returned.
Allowed users admin, operator, user
Setting White Balance for VN-V686
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", "manual" or "op_auto". "autoW" works in
wide range, and "autoN" works in narrow range of color. "autoW", "autoN" or current manual value is saved to
preset position by the API, camera(num).status=save. "autoW", "autoN" or current manual value is saved to Auto Pan
and Auto Trace by the API, camera.motion.auto_pan.image=save. If "op_auto" is specified, one push auto white
balance control is done, and setting becomes "manual". 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 R-Gain of White Balance from VN-V686
Format
/api/param?camera.image.white_balance.r
Example of response
camera.image.white_balance.r=s85&200 OK
Interpretation Acquire R-gain of white balance setting. s0 to s255 is returned. The s before number means "step".
Allowed users admin, operator, user
Setting R-Gain of White Balance for VN-V686
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 R-gain white balance setting. Specify s0 to s255. The s before number means "step".
Default value is s85. 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
Getting B-Gain of White Balance from VN-V686
Format
/api/param?camera.image.white_balance.b
Example of response
camera.image.white_balance.b=s219&200 OK
29
Interpretation Acquire B-gain of white balance setting. s0 to s255 is returned. The s before number means "step".
Allowed users admin, operator, user
Setting B-Gain of White Balance for VN-V686
Format
/api/param?camera.image.white_balance.b=data
Example of response
camera.image.white_balance.b&202 Accepted(camera.status=save)
Interpretation Change B-gain white balance setting. Specify s0 to s255. The s before number means "step". 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
Getting Current R-Gain of Auto White Balance from VN-V686
Format
/api/param?camera.image.autowhite_balance.r
Example of response
camera.image.autowhite_balance.r=s85&200 OK
Interpretation Acquire current R-gain of auto white balance. s0 to s255 is returned. The s before number means
"step".
Allowed users admin, operator, user
Getting Current B-Gain of Auto White Balance from VN-V686
Format
/api/param?camera.image.autowhite_balance.b
Example of response
camera.image.autowhite_balance.b=s219&200 OK
Interpretation Acquire current B-gain of auto white balance. s0 to s255 is returned. The s before number means
"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 VN-V686
Format
/api/param?camera.image.blc
30
Loading...