JVC VN-V685U, 686BU, 686U User Manual

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

Updates

tracking.

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

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.

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.

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

This document describes APIs of VN-V685/686/686B. Differences of VN-V685, VN-V686 and

All white balance mode

"autoFull" and "sodium" are

e modes are

VN-V686B are as below.

Function VN-V685 VN-V686 VN-V686B

Maximum Optical

x27 x36 x36

Zoom

White Balance Mode

s are available

not available

All white balanc 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

available none available

Discovery Protocol

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

boundary structure shows file size of each JPEG file. Using the size, reading the whole JPEG data becomes easy.

HTTP Response

boundary

pan/tilt/zoom information

boundary

Content

Length: 31614<CRLF><CRLF>

ntent-Length: 32756<CRLF><CRLF>

-foo<CRLF> Content-Type: image/jpeg<CRLF>

JPEG (No. 1)

JPEG (No. 1) <CRLF>

-foo<CRLF> Content-Type: image/jpeg<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.

JPEG (No. 1)

JPEG (No. 2)

,,,

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.

GET API space

space

HTTP/1.1

0x0D 0x0A 0x0D 0x0A

0x0D 0x0A

Host:

space

IP Address of VN

V685/

686/686B

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

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

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 FFE0 FFFE FFFE FFC4 FFDB FFDD FFC0 FFDA FFD9

Start Code Application Segment Comment Segment 1 Comment Segment 2 (reserved) DHT Huffman Table DQT Quantization Table DRI Restart Interval SOF Frame Information Data Start Segment 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

File Size Width Height Model Name

9 JVC V1.0 18 size = 123456

13 width = 640 14 height = 480 18 type = VN-V685U

Indicates the version of information stored in the comment segment. Indicates JPEG size in bytes.

Width of JPEG. Height of JPEG. Name of model that created the JPEG.

(reserved) 12 reverse = 0 (reserved)

Time Stamp

70 Timestamp =

20071014130509123

Indicates the time when the JPEG is created. This is made up of the year/month/day, hour/minute/second, millisecond and timezone code.

UTC

(reserved) 13 alarm = 00000000 (reserved)

Camera ID Motion Detect Setting Motion Detect Result

50 camera = input01 11 motion = 1 7 md = 1

Stores camera information set at VN-V685/686/686B. Specified as 1 when the motion detect is ON. Specified as 1 if motion is detected at the time when JPEG

is created.

Intelligent tracking

. 0 means

g target, 2 means

from

Target position of

track_area =

. The

Target color of

k_color =

Indicates color of Intelligent tracking target. The

V685/686B

w i d t h = 6 4 0 0x00

0x00

name

space

value

(stuffed with 0x00)

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.

17 track_status = 0 Indicates status of Intelligent tracking

status

Intelligent tracking

90,420-150,460

completed, 1 means waiting for specifyin

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

VN-V685/686B v2.00.

Indicates position of Intelligent tracking target

numbers are top left position and bottom right position.

* In VN-V686 before v1.02, this information is not available

26 trac

Intelligent tracking

10-20-30

numbers are red, green, blue.

* This information is available for VN-

from v2.00.

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 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

GET /api/video?encode=mpeg4 HTTP/1.1<CRLF>

HTTP Response

boundary

pan/tilt/zoom information

boundary

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.

VOP of MPEG-4 (No. 1)

VOP of MPEG-4 (No. 2)

,,,

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.

MPEG-4 VOP (No. 1)

MPEG-4 VOP (No. 2)

GET API space

space

HTTP/1.1

0x0D 0x0A 0x0D 0x0A

0x0D 0x0A

Host:

space

IP Address of VN

V685/686/686B

,,,

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>

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

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-V685/686/686B 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-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.

2.5. MPEG-4 Stream Format Sent Out by VN-V685/686/686B

HTTP R

esponse

VOL

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

P-VOP

I-VOP

P-VOP

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

Preset Position

Intelligent tracking

. 0 means

completed, 1 means waiting for specifying target, 2 means

V686 before v1.02, this information is not

from

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.

track_status = 0 Indicates status of Intelligent tracking

status

tracking, 3 means losing., and 4 means searching.

* In VN-

available.

* "searching" is available for VN-V685/686B

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.

4.2. Restrictions

Accept:

text/plain (or text/html)

space

HTTP/1.1

0x0D 0x0A

Host:

space

IP Address of VN

V685/686/686B

Authorization: Basic

space

Encoded

User Name and Password

0x0D 0x0A 0x0D 0x0A

GET space

API Characters

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 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.

0x0D 0x0A

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

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 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.

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 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-V685/686/686B.

/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-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

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<somename@somecompany.com>

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<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-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, 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-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. 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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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 VN-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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 VN-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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 VN-V685/686B from v3.00, DNR is removed and 3D noise reduction is added. Refer to the "Getting 3D Noise Reduction from VN-V685/686B" for details. In VN-V685/686B from v3.00, this API is available, but using camera.image.3ddnr, is recommended. When "camera.image.3ddnr" is "off", "off" is returned. When "camera.image.3ddnr" is not "off", "on" is returned.

Allowed users admin, operator, user

Setting DNR for VN-V685/686/686B

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 VN-V685/686B from v3.00, DNR is removed and 3D noise reduction is added. Refer to the "Setting 3D Noise Reduction for VN-V685/686B" for details. In VN-V685/686B from v3.00, this API is available, but using camera.image.3ddnr, is recommended. When "off" is set, "camera.image.3ddnr" is set to "off". When changed from "off" to "on", "camera.image.3ddnr" is restored to previous setting, "low", "mid" or "high".

Allowed users admin, operator

Getting 3D Noise Reduction from VN-V685/686B

Format /api/param?camera.image.3ddnr

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 VN-V685/686B from ver3.00. 3D Noise Reduction improves noise in dark image.

Allowed users admin, operator, user

Setting 3D Noise Reduction for VN-V685/686B

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

VN-V685/686B from ver3.00. 3D Noise Reduction improves noise in dark image. 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 AGC from VN-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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 VN-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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 VN-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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 VN-V685/686/686B

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-V685/686/686B

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 VN-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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-V685/686/686B

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 VN-V685/686/686B

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 VN-V686 before v1.02, "autoFull" and "sodium" are not available. "autoW" works in wide range, "autoN" works in narrow range, and "autoFull" works in more wide range than "autoW" of color. "sodium" works in sodium lamp of color. "autoW", "autoN", "autoFull", "sodium" or current manual value is saved to preset position by the API, camera(num).status=save. "autoW", "autoN", "autoFull", "sodium" 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-V685/686/686B

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

+ 81 hidden pages