JVC VN-686BU User manual

1
IP Camera
VN-V685U/686U/686BU
API GUIDE
This document provides a description of protocols and API of
VN-V685/686/686B.
2009.3.13. JVC
LST0856-001A

2
Updates
Version Date Updates
1.00 2008/10/16 First release.
1.01 2008/10/31 P17. Typo is fixes. (difference -> different)
1.02 2009/02/03 Garbled characters are fixed.
1.03 2009/03/13 P10, P15
"searching" is added to status of Intelligent tracking.
Target color is added to information of Intelligent
tracking.
P24-25
API for 3D noise reduction is added.
P88-89
API for mode of JPEG streaming is added.
P91.
Discription that access restricstions are applied to
bidrection audio is deleted.

3
Custom Application Software Development Guide
VN-V685/686/686B can be used from a custom application software by utilizing the API and
protocols for VN-V685/686/686B. The following operations are possible.
- Getting JPEG from VN-V685/686/686B.
- Getting MPEG-4 from VN-V685/686/686B.
- Getting Alarm from VN-V685/686/686B.
- Getting or changing VN-V685/686/686B settings.
- Pan/Tilt/Zoom/Focus operation of VN-V685/686/686B.
- Sending Multicast from VN-V685/686/686B.
- Customization of VN-V685/686/686B's built-in viewer.

4
Content
1. Getting JPEG from VN-V685/686/686B via HTTP
2. Getting MPEG-4 from VN-V685/686/686B via HTTP
3. API to Search VN-V685/686/686B
4. Getting Alarm from VN-V685/686/686B via TCP
5. Using API that Requires Basic Authentication
6. API for Getting/Changing Parameters of VN-V685/686/686B
7. List of Protocols and Port Numbers Used with VN-V685/686/686B
8. Customizing VN-V685/686/686B's Built-in Viewer
9. FAQ

5
This document describes APIs of VN-V685/686/686B. Differences of VN-V685, VN-V686 and
VN-V686B are as below.
Function VN-V685 VN-V686 VN-V686B
Maximum Optical
Zoom x27 x36 x36
White Balance Mode
All white balance mode
s are available
"autoFull" and "sodium" are
not available All white balanc
e modes are
available
3D Noise Reduction
available(from v3.00)
available(from v3.00) none
Click on Center available available (from v1.04) available
Intelligent Tracking
available available (from v1.03) available
IPv6 available none available
AMX Device
Discovery Protocol available none available
VSIP available none available
1. Getting JPEG from VN-V685/686/686B 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-V685/686/686B returns HTTP response.
Example of VN-V685
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-type: multipart/x-mixed-replace;boundary=-foo<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC VN-V685 Network Camera<CRLF>
x-vnv685_response:
encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF>
4) VN-V685/686/686B 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

6
boundary structure shows file size of each JPEG file. Using the size, reading the whole JPEG data becomes easy.
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>
HTTP Response
JPEG (No. 1)
JPEG (No. 2) <CRLF>
,,,
HTTP Response
JPEG (No. 1)
JPEG (No. 2)
,,,
boundary
pan/tilt/zoom information
pan/tilt/zoom information
boundary
JPEG (No. 1) <CRLF>
-foo<CRLF>
Content-Type: image/jpeg<CRLF>
Content
-
Length: 31614<CRLF><CRLF>
-foo<CRLF>
Content-Type: image/jpeg<CRLF>
Co
ntent
-
Length: 32756<CRLF><CRLF>

7
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-V685/686/686B 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.
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-V685/686/686B sends 1 frame of JPEG data, and disconnect the
GET
API
space
space
HTTP/1.1
0x0D 0x0A 0x0D 0x0A
0x0D 0x0A
Host:
space
IP Address of VN
-
V685/
686/686B

8
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-V685/686/686B will return 200 OK. The x-vnv685_response or x-vnv686_response line indicates actual
parameters.
Example of VN-V685
HTTP/1.1 200 OK<CRLF>
Content-Type: multipart/x-mixed-replace;boundary=--foo<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC VN-V685 Network Camera<CRLF>
x-vnv685_response:
encode=jpeg&framerate=30&framesize=vga&boundary=on&ptz_info=off<CRLF><CRLF>
When API is successfully received with boundary=off
VN-V685/686/686B will return 200 OK. Content-Length shows file size of first JPEG. The x-vnv686_response line
indicates actual parameters.
Example of VN-V685
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Length: 27616<CRLF>
Content-Type: image/jpeg<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC VN-V685 Network Camera<CRLF>
x-vnv685_response:
encode=jpeg&framerate=30&framesize=vga&boundary=off&ptz_info=off<CRLF><CRLF>
1.4. Restrictions

9
Access restriction
VN-V685/686/686B 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-V685/686/686B disconnects the TCP connection after API is
sent.
Restriction by maximum bitrate of VN-V685/686/686B
The maximum bitrate of VN-V685/686/686B 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-V685/686/686B
JPEG file from VN-V685/686/686B is JFIF compliant and consist of the following.
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. In VN-V686 before v1.02,
Intelligent tracking status" and "Target position of Intelligent tracking" are not available.
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-V685U Name of model that created the JPEG.
(reserved) 12 reverse = 0 (reserved)
Time Stamp 70 Timestamp =
20071014130509123
UTC
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-V685/686/686B.
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

10
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 specifyin
g target, 2 means
tracking, 3 means losing., and 4 means searching.
* In VN-V686 before v1.02,this information isnot available.
* "searching" is available for VN-V685/686B
from
VN-V685/686B v2.00.
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.
* In VN-V686 before v1.02, this information is not available
Target color of
Intelligent tracking 26 trac
k_color =
10-20-30
Indicates color of Intelligent tracking target. The
numbers are red, green, blue.
* This information is available for VN-
V685/686B
from v2.00.
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-V685/686/686B via HTTP
2.1. Basic Procedures
1) The client establishes a TCP connection to port number 80.
2) The client sends out API.
Example
w
i
d
t
h
=
6
4
0
0x00
0x00
name
=
space
space
value
(stuffed with 0x00)
fixed length for each item

11
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-V685/686/686B returns HTTP response.
Example of VN-V685
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Type: video/mp4v-es<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC VN-V685 Network Camera<CRLF>
x-vnv685_response:
encode=mpeg4&framerate=15&framesize=vga&ptz_info=off<CRLF><CRLF>
4) VN-V685/686/686B sends out MPEG-4 data after returning HTTP response.
HTTP Response and MPEG-4 stream sent out by VN-V685/686/686B 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.
HTTP Response
VOP of MPEG-4 (No. 1)
,,,
VOP of MPEG-4 (No. 2)
HTTP Response
MPEG-4 VOP (No. 1)
MPEG-4 VOP (No. 2)
boundary
pan/tilt/zoom information
pan/tilt/zoom information
boundary

12
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.
Details of MPEG-4 stream is explained later.
5) When the client wants to stop current MPEG-4 transmission, the client disconnects TCP80.
VN-V685/686/686B 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>
GET
API
space
space
HTTP/1.1
0x0D 0x0A 0x0D 0x0A
0x0D 0x0A
Host:
spac
e
IP Address of VN
-
V685/686/686B
,,,

13
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.
2.3. Response
When API is successfully received
VN-V685/686/686B will return 200 OK. The x-vnv686_response line indicates actual parameter.
Example of VN-V685
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Type: video/mp4v-es<CRLF>
Date: Tue, 02 Oct 2008 07:33:12 GMT<CRLF>
Server: JVC VN-V685 Network Camera<CRLF>
x-vnv685_response:
encode=mpeg4&framerate=30&framesize=vga&ptz_info=off<CRLF><CRLF>
MPEG-4 framerate can be changed byWeb page or API. WhenMPEG-4 framerateis changed, the framerate of current
stream is changed also.
2.4. Restrictions
Access restriction
VN-V685/686/686B has access restriction feature that enables to denyaccess from a specific IP address. If MPEG-4 is
requested from the IP address of access restriction, VN-V685/686/686B disconnects the TCP connection after API is
sent.
Restriction by maximum bitrate of VN-V685/686/686B
The maximum bitrate of VN-V685/686/686B 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.

14
2.5. MPEG-4 Stream Format Sent Out by VN-V685/686/686B
MPEG-4 stream from VN-V685/686/686B 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
There are VOL, Userdata1, GOV and Userdata2 before each I-VOP. In VN-V686 before v1.02, "Intelligent tarcking
status" of Userdata2 is not available.
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-V685U 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
HTTP R
esponse
P-VOP
P-VOP
I-VOP
P-VOP
VOL
P-VOP

15
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, 3 means losing., and 4 means searching.
* In VN-
V686 before v1.02, this information is not
available.
* "searching" is available for VN-V685/686B
from
VN-V685/686B v2.00.
3. API to Search VN-V685/686/686B
VN-V685/686/686B in LAN can be searched by broadcast packet that includes this API.
Search VN-V685/686/686B 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-V685/686/686B 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-V685/686/686B waits
0-0.7 second before sending response to avoid too many responses are sent in short period from many
VN-V685/686/686Bs.
Response Example of VN-V685 system.id=VN-V685U(192.168.0.2/24)&200 OK<CRLF>
4. Getting Alarm from VN-V685/686/686B
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-V685/686/686B, or when there are changes to the alarm input
(make or break), VN-V685/686/686B 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.

16
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-V685/686/686B disconnects the TCP connection.
Additionally, VN-V685/686/686B will also check whether the TCP connection is maintained at regular intervals.
VN-V685/686/686B 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 isrequired for APIs which are explained in Section 6. Thissection 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 VN-V685/686/686B.
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
Accept:
text/plain (or text/html)
space
space
HTTP/1.1
0x0D 0x0A
Host:
space
IP Address of VN
-
V685/686/686B
0x0D 0x0A
Authorization: Basic
space
Encoded
User Name and Password
0x0D 0x0A 0x0D 0x0A
GET
space
API Characters
0x0D 0x0A

17
encoded usernameand 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 VN-V685 and VN-V686B are different from VN-V686.
VN-V686
username default password
admin vn-v686
operator vn-v686
user vn-v686
VN-V685 and VN-V686B
username default password
admin jvc
operator jvc
user jvc
3) VN-V685/686/686B 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 of VN-V685
HTTP/1.1 200 OK<CRLF>
Connection: close<CRLF>
Content-Length: 80<CRLF>
Content-type: text/plain<CRLF>
Date: Fri, 13 MAY 2005 08:33:12 GMT<CRLF>
Server: JVC VN-V685 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.

18
6. API for Getting/Changing Parameters of
VN-V685/686/686B
This section provides description of APIs for getting/changing parameters of VN-V685/686/686B.Make useofthe 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-V685/686/686B.
/api/param?ParamA.ParamB.ParamC
The upper limit of this character string is 1024 bytes.
When acquisition is successfullycompleted, 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-V685/686/686B.
/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

19
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-V685/686/686B. By status=restore,
changes to camera settings are restored.
Allowed users admin, operator
Getting Camera ID stored in JPEG from VN-V685/686/686B
Format /api/param?camera.id
Example of response camera.id=VN-V685&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, see "Setting Sender Mail
Address for VN-V685/686/686B".
Example of response camera.id=Camera01&200 OK
Sender Camera01<[e-mail]>
Allowed users admin, operator, user
Setting Camera ID in JPEG from VN-V685/686/686B
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 VN-V685/686/686B".
Example of setting /api/param?camera.id=Camera01
Sender Camera01<[e-mail]>
The change is saved by the API, camera.status=save. If the change is not saved, the setting is restored by reboot.

20
Allowed users admin, operator
Getting Monitor Type from VN-V685/686/686B
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-V685/686/686B
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,
enhancebandsettingand gamma settingare ignored. The change is saved bythe API, camera.status=save. Ifthe change
is not saved, the setting is restored by reboot.
Allowed users admin, operator
Getting Black level from VN-V685/686/686B
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-V685/686/686B
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. Specify0 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