Network Camera Server WebView HTTP Protocol Specifications...

Network Camera Server

WebView HTTP Protocol

Specifications

Ver. 1.0

BIE-7082-001

February 27, 2015

CANON INC.

DRAFT

Revision History

Version Release Date Location Changes

1.0 February 27,

2015 - First edition

Table of Contents

1 Introduction .......................................................................................................................... 1

1.1 Use of this Document................................................................................................. 1

1.2 Supported Products ................................................................................................... 1

1.3 Notation ...................................................................................................................... 2

2 Related Documents .............................................................................................................. 3

3 Terms .................................................................................................................................... 4

4 Protocol Overview ................................................................................................................ 6

5 WebView HTTP Protocol Specifications ............................................................................. 7

5.1 Interface Specifications ............................................................................................. 7

5.1.1 Request ............................................................................................................. 7

5.1.1.1 HTTP Request Header ........................................................................... 8

5.1.2 Response ........................................................................................................... 8

5.1.2.1 HTTP Status ........................................................................................... 9

5.1.2.2 Livescope Status ................................................................................... 10

5.1.3 Protocol Configuration ................................................................................... 11

5.1.3.1 Command List ...................................................................................... 11

5.1.3.2 Protocol Syntax..................................................................................... 11

5.1.4 Sessions and Access Privileges...................................................................... 13

5.1.4.1 Client and Session Management ......................................................... 13

5.1.4.2 User Type of User Access Control Function ....................................... 14

5.1.4.3 Privilege Settings and Session Priority .............................................. 15

5.1.4.4 Creating a Session and Applied Restrictions ..................................... 15

5.1.4.5 User Types and Creatable Session Types ........................................... 16

5.1.4.6 Closing a Session .................................................................................. 16

5.1.4.7 Limits on the Number of Clients ......................................................... 16

5.1.4.8 Session-based Access Privileges by Function ..................................... 18

5.1.4.9 Sessionless Access Privileges by Function ......................................... 19

5.2 Command Specifications ......................................................................................... 21

5.2.1 Session Control ............................................................................................... 25

5.2.1.1 Creating a Session [open.cgi] ............................................................. 25

5.2.1.1.1 Commands ................................................................................. 25

5.2.1.1.2 Response ..................................................................................... 27

5.2.1.2 Closing a Session [close.cgi] ............................................................... 31

5.2.1.2.1 Commands ................................................................................. 31

5.2.1.2.2 Response ..................................................................................... 31

5.2.1.3 Camera Control Privilege Request [claim.cgi] .................................. 32

5.2.1.3.1 Commands ................................................................................. 37

5.2.1.3.2 Response ..................................................................................... 37

5.2.1.4 Releasing Camera Control Privileges [yield.cgi] ............................... 39

5.2.1.4.1 Commands ................................................................................. 39

5.2.1.4.2 Response ..................................................................................... 40

5.2.1.5 Changing Session Attributes [session.cgi]........................................ 41

5.2.1.5.1 Commands ................................................................................. 41

5.2.1.5.2 Response ..................................................................................... 43

5.2.2 Video Retrieval ............................................................................................... 46

5.2.2.1 Still Image Retrieval [image.cgi] ....................................................... 46

5.2.2.1.1 Commands ................................................................................. 47

5.2.2.1.2 Response ..................................................................................... 50

5.2.2.2 Video Stream Retrieval [video.cgi] .................................................... 52

5.2.2.2.1 Commands ................................................................................. 52

5.2.2.2.2 Response ..................................................................................... 55

5.2.3 Information Acquisition ................................................................................. 57

5.2.3.1 Information Acquisition [info.cgi] ...................................................... 57

5.2.3.1.1 Commands ................................................................................. 63

5.2.3.1.2 Response ..................................................................................... 64

5.2.3.1.3 System Information [s] .............................................................. 70

5.2.3.1.4 Video Information [v] ................................................................ 70

5.2.3.1.5 Video Information [w] ............................................................... 71

5.2.3.1.6 Camera Information [c] ............................................................. 74

5.2.3.1.7 Camera Correction Information [c] .......................................... 75

5.2.3.1.8 Focus Zoom Information [c] ...................................................... 80

5.2.3.1.9 Pan/Tilt Information [c] ............................................................ 82

5.2.3.1.10 Auto Flip Setting Information [c] ........................................... 85

5.2.3.1.11 View Restrictions Setting Information [c] ............................. 85

5.2.3.1.12 Panorama Image Information [c] ........................................... 86

5.2.3.1.13 Home Position Setting Information [c] .................................. 86

5.2.3.1.14 Contact Input/Output Information [i/o] ................................ 89

5.2.3.1.15 Preset Information [p] ............................................................. 90

5.2.3.1.16 Extension Preset Information [p] ........................................... 92

5.2.3.1.17 Intelligent Function Information [r] ...................................... 96

5.2.3.1.18 Audio Device Information [a] .................................................. 98

5.2.3.1.19 User Event Information [e] ..................................................... 98

5.2.3.1.20 Linked Event Information [l] .................................................. 99

5.2.3.1.21 External Memory Information [f] ........................................... 99

5.2.3.2 Get Panorama Image [panorama.cgi] ............................................. 100

5.2.3.2.1 Commands ............................................................................... 100

5.2.3.2.2 Response ................................................................................... 101

5.2.4 Camera Control ............................................................................................ 102

5.2.4.1 Camera Control [control.cgi] ............................................................ 102

5.2.4.1.1 Commands ............................................................................... 106

5.2.4.1.2 Camera Control Privileges [s] ................................................ 107

5.2.4.1.3 Camera Correction-related [c] ................................................ 107

5.2.4.1.4 Camera Operation-related [c] ................................................. 112

5.2.4.1.5 Camera Platform-related [c] ................................................... 114

5.2.4.1.6 View Restrictions Setting Information [c] ............................. 119

5.2.4.1.7 Contact Output [o] .................................................................. 119

5.2.4.1.8 Extension Presets [p] .............................................................. 119

5.2.4.1.9 User Event [e] .......................................................................... 120

5.2.4.1.10 Digital PTZ [w] ...................................................................... 120

5.2.4.1.11 Response ................................................................................. 122

5.3 Items Related to the WebView Settings Protocol ................................................ 124

Appendix ................................................................................................................................... 129

A List of Differences by Function or Series ................................................................. 129

A.1 Focus Function ............................................................................................. 130

A.2 Full HD Function ......................................................................................... 142

A.3 PTZ and Digital PTZ Function .................................................................... 151

A.4 View Restrictions Function ......................................................................... 208

A.5 Panorama Function ..................................................................................... 214

A.6 Angle of View Linkage Function ................................................................. 220

A.7 Multilingual Support ................................................................................... 231

A.8 Image Stabilizer ........................................................................................... 237

A.9 Exposure Function ....................................................................................... 241

A.10 Audio Function ............................................................................................. 248

A.11 Haze Compensation Function ..................................................................... 251

A.12 Infrared Function ......................................................................................... 257

A.13 Auto Flip Function ....................................................................................... 265

A.14 Home Position Function .............................................................................. 271

A.15 Preset Function ............................................................................................ 277

A.16 Contact Input/Output Function .................................................................. 282

A.17 Intelligent Function ..................................................................................... 287

A.18 Linked Event Function ................................................................................ 290

A.19 External Memory Information .................................................................... 293

A.20 System Information ..................................................................................... 295

A.21 Array Valid Value Information ................................................................... 298

A.22 Video Quality ................................................................................................ 301

B Support for Commands of Older Models .................................................................. 305

B.1 Compatibility of Information Items ............................................................ 306

C JPEG Header Information ........................................................................................ 311

C.1 JPEG Image Data Format ........................................................................... 311

C.2 JPEG Header Information [APP0] .............................................................. 311

D H.264 Transmission Function .................................................................................. 315

D.1 H.264 Image Parameters ............................................................................. 315

D.2 Fragmented MP4 ......................................................................................... 317

E HTTP Upload Specifications ..................................................................................... 319

E.1 Upload Event Triggers................................................................................. 319

E.2 Upload Settings ............................................................................................ 320

E.3 Request ......................................................................................................... 325

F VB-Discovery ............................................................................................................. 326

F.1 Sequence ....................................................................................................... 326

F.2 Packet Format .............................................................................................. 327

G Linked Event ............................................................................................................. 330

G.1 Linked Event Operation Example .............................................................. 330

1

1 Introduction

These specifications specify the WebView HTTP protocol, which is one of the Canon

Network Camera Server WebView protocols.

With the WebView HTTP protocol, you can control video transmission to a Canon

network camera and control the camera.

1.1 Use of this Document This document is for developers of applications using the Canon network camera. Use

of this document requires knowledge of application development.

1.2 Supported Products This document was designed for the following Canon network cameras.

Canon Network Camera VB-S30D



Canon Network Camera VB-S900F


Canon Network Camera VB-S905F

Canon Network Camera VB-H43

Canon Network Camera VB-H630VE

Canon Network Camera VB-H630D

Canon Network Camera VB-H730F

Canon Network Camera VB-M42

Canon Network Camera VB-M620VE

Canon Network Camera VB-M620D

Canon Network Camera VB-M720F

Canon Network Camera VB-R11VE

Canon Network Camera VB-R11

Canon Network Camera VB-R10VE


Canon Network Camera VB-M641V


Canon Network Camera VB-M640V

Canon Network Camera VB-M741LE

2

Canon Network Camera VB-M740E

1.3 Notation The following notation and text formatting are used in this document.

“Courier New” Indicates a code sample.

“Italic” Indicates a parameter replaceable with an actual name or value.

“Verdana 0…50” Indicates a parameter or setting value.

“<Verdana>” Indicates a variable.

“Note:” Indicates a special note or precaution.

“!” Indicates an example of the occurrence of a phenomenon.

“XXXXXX ” Indicates a reference document.

‘XXXXXX ’ Indicates a reference chapter or section.

If the specifications for each product differ from those listed in this chapter, the

differences are listed in ‘AppendixA List of Differences by Function or Series ’.

Areas listed in “Reference to Differences” as “** Difference caution **” are parts

with new functions or significantly added functions. It is recommended that you

refer to the list of differences (‘AppendixA List of Differences by Function or

Series ’).

3

2 Related Documents

The Canon network camera server WebView protocol specifications include the

following documents.

Protocol specifications

Network Camera Server WebView Protocol Overview

Network Camera Server WebView HTTP Protocol Specifications (this

document)

Network Camera Server WebView Settings Protocol Specifications

Network Camera Server WebView Audio Protocol Specifications

Network Camera Server WebView Data Protocol Specifications

Network Camera Server WebView Memory Card Protocol Specifications

4

3 Terms

Terms Description

AGC Automatic Gain Control.

In this document, this refers to the automatic exposure control

limiter.

CBR value Constant Bit Rate value.

In this document, this refers to the value indicating the amount of

H.264-compressed data per second.

DDNS Dynamic Updates in the Domain Name System.

RFC2136: http://tools.ietf.org/html/rfc2136

H.264 The video encoding method standardized jointly by ITU-T and

ISO/IEC.

http://www.itu.int/rec/T-REC-H.264

JPEG Digital video image compression method. Abbreviation of Joint

Photographic Experts Group. Generally refers to the image data

formed by using the JPEG compression method.

MPEG4 A diverse multimedia encoding format (standardized by ISO/IEC

14496) that can handle a wide range of video and audio. H.264 is

standardized by ISO/IEC 14496-10 Advanced Video Coding.

Q value Quantized parameter value given to discrete cosine

transformation (DCT) used in video image compression.

In this document, this refers to the value abstracted to levels of

video image quality, not the quantized parameter value itself.

realm String expressing the “area” that indicated the user privileges to

be used shown in HTTP Basic authentication and Digest

authentication.

RFC2616 : http://tools.ietf.org/html/rfc2616


RTP Real-time Transport Protocol.



RTSP Real Time Streaming Protocol.


Aperture correction Function that corrects the decrease in high amplitude of a video

signal.

Intelligent functions In this document, this collectively refers to the network camera

functions Moving Object Detection, Removed Object Detection,

Abandoned Object Detection, Camera Tampering Detection, and

Passing Detection.

http://tools.ietf.org/html/rfc2136

http://www.itu.int/rec/T-REC-H.264






5

Terms Description

Digital PTZ PTZ stands for Pan, Tilt, and Zoom. Function that enables PTZ

using digital processing without using a mechanical PTZ

mechanism.

Smart Shade Control Function that corrects only the contrast in dark areas to make

the subject easier to see when the subject is difficult to see due to

a bright background.

One-shot AF Function that focuses automatically using the autofocus (AF)

function and then stops in manual focus.

6

4 Protocol Overview

The WebView HTTP protocol (“WV-HTTP”) is a WebView protocol that provides

functions for controlling the camera and video transmission to the network camera.

WV-HTTP is provided as an HTTP service of the network camera.

Fig. 4-1 WebView Protocol Concept Diagram

HTTP server

- WebView HTTP protocol

- WebView settings protocol

- WebView audio protocol

- WebView data protocol

- WebView memory card protocol

Canon network camera Client

Router/firewall

Client

- User application

- Web browser

Internet

WAN

LAN

HTTP request →

← HTTP response

Client

- User application

- Web browser

7

5 WebView HTTP Protocol Specifications

5.1 Interface Specifications The interface specifications of WV-HTTP are described in the following order.

- Request format and content

- Response format and content, and list of status codes

- Protocol command configuration, syntax format

- User access management function, session/sessionless and function execution

privileges

5.1.1 Request

In WV-HTTP, WV-HTTP commands are used to perform video transmission and

camera control. The WV-HTTP command is received by the HTTP server of the

network camera as an HTTP request.

- The WV-HTTP protocol is not dependent on a specific HTTP version.

- The network cameras supported by this document are HTTP/1.1-compliant.

- GET or POST can be used as the HTTP method.

- The URI is made up of a WV-HTTP command or parameter that starts with “/-

wvhttp-01-/”.

- With the exception of the starting “wvhttp”, the URI and message body are not

case-sensitive.

Syntax:

GET /-wvhttp-01-/<Command>[?<ParameterList>…] HTTP/1.1

8

5.1.1.1 HTTP Request Header

The following is the HTTP request header field related to operation of WV-HTTP.

All other HTTP request headers are ignored.

Authorization

Connection

Content-Length

If-Modified-Since *1

Note:

*1 If-Modified-Since is referenced with a get still image or panorama image command.

5.1.2 Response

Under WV-HTTP, image data and camera status information is sent from the HTTP

server of the network camera as an HTTP response.

Response:

HTTP/1.1 200 OK

Date: <TimeStamp>

Server: VB

Accept-Ranges: none

Cache-Control: no-cache

Pragma: no-cache

Connection: keep-alive

Keep-Alive: timeout=10

Livescope-Status: 0

Content-Length: <MessageBodyLengthValue>

Content-Type: <MessageBody’s mime-type>

<MessageBody>

9

5.1.2.1 HTTP Status

The execution result of the HTTP protocol of the WV-HTTP command is returned with

an HTTP status. The main return values and meanings are described below.

Table 5-1 List of Returned HTTP Statuses

HTTP Status Description

200 OK Request was processed normally.

304 Not Modified Data is not modified.

400 Bad Request Request is invalid.

401 Unauthorized User authentication failed.

404 Not Found Resource corresponding to requested URI does not exist.

411 Length Required Content-Length is not specified.

500 Internal Server Error Request denied due to internal processing error.

503 Service Unavailable Request denied due to temporary overload.

10

5.1.2.2 Livescope Status

Livescope status is an independent extension field that indicates the execution result of

the WV-HTTP command. If the Livescope status indicates an abnormality, “200 OK” is

returned as the HTTP status. The return values and meanings are described below.

Table 5-2 List of Returned Livescope Statuses

Livescope Status Description

0 Processed normally.

301 No Camera Control Right Request denied due to no issuing of the control privilege

request.

Note: For details on the camera control privileges, see ‘5.1.4

Sessions and Access Privileges ’.

302 Camera is not available Camera specified with <Camera> parameter does not exist.

Note: For details on the <Camera> parameter, see the

notation in ‘5.2 Command Specifications ’.

303 Camera is not

controllable

Camera cannot be controlled due to a camera abnormality.

401 Unknown Operator Undefined command specified.

403 Invalid Parameter Value Invalid parameter value specified.

404 Operation Timeout Command execution not completed even at response time

limit.

406 Parameter Missing Required parameter not specified.

407 Invalid Request Invalid session function requested.

408 Conflict Exclusive operation requested.

409 Conflict Recording stream requested while migrating video to external

memory.

501 Unknown Connection ID Specified session does not exist.

503 Too many clients Maximum number of connections exceeded.

Note: For details on the maximum number of connections,

see the WebView settings protocol > “Maximum

number of clients (ha03)” setting value in ‘5.3 Items

Related to the WebView Settings Protocol ’.

507 Insufficient Privilege Cannot access due to access privilege.

508 Request Refused Request denied due to temporary connection limit of camera.

11

5.1.3 Protocol Configuration

5.1.3.1 Command List

The following are the functions provided by WV-HTTP and the corresponding

commands.

Open, update, and close a session [open.cgi,session.cgi,close.cgi]

Get and release camera control privileges [claim.cgi,yield.cgi] *1

Get image data [image.cgi,video.cgi] *2

Get panorama image data [panorama.cgi] *3

Get information [info.cgi] *2

Control camera [control.cgi] *2

Note:

*1 To get or release the control privilege with claim.cgi or yield.cgi, a session must be

started. For details on sessions, see ‘5.1.4 Sessions and Access Privileges ’.

*2 image.cgi, video.cgi, info.cgi, and control.cgi can be used sessionless. However, when

control.cgi is used sessionless, the camera control privileges are acquired and operated

internally.

*3 Although panorama.cgi basically requires the starting of a session, an administrator

can also use it as a sessionless cgi.

5.1.3.2 Protocol Syntax

A WV-HTTP command is made up of a command name and parameter. The following

are the syntax conditions when specifying a command and parameter.

- The parameter is in the format “<Name>=<Value>”.

- The parameter is specified with the “&” separator in the URI query string.

- The parameter performs URL encoding.

- The parameter name and value may be partially abbreviated with the “[...]”

notation. *1

- There are no limitations in the order of parameter specification. *2

Note:

*1 Most parameters can be abbreviated under WV-HTTP. Parameters that cannot be

abbreviated are indicated with “Required”.

*2 If a parameter is specified multiple times, only the last specified parameter is used

unless it is a parameter that can be specified multiple times.

12

Example:

http://192.168.100.1/-wvhttp-01-/image.cgi?pan=1000&tilt=1000

Note:

WV-HTTP does not support pipelining even when conforming with HTTP/1.1.

13

5.1.4 Sessions and Access Privileges

5.1.4.1 Client and Session Management

WV-HTTP can be used in two ways: session-based, in which a session is created and a

series of command operations are performed; and sessionless, in which a command

operation is performed per each request and response.

The following types of clients are available when using WV-HTTP session-based and

sessionless.

Session-based

□ Normal session

In a normal session, the session ID is specified and a series of command operations

are performed.

It has the following functions:

- Priority camera control when creating a session (claim.cgi, control.cgi)

- Use video stream set when creating a session (image.cgi, video.cgi)

- Get difference in information items when using a session-specified event stream

(info.cgi)

- Get session-specified panorama image (panorama.cgi)

- Change priority/video stream setting by changing session attribute (session.cgi)

□ Video-less session

In a video-less session, a session is created without using the video transmission

function and without selecting a video stream. Other functions are the same as

during a normal session.

- Priority camera control when creating a session (claim.cgi, control.cgi)

- Get difference in information item when using a session-specified event stream

(info.cgi)

- Get session-specified panorama image (panorama.cgi)

Sessionless

□ Event stream - client

An event stream - client is a client that makes a request to get an information item

(info.cgi), in which the stream method is selected, without creating a session.

- Get difference in information item using an event stream (info.cgi)

□ Video stream - client

A video stream - client is a client that gets a video stream (video.cgi) without

creating a session.

14

- Get video stream using a video stream (video.cgi)

- Sessionless camera control (control.cgi)

□ Sessionless camera control

Sessionless camera control is a client that performs camera control (control.cgi)

without creating a session.

- Sessionless camera control (control.cgi)

- Pan, tilt, and zoom control when retrieving a still image (image.cgi) in sessionless

mode

5.1.4.2 User Type of User Access Control Function

The user access control function of the network camera manages the authentication

information of administrators and authorized users. A user with anonymous access

that does not require authentication is called a guest user.

Guest user: Does not require authentication and is not registered to the user list.

Authorized user: Requires user authentication and is registered to the user list.

Administrator: Requires authentication as an administrator.

The user access control function manages and controls the network camera operation

privileges for each of these three types of user. The administrator can use the WebView

settings protocol to configure and change the control privileges for authorized and

guest users.

Table 5-3 Relationship between User Type, Granted Privileges, and Configurable Privilege Type

User Type Overview of Granted Privileges Configurable Privilege Type

Guest user According to video transmission and camera

control privilege settings for guest users

Use commands permitted for guest user

privileges

Video transmission and camera control

not available

Video transmission only available

Video transmission and general camera

control available

Authorized

user

According to video transmission and camera

control privilege settings for authorized users

Use commands permitted for authorized user

privileges

Video transmission and camera control

not available

Video transmission only available

Video transmission and general camera

control available

Video transmission and privileged

camera control available

Administrator No restrictions on video transmission or

camera control due to privilege settings

Use commands that can only be operated with

administrator authorities

Use exclusive commands as an administrator

*No restrictions due to privilege settings

15

5.1.4.3 Privilege Settings and Session Priority

In a WV-HTTP session, camera control privilege settings are applied according to the

user access control function. The value indicating the level of the camera control

privileges in a WV-HTTP session is called the priority. A session-based client must

obtain camera control privileges (claim.cgi) to control a camera, and higher priority

sessions can obtain camera control privileges first.

Sessions interrupted by a higher priority session must forfeit camera control privileges.

For details on obtaining and forfeiting camera control privileges, see ‘5.2.1.3 Camera

Control Privilege Request [claim.cgi] ’.

5.1.4.4 Creating a Session and Applied Restrictions

A WV-HTTP session is created with a session creation request (open.cgi). The type of

session (general, privileged, or administrator) is determined by the “priority”

parameter specified when the session is created or the “type” parameter.

- The type of session (general or privileged) is determined by the “priority” parameter

specified to the session creation request command.

- The session connection time is limited by the “Maximum connection time (ha06)”

setting of the WebView settings protocol.

- The number of simultaneous session connections is limited by the “Maximum

number of clients (ha03)” setting of the WebView settings protocol.

- The camera control privileges of the administrator are determined by the “type”

parameter specification.

- The administrator session is limited to only one, and there are no restrictions on the

session connection time or number of connections.

Table 5-4 Session Privilege Types and Their Features

Session Type priority/type Description

General session priority=0 Session connection time is limited by “Maximum

connection time”.

Number of simultaneous session connections is limited

by “Maximum number of connections”.

Privileged session priority=5...50 Session connection time is unlimited.


by “Maximum number of connections”.

Administrator

session type=admin Session connection time is unlimited.


to 1.

Note:

Priorities 1 to 4 are reserved, and if specified, it may be treated as 5.

16

5.1.4.5 User Types and Creatable Session Types

In a WV-HTTP session, the session types that can be created are limited according to

the user type.

Table 5-5 Relationship between User Types and Creatable Session Types

User Type Creatable Session Type

Guest user Can only create a general session

Authorized user Can create a general session

Can create a privileged session with privileged camera control

Administrator Can create a general session

Can create a privileged session

Can create an administrator session

5.1.4.6 Closing a Session

A WV-HTTP session can be closed with a session close request (close.cgi), and the

connection held by the sessionless client ceases to exist when the HTTP connection is

disconnected.

In addition to this external connection close operation based on a client request, the

connection can be closed on the network camera side when the connection time limit is

exceeded or during idling detection.

5.1.4.7 Limits on the Number of Clients

In addition to the limit on the number of connections during a normal WV-HTTP

session, the following limits on the number of connections also apply to session-based

clients and sessionless clients.

Session-based

□ Normal session

The number of simultaneous connections during a normal session is limited by the

“Maximum number of clients (ha03)” setting value of the WebView settings

protocol, and the maximum value is 30.

See ‘5.3 Items Related to the WebView Settings Protocol ’.

*Note that an administrator session is not included in normal sessions.

17

□ Video-less session

The number of simultaneous connections during a video-less session is different

from that of a normal session and is limited as the number of connections of a video-

less session.

The number of video-less session connections, sessionless event stream client

connections, and sessionless video stream connections are managed collectively, and

the maximum value is 15.

Sessionless

□ Event stream - client

The number of simultaneous sessionless event stream client connections is managed

as the total of the number of video-less session connections, sessionless event

stream client connections, and sessionless video stream connections, and the

maximum value is 15.

*Note that the execution of a request to get a single information item (info.cgi)

with the stream method not specified does not include the number of connections.

□ Video stream - client

The number of simultaneous sessionless video stream client connections is managed

as the total of the number of video-less session connections, sessionless event

stream client connections, and sessionless video stream connections, and the

maximum value is 15.

□ Sessionless camera control

This function does not use a stream, so there is no limit to the number of

simultaneous connections.

18

5.1.4.8 Session-based Access Privileges by Function

The following are the WV-HTTP commands that can be operated according to the

privileges configured for a session-based user.

Table 5-6 WV-HTTP Command Access Privileges by Session-based User

Session Management Video Information Panorama Camera

User Type Set Privileges open

close

session

claim

yield

image

video

info

panorama control

Guest

user

×: Video

transmission

×: Camera

control

General

(Limited)*1 × × ○ ○ ×

○: Video

transmission

×: Camera

control

General

(Limited)*1 ×

○

(Limited)*3 ○ ○ ×

○: Video

transmission

○: Camera

control

General

General

(Limited)*1

General

(Limited)*2

○

(Limited)*3 ○ ○

General

*4

Authorized

user

×: Video

transmission

×: Camera

control

General

(Limited)*1 × × ○ ○ ×

○: Video

transmission

×: Camera

control

General

(Limited)*1 ×

○

(Limited)*3 ○ ○ ×

○: Video

transmission

○: Camera

control

General

General

(Limited)*1

General

(Limited)*2

○

(Limited)*3 ○ ○

General

*4

○: Video

transmission

○: Camera

control

Privileged

Privileged

(Unlimited)*1

Privileged

(Unlimited)*2

○

(Unlimited)*3 ○ ○

Privileged

*3

Administr

ator

*No

restrictions

due to

privilege

setting

General

(Limited)*1

General

(Limited)*2

○

(Limited)*3 ○ ○

General

*4

Privileged/Ad

min

(Unlimited)*1

Privileged/Ad

min

(Unlimited)*2

○


Privileged/Ad

min

*4

Legend:

○: Available; ×: Unavailable (no privilege); －: Unavailable (session required)

General: camera control; Privileged: privileged camera control; Admin: administrator

authorities

19

Note:

*1 This refers to the session connection time, and “(Limited)” is limited by the “Maximum

connection time (ha06)” setting value of the WebView settings protocol. See ‘5.3 Items


*2 This refers to the camera control time, and “(Limited)” is limited by the “Camera control

time (ha07)” setting value of the WebView settings protocol. See ‘5.3 Items Related to

the WebView Settings Protocol ’.

*3 In cases of “(Limited)”, the video transmission time is limited by the session connection

time.

*4 Functions permitted only in a privileged or administrator session, and functions

permitted only in an administrator session. This is determined by the created session

type.

5.1.4.9 Sessionless Access Privileges by Function

The following are the WV-HTTP commands that can be operated according to the

privileges configured for a sessionless user.

Table 5-7 WV-HTTP Command Access Privileges by Sessionless User

Session

Management

Video Information Panorama Camera

User Type Set Privileges open

close

session

claim

yield

image

video

info

panorama control

Guest

user

×: Video transmission

×: Camera control －－ × ○ × ×

○: Video transmission

×: Camera control －－

○

(Unlimited)*1 ○ × ×


○: Camera control General －－

○

(Unlimited)*1 ○ × General*2

Authorized

user

×: Video transmission

×: Camera control －－ × ○ × ×


×: Camera control －－

○

(Unlimited)*1 ○ × ×


○: Camera control General －－

○

(Unlimited)*1 ○ × General*2


○: Camera control

Privileged

－－ ○

(Unlimited)*1 ○ ×

Privileged

*3

Administr

ator

*No restrictions due to

privilege settings －－

○


Privileged

*3

Legend:

○: Available; ×: Unavailable (no privilege); －: Unavailable (session required)

General: camera control; Privileged: privileged camera control; Admin: administrator

authorities

20

Note:

*1 In sessionless cases, the video transmission time is not limited by the session

connection time, so this is “(Unlimited)”. (*However, the video attribute has a

restriction on sharing among sessionless clients.)

*2 In sessionless cases, camera control privileges are acquired and operated in the priority

that control.cgi has specified. Users without camera control privileges cannot perform

operations, and even for users with privileged camera control, the usable functions are

limited to the range of camera control when the priority specified to control.cgi is a

general value instead of a session.

*3 In sessionless cases, the usable functions are limited to the range of privileged camera

control.

21

5.2 Command Specifications This describes the WV-HTTP command specifications.

Open a session [open.cgi]

Close a session [close.cgi]

Get camera control privileges [claim.cgi]

Release camera control privileges [yield.cgi]

Update session attributes [session.cgi]

Get still image data [image.cgi]

Get video data [video.cgi]

Get panorama image data [panorama.cgi]

Get information [info.cgi]

Control camera / Operate external device [control.cgi]

The following is the notation used in this document.

Notation - List of Information Item Attributes:

The information items have different behavior depending on whether it is an item

that can only be referenced, an item that can be referenced and updated, or an item

that provides event notification when updated.

This behavior is called an attribute, and the attribute information is abbreviated as

shown below.

Table 5-8 Attribute Notation of Information Items

Attribute Attribute Value

Description

Can be referenced R Indicates an item that can be referenced with info.cgi

Can be controlled C Indicates an item that can be updated with control.cgi

Session-specific item S This is a session-specific value. Indicates an item that does

not affect changes to other items

Update notification item U Indicates an item whereby the update provides event

notification with info.cgi

Note:

Items that can be executed in a privileged session or higher are listed as “privileged”, and

items that can be executed only in an administrator session are listed as “admin” in the

attribute value column.

Notation - List of Subscript Abbreviations of Array Information Items:

The array subscripts are abbreviated as shown below for the items selected in an

array as information items.

Some items may have a valid value range that varies according to the model. For

details, see ‘A.21 Array Valid Value Information ’.

22

Table 5-9 Subscript Abbreviations of Array Information Items

Abbreviation Valid Value

Description

<Video> 1…6 Video stream number

<Preset> 1…257 Preset number (only when a preset is valid)

<Input> 1…2 Contact input terminal number

<Output> 1…2 Contact output terminal number

<Rule> 1…15 Intelligent Function rule number

<Audio> 1 Number of audio input terminals

<Event> 1 User event number

<Joint> 1…4 Linked Event number

Note:

Although there are subscripts for selecting information items also for the camera, the

number of cameras is fixed at 1, so the abbreviation of <Camera> is not listed.

Descriptions of information items hereafter are listed as shown below.

E.g. c.1.status:=<string> Camera controllable status

Notation - List of Information Item Types:

The type information of information items is abbreviated as shown below.

Table 5-10 Type Notation of Information Items

Type Type Value Description

Character string

[ASCII] <string> ASCII character string. Also includes multiple element joint

type. *1

Character string

[UTF-8] <unicode> Indicates a UTF-8 encoded multibyte character string type

Signed integer <int> Indicates a signed decimal integer type

Unsigned integer <uint> Indicates an unsigned decimal integer type

Fixed point number <fixed> Indicates a signed decimal fixed point number type

Note:

*1 “Multiple element joint type” is a character string with multiple elements joined with a

delimiter as in “<IP address>:<port>”.

E.g. “192.168.100.1:80”

23

Notation - List of Information Item Camera Types:

The camera type attribute value is provided to distinguish the camera type

according to the function of each information item. The camera type is abbreviated

as shown below.

Table 5-11 Camera Type Notation of Information Items

Camera Type Attribute Value

Description

PTZ device Z Indicates a PTZ device

PT device T Indicates a PT device

FIX device F Indicates a FIX device (other than devices with a fixed focal

length lens)

Device with a fixed focal

length lens S Indicates a device with a fixed focal length lens (other than

PT device)

Speed dome device R Indicates a speed dome device

The description policy of this chapter is as follows.

Cover all specifications of supported products*1.

E.g. The PTZ function and digital PTZ function have an exclusive relation, but

both are described in this chapter.

For values, ranges, and selection items, the minimum and maximum values within

all supported products*1 are described. However, the models within those ranges

may not exist.

E.g. When the models within the value range exist

VB-S30D specifications*2

Parameter Value Type/Range Attribute Description

c.1.xx=<int> 10...100

↑

RC-U Integer with a range of 10 to

100



c.1.xx=<int> 10...50

↑


50

Description in this chapter*2


c.1.xx=<int> 10...100 RC-U Integer with a range of 10 to

100

24

E.g. When the models within the value range do not exist



c.1.yy=<int> 10...100

↑


100



c.1.yy=<int> 50...200

↑


200

Description in this chapter*2


c.1.yy=<int> 10...200 RC-U Integer with a range of 10 to

200

If the specifications for each product differ from those listed in this chapter, the

differences are listed in ‘AppendixA List of Differences by Function or Series ’.

Areas listed in “Reference to Differences” as “** Difference caution **” are parts

with new functions or significantly added functions. It is recommended that you

refer to the list of differences (‘AppendixA List of Differences by Function or

Series ’).

Note:

*1 See ‘1.2 Supported Products ’.

*2 The listed items do not exist in the actual specifications.

25

5.2.1 Session Control

In WV-HTTP, obtaining camera control privileges or obtaining video stream are

managed for each session individually created.

Although there are functions that can be operated sessionless, such as to obtain

information, it is necessary to create a session to use all functions of WV-HTTP because,

for example, when specifying a session even to obtain information, it is possible to use

the function to receive event notification when a difference occurs during a continuous

connection.

5.2.1.1 Creating a Session [open.cgi]

This creates a WV-HTTP session.

- The type of general or privileged session is determined according to the priority

specification.

- Specify the administrator session with the “type” specification.

- The content of the video to be obtained in the session is determined by the video

stream specification.

- The video stream can be selected with either of two methods: by specifying the video

format, video size, and other video parameters, or by specifying the video stream

number. It is possible to create a session without performing a video transmission

by specifying “Invalid”.

When a session is created successfully, the session ID, remaining time, priority, and

selected video stream information (only when specified) are returned as a response.

5.2.1.1.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/open.cgi?[s.priority=<Value>][&v=<Val

ue>][&w=<Value>][&w.<Video>.frate=<Value>][&type=<Value>]

Preconditions and precautions:

- The session lifetime varies depending on the priority, but privileged and

administrator sessions are unlimited. Guest users are limited by the “Maximum

connection time (ha06)” setting value of the WebView settings protocol.

- If the maximum number of connections, as specified by the “Maximum number

of clients (ha03)” setting value of the WebView settings protocol, is exceeded,

the session is not created, and “503” is returned as the Livescope status

response.

26

- The administrator session has no restrictions on the connection time or number

of connections. However, if a separate administrator session has already been

established, the connection is denied, and “408” is returned as the Livescope

status response.

- For video parameter specification (v), if there is no stream that conforms to the

specified video size, a stream with a video size that is close to the specified

value and is one size lower is selected.

- If both the video parameter specification (v) and video stream number

specification (w) are specified when selecting a video stream, the video

parameter specification (v) has priority.

- If the video stream specification is omitted, the “Video capture setting (dp00-

dr01)” setting value of the WebView settings protocol is used.

- A session with no video stream (“video-less”) can also be created. However, a

video stream must be specified for an administrator session.

Parameters:

Parameter Value Type/Range Description Camera Type

Reference to Differences

[s.]priority

=<int>

0…50 Specifies the session priority.

*1

Note: “0” when omitted

(general session).

ZTFSR ‐

v=<string> <video parameter>

null

Selects the stream by the video

parameter. *2

Note: Video-less session when

null is specified.

ZTFSR

A.2 Full HD

Function

w=<int> 1...6 Selects the stream by the video

stream number.

Note: Specify a video stream

number that can be

referenced with

info.cgi.

ZTFSR

A.3 PTZ and

Digital PTZ

Function

[w.<Video>.]

frate=<int>

100...30000 Specifies the video stream

frame rate.

Note: Unit is number of

frames per 1000

seconds.

ZTFSR ‐

type=<string> admin

Specifies an administrator

session.

ZTFSR ‐

*For details on the <Video> array subscript abbreviation, see ‘5.2 Command Specifications ’.

27

Note:

*1 The value ranges have the following meanings.

0 : General session

1 - 4 : Reserved (if specified, it is treated as “5”)

5 - 50 : Privileged session

*This is ignored when an administrator session (type=admin) is specified.

*2 Specify <video parameter> with the format shown below.

<jpg or h264>[:<video width>[x<video height>[::<frame rate>]]]

The video width and height are expressed in pixels. Specify the frame rate by the

number of frames per 1000 seconds.

E.g. “jpg:480x270::30000”

*If <video width> and <video height> are omitted for JPEG, the “Video capture

setting (dp00-dr01)” setting value of the WebView settings protocol is used.


*Do not specify <video width>, <video height> and <frame rate> for H.264 data.

(“H.264(1)” can only be selected for an H.264 stream with open.cgi.)

E.g. “h264”

*For details on combinations that can be selected, see ‘D.1 H.264 Image Parameters ’.

5.2.1.1.2 Response

The response content for open.cgi varies depending on whether the video parameter

specification (v) or video stream number specification (w) was specified. The following

shows the response content and status value returned when an error occurs.

A. Successful response [video parameter specification (v)]

HTTP Code ：200 OK

Content-Type ：text/plain;charset=utf-8

Livescope-Status ：0

MessageBody ：

<Parameter>:=<Value>

<Parameter>==<Value>

s:=8a96-c09b18f0

s.origin:=192.168.100.1:80

s.duration:=0

s.priority:=0

v:=jpg:1920x1080:3:30000

28

Return value: (*The specified parameter determines whether “==” or “:=” is returned as the return value.)

Return Value Value Type/Range Description Camera Type


s:=<string> Session ID

ZTFSR ‐

s.origin

:= <string>

<IP address>:

<port>

Camera IP address and HTTP

port number *1

ZTFSR ‐

s.duration

:=<int>

0…<Maximum connection time>

Remaining session connection

time *2

Note: Unit is seconds.

Note: 0=Unlimited

ZTFSR ‐

s.priority

:= <int>

0…50 Session priority

ZTFSR ‐

v:= <string> <video parameter>

Video parameter of selected

stream *3

Note: Not returned if video-

less (v=null) is

specified.

ZTFSR

A.2 Full HD

Function

Note:

*1 The client protocol type determines whether to use IPv4 or IPv6 notation.

If multiple addresses are defined, the manually configured ones have priority for return,

and those not configured manually are returned in the order obtained, starting with the

first address.

IPv6 [<IPv6 Address>]:<port> E.g. “[3FFE:2A00:100:7031::1]:80”

IPv4 <IPv4 Address> :<port> E.g. “192.168.100.1:80”

*2 The maximum value of the remaining session connection time is the “Maximum

connection time (ha06)” setting value of the WebView settings protocol. See ‘5.3 Items


*3 The video stream parameters are returned for <video parameter> with the format

shown below.

<jpg or h264>:<video width>x<video height>:<video quality>:<frame rate>

B. Successful response [video stream number specification (w)]

HTTP Code ：200 OK



MessageBody ：

29



s:=8a96-c09b18f0

s.origin:=192.168.100.1:80

s.duration:=0

s.priority:=0

w:=1

w.1.type==h264

w.1.size==480x270

w.1.quality==0

w.1.frate==1000

w.1.crop==off



Reference to

Differences

s:=<string> Session ID ZTFSR ‐

s.origin

:=<string>

<IP address>:

<port>

Camera IP address and HTTP port

number ZTFSR ‐

s.duration

:=<int>

0… Remaining session connection time


Note: 0=Unlimited

ZTFSR ‐

s.priority:=<int> 0…50 Session priority ZTFSR ‐

w:=<int> 1…6 Selected video stream number *1 ZTFSR A.3 PTZ and

Digital PTZ

Function

w.<Video>.type

==<string>

jpg,

h264

Selected video stream video format ZTFSR ‐

w.<Video>.size

==<string>

<video width>x

<video height>

Selected video stream size ZTFSR A.2 Full HD

Function

w.<Video>.quality==<int>

1… 10 Selected video stream Q value *2

Note: Low quality 1←→10 High

quality

ZTFSR A.22 Video

Quality

** Difference

caution **

w.<Video>.cbr

==<int>

64...16384 Selected video stream target bit rate

Note: Unit is kbps. ZTFSR ‐

w.<Video>.frate

==<string>

100…30000 Selected video stream frame rate

Note: Unit is number of frames per

1000 seconds.

ZTFSR ‐

w.<Video>.crop

==<string>

off

on

Enable/disable digital PTZ ZTFSR A.3 PTZ and

Digital PTZ

Function


30

Note:

*1 The video stream number is a subscript indicating the video stream shown with the

continually returned item w.<Video>.

*2 The range for the video stream’s Q value in the video stream, differs by model.

C. Error response

HTTP status return value:

HTTP Status Meaning


! A guest user requested a privileged or administrator

session.

! An authorized user requested an administrator session.

Livescope status return value:

Livescope Status Meaning


! A video stream number (w) outside the valid range was

specified.


! An invalid video stream number (w) was specified.

! A video-less (v=null) administrator session was requested.

408 Conflict An exclusive operation was requested.

! An administrator session was requested and excluded to an

existing session.

503 Too many clients Maximum number of connections exceeded. *1

! A session that exceeds the maximum number of connections

was requested.

Note:

*1 The maximum number of connections is limited by the “Maximum number of clients

(ha03)” setting value of the WebView settings protocol. See ‘5.3 Items Related to the

WebView Settings Protocol ’.

31

5.2.1.2 Closing a Session [close.cgi]

This closes a WV-HTTP session.

5.2.1.2.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/close.cgi?s=<SessionID>


- A guest user cannot close a privileged session.

- A guest user or authorized user cannot close an administrator session.

Parameters:



s=<string> Session ID (required)

ZTFSR ‐

5.2.1.2.2 Response

A. Successful response

HTTP Code ：200 OK



MessageBody ：

OK

32

B. Error response


HTTP Status Meaning


! A guest user requested the closing of a privileged or

administrator session.

! An authorized user requested the closing of an

administrator session.




! Required parameter or session ID(s) not specified.


! Invalid session ID(s) specified.

5.2.1.3 Camera Control Privilege Request [claim.cgi]

This is used to obtain camera control privileges. The priority of the session determines

whether camera control privileges can be obtained and the assigned time of the control

privileges.

Camera control privilege request for a general session

- The assigned time of the camera control privileges is limited by the set camera

control time. *1

- If a general session has already obtained control privileges, a control privilege

request from the same general session is queued until the previous session

releases control privileges or the assigned time for camera control privileges has

elapsed.

- Control privileges are assigned to queued control privilege requests in the order

they were requested.

Note:

*1 The camera control time is limited by the “Camera control time (ha07)” setting value of

the WebView settings protocol. However, unless another client has requested camera

control privileges, control privileges can exceed the assigned time. The camera control

time can also be set to an unlimited time.


33

Fig. 5-1 Sequence of General Sessions Getting and Waiting for Camera Control Privileges

(Check claim.cgi)

34

- When obtaining control privileges, in addition to using the result of the control

privilege request, info.cgi can also be used to obtain notification of a change in the

status of an information item. See ‘5.2.3.1 Information Acquisition [info.cgi] ’.

Fig. 5-2 Sequence of General Sessions Getting and Waiting for Camera Control Privileges

(info.cgi Notification)

35

- The number of sessions queued to obtain camera control privileges is managed

by the set the maximum camera control queue length. If a control privilege

request exceeds the camera control queue length, a failure response is returned.

Fig. 5-3 Failed to Acquire Camera Control Privileges Because Maximum Queue Count Was

Exceeded

36

Camera control privilege request for a privileged session

- In a privileged session, session management in which control privilege requests

are queued, as in a general session, is not performed, and instead, the higher

priority privileged session obtains control privileges. In this case, the control

privileges of the session that had previously obtained control privileges are

forfeited.

- Control privileges can also be obtained when a session with the same priority

requests control privileges.

- If a privileged session requests control privileges, all queued control privilege

requests of general sessions fail.

Fig. 5-4 Sequence of a Privileged Session Seizing Camera Control Privileges

37

5.2.1.3.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/claim.cgi?s=<SessionID>

Parameters:




ZTFSR ‐

5.2.1.3.2 Response

A. Successful response [Change in control privileges status of own

session due to control privilege request]

The following is the response when the status of the control privileges changes as a

result of a processed control privilege request.

E.g. Before control privilege request = disabled → After control privilege request =

enabled or waiting

HTTP Code ：200 OK



MessageBody ：

s.control:=enabled:20000




s.control

:=<string>

enabled

[:<assigned time>],

waiting

[:<standby time>]

Camera control privileges

status of own session *1

Note: Unit is milliseconds.

ZTFSR ‐

38

Note:

*1 This shows the camera control privileges status of your own session. If “enabled” (or

“waiting”), the remaining assigned time (or remaining standby time until privileges are

obtained) is added in milliseconds only when both are limited.

s.control:=enabled : Obtaining camera control privileges

s.control:=waiting : Waiting to obtain camera control privileges

B. Successful response [No change in control privileges status of own

session due to control privilege request]

The following is the response when the status of the control privileges does not

change even when a control privilege request is processed.

E.g. Before control privilege request = disabled → After control privilege request =

disabled (failed to obtain control privileges)

Before control privilege request = waiting → After control privilege request =

waiting (continuing to wait)

HTTP Code ：200 OK



MessageBody ：

s.control==disabled




s.control ==<string>

enabled

[:<assigned time>],

waiting

[:<standby time>]

disabled


status of own session *1

Note: Unit is milliseconds.

ZTFSR ‐

Note:

*1 This shows the camera control privileges status of your own session. If “enabled” (or

“waiting”), the remaining assigned time (or remaining standby time until privileges are

obtained) is added in milliseconds only when both are limited.

s.control==enabled : Obtaining camera control privileges

s.control==waiting : Waiting to obtain camera control privileges

s.control==disabled : Failed to obtain camera control privileges

39

C. Error response


HTTP Status Meaning


! Specified session ID(s) does not have camera control

privileges.







5.2.1.4 Releasing Camera Control Privileges [yield.cgi]

This releases camera control privileges. If waiting to obtain camera control privileges,

this cancels the wait status.

- When releasing control privileges, in addition to using the result of the control

privilege release, info.cgi can also be used to obtain notification of a change in the

status of an information item. See ‘5.2.3.1 Information Acquisition [info.cgi] ’.

5.2.1.4.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/yield.cgi?s=<SessionID>

Parameters:




ZTFSR ‐

40

5.2.1.4.2 Response

A. Successful response [Change in control privileges status of own

session due to control privilege release]

The following is the response when the status of the control privileges changes as a

result of a processed control privilege release with respect to the privileges status

before release of control privileges.

E.g. Before control privilege release = enabled or waiting → After control privilege

release = disabled

HTTP Code ：200 OK



MessageBody ：

s.control:=disabled




s.control

:=<string>

disabled


status of own session ZTFSR ‐

B. Successful response [No change in control privileges status of own

session due to control privilege release]

The following is the response when the status of the control privileges does not

change even when a control privilege release is processed with respect to the

privileges status before release of control privileges.

E.g. Before control privilege release = disabled → After control privilege release =

disabled

HTTP Code ：200 OK



MessageBody ：

s.control==disabled

41




s.control ==<string>

disabled Camera control privileges

status of own session ZTFSR ‐

C. Error response







5.2.1.5 Changing Session Attributes [session.cgi]

This retrieves a WV-HTTP session-specific attribute or changes a specific attribute.

- A session-specific attribute can be used to change the priority and video stream.

- Changes to the session priority affect the WV-HTTP command access privileges

and camera control privileges.

- The size and frame rate of the video to be retrieved in the session can be changed

by changing the video stream attributes.

- The video stream can be selected with either of two methods: by specifying the

video format, video size, and other video parameters, or by specifying the video

stream number.

When a session attribute is changed successfully, the changed priority and changed

video stream information are returned as a response.

5.2.1.5.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/session.cgi?s=<SessionID>[&s.priority

=<Value>][&v=<Value>][&w=<Value>][&w.<Video>.frate=<Value>]

42


- If the session priority is lowered to a general session, the session may be

disconnected due to the “Maximum connection time (ha06)” limit of the

WebView settings protocol.

- If the session priority is lowered to a level where there are no camera control

privileges, the camera control privileges are forfeited.

- If the session priority is lowered and there is a session requesting camera

control privileges at a higher priority, the camera control privileges are forfeited.









- When the image.cgi or video.cgi video retrieval command is being executed for

the video parameter specification (v), changes to the video format of the video

stream are denied, and “408” is returned as the Livescope status response.

- When the image.cgi or video.cgi video retrieval command is being executed for

the video stream number specification (w), changes are only permitted to the

type between JPEG video streams. If H.264 is specified, changes are denied,

and “408” is returned as the Livescope status response.

Parameters:




ZTFSR ‐

[s.]priority

=<int>

0…50 Specifies the session priority.

*1


(general session)

ZTFSR ‐



parameter. *2 ZTFSR A.2 Full HD

Function


stream number.


number that can be

referenced with

info.cgi.

ZTFSR

A.3 PTZ and

Digital PTZ

Function

[w.<Video>.]

frate=<int>


frame rate.


frames per 1000

seconds.

ZTFSR ‐


43

Note:


0 : General session

1 - 4 : Reserved (*if specified, it is treated as “5”)

5 – 50 : Privileged session

*This is ignored when an administrator session (type=admin) is specified.

*2 *Specify <video parameter> with the format shown below.




E.g. “jpg:480x270::30000”




*Do not specify <video width>, <video height>, and <frame rate> for H.264 data.

(“H.264(1)” can only be selected for an H.264 stream with session.cgi.)

E.g. “h264”


5.2.1.5.2 Response

The response content for session.cgi varies depending on whether the video parameter

specification (v) or video stream number specification (w) was specified. The following

shows the response content and status value returned when an error occurs.

A. Successful response [video parameter specification (v)]

HTTP Code ：200 OK



MessageBody ：

s.priority:=0

v:=jpg:1920x1080:3:30000




s.priority

:= <int>

0…50 Changed session priority

ZTFSR ‐

v:= <string> <video parameter>

Video parameter of changed

stream *1 ZTFSR A.2 Full HD

Function

44

Note:

*1 The video stream parameters are returned for <video parameter> with the format

shown below.


B. Successful response [video stream number specification (w)]

HTTP Code ：200 OK



MessageBody ：

s.priority:=0

w:=5

w.1.type==h264

w.1.size==480x270

w.1.quality==0

w.1.frate==1000

w.1.crop==off




s.priority:= <int>

0…50 Changed session priority ZTFSR ‐

w:= <int> 1…6 Changed video stream number ZTFSR A.3 PTZ and

Digital PTZ

Function

w.<Video>.type

==<string>

jpg,

h264

Changed video stream video

format ZTFSR ‐

w.<Video>.size

==<string>

<video width>x

<video height>

Changed video stream size ZTFSR A.2 Full HD

Function

w.<Video>.quality==<int>

1…10 Changed video stream Q value

*1

Note: Low quality 1 ←→ 10

High quality

ZTFSR A.22 Video

Quality

** Difference

caution **

w.<Video>.cbr

==<int>

64...16384 Changed video stream target

bit rate

Note: Unit is kbps.

ZTFSR ‐

45



w.<Video>.frate

==<string>

100…30000 Changed video stream frame

rate


frames per 1000

seconds.

ZTFSR ‐

w.<Video>.crop

==<string>

off

on

Enable/disable digital PTZ

ZTFSR A.3 PTZ and

Digital PTZ

Function


Note:


C. Error response


HTTP Status Meaning


! A guest user requested a privileged session.





specified.






! A change in the video stream was specified with the video

parameter specification (v) while the video retrieval

command was being executed.

! A change in the video stream to a format other than JPEG

was specified with the video stream number specification

(w) while the video retrieval command was being executed.



46

5.2.2 Video Retrieval

The camera video image data retrieval commands for WV-HTTP include image.cgi for

still image retrieval and video.cgi for video stream retrieval.

5.2.2.1 Still Image Retrieval [image.cgi]

This is used to retrieve a JPEG still image. Select from using a video stream selected in

a session for a session-based client and specifying a video stream to a command for a

sessionless client.

Session-based

- This uses the video stream settings of a session specified with a session ID.

- The pan, tilt, and zoom camera control parameters are ignored. *1

- If the video stream setting of the specified session is H.264, it is changed

automatically to JPEG. *2

Note:

*1 To change the shooting position, use with control.cgi.

*2 The changed JPEG stream setting becomes the “Video capture setting (dp00-dr01)”

setting value of the WebView settings protocol. See ‘5.3 Items Related to the WebView

Settings Protocol ’.

If a change in the settings occurs, notification is sent by an event using info.cgi. The

changed setting is maintained even after image.cgi processing is completed. (*The

setting is not restored automatically.)

Sessionless

- The content of the video to be retrieved is determined by the video stream

specification.



stream number.

- The pan, tilt, and zoom camera control parameters can be used to specify the

shooting position. *1

Note:

*1 Note that camera control is not performed if the camera control privileges cannot be

obtained due to a problem with the priority.

47

5.2.2.1.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/image.cgi?[s=<SessionID>][&v=<Value>]

[&w=<Value>][&c.1.zoom=<Value>][&c.1.pan=<Value>][&c.1.tilt=<Value>]

[&cache=<Value>]


- This command cannot be used when transmitting a video stream with

video.cgi. If this command is requested, it is not executed, and “408” is

returned as the Livescope status response.

- The video format specifies the JPEG video stream for both the video parameter

specification (v) and video stream number specification (w). If a format other

than JPEG is specified, “403” is returned as the Livescope status response.









- The frame rate cannot be specified with this command for the video stream

number specification (w).

48

Parameters:


Reference to

Differences

s=<string> Session ID ZTFSR ‐



parameter. *1

ZTFSR A.2 Full HD

Function


stream number.


number that can be

referenced with info.cgi.

ZTFSR

A.3 PTZ and

Digital PTZ

Function

c.1.zoom

=<string>

<absolute position>

(11...9500),

d[±]<differential position>

(-9489...9489),

v[+]<magnification>

(0...53091)

Zoom movement

Note: Specify any of the

following:

・<absolute position>

specification

Moves the horizontal viewing

angle using the viewing angle

specification in units of 0.01

degrees.

・d[±]<differential position>

specification

Moves the differential

specification from the current

position using the viewing angle


degrees.

・v[＋]<magnification>

specification *2

Moves from the current viewing

angle using the magnification

specification.

The magnification is the relative

value specification, where the

current viewing angle is 100.

ZT--R

c.1.pan

=<string>

<absolute position>

(-18000...17999),

Pan movement


following:


specification

Moves using the viewing angle


degrees.

Specify the right side with a

positive (+) value, where the

front of the housing is 0.

ZT--R

49


Reference to

Differences


(-35999...35999),

v[±]<relative position>

(-100...100)


specification





degrees.

・v[±]<relative position> *3

Moves from the current position

using the relative position

specification.

Specify with a relative position,

with -100 at the left end and 100

at the right end, where the front

of the current position is 0.

A.3 PTZ and

Digital PTZ

Function

c.1.tilt=<string>

<absolute position>

(-18000...1000),


(-19000...19000),


(-100...100)

Tilt movement


following:


specification



degrees.

Specify up with a positive (+)

value, where the housing is level

at 0.


specification





degrees.

・v[±]<relative position>

specification *4



specification.


with -100 at the lowermost

position and 100 at the

uppermost position, where the

front of the current position is 0.

ZT--R

cache =<string>

on (or 1),

off (or 0)

HTTP1.1 cache use specification

・Enable “Last-Modified”

assigned

・Disable “Cache-Control

no-cache” assigned

ZTFSR ‐

50

Note:


<jpg>[:<video width>[x<video height>]]



E.g. “jpg:480x270::30000”

*If <video width> and <video height> are omitted, the “Video capture setting

(dp00-dr01)” setting value of the WebView settings protocol is used.



*2 The magnification is the relative value, where the current viewing angle is 100. If 0 is

specified, the minimum value (c.1.zoom.min value) is used.

E.g. c.1.zoom=v+50 Moves at 50% magnification in the current viewing angle.

c.1.zoom=v+200 Moves at 200% in the current viewing angle.

*3 Specify the value with the left and right ends of the current viewing angle (current

video image) at ±100, where the front of the current position is 0. Therefore, the pan

angle per specification unit varies according to the current zoom position. If zoom

movement is also specified at the same time, the standard zoom position will end up

moving, and, therefore, the specified pan position will not be at the front.

*4 Specify the value with the uppermost and lowermost positions of the current viewing

angle (current video image) at ±100, where the front of the current position is 0.

Therefore, the tilt angle per specification unit varies according to the current zoom

position. If zoom movement is also specified at the same time, the standard zoom

position will end up moving, and, therefore, the specified tilt position will not be at the

front.

5.2.2.1.2 Response


HTTP Code ：200 OK

Content-Type ：image/jpeg


Livescope-Frame-Number ：<JPEG data serial number>*1

MessageBody ：

<JpegImageData>

Note:

*1 Livescope-Frame-Number is an extension field unique to WV-HTTP similar to

Livescope-Status. A serial number is assigned in the order the still image request

commands are received, and this can be used for sequence control on the client side.

51

B. Error response


HTTP Status Meaning


! A user without video transmission privileges requested

video transmission.




! A format other than JPEG was specified with the video

parameter specification (v).

! A format other than JPEG was specified with the video

stream number specification (w).


specified.

! “-0” was specified with the differential position

(magnification) specification for pan, tilt, or zoom.






! Still image retrieval was requested while executing a video

stream retrieval command.



Note:

As a usage method during session specification, JPEG still images can be continually

requested, which is useful for applications compiling a pseudo-video. In sessionless mode,

this is useful for applications retrieving one JPEG still image.

Still image requests during the same session are processed in the order they are received

with this command, and Livescope frame numbers are assigned and returned in that order.

52

5.2.2.2 Video Stream Retrieval [video.cgi]

This requests a video stream transmission. Select from using a video stream selected in

a session for a session-based client and specifying a video stream to a command for a

sessionless client.

Session-based

- This uses the video stream settings of a session specified with a session ID.

- The video stream transmission continues until the session is ended by the

session duration end or the client ends the session, or the HTTP connection is

disconnected by the client.

Sessionless

- The content of the video to be retrieved is determined by the video stream

specification.



stream number.

- The video stream transmission continues until the specified video transmission

time has elapsed or the HTTP connection is disconnected by the client.

For the send control method (buffering policy) of the video stream transmission with

video.cgi, select from “Transmit latest video data (type=live)” or “Prevent video data

loss (type=rec)”. This operation is shared regardless of whether there is a session

specification.

5.2.2.2.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/video.cgi?[s=<SessionID>][&v=<Value>]

[&w=<Value>][&w.<Video>.frate=<Value>][&duration=<Value>][&type=<Val

ue>]

53


- This command cannot be used while executing still image retrieval with

image.cgi. If this command is requested, “408” is returned as the Livescope

status response.

- If the video format is H.264 or the frame rate is set to 10 fps or higher, select

“Transmit new video (type=live)” for the send control method. If “Prevent

video data loss (type=rec)” is selected, “407” is returned as the Livescope

status response.

- “Prevent video data loss (type=rec)” can be specified for the send control

method with video.cgi for only one connection at a time. If type=rec is

specified multiple times at the same time, “408” is returned as the Livescope

status response.

- When “Upload (ja03)” in the WebView settings protocol is set to “FTP Upload”

or “HTTP Upload”, select “Transmit new video (type=live)” for the send control

method. If “Prevent video data loss (type=rec)” is selected, “408” is returned

as the Livescope status response.









Parameters:



s=<string> Session ID ZTFSR ‐

v=<string> <video

parameter>


parameter. *1

ZTFSR A.2 Full HD

Function


stream number.


number that can be

referenced with

info.cgi.

ZTFSR

A.3 PTZ and

Digital PTZ

Function

[w.<Video>.]frate=<int>


frame rate.


frames per 1000

seconds.

ZTFSR ‐

54



duration=<int> 0…<Maximum connection time>

Video send time specification

*2


Note: 0=Unlimited

ZTFSR

‐

type=<string>

live,

rec

Send control method (buffering

policy) *3

・Congested video data is

canceled, and the newest

data is transmitted.

・Congested video data is

buffered, and an attempt is

made to prevent loss of data

as much as possible.

Note: A setting value for

which rec does not

apply is interpreted as

live.

ZTFSR

‐


Note:





E.g. “jpg:480x270::30000”




*Do not specify <video width>, <video height>, and <frame rate> for H.264 data.

(“H.264(1)” can only be selected for an H.264 stream with video.cgi.)

E.g. “h264”

*2 The maximum value for the video send time is the maximum value of the session

connection time. The maximum value of the session connection time is the “Maximum

connection time (ha06)” setting value of the WebView settings protocol.


*3 Even when rec is specified, if the buffer is exhausted, a data loss will occur.

55

5.2.2.2.2 Response

The response content of video.cgi varies depending on the specified video format. The

following shows the response content for both JPEG and H.264 and the status value

returned when an error occurs.

A. Successful response [video type: JPEG specification]

HTTP Code ：200 OK

Content-Type ：multipart/x-mixed-replace;boundary=boundary


MessageBody ：

--boundary

Content-Type: image/jpeg

Content-Length: <ImageLength>

<JpegImageData 1>

--boundary



<JpegImageData 2>

--boundary

･･･

--boundary



<JpegImageData Last>

--boundary--

56

B. Successful response [video type: H.264 specification]

HTTP Code :200 OK

Content-Type :video/mp4

Livescope-Status :0

MessageBody :

<H.264VideoData>

C. Error response


HTTP Status Meaning


! A user without video transmission privileges requested

video transmission.





specified.



! type=rec was specified to a stream of H.264 or 10 fps or

higher.


! Video stream retrieval was requested while executing a still

image retrieval command.

! A video stream retrieval with multiple type=rec

specifications was requested.



57

5.2.3 Information Acquisition

The information acquisition commands used for acquiring various information from

network cameras and panorama images under WV-HTTP are described below.

5.2.3.1 Information Acquisition [info.cgi]

This is used to acquire various information from network cameras. Select whether to

acquire information from a session-based or sessionless client. In addition, as needed,

select the method for issuing the command and acquiring the result and the method for

receiving notification each time there is a change in information in a camera due to the

stream format.

Session-based - Issuing a request as needed

- At the initial information acquisition after the camera is started, all requested

items are returned immediately as a response.

- At all subsequent information acquisitions, items are returned as a response only

when those items are different from the initial response content. If there is no

difference at the time of the information acquisition request, the response is

queued until a difference exists.

- The “timeout” parameter can be used to specify the response time limit.

Sessionless - Issuing a request as needed

- All requested items are returned immediately as a response for each information

acquisition request.

Stream format specification

- You can select the stream format for both session-based and sessionless clients.

The server push mode using the “multipart/x-mixed-replace” MIME type is

used for the response format.

- At the initial information acquisition after the camera is started, all requested

items are returned immediately as a response.

- Thereafter, an information acquisition request is not performed, and items are

repeatedly returned as a response only when those items are different from the

previous response content.

- The “timeout” parameter can be used to specify the response time limit.

The following shows the behavior of info.cgi for each usage.

58

When the stream format is not specified in a sessionless case, all requested items are

returned immediately as a response for each information acquisition request.

Fig. 5-5 In the Case of Sessionless Execution, the Response Always Returns All Items Immediately

59

When the stream format is not specified in a session-based case, in all subsequent

information acquisitions, items are returned as a response only when those items are

different from the initial response content.

Fig. 5-6 In Session-Based Execution, the Second and Subsequent Requests Return Differential Responses

60

When the stream format is not specified in a session-based case, in all subsequent

information acquisitions, if there is no difference at the time of the information

acquisition request, the response is queued until a difference exists.

Fig. 5-7 If There Is No Difference at the Time of the Second Request, It Waits for a Response

61

When the stream format is specified, at the initial information acquisition after the

camera is started, all requested items are returned immediately as a response.

Thereafter, an information acquisition request is not performed, and items are

repeatedly returned as a response only when those items are different from the

previous response content.

Fig. 5-8 In Sessionless Execution, Specify the Stream Format to Receive the Differences as They Arise

62

The “timeout” specification can be used to specify the response time limit. When the

response time limit specified with “timeout” elapses, only the “timestamp” item,

which indicates that the time limit timed out, is returned as a response.

Fig. 5-9 Response Period Times Out If Stream Format and Timeout Are Specified

63

5.2.3.1.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/info.cgi?[s=<sessionID>][&type=<Value

>][&timeout=<Value>]...


- A request cannot be executed multiple times in the same session, and if

attempted, “408” is returned as the Livescope status response.

Parameters:



s=<string> Session ID

ZTFSR ‐

item=<string> <item name 1>

[,<item name

2>...]

Specifies the information item

to be acquired. *1

Note: If item is omitted, all

item specifications are

the same.

ZTFSR ‐

type=<string> stream Response format specification

ZTFSR ‐

timeout=<int> <sec.> Response time limit

specification


ZTFSR ‐

Note:

*1 *The names of information items are hierarchically organized and are specified with the

following format.

item=c : Specify item c (camera) and lower to the acquisition target.

item=c! : Exclude item c (camera) and lower from the acquisition target.

*The specification of information items can be enumerated, and in this case, the

specified items are evaluated in the enumeration order.

E.g. Specification with one item “info.cgi?item=s,c...”

E.g. Specification with multiple items “info.cgi?item=s&item=c...”

*The details of the return values of the information items are described in the

information categories that follow.

64

5.2.3.1.2 Response

There are two types of response formats for information acquisition depending on the

factor for the change in value: “item name:=value” and “item name==value”.

- “item name:=value” indicates an item changed due to the initial response of the

information acquisition or external factors, such as a control request from another

client or a change in the setting value in the WebView settings protocol.

- “item name==value” indicates an item changed as a result of a control request

processed in one’s own session.

Note:

The initial response is always “item name:=value”, and “item name==value” is only

returned for subsequent responses of specified sessions.

A. Successful response [normal]

This indicates the initial response of an information acquisition or a response when a

command is issued as needed.

HTTP Code ：200 OK



MessageBody ：

timestamp=4091.450

realtime=1380159728.596

s.epoch:=Thu, 26 Sep 2013 08:34:24 +0900

s.hardware:=Canon VB

s.firmware:=Ver. 1.0.0

s.protocol:=02.30

v.list:=jpg:480x270:3:30000,jpg:960x540:3:30000,jpg:1920x1080:3:30000,

h264:480x270:0:30000

v.h264.cbr:=2048

w.count:=5

w.1.status:=enabled

w.1.type:=jpg

w.1.size:=480x270

w.1.quality:=3

w.1.frate.min:=100

w.1.frate.max:=30000

w.1.crop:=off

w.2.status:=enabled

w.2.type:=jpg

w.2.size:=960x540

w.2.quality:=3

w.2.frate.min:=100


65

w.2.crop:=off

w.3.status:=enabled

w.3.type:=jpg

w.3.size:=1920x1080

w.3.quality:=3

w.3.frate.min:=100


w.3.crop:=off

w.4.status:=enabled

w.4.type:=h264

w.4.size:=480x270

w.4.cbr:=2048

w.4.frate.min:=100


w.4.crop:=off

w.5.status:=disabled

w.5.type:=h264

w.5.size:=480x270

w.5.cbr:=2048

w.5.frate.min:=100


w.5.crop:=off

c:=1

c.count:=1

c.1.type:=Canon VB

c.1.status:=enabled

c.1.name.asc:=Camera

c.1.name.utf8:=

c.1.exp:=auto

c.1.exp.list:=auto,flickerfree,tv,manual

c.1.ae.autoss:=30

c.1.ae.autoss.list:=2,4,8,15,30

c.1.ae.shutter.list:=2,4,8,15,30,60,100,120,250,500,1000,

2000,4000,8000,10000,16000

c.1.ae.brightness:=0

c.1.ae.brightness.min:=-8

c.1.ae.brightness.max:=8

c.1.ae.brightness.list:=-8,-6,-4,-2,0,2,4,6,8

c.1.ae.photometry:=center

c.1.ae.photometry.list:=center,average,spot

c.1.me.shutter.list:=1,2,4,8,15,30,60,100,120,250,500,1000,

2000,4000,8000,10000,16000

c.1.me.gain.min:=0

c.1.me.gain.max:=32

c.1.dn:=off

c.1.dn.mode:=manual

c.1.dn.mode.list:=manual,auto1

c.1.wb:=auto

c.1.wb.list:=auto,manual,one_shot,sodium,halogen,mercury,

fluorescent_w,fluorescent_l,fluorescent_h

c.1.nr:=1

c.1.nr.min:=0

c.1.nr.max:=2

c.1.ac:=1

66

c.1.ac.min:=0

c.1.ac.max:=2

c.1.saturation:=1

c.1.saturation.min:=0

c.1.saturation.max:=2

c.1.shade:=on

c.1.shade.list:=off,on,auto

c.1.shade.param:=0

c.1.shade.param.min:=0

c.1.shade.param.max:=6

c.1.focus:=auto

c.1.focus.list:=auto,infinity,manual

c.1.zoom:=7770

c.1.zoom.d:=2070

c.1.zoom.min:=2070

c.1.zoom.max:=7770

c.1.zoom.limit.min:=2070

c.1.zoom.limit.max:=7770

c.1.zoom.speed.min:=0

c.1.zoom.speed.max:=7

c.1.pan:=0

c.1.pan.min:=-17500

c.1.pan.max:=17500

c.1.pan.limit.min:=-17500

c.1.pan.limit.max:=17500

c.1.pan.speed.min:=1000

c.1.pan.speed.max:=12000

c.1.tilt:=0

c.1.tilt.min:=-9000

c.1.tilt.max:=0

c.1.tilt.limit.min:=-9000

c.1.tilt.limit.max:=0

c.1.tilt.speed.min:=3000

c.1.tilt.speed.max:=12000

c.1.view:=-21385:2186:42770:13372

c.1.view.restriction:=off

c.1.panorama.count:=0

c.1.home.pan:=

c.1.home.tilt:=

c.1.home.zoom:=

c.1.home.focus:=auto

c.1.home.ae.brightness:=0

c.1.home.shade:=off

c.1.home.shade.param:=0

c.1.home.wb:=auto

i.count:=1

i.1:=0

i.1.name.asc:=

i.1.name.utf8:=

o.count:=1

o.1:=0

o.1.name.asc:=

o.1.name.utf8:=

p.count:=0

67

r.engine:=0

r.meta:=off

r.pseudo:=0

r.count:=15

r.1:=0

r.1.name.asc:=

r.1.name.utf8:=

r.1.type:=0

r.2:=0

r.2.name.asc:=

r.2.name.utf8:=

r.2.type:=0

r.3:=0

r.3.name.asc:=

r.3.name.utf8:=

r.3.type:=0

r.4:=0

r.4.name.asc:=

r.4.name.utf8:=

r.4.type:=0

r.5:=0

r.5.name.asc:=

r.5.name.utf8:=

r.5.type:=0

r.6:=0

r.6.name.asc:=

r.6.name.utf8:=

r.6.type:=0

r.7:=0

r.7.name.asc:=

r.7.name.utf8:=

r.7.type:=0

r.8:=0

r.8.name.asc:=

r.8.name.utf8:=

r.8.type:=0

r.9:=0

r.9.name.asc:=

r.9.name.utf8:=

r.9.type:=0

r.10:=0

r.10.name.asc:=

r.10.name.utf8:=

r.10.type:=0

r.11:=0

r.11.name.asc:=

r.11.name.utf8:=

r.11.type:=0

r.12:=0

r.12.name.asc:=

r.12.name.utf8:=

r.12.type:=0

r.13:=0

r.13.name.asc:=

68

r.13.name.utf8:=

r.13.type:=0

r.14:=0

r.14.name.asc:=

r.14.name.utf8:=

r.14.type:=0

r.15:=0

r.15.name.asc:=

r.15.name.utf8:=

r.15.type:=0

a.count:=1

a.1.send:=off

a.1.recv:=off

a.1.detect:=0

e.count:=1

e.1:=0

f.sd:=0

Return value:



timestamp=

<fixed>

<sec.>.<ms> Network camera specific time

Note: Total time from camera

start

ZTFSR ‐

realtime=

<fixed>

<sec.>.<ms> Network camera actual time

Note: Seconds from

Greenwich Mean Time

ZTFSR ‐

Note:

The details of the return values of the information items are described in the information

categories that follow.

B. Successful response [Stream format specification]

This indicates the content of the different response when the stream format was

specified.

HTTP Code ：200 OK

Content-Type ：multipart/x-mixed-replace;boundary=boundary


MessageBody ：

69

--boundary

Content-Type: text/plain; charset=utf-8

Content-Length: <DataLength>

timestamp=4091.450

realtime=1380159728.596

s.epoch:=Thu, 26 Sep 2013 08:34:24 +0900

s.hardware:=Canon VB

...

--boundary



timestamp=<Second.MSecond>

realtime=<Second.MSecond>

c.1.zoom:=5070

--boundary

･･･

--boundary



timestamp=<Second.MSecond>

realtime=<Second.MSecond>

--boundary--

Note:

Only the “timestamp” item is returned for the final response.

C. Error response




! A value other than a seconds value is specified to the

“timeout” parameter.


! Information acquisition was requested multiple times at

the same time during the same session.



70

5.2.3.1.3 System Information [s]

Parameters: System Information

Parameter Value Type/Range Attribute Description Camera Type


s.epoch

:=<string>

<date and time> R--U Start time *1

E.g. Tue,30 Oct 2012

16:33:10 +0900

ZTFSR ‐

s.hardware

:=<string>

R--- Model name

E.g. Canon VB-H43 ZTFSR ‐

s.hardware.id

:=<string>

R--- Hardware ID

E.g. 2D --F-R A.20 System

Information

** Difference

caution **

s.firmware

:=<string>

R--- Firmware version

E.g. Ver.1.1.0 ZTFSR ‐

s.protocol

:=<string>

R--- Protocol version

E.g. 02.30 ZTFSR ‐

Note:

*1 <date and time> is displayed in the following format.

<day of week>,<day><month><year> <hour>:<minute>:<second> <time zone>

5.2.3.1.4 Video Information [v]

Parameters: Video Stream Parameter Information



v.list:=<string> <video stream

parameter list>

R--U Video stream parameter list *1 ZTFSR A.2 Full HD

Function

Note:

*1 The list of video stream parameters is returned for <video stream parameter list>

with the format shown below. The video quality is the same as the setting value and is

a level value.


E.g. v.list:=jpg:480x270:3:30000,jpg:960x540:3:30000,

jpg:1920x1080:3:30000,h264:480x270:0:30000

71

5.2.3.1.5 Video Information [w]

Parameters: Video Stream Number Information



w.count:=<int> 6 R--U Number of stream lists

ZTFSR A.3 PTZ and

Digital PTZ

Function

w.<Video>.status

:=<string>

enabled,disabled R--U Status of stream <Video> ZTFSR ‐

w.<Video>.type

:=<string>

jpg,h264 R--U Type of stream <Video>

ZTFSR ‐

w.<Video>.size

:=<string>

<video width>x

<video height>

R--U Video size of stream <Video>

*1 ZTFSR A.2 Full HD

Function

w.<Video>.

quality:=<int>

1…10 R--U Q value of stream <Video> *7

Note: Low quality 1 ←→ 10

High quality

ZTFSR A.22 Video Quality

** Difference

caution **

w.<Video>.cbr

:=<int>

64...16384 R--U Target bit rate of stream

<Video>

Note: Units is kbps.

ZTFSR ‐

w.<Video>.frate.min:=<string>

100 R--U Selectable minimum frame

rate value of stream <Video>

ZTFSR ‐

w.<Video>.frate.max:=<string>

30000 R--U Selectable maximum frame

rate value of stream <Video>

*2

ZTFSR ‐

w.<Video>.crop

:=<string>

off,on R--U Digital PTZ setting of stream

<Video> ZTFSR

A.3 PTZ and

Digital PTZ

Function

w.4.crop.area

:=<string>

<crop width>x

<crop height>

R--U Crop size of digital PTZ setting

*3 --FS-

w.4.crop.x

:=<int>

<crop position X> R--U Crop position X coordinate of

digital PTZ setting *3 --FS-

w.4.crop.y

:=<int>

<crop position Y> R--U Crop position Y coordinate of


w.4.zoom

:=<int>

633...5710 R--U Zoom value of digital PTZ

setting

*4

--FS-

w.4.zoom.min

:=<int>

633...1142 R--U Zoom telephoto side control

limit value of digital PTZ

setting *4

--FS-

w.4.zoom.max:=<int>

3167...5710 R--U Zoom wide-angle side control

limit value of digital PTZ

setting *4

--FS-

w.4.zoom.limit.min:=<int>

633 R--- Zoom telephoto movable limit

value of digital PTZ setting

*4

--FS-

72



w.4.zoom.limit.max:=<int>

11420 R--- Zoom wide-angle movable limit

value of digital PTZ setting

*4

--FS-

A.3 PTZ and

Digital PTZ

Function

w.4.pan:=<int> -5710...5710 RC-U Pan position of digital PTZ

setting *5 --FS-

w.4.pan.min

:=<int>

-5710...-3420 R--U Left side control limit value of

camera platform in digital PTZ

setting *5

--FS-

w.4.pan.max

:=<int>

3420...5710 R--U Right side control limit value

of camera platform in digital

PTZ setting *5

--FS-

w.4.pan.limit.min:=<int>

-5710 R--- Left side movable limit value


PTZ setting *5

--FS-

w.4.pan.limit. max:=<int>

5710 R--- Right side movable limit value


PTZ setting *5

--FS-

w.4.tilt:=<int> -3854...4283 RC-U Tilt position of digital PTZ

setting *6 --FS-

w.4.tilt.min

:=<int>

-3854...-2404 R--U Downward control limit value


PTZ setting *6

--FS-

w.4.tilt.max

:=<int>

2404...4283 R--U Upward control limit value of


setting *6

--FS-

w.4.tilt.limit. min:=<int>

-4283 R--- Downward movable limit value


PTZ setting *6

--FS-

w.4.tilt.limit. max:=<int>

4283 R--- Upward movable limit value of


setting *6

--FS-

w.4.home.pan

:=<int>

-5710...5710 R--U Pan position of home position

of digital PTZ setting *5 --FS-

w.4.home.tilt

:=<int>

-3854...4283 R--U Tilt position of home position

of digital PTZ setting *6 --FS-

w.4.home.zoom

:=<int>

633...5710 R--U Zoom value of home position of



In addition, because the value of <Video> in the digital PTZ setting is fixed to 4, that value

remains as is.

73

Note:

*1 The following video sizes are available according to the video size set.

Table 5-12 Selectable Video Sizes

Video Size Set Selectable Video Size

1280x960 1280x960, 640x480, 320x240

1280x720 1280x720, 640x360, 320x180

1920x1080 1920x1080, 960x540, 480x270

*2 This is determined by the “Maximum frame rate value (ha05)” of the WebView settings

protocol x 1000. See ‘5.3 Items Related to the WebView Settings Protocol ’.

*3 The following digital PTZ video crop sizes are available according to the video size set.

In addition, because the crop size differs according to the video size set, as shown below,

the maximum and minimum values of the individual PTZ control limits will fluctuate

according to the video size set.

Table 5-13 Digital PTZ Selectable Video Crop Sizes

Video Size Set Selectable Video Size

1280x960 640x480, 512x384, 384x288, 256x192, 128x96

1280x720 640x360, 512x288, 384x216, 256x144, 128x72

1920x1080 640x360, 512x288, 384x216, 256x144, 128x72

*4 The digital PTZ zoom function provides pseudo-zoom operations by adjusting the video

crop size to a viewing angle equivalent to a zoom value. By enlarging the video cropped

by the camera to the display size specified on the viewer, pseudo-zooming can be

achieved.

*5 The digital PTZ pan function provides pseudo-pan operations by adjusting the video

crop position in the horizontal direction.

*6 The digital PTZ tilt function provides pseudo-tilt operations by adjusting the video crop

position in the vertical direction.


74

5.2.3.1.6 Camera Information [c]

Parameters: Camera Information



c:=<int> 1 R--U Selected camera

Note: Always 1 ZTFSR ‐

c.count:=<int> 1 R--U Number of cameras


c.1.type

:=<string>

R--U Type of camera

E.g. Canon VB-H43 ZTFSR ‐

c.1.status

:=<string>

enabled,disabled R--U Camera controllable status

*1 ZTFSR ‐

c.1.name.asc

:=<string>

R--U Camera name (ASCII)

ZTFSR ‐

c.1.name.utf8

:=<unicode>

R--U Camera name (UTF-8)

ZTFSR ‐

c.1.name.lang

:=<string>

en, ja, fr, it, de, es, zh, tr, ru

R--U Set language for camera name

(UTF-8) *2 ZTFSR A.7

Multilingual

Support

Note:

*1 This indicates the camera controllable status and displays “disabled” immediately after

startup. After initialization, “enabled” is displayed.

c.1.status:=disabled : Camera control disabled

c.1.status:=enabled : Camera control enabled

*2 This item is also visible only when “Camera name (UTF-8)” is set.

c.1.name.lang:=en : English

c.1.name.lang:=ja : Japanese

c.1.name.lang:=fr : French

c.1.name.lang:=it : Italian

c.1.name.lang:=de : German

c.1.name.lang:=es : Spanish

c.1.name.lang:=zh : Chinese (Simplified)

c.1.name.lang:=tr : Turkish

c.1.name.lang:=ru : Russian

75

5.2.3.1.7 Camera Correction Information [c]

Parameters: Camera Correction Information



c.1.exp

:=<string>

Select from c.1.exp.list

RC-U Exposure mode *1

Note: manual is disabled in

Shade Control auto

mode.

ZTFSR ‐

c.1.exp.list

:=<string>

“auto,flickerfree,

tv,manual,

flickerfree2”

R--U Exposure mode list ZTFSR A.9 Exposure

Function

** Difference

caution **

c.1.ae.autoss

:=<int>

Select from

c.1.ae.autoss.list RC-U Auto slow shutter *2

Note: Disabled in exposure

mode other than auto

or flickerfree,

flickerfree2.

ZTFSR ‐

c.1.ae.autoss.list

:=<string>

“2,4,8,15,30” R--U Auto slow shutter list *2 ZTFSR ‐

c.1.ae.shutter

:=<int>

Select from c.1.ae.shutter.list

RC-U Shutter speed *2


mode other than tv.

ZTFSR ‐

c.1.ae.shutter.list

:=<string>

“2,4,8,15,30,60,

100,120,250,500,

1000,2000,4000,

8000,10000,

16000”

R--U Shutter speed list *2

ZTFSR ‐

c.1.ae.brightness

:=<int>

Select from

c.1.ae.brightness. list

RC-U Exposure compensation value

Note: Dark -8 ←→ 8 Bright

Note: Disabled in manual

exposure mode.

Note: Disabled in Shade

Control auto mode.

ZTFSR ‐

c.1.ae.brightness.min:=<int>

-8 R--U Minimum configurable

exposure compensation value ZTFSR ‐

c.1.ae.brightness.max:=<int>

8 R--U Maximum configurable

exposure compensation value ZTFSR ‐

c.1.ae.brightness.list:=<string>

“-8,-6,-4,-2,

0,2,4,6,8”

R--U Exposure compensation value

list ZTFSR ‐

c.1.ae.photometry:=<string>

Select from

c.1.ae.photometry.list

RC-U Metering Mode *3


exposure mode.

ZTFSR ‐

c.1.ae.photometry.list:=<string>

“center,average,

spot”

R--U Metering Mode list

ZTFSR ‐

c.1.me.shutter:=<int>

Select from

c.1.me.shutter.list RC-U Shutter speed *2


mode other than

manual.

ZTFSR ‐

76



c.1.me.shutter.list:=<string>

“1,2,4,8,15,30,60,

100,120,250,500,

1000,2000,4000,

8000,10000,

16000”

R--U Shutter speed list *2

ZTFSR ‐

c.1.me.iris

:=<int>

2...32 RC-U Aperture value *4


mode other than

manual.

Z-F-R

A.9 Exposure

Function c.1.me.iris.min

:=<int>

2 R--U Minimum configurable

aperture value Z-F-R

c.1.me.iris.max

:=<int>

32

R--U Maximum configurable

aperture value Z-F-R

c.1.me.gain

:=<int>

0...47 RC-U AGC gain value *4


mode other than

manual.

ZTFSR

A.9 Exposure

Function c.1.me.gain.min

:=<int>

0 R--U Minimum configurable gain

value ZTFSR

c.1.me.gain.max

:=<int>

47 R--U Maximum configurable gain

value ZTFSR

c.1.dn:=<string> off,on RC-U

Privileged

Day/Night mode *5

Note: Disabled in Day/Night

switching mode other

than manual.

ZTFSR ‐

c.1.dn.mode

:=<string>

Select from

c.1.dn.mode.list

RC-U

Privileged

Day/Night switching mode

ZTFSR ‐

c.1.dn.mode.list

:=<string>

“manual,auto1” R--U Day/Night switching mode list

ZTFSR ‐

c.1.dn.irlight

:=<string>

Select from c.1.dn.irlight.list

RC-U Infrared Day/Night operation

*6 --F--

A.12 Infrared

Function

** Difference

caution **

c.1.dn.irlight.list

:=<string>

“off,on” R--- Infrared Day/Night operation

list

--F--

c.1.irlight

:=<string>

off,on R--U Infrared light status *7 --F--

c.1.irlight.param

:=<string>

0...4 RC-U Infrared level *4


mode other than

manual.

--F--

c.1.irlight.param.min:=<int>

0 R--- Infrared level minimum value --F--

77



c.1.irlight.param.max:=<int>

4 R--- Infrared level maximum value --F--

c.1.wb

:=<string>

Select from

c.1.wb.list RC-U White balance mode *8

ZTFSR ‐

c.1.wb.list

:=<string>

“auto,manual,

one_shot,

sodium,

halogen, mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h”

R--U White balance mode list ZTFSR ‐

c.1.wb.value

:=<string>

<R gain value>

-<B gain value>

RC-U RB gain value *9

Note: Disabled in white

balance mode other

than manual.

ZTFSR ‐

c.1.is:=<string> off,on1,on2 RC-U Image stabilization *10

Z-F-R A.8 Image

Stabilizer

c.1.nr:=<int> 0...2 RC-U Noise reduction level

Note: Mild 0 ←→ 2 Strong ZTFSR ‐

c.1.nr.min

:=<int>

0 R--U Minimum configurable value of

noise reduction level ZTFSR ‐

c.1.nr.max

:=<int>

2 R--U Maximum configurable value

of noise reduction level ZTFSR ‐

c.1.ac:=<int> 0...6 RC-U Aperture correction level

Note: Weak 0 ←→ 6 Strong ZTFSR ‐

c.1.ac.min

:=<int>


aperture correction level ZTFSR ‐

c.1.ac.max

:=<int>


of aperture correction level ZTFSR ‐

c.1.saturation

:=<int>

0...6 RC-U Saturation level

Note: Light 0 ←→ 6 Dark ZTFSR ‐

c.1.saturation.

min:=<int>


saturation level ZTFSR ‐

c.1.saturation.

max:=<int>


of saturation level ZTFSR ‐

78



c.1.shade

:=<string>

Select from

c.1.shade.list RC-U Shade control mode

Note: auto is disabled in

manual exposure mode.

ZTFSR ‐

c.1.shade.list

:=<string>

“on,off,auto” R--U Shade control mode list ZTFSR ‐

c.1.shade.param

:=<int>

0...6 RC-U Shade control parameter

Note: Weak 0 ←→ 6 Strong


Control auto mode.

ZTFSR ‐

c.1.shade.param.min:=<int>

0 R--U Minimum value of shade

control parameter ZTFSR ‐

c.1.shade.param.max:=<int>

6 R--U Maximum value of shade

control parameter ZTFSR ‐

c.1.defog

:=<string>

Select from

c.1.defog.list

RC-U Haze compensation mode

Note: Disabled in shade

control mode other than

off.

--F-R

A.11 Haze

Compensation

Function

** Difference

caution **

c.1.defog.list

:=<string>

“on,off,auto” R--U Haze compensation mode list

--F-R

c.1.defog.param

:=<int>

0...6 RC-U Haze compensation parameter

Note: Mild 0 ←→ 6 Strong



off.

Note: Disabled in haze

compensation auto

mode.

--F-R

c.1.defog.param.min:=<int>

0 R--U Minimum value of haze

compensation parameter

--F-R

c.1.defog.param.max:=<int>

6 R--U Maximum value of haze

compensation parameter --F-R

79

Note:

*1 Indicates the camera exposure mode.

c.1.exp:=auto : auto

c.1.exp:=flickerfree : auto (flickerless)

c.1.exp:=tv : auto (shutter priority)

c.1.exp:=manual : manual

c.1.exp:=flickerfree2 : auto (flickerless2)

*2 Shutter speed reverse number (1/n seconds)

*3 Indicates the camera metering mode.

c.1.photometry:=center : center-weighted

c.1.photometry:=average : average

c.1.photometry:=spot : spot

*4 When the exposure mode is set to manual, the control range (minimum/maximum gain

value range) may be exceeded.

*5 Indicates the night mode on/off status.

c.1.dn:=off : Day Mode

c.1.dn:=on : Night Mode

*6 Indicates the infrared day/night operation mode on/off status.

c.1.dn.irlight:=off : Disable

c.1.dn.irlight:=on : Day/Night Operation

*7 Indicates the infrared light status.

c.1.irlight:=off : Light off

c.1.irlight:=on : Light on

*8 Indicates the white balance mode.

c.1.wb:=auto : auto

c.1.wb:=manual : manual

c.1.wb:=one_shot : One-shot WB

c.1.wb:=sodium : Sodium Lamp

c.1.wb:=halogen : Halogen Lamp

c.1.wb:=mercury : Mercury Lamp

c.1.wb:=fluorescent_w : Warm Fluorescent

c.1.wb:=fluorescent_l : White Fluorescent

c.1.wb:=fluorescent_h : Daylight Fluorescent

* One-shot WB:

This is used for forcibly matching the white balance to the light source.

Use this to illuminate the subject to become the reference for white and shoot with

the subject filling the viewing angle.

After the white balance is matched, the mode switches to manual.

*9 The value range for <R gain value> and <B gain value> is 0...1023.

E.g. “c.1.wb.value:=1023-1023”

*10 Indicates whether or not the image stabilizer function is controlled.

* This function has the effect of correcting blurry images caused by movement of the

camera.

c.1.is:=off : Disable

c.1.is:=on1 : For small amplitude

c.1.is:=on2 : For large amplitude

80

5.2.3.1.8 Focus Zoom Information [c]

Parameters: Focus Zoom Information



c.1.focus

:=<string>

Select from

c.1.focus.list RC-U Focus mode *1

Z-F-R

A.1 Focus

Function

c.1.focus.list

:=<string>

“auto,infinity,

manual”

R--- Focus mode list

Z-F-R

c.1.focus.value

:=<int>

0...2048 RC-U Focus value

Note: Disabled in focus mode

other than manual.

Z-F-R

c.1.focus.raw

:=<int>

R--U Focus lens position

Z-F-R

c.1.zoom:=<int> 11...9500 RC-U Zoom value *2

Note: Unit is 0.01 degrees. ZTF-R

A.3 PTZ and

Digital PTZ

Function

c.1.zoom.d

:=<int>

210 R--- Digital zoom border value

(optical telephoto end) *2

Note: Unit is 0.01 degrees.

ZTF-R

c.1.zoom.min

:=<int>

11...9500 R--U Zoom telephoto side control

limit *2


ZTF-R

c.1.zoom.max

:=<int>

9500 R--U Zoom wide-angle side control

limit *2


ZTF-R

A.3 PTZ and

Digital PTZ

Function

c.1.zoom.limit.

min:=<int>

11 R--- Zoom telephoto side movable

limit *2


ZTF-R

c.1.zoom.limit.

max:=<int>

9500 R--- Zoom wide-angle side movable

limit *2


ZTF-R

c.1.zoom.speed.

pos:=<int>

0...7 RCS- Position specification zoom

speed ZTF-R

c.1.zoom.speed.

dir:=<int>

0...7 RCS- Direction specification zoom

speed ZTF-R

c.1.zoom.speed.min:=<int>

0 R--- Minimum zoom speed ZTF-R

c.1.zoom.speed.max:=<int>

7 R--- Maximum zoom speed ZTF-R

81

Note:

*1 Indicates the camera focus mode.

c.1.focus:=auto : auto

c.1.focus:=infinity : fixed at infinity

c.1.focus:=manual : manual

*2 This supports the control parameters of the optical system and is expressed in the

viewing angle (1=0.01 degrees) in the horizontal direction, but the actual obtained value

is discrete. (This is dependent on the resolution of the optical system, with the wide-

angle side being grainy and the telephoto side having more detail.)

* The telephoto zoom movable limit uses the digital zoom to enlarge the control range.

(The value decreases.)

* The telephoto zoom control limit uses the digital zoom to enlarge the control range.

(The value decreases.) If view restrictions are set, the area up to the setting is the

control limit.

* Set the view restrictions and digital zoom use with “View Restrictions (db20-db26)”

and “Digital Zoom Use Setting (db32)” of the WebView settings protocol.


82

5.2.3.1.9 Pan/Tilt Information [c]

Parameters: Pan/Tilt Information



c.1.pan:=<int> -18000...17999 RC-U Pan position *1

Note: Unit is 0.01 degrees. ZT--R

A.3 PTZ and

Digital PTZ

Function

c.1.pan.min

:=<int>

-18000 R- U Left side control limit of

camera platform *1


ZT--R

c.1.pan.max

:=<int>

17999 R- U Right side control limit of

camera platform *1


ZT--R

c.1.pan.limit.min

:=<int>

-18000 R--- Left side movable limit of

camera platform *1


ZT--R

c.1.pan.limit.max

:=<int>

17999 R--- Right side movable limit of

camera platform *1


ZT--R

c.1.pan.speed.

pos:=<int>

30...45000 RCS- Position specification pan

speed

Note: Unit is 0.01 degrees/sec.

Note: Speed when operation

mode is manual

ZT--R

c.1.pan.speed.dir

:=<int>

30...45000 RCS- Direction specification pan

speed



mode is manual *2

ZT--R

c.1.pan.speed.

min:=<int>

30 R--- Minimum pan speed



mode is manual

ZT--R

c.1.pan.speed.

max:=<int>

45000 R--- Maximum pan speed



mode is manual

ZT--R

c.1.pan.speed. mode.pos

:=<string>

Select from

c.1.pan.speed. mode.list

RCSU Positional pan operating speed

mode *3 Z---R

A.6 Angle of

View Linkage

Function

c.1.pan.speed. mode.dir

:=<string>

manual,auto1, auto2

RCSU Directional pan operating

speed mode *3 Z---R

c.1.pan.speed. mode.list

:=<string>

“manual,auto1” R--- Pan operating speed mode list

*4 Z---R

c.1.pan.speed. ratio.pos:=<int>

1...1000 RCSU Positional pan speed *5



mode is auto1

Z---R

83



c.1.pan.speed. ratio.dir:=<int>

1...1000 RCSU Directional pan speed *5



mode is auto1

Z---R

A.6 Angle of

View Linkage

Function

c.1.pan.speed. ratio.min:=<int>

1 R--- Minimum pan speed



mode is auto1

Z---R

c.1.pan.speed. ratio.max:=<int>

1000 R--- Maximum pan speed



mode is auto1

Z---R

c.1.tilt:=<int> -18000...1000 RC-U Tilt position *1


A.3 PTZ and

Digital PTZ

Function

c.1.tilt.min

:=<int>

-18000 R- U Downward control limit of

camera platform *1


ZT--R

c.1.tilt.max

:=<int>

1000 R- U Upward control limit of camera

platform *1


ZT--R

c.1.tilt.limit.min

:=<int>

-18000 R--- Downward movable limit of

camera platform *1


ZT--R

c.1.tilt.limit.max

:=<int>

1000 R--- Upward movable limit of

camera platform *1


ZT--R

c.1.tilt.speed.pos

:=<int>

30...45000 RCS- Position specification tilt speed



mode is manual

ZT--R

c.1.tilt.speed.dir

:=<int>

30...45000 RCS- Direction specification tilt

speed



mode is manual *2

ZT--R

c.1.tilt.speed.min

:=<int>

30 R--- Minimum tilt speed



mode is manual

ZT--R

c.1.tilt.speed.

max:=<int>

45000 R--- Maximum tilt speed



mode is manual

ZT--R

c.1.tilt.speed. mode.pos

:=<string>

Select from

c.1.tilt.speed. mode.list

RCSU Positional tilt operating speed

mode *3 Z---R

A.6 Angle of View Linkage

Function c.1.tilt.speed. mode.dir

:=<string>

manual,auto1,

auto2

RCSU Directional tilt operating speed

mode *3 Z---R

84



c.1.tilt.speed. mode.list

:=<string>

“manual,auto1” R--- Tilt operating speed mode list

*4 Z---R

A.6 Angle of View Linkage

Function

c.1.tilt.speed. ratio.pos:=<int>

1...1000 RCSU Positional tilt speed *5



mode is auto1

Z---R

c.1.tilt.speed.

ratio.dir:=<int>

1...1000 RCSU Directional tilt speed *5



mode is auto1

Z---R

c.1.tilt.speed. ratio.min:=<int>

1 R--- Minimum tilt speed



mode is auto1

Z---R

c.1.tilt.speed. ratio.max:=<int>

1000 R--- Maximum tilt speed



mode is auto1

Z---R

Note:

*1 This supports the control parameters of the optical system and is expressed with the

viewing angle (1=0.01 degrees) in the horizontal direction, but the actual front is

expressed as 0/0 and the right/top are expressed with a positive viewing angle (1=0.01

degrees). The value actually obtained is discrete (dependent on the position resolution

of the camera platform), and the value range is dependent on the “Image Flip (da05)”

setting value of the WebView settings protocol. See ‘5.3 Items Related to the WebView

Settings Protocol ’.

The control limit value of pan and tilt is the limit value when at the zoom telephoto

limit. When the view restrictions are set or depending on the on/off status of auto flip,

the pan and tilt control range changes according to the zoom position, so the value is

indicated.

*2 c.1.pan.speed.dir and c.1.tilt.speed.dir indicate the operating speed when the

operating speed mode (c.1.pan.speed.mode.dir and c.1.tilt.speed.mode.dir) is

manual. In auto2, it indicates the operating speed at the wide angle end, and

multiplying this by the ratio to the wide angle end of the zoom viewing angle can be

used to obtain the current pan and tilt speed.

*3 This indicates the pan and tilt operating speed mode. The following are examples of

directional pan operating speed modes, and the same modes apply to tilt. The maximum

speed mode is only enabled when the direction is specified.

* The maximum speed mode applies when the WebView settings protocol “Pan-tilt speed

control method (ha02)” setting item is set to “1”.

c.1.pan.speed.mode.pos:=manual : Constant speed mode

c.1.pan.speed.mode.pos:=auto1 : Ratio mode

c.1.pan.speed.mode.pos:=auto2 : Maximum speed mode

*4 The pan and tilt operating speed mode list is fixed at “manual,auto1”. This list is

“manual,auto1” even when the directional operating speed mode is “auto2”.

85

*5 c.1.pan.speed.ratio.xxx and c.1.tilt.speed.ratio.xxx multiply the current zoom viewing

angle as a percentage to determine the operating speed when the operation mode is auto1.

E.g. When c.1.pan.speed.ratio.dir is 200 and the current horizontal viewing angle is

2040, the directional panning speed is 40.80 degrees per second.

5.2.3.1.10 Auto Flip Setting Information [c]

Parameters: Auto Flip Setting Information



c.1.eflip

:=<string>

off,on R--U Flip status ----R A.13 Auto Flip

Function

** Difference

caution **

5.2.3.1.11 View Restrictions Setting Information [c]

Parameters: View Restrictions Setting Information



c.1.view

:=<string>

<visible range> R--U Visible range *1


A.4 View

Restrictions

Function c.1.view.restriction:=<string>

off,on RC-U

Administrator

View Restrictions ZT--R

Note:

*1 <visible range> is displayed in the following format. (1=0.01 degrees)

<left limit>:<upper limit>:<width>:<height>

The value actually obtained is generally discrete, but it is dependent on the

combination of the pan, tilt, and zoom values.

86

5.2.3.1.12 Panorama Image Information [c]

Parameters: Panorama Image Information

Parameter Value Type/ Range

Attribute Description Camera Type


c.1.panorama.

count:=<int>

0...1 R--- Number of panorama images

Note: Image is created.

*1

ZTFSR

A.5 Panorama

Function

c.1.panorama.1.

view:=<string>

<visible range> R--- Panorama image field of view

information *1


ZT--R

c.1.panorama.1.

image:=<string>

<image

information> R--- Panorama image information *2 ZT--R

c.1.panorama.1.

timestamp

:=<string>

<date and time> R--U Panorama image shooting date

and time *3

E.g. Tue,30 Oct 2012 16:33:10

+0900

ZT--R A.5 Panorama

Function

Note:

*1 <visible range> is displayed in the following format. (1=0.01 degrees)

<left limit>:<upper limit>:<width>:<height>

*2 <image information> is displayed in the following format.

<width>x<height>:<image quality>:<size>

*3 <date and time> is displayed in the following format.

<day of week>,<day><month><year> <hour>:<minute>:<second> <time zone>

5.2.3.1.13 Home Position Setting Information [c]

Parameters: Home Position Setting Information



c.1.home.pan

:=<int>

-18000...17999 R--U Pan position of home position


A.3 PTZ and

Digital PTZ

Function

c.1.home.tilt

:=<int>

-18000...1000 R--U Tilt position of home position


c.1.home.zoom

:=<int>

11...9500 R--U Zoom value of home position


c.1.home.focus

:=<string>

auto,infinity,manual:<focus value>

R--U Focus mode of home position *1

Z---R A.1 Focus

Function

c.1.home.eflip

:=<string>

off,on R--U Flip information of home

position ----R A.13 Auto Flip

Function

** Difference

caution **

87



c.1.home.exp

:=<string>

auto,flickerfree, tv,manual

R--U Exposure mode of home

position ----R

A.14 Home

Position

Function

** Difference

caution **

c.1.home. ae.autoss

:=<int>

2,4,8,15,30 R--U Auto slow shutter of home

position


mode other than auto or

flickerfree.

----R

c.1.home. ae.shutter

:=<int>

2,4,8,15,30,60,

100,120,250,500, 1000, 2000,4000, 8000, 10000,16000

R--U Shutter speed of home position


mode other than tv.

----R

c.1.home.ae.

brightness

:=<int>

-8,-6,-4,2,0,2,4,6,8 R--U Exposure compensation value

of home position


exposure mode.


control auto mode.

ZT--R

A.3 PTZ and

Digital PTZ

Function

c.1.home.ae.

photometry

:=<string>

center,average,spot R--U Metering mode of home

position

Note: Disabled in manual exposure mode.

----R

A.14 Home

Position

Function

** Difference

caution **

c.1.home.me.

shutter:=<int>

1,2,4,8,15,30,60,

100,120,250,500, 1000,2000,4000, 8000,10000,16000

R--U Shutter speed of home position


mode other than

manual.

----R

c.1.home.me.iris

:=<int>

2...32 R--U Aperture value of home

position


mode other than

manual.

----R

c.1.home.me.

gain:=<int>

0...47 R--U Gain value of home position


mode other than

manual.

----R

c.1.home.dn

:=<string>

off,on R--U Day/Night state of home

position


mode other than

manual.

----R

c.1.home.dn

mode:=<string>

manual,auto1 R--U Day/Night control mode of

home position ----R

c.1.home.wb

:=<string>

auto,manual,

one_shot,sodium,

halogen,mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

R--U White balance mode of home

position ZT--R

A.3 PTZ and

Digital PTZ

Function

88



c.1.home.wb.

value:=<string>

<R gain value>

-<B gain value> R--U RB Gain value of home position

*2


balance mode other than

manual.

ZT--R

c.1.home.nr

:=<int>

0...2 R--U Noise reduction level of home

position


----R

A.14 Home

Position

Function

** Difference

caution **

c.1.home.ac

:=<int>

0...6 R--U Sharpness of home position

Note: Mild 0 ←→ 6 Strong ----R

c.1.home.saturation:=<int>

0...6 R--U Color saturation level of home

position

Note: Light 0 ←→ 6 Dark

----R

c.1.home.shade

:=<string>

on,off,auto R--U Shade control mode of home

position


control auto mode.

ZT--R

A.3 PTZ and

Digital PTZ

Function c.1.home.shade.

param:=<int>

0...6 R--U Shade control parameter of

home position


control auto mode.

ZT--R

c.1.home.defog

:=<string>

on,off,auto R--U Haze compensation mode of

home position



off.

----R

A.11 Haze

Compensation

Function

** Difference

caution **

c.1.home.defog.

param:=<int>

0...6 R--U Haze compensation parameter

of home position



off.


compensation auto

mode.

----R

Note:

*1 This is manual:<focus value> in manual mode.

E.g. “c.1.home.focus:=manual:2048”


E.g. “c.1.home.wb.value:=1023-1023”

89

5.2.3.1.14 Contact Input/Output Information [i/o]

Parameters: Contact Input/Output Information



i.count:=<int> 1...2 R--- Number of contact

input/output terminals ZTFSR

A.16 Contact Input/Output

Function

** Difference

caution **

i.<Input>

:=<int>

0, 1 R--U Status of contact input

terminal <Input> *1 ZTFSR

i.<Input>.name.asc:=<string>

R--U Contact input terminal

<Input> name (ASCII) ZTFSR

i.<Input>.name.utf8:=<unicode>

R--U Contact input terminal

<Input> name (UTF-8) ZTFSR

i.<Input>.name.

lang:=<string>

en,ja,fr,it,de,es,zh,tr,ru

R--U Set language for contact input

terminal <Input> name

(UTF-8) *2

ZTFSR A.7 Multilingual

Support

o.count:=<int> 1...2 R--- Number of contact output

terminals ZTFSR

A.16 Contact Input/Output

Function

** Difference

caution **

o.<Output>

:=<int>

0, 1 RC-U

Privileged

Status of contact output

terminal <Output> *1 ZTFSR

o.<Output>.name.asc:=<string>

R--U Contact output terminal

<Output> name (ASCII) ZTFSR

o.<Output>.

name.utf8

:=<unicode>

R--U Contact output terminal

<Output> name (UTF-8) ZTFSR

o.<Output>.name.lang:=<string>


R--U Set language for contact output

terminal <Output> name

(UTF-8) *2


Support

* For details on the <Input>, <Output> array subscript abbreviation, see ‘5.2 Command

Specifications ’.

Note:

*1 Indicates the camera contact status.

i/o.<Input/Output>:=0 : OFF

i/o.<Input/Output>:=1 : ON

*2 This item is also visible only when “Contact input/output terminal name (UTF-8)” is set.

i/o.<Input/Output>.name.lang:=en : English

i/o.<Input/Output>.name.lang:=ja : Japanese

i/o.<Input/Output>.name.lang:=fr : French

i/o.<Input/Output>.name.lang:=it : Italian

i/o.<Input/Output>.name.lang:=de : German

i/o.<Input/Output>.name.lang:=es : Spanish

i/o.<Input/Output>.name.lang:=zh : Chinese (Simplified)

i/o.<Input/Output>.name.lang:=tr : Turkish

i/o.<Input/Output>.name.lang:=ru : Russian

90

5.2.3.1.15 Preset Information [p]

For details about models that support this item, see ‘A.15 Preset Function ’.

Parameters: Preset Information



p.count:=<int> 0...20 R--U Number of preset information

settings

Note: Returns the number of

valid information

settings.

ZTFSR ‐

p.<Preset>.name.asc:=<string>

R--U Preset <Preset> name

(ASCII) ZTFSR ‐

p.<Preset>.name.utf8:=<unicode>

R--U Preset <Preset> name (UTF-

8)

ZTFSR ‐

p.<Preset>.name.lang:=<string>


R--U Set language of preset

<Preset> name (UTF-8) *1 ZTFSR A.7

Multilingual Support

p.<Preset>.c:=<int>

1 R--U Preset <Preset> camera


p.<Preset>.pan:=<int>

-17500...17500 R--U Preset <Preset> pan position

*2


ZTFSR

A.3 PTZ and

Digital PTZ

Function

p.<Preset>.tilt:=<int>

-9000...2777 R--U Preset <Preset> tilt position

*2


ZTFSR

p.<Preset>.zoom:=<int>

27...9500 R--U Preset <Preset> zoom value

*2


ZTFSR

p.<Preset>.focus:=<string>


R--U Preset <Preset> focus mode

*3 ----R A.1 Focus

Function

p.<Preset>.ae.brightness:=<int>

-8,-6,-4,-2, 0,2,4,6,8

R--U Preset <Preset> exposure

compensation value


Control auto mode.

ZT--R

A.3 PTZ and

Digital PTZ

Function

p.<Preset>.shade:=<string>

on,off,auto

R--U Preset <Preset> shade control

mode ZT--R

p.<Preset>.shade.param:=<int>

0...6 R--U Preset <Preset> shade control

value


Control auto mode.

ZT--R

p.<Preset>.wb:=<string>

auto,manual,

one_shot,sodium,

halogen,mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

R--U Preset <Preset> white

balance mode

ZT--R

91



p.<Preset>.wb.

value:=<string>

<R gain value>

-<B gain value>

R--U Preset <Preset> RB gain

value *4


balance mode other

than manual.

ZT--R A.3 PTZ and

Digital PTZ

Function

*For details on the <Preset> array subscript abbreviation, see ‘5.2 Command Specifications ’.

Note:

*1 This item is also visible only when “Preset name (UTF-8)” is set.

p.<Preset>.name.lang:=en : English

p.<Preset>.name.lang:=ja : Japanese

p.<Preset>.name.lang:=fr : French

p.<Preset>.name.lang:=it : Italian

p.<Preset>.name.lang:=de : German

p.<Preset>.name.lang:=es : Spanish

p.<Preset>.name.lang:=zh : Chinese (Simplified)

*2 Either the PTZ or digital PTZ value can be specified for the preset pan, tilt, and zoom

values, depending on the model, and therefore, the range value is listed as a

combination of the minimum and maximum values.


E.g. “p.1.focus:=manual:2048”


E.g. “p.1.wb.value:=1023-1023”

92

5.2.3.1.16 Extension Preset Information [p]





p 0...257 RC-U Preset number --F-R

A.15 Preset

Function

** Difference

caution **

p.count:=<int> 0...257 R--U Number of preset information

settings

Note: Returns the number of

valid information

settings.

ZTFSR

p.<Preset>.reference:=<string>

R--U Preset <Preset> setting

protocol ID --F-R

p.<Preset>.name.asc:=<string>


(ASCII)

ZTFSR ‐

p.<Preset>.name.utf8:=<unicode>


(UTF-8)

ZTFSR ‐

p.<Preset>.name.lang:=<string>

en,ja,fr,it,de,es,zh, tr,ru

R--U Set language of preset

<Preset> name (UTF-8) *1


Support

p.<Preset>.c:=

<int>

1 R--U Preset <Preset> camera

Note: Always 1

ZTFSR ‐


-18000...17999 R--U Preset <Preset> pan position

*2


ZTFSR

A.3 PTZ and Digital PTZ

Function

p.<Preset>.tilt:= <int>

-18000...4283 R--U Preset <Preset> tilt position

*2


ZTFSR


11...9500 R--U Preset <Preset> zoom value

*2


ZTFSR



R--U Preset <Preset> focus mode

*3 Z-F-R A.1 Focus

Function

p.<Preset>.eflip:=<string>

off,on R--U Preset <Preset> flip

information

----R A.13 Auto Flip Function

** Difference

caution **

p.<Preset>.exp:=<string>

auto,flickerfree,tv,manual


mode --F-R

A.15 Preset Function

** Difference

caution **

p.<Preset>.ae.autoss:=<int>

2,4,8,15,30 R--U Preset <Preset> auto slow

shutter


mode other than auto or

flickerfree.

--F-R

93



p.<Preset>.ae.shutter:=<int>

2,4,8,15,30,60,

100,120,250,500, 1000,2000,4000, 8000,10000,16000

R--U Preset <Preset> shutter

speed


mode other than tv.

--F-R


-8,-6,-4,-2,0,2,4, 6,8


compensation value


control auto mode.

ZTF-R A.3 PTZ and Digital PTZ

Function

p.<Preset>.ae.ph

otometry:=<string>

center,average, spot

R--U Preset <Preset> metering

mode

Note: Disabled in manual exposure mode.

--F-R


** Difference

caution **

p.<Preset>.me.shutter:=<int>

1,2,4,8,15,30,60, 100,120,250,500, 1000,2000,4000, 8000,10000,16000

R--U Preset <Preset> shutter

speed


mode other than

manual.

--F-R

p.<Preset>.me.iris:=<int>

2...32 R--U Preset <Preset> aperture

value


mode other than

manual.

--F-R

p.<Preset>.me.ga

in:=<int> 0...47 R--U Preset <Preset> gain value


mode other than

manual.

--F-R

p.<Preset>.dn:= <string>

off,on R--U Preset <Preset> Day/Night

mode


switching mode other

than manual.

--F-R

p.<Preset>.dn. mode:=<string>

manual,auto1 R--U Preset <Preset> Day/Night

switching mode --F-R

p.<Preset>.dn. irlight:=<string>

off,on R--U Preset <Preset> infrared

Day/Night operation --F--

A.12 Infrared Function

** Difference

caution **

p.<Preset>.irlight.param:=<int>

0...4 R--U Preset <Preset> infrared level


mode other than

manual.

--F--

p.<Preset>.wb:= <string>

auto,manual,

one_shot,sodium,

halogen,mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

R--U Preset <Preset> white

balance mode

ZTF-R


Function

94



p.<Preset>.wb.value:=<string>

<R gain value>

-<B gain value>

R--U Preset <Preset> RB gain

value *4


balance mode other than

manual.

ZTF-R

p.<Preset>.nr:= <int>

0...2 R--U Preset <Preset> noise

reduction


--F-R


** Difference

caution **

p.<Preset>.ac:= <int>

0...6 R--U Preset <Preset> sharpness

Note: Mild 0 ←→ 6 Strong --F-R

p.<Preset>.saturation:=<int>

0...6 R--U Preset <Preset> color

saturation


--F-R


on,off,auto

R--U Preset <Preset> shade control

mode

ZTF-R


Function p.<Preset>.shade.param:=<int>

0...6 R--U Preset <Preset> shade control

value


control auto mode.

ZTF-R

p.<Preset>.defog

:=<string>

on,off,auto R--U Preset <Preset> haze

compensation mode



off.

--F-R

A.11 Haze Compensation

Function

** Difference

caution **

p.<Preset>.

defog.param

:=<int>

0...6 R--U Preset <Preset> haze

compensation level



off.


compensation auto

mode.

--F-R


95

Note:


p.<Preset>.name.lang:=en : English

p.<Preset>.name.lang:=ja : Japanese

p.<Preset>.name.lang:=fr : French

p.<Preset>.name.lang:=it : Italian

p.<Preset>.name.lang:=de : German

p.<Preset>.name.lang:=es : Spanish

p.<Preset>.name.lang:=zh : Chinese (Simplified)

p.<Preset>.name.lang:=tr : Turkish

p.<Preset>.name.lang:=ru : Russian

*2 Either the PTZ or digital PTZ value can be specified for the preset pan, tilt, and zoom

values, depending on the model, and therefore, the range value is listed as a

combination of the minimum and maximum values.


E.g. “p.1.focus:=manual:2048”

*4 The value range for <Rgain value> and <B gain value> is 0...1023.

E.g. “p.1.wb.value:=1023-1023”

96

5.2.3.1.17 Intelligent Function Information [r]

Parameters: Intelligent Function Information



r.engine:=<int> 0,1,-1 R--U Intelligent Function status

*1 ZTFSR ‐

r.meta:=<int> 0,1 RC-U Whether to embed in JPEG

header of meta data *2 ZTFSR ‐

r.pseudo:=<int> 0,1 R--U Pseudo-setting detection status

*3 ZTFSR ‐

r.track:=<int> 0,1 R--U Auto track information *4 ----R A.17 Intelligent

Function

** Difference

caution **

r.count:=<int> 0...15 R--U Number of Intelligent Function

detection rules ZTFSR ‐

r.<Rule>

:=<int>

0,1 R--U Detection status of detection

rule <Rule> *5 ZTFSR ‐

r.<Rule>.name.

asc:=<string>

R--U Detection rule <Rule> name

(ASCII) ZTFSR ‐

r.<Rule>.name.

utf8:=<unicode>

R--U Detection rule <Rule> name

(UTF-8) ZTFSR ‐

r.<Rule>.name.

lang:=<string>


R--U Set language of detection rule

<Rule> name (UTF-8) *6 ZTFSR A.7

Multilingual Support

r.<Rule>.type

:=<int>

0,1,2,3,4,5,6 R--U Detection type of detection rule

<Rule> *7 ZTFSR A.17 Intelligent

Function

** Difference

caution **

*For details on the <Rule> array subscript abbreviation, see ‘5.2 Command Specifications ’.

97

Note:

*1 Indicates the Intelligent Function status.

r.engine:=0 : OFF

r.engine:=1 : ON

r.engine:=-1 : Invalid

*2 Indicates the JPEG header embed status of the Intelligent Function detection result

meta data.

r.meta:=0 : OFF

r.meta:=1 : ON

*3 Indicates the detection status of the Intelligent Function pseudo-setting.

r.pseudo:=0 : OFF

r.pseudo:=1 : ON

*4 Indicates the auto track function status.

r.track:=0 : OFF

r.track:=1 : ON

*5 Indicates the detection status of the Intelligent Function.

r.<Rule>:=0 : OFF

r.<Rule>:=1 : ON


r.<Rule>.name.lang:=en : English

r.<Rule>.name.lang:=ja : Japanese

r.<Rule>.name.lang:=fr : French

r.<Rule>.name.lang:=it : Italian

r.<Rule>.name.lang:=de : German

r.<Rule>.name.lang:=es : Spanish

r.<Rule>.name.lang:=zh : Chinese (Simplified)

r.<Rule>.name.lang:=tr : Turkish

r.<Rule>.name.lang:=ru : Russian

*7 Indicates the detection type of the Intelligent Function.

r.<Rule>.type:=0 : Not set

r.<Rule>.type:=1 : Moving Object Detection

r.<Rule>.type:=2 : Abandoned Object Detection

r.<Rule>.type:=3 : Removed Object Detection

r.<Rule>.type:=4 : Camera Tampering Detection

r.<Rule>.type:=5 : Passing Detection

r.<Rule>.type:=6 : Intrusion Detection

98

5.2.3.1.18 Audio Device Information [a]

Parameters: Audio Device Information



a.count:=<int> 1 R--U Number of audio devices

ZTFSR

A.10 Audio

Function

** Difference

caution **

a.<Audio>.send

:=<string>

on,off R--U Transmit audio from audio

device <Audio> setting *1 ZTFSR

a.<Audio>.recv

:=<string>

on,off R--U Receive audio from audio

device <Audio> setting *2 ZTFSR

a.<Audio>.detect

:=<int>

0,1 R--U Volume detection status of

audio device <Audio> *3 ZTFSR

a.<Audio>.scream:=<int>

0,1 R--U Scream detection status of

audio device <Audio> *4 --F-R

*For details on the <Audio> array subscript abbreviation, see ‘5.2 Command Specifications ’.

Note:

*1 Indicates the audio transmission setting status. This is the same as the “Audio

Transmission (hb00)” setting of the WebView settings protocol.

a.<Audio>.send:=off : Audio transmission disabled

a.<Audio>.send:=on : Audio transmission enabled

*2 Indicates the audio reception setting status. This is the same as the “Audio Reception

(hb10)” setting of the WebView settings protocol.

a.<Audio>.recv:=off : Audio reception disabled

a.<Audio>.recv:=on : Audio reception enabled

*3 Indicates the volume detection status of the audio device.

a.<Audio>.detect:=0 : Detection not available

a.<Audio>.detect:=1 : Detection available

*4 Indicates the scream detection status of the audio device.

a.<Audio>.scream:=0 : Detection not available

a.<Audio>.scream:=1 : Detection available

5.2.3.1.19 User Event Information [e]

Parameters: User Event Information



e.count:=<int> 1 R--- Number of user-defined events

ZTFSR ‐

e.<Event>

:=<int>

0,1

RC-U

Administrator

Status of user-defined event

<Event> *1 ZTFSR ‐

*For details on the <Event> array subscript abbreviation, see ‘5.2 Command Specifications ’.

99

Note:

*1 Indicates the status of a user-defined event. (“e.1” is assigned to a manual recording

event.)

e.<Event>:=0 : OFF (Recording is not specified, or recording has finished.)

e.<Event>:=1 : ON (Recording is specified, or recording is being performed.)

5.2.3.1.20 Linked Event Information [l]

Parameters: Linked Event Information



l.count:=<int> 1...4 R--- Number of linked events --F-R A.18 Linked

Event Function

** Difference

caution **

l.<Joint>:=<int> 0,1 RC-U Status of linked event <Joint>

*1 --F-R

*For details on the <Joint> array subscript abbreviation, see ‘5.2 Command Specifications ’.

Note:

*1 Indicates the status of a linked event.

e.<Joint>:=0 : OFF

e.<Joint>:=1 : ON

Note:

For details of linked events, see ‘AppendixG Linked Event ’.

5.2.3.1.21 External Memory Information [f]

Parameters: External Memory Information



f.sd:=<int> 0,1,2 R--U Memory card mount status

*1 ZTFSR ‐

f.sd.magic:=<int> R--U Management information

update ID of memory card --F-R A.19 External

Memory

Information

** Difference

caution **

Note:

*1 Indicates the memory card mount status.

f.sd:=0 : Unmount

f.sd:=1 : Mount

f.sd:=2 : Mount (write-protected)

100

5.2.3.2 Get Panorama Image [panorama.cgi]

This is used to acquire panorama image data. Panorama image data is in the form of

JPEG files shot with the panorama creation tool and saved to the camera.

Shooting, saving, and deleting panorama image data can be done arbitrarily, and data

may not exist or may be updated. HTTP/1.1 caching can be used with panorama.cgi to

enable detection of updates to panorama image data.

- Panorama image data is subject to HTTP/1.1 caching. If data exists, the response

header changes to the “Cache-Control” header, and the “Last-Modified”

header, which is a cache validator, is granted. The client can use this to make a

request with the “if-Modified-Since” condition.

- panorama.cgi basically requires a session specification. In sessionless mode, this

is restricted only to the administrator.

5.2.3.2.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/panorama.cgi?s=<SessionID>


- If the panorama image data is not updated, HTTP status “304 Not Modified” is

returned as a response, and if no data exists, “404 Not Found” is returned.

- If this command is requested without a user other than the administrator

specifying the session ID, HTTP status “401 Unauthorized” is returned as a

response.

Parameters:



s=<string> Session ID ZTF-R A.5 Panorama

Function

101

5.2.3.2.2 Response

A. Successful response [Panorama image data available]

HTTP Code ：200 OK

Content-Type ：image/jpeg


MessageBody ：

<PanoramaImageData>

B. Error response


HTTP Status Meaning


! Session ID(s) not specified for request from user other than

administrator.

404 Not Found Resource corresponding to requested URI does not exist.

! Panorama image is not created.





102

5.2.4 Camera Control

The camera control commands under WV-HTTP are described below.

5.2.4.1 Camera Control [control.cgi]

This is used to control a network camera and control to a contact output terminal.

Select from control by using the camera control privileges being obtained in a session-

based case and control by obtaining the temporary camera control privileges in a

sessionless case. In addition, some functions can be controlled without camera control

privileges.

Table 5-14 Relationship between Camera Control Privileges and Whether a Session Is Specified

Camera Control Privileges

Action in Response to Specified Request

Session-based Use the camera control privileges being obtained in a session.

Sessionless control.cgi obtains the temporary control privileges of the specified priority

within the command process.

If camera control cannot be obtained immediately, control is not performed.

Camera control

privileges not

needed

Control can be performed without camera control privileges for only the

following types of control.

Control to the contact output terminals

Control of the pan, tilt, and zoom speeds

- A control request for multiple items can be included in one command. *1

- If one command contains both control that requires camera control privileges and

control that does not, camera control privileges are required. *2

Note:

*1 If control is requested for multiple items at one time, not all control may be executed as

requested, depending on the camera operation status. In particular, it is important to

note that control that performs mechanical operations, such as pan, tilt, and zoom

operation and Day/Night mode switching, requires time until the operation is completed.

To perform control requests separately, it is recommended that an interval of 200 ms or

more be used between requests.

*2 If camera control privileges cannot be obtained, control not requiring camera control

privileges will not be executed.

Angle of View Linkage

- Some models support the angle of view linkage function.

- This function adjusts the operating speed according to the angle of view of the

zoom as a pan-tilt speed adjustment function. For details about compatible

models, see ‘A.6 Angle of View Linkage Function ’.

- This function has the following three operation modes.

103

Table 5-15 Operation Modes

Operation Mode Description

manual This mode operates at a constant speed.

Pan-tilt operation is performed at a specified speed regardless of the zoom

viewing angle.

auto2 In this mode, the pan-tilt operation speed changes according to the zoom

viewing angle.

The operation speed is faster at the wide angle side and slower at the telephoto

side.

This is enabled by setting the settings protocol item “ha02” to “1”.

auto1 Similar to auto2, in this mode, the pan-tilt operation speed changes according

to the zoom viewing angle.

By specifying the control.cgi parameter, it is possible to control the linkage

ratio between the zoom viewing angle and pan-tilt operation speed.

- The operating mode is determined by the WebView settings protocol “Pan-tilt

speed control method (ha02)” setting value and control.cgi operating mode

parameter. When the constant speed mode is specified, the operating mode is

different when positional and directional. Angle of view linkage is only valid

when directional.

The following shows the differences in the operating mode when positional and

directional. The operating mode is managed individually for pan and tilt operations.

Table 5-16 Positional Operating Mode

Settings Protocol Setting Item “ha02” *1

0 (Manual) 1 (Auto (angle of view linkage))

Input Value*2

Constant speed mode Constant speed mode

(manual)

Constant speed mode (manual)

Ratio mode Ratio mode (auto1) Ratio mode (auto1)

Table 5-17 Directional Operating Mode

Settings Protocol Setting Item “ha02” *1

0 (Manual) 1 (Auto (angle of view linkage))

Input Value*2

Constant speed mode Constant speed mode

(manual)

Maximum speed mode (auto2)

Ratio mode Ratio mode (auto1) Ratio mode (auto1)

Note:

*1 For details on the WebView settings protocol “Pan-tilt speed control method (ha02)”

setting value, see ‘5.3 Items Related to the WebView Settings Protocol ’.

*2 This is the value input with c.1.pan.speed.mode and c.1.tilt.speed.mode of

control.cgi, and specify “manual” for the constant speed mode and “auto1” for the

ratio mode.

104

Auto Flip

- Some models support the auto flip function. See ‘A.13 Auto Flip Function ’.

- Auto flip is a tilt-specific function that performs an automatic flip operation

when the tilt value nears -100° and inverts the image. When the camera is

automatically tracking a moving object (such as a person), the image is inverted

as the person or object is almost directly below the camera, enabling display of

the image in a normal position.

- The pan and tilt angle values are converted as follows, as the image is inverted.

Pan 0° 0° Flip

180°

Tilt 0° Near -100° 0°

Fig. 5-10 Auto Flip Operation

The above figure shows the change in the camera movement and tilt angle value.

When the camera moves from position A (pan 0°, tilt 0°) to position C (tilt -180°), the

image flips at position B (tilt near -100°), the camera stops at position C, and the

angle values are converted to pan 180° and tilt 0°. (The pan position is moved by

180°.)

The tilt position can be specified up to -180° when auto flip is on.

When the angle is 0° to near -100°, the angle value is retained and is not converted.

105

The following is an operation example of the VB-R11VE.

The value of info.cgi changes as follows when the pan angle is 0° and the tilt angle

moves from 0° to -150°.

Fig. 5-11 Tilt Angle Value

The initial position becomes D, and c.1.pan:=0 and c.1.tilt:=0.

To move the tilt angle to -150°, use control.cgi to specify c.1.tilt=-15000.

After the tilt angle moves to -150°, the camera stops at position E.

The value of info.cgi at the position of E’ becomes c.1.pan:=-17999 and

c.1.tilt:=-3000.

Auto flip turns on, and although the camera orientation does not change, it is

converted to a coordinate up to -100°.

The position of point symmetry is centered at the pan angle of 0° and tilt angle of

-90°, the pan angle becomes a value of -179.99° and the tilt angle becomes a

value of -180-(-150)=-30°.

(The angle values with control.cgi and info.cgi are in units of 0.01°.)

- The auto flip information can be acquired with c.1.eflip of info.cgi. See

‘5.2.3.1.10 Auto Flip Setting Information [c] ’.

From position A to position B in Figure 5-10 c.1.eflip:=off

From position B to position C in Figure 5-10 c.1.eflip:=on

106

Note:

When auto flip is off, the operation range of the tilt is restricted to 0 to -90.00°.

To move to position C in Figure 5-10 at this point, move by performing the pan

operation.

Fig. 5-12 Auto Flip Off Operation

5.2.4.1.1 Commands

Syntax:

http://<ipaddress>/-wvhttp-01-/control.cgi?[s=<sessionID>][&s.priori

ty=<Priority>][&<Name>=<Value>]...


- If camera control privileges cannot be obtained immediately with a sessionless

control request, camera control is not performed, and “301” is returned as the

Livescope status response.

- Depending on the camera operation status, while the camera is executing

control.cgi, a status update notification may be sent from info.cgi multiple times.

- The actual camera movement position may not match the position specified with

the pan, tilt, or zoom control instructions. Confirm the actual movement position

with info.cgi.

- If a control item is not specified in the command, “406” is returned as the

Livescope status response.

- If an item other than the pan, tilt, or zoom speed is not specified for the control

item with a sessionless control request, “406” is returned as the Livescope status

response.

- If “-0” is specified with a control request by the pan, tilt or zoom difference

(magnification), “403” is returned as the Livescope status response.

- A session ID specification has priority over a priority specification.

107

5.2.4.1.2 Camera Control Privileges [s]

Parameters: Camera Control Privileges



s=<string> -C-- Session ID ZTFSR ‐

s.priority=<int> 0…50 -C-- Specifies the session priority.

*1


(general session)

ZTFSR ‐

Note:


0 : General session

1 - 4 : Reserved (if specified, it is treated as “5”)

5 - 50 : Privileged session

5.2.4.1.3 Camera Correction-related [c]

Parameters: Camera Correction-related



c.1.exp=<string>

auto,

flickerfree,

tv,

manual,

flickerfree2

RC-U Exposure mode


following:

Auto

Auto (Flickerless)

Auto (Shutter-priority AE)

Manual

Auto (Flickerless2)

Note: manual is disabled in

Shade Control auto

mode.

Note: Valid value list

c.1.exp.list

ZTFSR

A.9 Exposure

Function

** Difference

caution **

c.1.ae.autoss

=<int>

2,4,8,15,30 RC-U Auto slow shutter *1


mode other than auto

or flickerfree,

flickerfree2.


c.1.ae.autoss.list

ZTFSR ‐

c.1.ae.shutter

=<int>

2,4,8,15,30,60,

100,120,250,500, 1000,2000,4000, 8000,10000,16000



mode other than tv.


c.1.ae.shutter.list

ZTFSR ‐

108



c.1.ae.brightness

=<int>

-8,-6,-4,-2,0,2,4, 6,8

RC-U Exposure compensation value

Note: Dark -8 ←→ 8 Bright


exposure mode.


Control auto mode.


c.1.ae.brightness.list

ZTFSR ‐

c.1.ae.photometr

y=<string>

center,

average,

spot

RC-U Metering Mode


following:

Center-weighted metering

Average metering

Spot metering


exposure mode.


c.1.ae.photometry.list

ZTFSR ‐

c.1.me.shutter

=<int>

1,2,4,8,15,30,60,

100,120,250,500, 1000,2000,4000, 8000,10000,16000



mode other than

manual.


c.1.me.shutter.list

ZTFSR ‐

c.1.me.iris

=<int>

2...32 RC-U Aperture value *2


mode other than

manual.

Note: Valid value range

c.1.me.iris.min–max

ZTFSR

A.9 Exposure Function c.1.me.gain

=<int>

0...47 RC-U AGC gain value *2


mode other than

manual.


c.1.me.gain.min–max

ZTFSR

c.1.dn=<string>

off,

on

RC-U

Privileged

Day/Night state


following:

Day Mode

Night Mode


mode other than

manual.

Note: Privileged camera

control is required.

ZTFSR ‐

109



c.1.dn.mode

=<string>

manual,

auto1

RC-U

Privileged

Day/Night switching mode


following:

Manual

Auto

Note: In manual, the c.1.dn

value is used.


c.1.dn.mode.list



ZTFSR ‐

c.1.dn.irlight =<string>

off,

on

RC-U Infrared Day/Night operation


following:

Disable

Day/Night Operation

--F--

A.12 Infrared

Function

** Difference

caution ** c.1.irlight.param =<int>

0...4 RC-U Infrared Day/Night level


mode other than

manual.

--F--

c.1.is=<string>

off,

on1,

on2

RC-U

Privileged

Image stabilizer function


following:

Do not use

For small amplitude

For large amplitude



Z-F-R

A.8 Image

Stabilizer

c.1.wb=<string>

auto,

manual,

one_shot,

sodium,

halogen,

mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

RC-U White balance mode


following:

Auto

Manual

One-shot WB *3

Sodium Lamp

Halogen Lamp

Mercury Lamp

Warm Fluorescent

White Fluorescent

Daylight Fluorescent


c.1.wb.list

ZTFSR ‐

c.1.wb.value

=<string>

<R gain value>

-<B gain value>

RC-U RB gain value *4


balance mode other

than manual.

ZTFSR ‐

c.1.nr=<int> 0...2 RC-U Noise reduction level

Note: Mild 0←→ 2 Strong


c.1.nr.min–max

ZTFSR ‐

110



c.1.ac=<int> 0...6 RC-U Aperture correction level



c.1.ac.min–max

ZTFSR ‐

c.1.saturation

=<int>

0...6 RC-U Saturation level



c.1.saturation.min–

max

ZTFSR ‐

c.1.shade

=<string>

on,

off,

auto

RC-U Shade control mode

Control ON

Control OFF

Auto

Note: auto is disabled in

manual exposure mode.


compensation mode

other than off.


c.1.shade.list

ZTFSR ‐

c.1.shade.param

=<int>

0...6 RC-U Shade control parameter



Control auto mode.


c.1.shade.param.min

–max

ZTFSR ‐

c.1.defog

=<string>

on,

off,

auto

RC-U Haze compensation mode

Shade control ON

Shade control OFF

Shade control auto



off.


c.1.defog.list

--F-R

A.11 Haze

Compensation

Function

** Difference

caution ** c.1.defog.param

=<int>

0...6 RC-U Haze compensation parameter



compensation auto

mode.


c.1.defog.param.min

–max

--F-R

111

Note:

*1 Shutter speed reverse number (1/n seconds)

*2 When the exposure mode is set to manual, the control range (minimum/maximum gain

value range) may be exceeded.

*3 White balance mode “One-shot WB” is used for forcibly matching the white balance to

the light source. Use this to illuminate the subject to become the reference for white and

shoot with the subject filling the viewing angle.

After the white balance is matched, the mode switches to manual.


E.g. “c.1.wb.value:=1023-1023”

112

5.2.4.1.4 Camera Operation-related [c]

Parameters: Camera Operation-related


Reference to

Differences

c.1.focus

=<string>

auto,

infinity,

manual,

one_shot,

stop,

near,

far

RC-U Focus Mode

Note: Specify any of the following:

Auto

Fixed at infinity

Manual

One-shot AF *1

Stop *2

Move to near side *2

Move to far side *2


c.1.focus.list

Z-F-R

A.1 Focus

Function

c.1.focus.value

=<int>

0...2048 RC-U Focus value *3

Note: Disabled in focus mode other

than manual.

Z-F-R

c.1.zoom

=<string>

<absolute position>

(11...9500),

d[±]<differential

position>

(-9489...9489),

v[+]<magnification>

(0...53091),

stop,

tele,

wide

RC-U Zoom movement


<absolute position> specification

Moves the horizontal viewing angle

using the viewing angle


degrees.


specification

Moves the differential specification

from the current position using the

viewing angle specification in units

of 0.01 degrees.

v[+]<magnification> specification

*4


angle according to magnification

specification.




Stop *5

Move to telephoto side *5

Move to wide-angle side *5



c.1.zoom.min–max

ZT--R

A.3 PTZ and

Digital PTZ

Function

c.1.zoom.speed.

pos=<int>

0...7 RCS- Zoom speed at specified position


c.1.zoom.speed.min–max

ZT--R

A.3 PTZ and

Digital PTZ

Function c.1.zoom.speed.

dir=<int>

0...7 RCS- Zoom speed at specified direction


c.1.zoom.speed.min–max

ZT--R

113

Note:

*1 After focusing with autofocus, one-shot AF switches to manual.

*2 Focus mode parameters “Move to near side”, “Move to far side”, and “Stop” are

command operations used to adjust the position of the focus. The focus begins operating

at the “Move to near side” or “Move to far side” instruction, and operation stops at the

“Stop” instruction. When “Stop” is instructed, after the focus operation stops, the mode

switches to manual.

(If “Stop” is not instructed, the camera operates to the control limit, and then the mode

switches to manual.)

*3 The focus value is dependent on the zoom position, and therefore, the camera may not

focus even at the same focus value if the zoom position is different. In addition, the

actual configurable range fluctuates depending on the zoom position even in the range

of 0 to 2048.

*4 The magnification is the relative value, where the current viewing angle is 100. If 0 is

specified, the minimum value (c.1.zoom.min value) is used.

E.g. c.1.zoom=v+50 Moves at 50% magnification in the current viewing angle.

c.1.zoom=v+200 Moves at 200% in the current viewing angle.

*5 Zoom movement parameters “Move to telephoto side”, “Move to wide-angle side”, and

“Stop” are command operations used to adjust the zoom position. The zoom operation

begins at the “Move to telephoto side” or “Move to wide-angle side” instruction, and

operation stops at the “Stop” instruction.

114

5.2.4.1.5 Camera Platform-related [c]

Parameters: Camera Platform-related


Reference to

Differences

c.1.pan =<string>

<absolute

position>

(-18000...17999),

d[±]<differential

position>

(-35999...35999),

v[±]<relative

position>

(-100...100),

stop,

left,

right

RC-U Pan movement





degrees.

Specify the right side with a positive

(+) value, where the front of the

housing is 0.


specification




of 0.01 degrees.


specification *1



specification.

Specify with a relative position, with

-100 at the left end and 100 at the

right end, where the front of the

current position is 0.

Stop *2

Move to left side *2

Move to right side *2



c.1.pan.min–max

ZT--R

A.3 PTZ and

Digital PTZ

Function

c.1.pan.speed. mode=<string>

manual,

auto1

RCS- Pan speed operation mode *3

Note: The positional and directional

operation modes are set at the

same time.


Constant speed mode

Ratio mode

Z---R

A.6 Angle of View

Linkage Function

c.1.pan.speed. mode.pos =<string>

manual,

auto1

RCS- Positional pan operating speed mode


Constant speed mode

Ratio mode

Z---R

c.1.pan.speed. mode.dir =<string>

manual,

auto1

RCS- Directional pan operating speed mode


Constant speed mode

Ratio mode

Z---R

115


Reference to

Differences

c.1.pan.speed

=<int>

30...45000 RCS- Pan speed

Note: Speed when operation mode is

manual


pan speeds are set at the same

time.


c.1.pan.speed.min–max

ZT--R

A.3 PTZ and

Digital PTZ

Function

c.1.pan.speed.

pos=<int>

30...45000 RCS- Position specification pan speed


manual



ZT--R

c.1.pan.speed.dir

=<int>

30...45000 RCS- Direction specification pan speed


manual *4



ZT--R

c.1.pan.speed.ratio=<int>

1...1000 RCS- Pan speed *5


auto1


pan speeds are set at the same

time.


c.1.pan.speed.ratio.min–max

Z---R

A.6 Angle of View

Linkage Function

c.1.pan.speed. ratio.pos=<int>

1...1000 RCS- Position specification pan speed *5


auto1



Z---R

c.1.pan.speed. ratio.dir=<int>

1...1000 RCS- Direction specification pan speed *5


auto1



Z---R

116


Reference to

Differences

c.1.tilt=<string>

<absolute position>

(-18000...1000),


(-19000...19000),


(-100...100),

stop,

up,

down

RC-U Tilt movement





degrees.

Specify up with a positive (+) value,

where the housing is level at 0.


specification




of 0.01 degrees.


specification *6



specification.

Specify with a relative position, with

-100 at the lowermost position and

100 at the uppermost position,

where the front of the current

position is 0.

Stop *7

Move up *7

Move down *7



c.1.tilt.min–max

ZT--R

A.3 PTZ and

Digital PTZ

Function

c.1.tilt.speed. mode=<string>

manual,

auto1

RCS- Tilt speed operation mode *3


operation modes are set at the

same time.


Constant speed mode

Ratio mode

Z---R

A.6 Angle of View

Linkage Function

c.1.tilt.speed.mode.pos=<string>

manual,

auto1

RCS- Positional tilt operating speed mode


Constant speed mode

Ratio mode

Z---R

c.1.tilt.speed.

mode.dir= <string>

manual,

auto1

RCS- Directional tilt operating speed mode


Constant speed mode

Ratio mode

Z---R

117


Reference to

Differences

c.1.tilt.speed

=<int>

30...45000 RCS- Tilt speed


manual


tilt speeds are set at the same

time.


c.1.tilt.speed.min–max

ZT--R

A.3 PTZ and

Digital PTZ

Function

c.1.tilt.speed.pos=<int>

30...45000 RCS- Position specification tilt speed


manual



ZT--R

c.1.tilt.speed.dir=<int>

30...45000 RCS- Direction specification tilt speed


manual *4



ZT--R

c.1.tilt.speed. ratio=<int>

1...1000 RCS- Tilt speed *5


auto1


tilt speeds are set at the same

time.


c.1.tilt.speed.ratio.min–max

Z---R

A.6 Angle of View

Linkage Function

c.1.tilt.speed. ratio.pos=<int>

1...1000 RCS- Position specification tilt speed *5


auto1



Z---R

c.1.tilt.speed. ratio.dir=<int>

1...1000 RCS- Direction specification tilt speed *5


auto1



Z---R

118

Note:

*1 Specify the value with the left and right ends of the current viewing angle (current

video image) at ±100, where the front of the current position is 0. Therefore, the pan

angle per specification unit varies according to the current zoom position. If zoom

movement is also specified at the same time, the standard zoom position will end up

moving, and, therefore, the specified pan position will not be at the front.

*2 Pan movement parameters “Move to left side”, “Move to right side”, and “Stop” are

command operations used to adjust the pan position. The pan operation begins at the

“Move to left side” or “Move to right side” instruction, and operation stops at the “Stop”

instruction.

*3 When “manual” is specified for c.1.pan.speed.mode, the positional and directional

operation modes differ according to the WebView settings protocol “Pan-tilt speed

control method (ha02)” setting value. When this value is “0”, “manual” is set for both

c.1.pan.speed.mode.pos and c.1.pan.speed.mode.dir. When this value is “1”,

“manual” is set for c.1.pan.speed.mode.pos and “auto2” is set for

c.1.pan.speed.mode.dir. The same applies for tilt.

*4 c.1.pan.speed.dir and c.1.tilt.speed.dir indicate the operating speed when the

operation mode is manual. In auto2, it indicates the operating speed at the wide angle

end, and multiplying this by the ratio to the wide angle end of the zoom viewing angle

can be used to obtain the current pan and tilt speed.

*5 c.1.pan.speed.ratio.xxx and c.1.tilt.speed.ratio.xxx multiply the current zoom

viewing angle as a percentage to determine the operating speed when the operation

mode is auto1.

E.g. When c.1.pan.speed.ratio.dir is 200 and the current horizontal viewing angle is

2040, the directional panning speed is 40.80 degrees per second.

*6 Specify the value with the uppermost and lowermost positions of the current viewing

angle (current video image) at ±100, where the front of the current position is 0.

Therefore, the tilt angle per specification unit varies according to the current zoom

position. If zoom movement is also specified at the same time, the standard zoom

position will end up moving, and, therefore, the specified tilt position will not be at the

front.

*7 Tilt movement parameters “Move up”, “Move down”, and “Stop” are command

operations used to adjust the tilt position. The tilt operation begins at the “Move up” or

“Move down” instruction, and operation stops at the “Stop” instruction.

119

5.2.4.1.6 View Restrictions Setting Information [c]




c.1.view.restriction=<string>

off,on RC-U Administrator

View Restrictions ZT--R A.4 View

Restrictions

Function

5.2.4.1.7 Contact Output [o]

Parameters: Contact Output



o.<Output> =<int>

0 (or off),

1 (or on)

RC-U

Privileged

Status of contact output

terminal <Output>


following:

OFF

ON



ZTFSR ‐

*For details on the <Output> array subscript abbreviation, see ‘5.2 Command Specifications ’.

5.2.4.1.8 Extension Presets [p]


Parameters: Preset



p =<int> 0...257 RC-U Specify the preset --F-R A.15 Preset

Function

** Difference

caution **

120

5.2.4.1.9 User Event [e]

Parameters: User Event



e.<Event> =<int>

0,

1

RC-U

Administrator

Status of user-defined event

<Event>


following:

OFF

ON *1

Note: Administrator

authorities are

required.

ZTFSR ‐

*For details on the <Event> array subscript abbreviation, see ‘5.2 Command Specifications ’.

Note:

*1 e.1 is assigned to manually recording video to a memory card.

e.1 = 0 : OFF (recording video stop instruction)

e.1 = 1 : ON (recording video start instruction)

5.2.4.1.10 Digital PTZ [w]

Parameters: Digital PTZ


Reference to

Differences

w.4.zoom

=<string>

<absolute position>

(633...5710),


(-5077...5077),

v[+]<magnification>

(0...500)

RC-U Digital PTZ zoom movement *1



Moves the horizontal viewing angle

using the viewing angle


degrees.


specification




of 0.01 degrees.

v[+]<magnification>

specification


angle using the magnification

specification.




--FS-

A.3 PTZ and

Digital PTZ

Function

121


Reference to

Differences

w.4.pan

=<string>

<absolute position>

(-5710...5710),


(-11420...11420),


(-100...100)

RC-U Digital PTZ pan movement *2





degrees.

Specify the right side with a

positive (+) value, where the front

of the housing is 0.


specification




of 0.01 degrees.


specification



specification.


with -100 at the left end and 100 at

the right end, where the front of the

current position is 0.

--FS-

A.3 PTZ and

Digital PTZ

Function w.4.tilt

=<string>

<absolute position>

(-3854...4283),


(-8137...8137),


(-100...100)

RC-U Digital PTZ tilt movement *3





degrees.

Specify up with a positive (+) value,

where the housing is level at 0.


specification




of 0.01 degrees.


specification



specification.


with -100 at the lowermost position

and 100 at the uppermost position,

where the front of the current

position is 0.

--FS-

122

Note:

*1 The digital PTZ zoom function provides pseudo-zoom operations by adjusting the video

crop size to a viewing angle equivalent to the zoom value. By enlarging the video

cropped by the camera to the display size specified on the viewer, pseudo-zooming can

be achieved.

*2 The digital PTZ pan function provides pseudo-pan operations by adjusting the video

crop position in the horizontal direction.

*3 The digital PTZ tilt function provides pseudo-tilt operations by adjusting the video crop

position in the vertical direction.

5.2.4.1.11 Response

The item value of the processing result of the specified control item is returned for the

response to the control request. There are three different formats for the returned

response: “item name:=value”, “item name==value”, and “item name==?”.

- “item name:=value” indicates an item changed as a result of a processed control

request.

- “item name==value” indicates an item not changed as a result of a processed

control request.

- “item name==?” indicates that the value specified to a control item was disabled

for a control item mode or control item combination.

A. Successful response [normal]

HTTP Code ：200 OK



MessageBody ：



c.1.exp==auto

c.1.ae.autoss:=30

c.1.ae.brightness:=2

c.1.ae.photometry:=center

c.1.me.shutter==?

c.1.me.gain==?

123

Note:

Normally, only the result of the item is returned for the control request specified to the

parameter.

The above is an example of a response, and not all items are returned with one control

request.

In addition, all results related to the control request are returned for the custom settings

indicated below.

B. Error response


HTTP Status Meaning


! A user without privileged camera control requested control

that requires privileges.

! A user other than an administrator requested control that

requires administrator authorities.



301 No Camera Control Right Request denied due to no issuing of the control privilege

request.

! Unable to obtain camera control privileges with the priority

specification request.


! A value that does not match the type was specified to the

parameter.

! “-0” was specified with the differential position

(magnification) specification for pan, tilt, or zoom.


! Control item not specified to the parameter.

! An item other than pan, tilt, and zoom speed was not

specified with the priority specification request.



124

5.3 Items Related to the WebView Settings

Protocol Among the settings of the WebView settings protocol, the following are related items

for when using the commands of the WV-HTTP.

Administrator setting

Administrator authentication is required for administrator session creation

privileges, panorama information acquisition in sessionless mode, and some camera

control items under WV-HTTP. The administrator information is managed with the

following item.

WebView settings protocol: System information

Parameter Default Setting Description

aa00 Root Admin user name

See ‘5.4.1 System Information ’ in “Network Camera Server WebView Settings Protocol

Specifications ”.

Guest and authorized user setting

Under WV-HTTP, authentication is required as a network camera authorized user

for privileged session creation privileges and some camera control items. The WV-

HTTP authorized user information is managed with the following items. The

settings for video transmission and camera control privileges for guest users and

authorized users are also managed with the following items.

WebView settings protocol: User access control


gb00 Authorized user list (register up to 50 users)

gb13 Yes Authorized user audio transmission privilege

setting

gb33 Yes Guest user audio transmission privilege setting

gb50 Video transmission and

privileged camera control available

Authorized user camera privilege setting

gb51 Video transmission and

general camera control available

Guest user camera privilege setting

See ‘5.4.11 Security ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

125

HTTP authentication setting

The WV-HTTP administrator and authorized users must have HTTP Basic

authentication or Digest authentication. The authentication setting information is

managed with the following item.

WebView settings protocol: HTTP Server


ia06 Digest authentication HTTP authentication method

See ‘5.4.8 Servers ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

Note:

The HTTP server of models supported by these specifications supports Basic and Digest

authentication. The authentication method cannot support both authentication types; set

one authentication method on the Setting Page. By default, Digest authentication is set, and

if the authentication method is changed, the system must be restarted.

If a request is received with an appended authentication information header that differs

from the authentication method requested by the server, the client that made the request is

asked for re-authentication. The HTTP request fails unless the correct authentication

information is input for the re-authentication request (*401 Unauthorized).

Video transmission and camera control client setting

The control settings for the client requesting video transmission and camera control

under WV-HTTP are managed with the following items.

WebView settings protocol: Camera server


ha03 30 Maximum number of clients

ha04 30 Camera control queue length

ha05 30 Maximum frame rate

ha06 0 Maximum connection time

ha07 20 Camera control time


126

Note:

The HTTP server of models supported by these specifications disconnects the HTTP

connection as a timeout if communication cannot be established within 6 minutes (360

seconds) even for a connection with Keep-Alive specified. If a change in the system clock

causes a change in time that exceeds the timeout range of 6 minutes (360 seconds), a

disconnection may occur.

Video stream setting

The video stream options selected for video transmission under WV-HTTP and the

video stream content are changed by selecting the video size set. The video stream

setting is managed with the following items.

WebView settings protocol: Video capture


dp00 1920 x 1080 Video Size Set

dq02 6 320 x 240 video quality









dr01 480 x 270 Video size

See ‘5.4.6 Video ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

Note:

The Initial value for the video quality, varies by model.

127

Video stream setting [H.264]

The setting for selecting H.264 video transmission under WV-HTTP is managed

with the following items.

WebView settings protocol: H.264


dh00 Use bit rate control Bit Rate Control

dh01 6 Video quality

dh02 2048 Target bit rate (kbps)

dh03 480 x 270 Video size

dh04 30fps Frame rate

dh05 1.0 sec. I Frame interval


Note:

These settings exist for both the H.264[1] and H.264[2] video streams.

The Initial value for the video quality, varies by model.

Apply view restrictions/Digital zoom settings

The range of pan, tilt, and zoom control of WV-HTTP with the applied view

restriction setting is restricted. In addition, the telephoto zoom control limit of WV-

HTTP changes depending on whether the digital zoom is used. The application of

view restriction settings and digital zoom use settings are managed with the

following items.

WebView settings protocol: Camera Control


db20 Disable View restriction application setting

db21 Upper limit of visible range

db22 Lower limit of visible range

db23 Left limit of visible range

db24 Right limit of visible range

db25 Telephoto end of visible range

db26 Wide-angle end of visible range

db32 Do not use Digital zoom use setting

See ‘5.4.5 Cameras ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

128

Camera control preset limit setting

Set whether or not to limit the pan, tilt and zoom operations of camera control

under WV-HTTP to the preset positions registered in advance. This is called a

preset limit, and the setting is managed with the following items.

WebView settings protocol: Preset


ea08 Not restricted to preset limit. Restricted to camera control preset limit.

See ‘5.4.7 Preset ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

Event setting

Control of external device output under WV-HTTP is performed with the behavior

according to the external device output setting. The setting is managed with the

following items.

WebView settings protocol: External Device Output


sq00 Continuous Output format

sq01 1 sec. Hold time

sq80 Normally Open Operation Mode

See ‘5.4.10 Events ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

Image Stabilizer

Control of WV-HTTP image stabilization (image stabilizer function) can be

performed while the camera is powered on, but the following setting value is applied

when the camera reboots. This value is managed with the following item.

WebView settings protocol: Camera Control


db34 Do not use Use image stabilizer

See ‘5.4.5 Camera ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

129

Appendix

A List of Differences by Function or Series The following lists the differences in models by network camera function and series.

The different specifications for ‘5.2 Command Specifications ’ in each series are listed

by command type. Items that are not supported are grayed out, and areas that are

different from ‘5.2 Command Specifications ’ are displayed in bold underlined text.

VB-S30D/VB-S31D/VB-S800D/VB-S900F

VB-S805D/VB-S905F

VB-H43/VB-H630VE/VB-H630D/VB-H730F

VB-M42/VB-M620VE/VB-M620D/VB-M720F

VB-R11VE/VB-R11/VB-M641VE/VB-M641V/VB-M741LE

VB-R10VE/VB-M640VE/VB-M640V/VB-M740E

130

A.1 Focus Function

The differences in the focus function for models are listed by series.

A.1.1 [VB-S30D/VB-S31D/VB-S800D/VB-S900F]

The different specifications for the models in this series are shown below.

Information Acquisition [info.cgi]


Parameter

VB-S30D VB-S31D/S800D/S900F

Value Type/Range

Attribute Value Type/Range

Attribute

c.1.focus:=<string> Select from

c.1.focus.list RC-U N/A

c.1.focus.list:=<string> “auto,infinity,

manual”

R--- N/A

c.1.focus.value:=<int> 0...2048 RC-U N/A

c.1.focus.raw:=<int> R--U N/A

See ‘5.2.3.1.8 Focus Zoom Information [c] ’.


Parameter


Value Type/Range


Attribute

c.1.home.focus:=<string> auto, infinity,

manual:

<focus

value>

R--- N/A

See ‘5.2.3.1.13 Home Position Setting Information [c] ’.

131


Parameter


Value Type/Range


Attribute

p.<Preset>.focus:=<string> auto, infinity, manual:

<focus value>

R--U N/A

See ‘5.2.3.1.15 Preset Information [p] ’, ‘5.2.3.1.16 Extension Preset Information [p] ’.

* For details on the <Preset> array subscript abbreviation, see ‘5.2 Command

Specifications’.

Camera Control [control.cgi]


Parameter


Value Type/Range


Attribute

c.1.focus=<string> auto, infinity,

manual, one_shot, stop, near, far

RC-U N/A

c.1.focus.value=<int> 0...2048 RC-U N/A

See ‘5.2.4.1.4 Camera Operation-related [c] ’.

132

A.1.2 [VB-S805D/VB-S905F]

The models in this series do not support the focus function.



Parameter

VB-S805D/S905F

Value Type/Range Attribute

c.1.focus:=<string> N/A

c.1.focus.list:=<string> N/A

c.1.focus.value:=<int> N/A

c.1.focus.raw:=<int> N/A

See ‘5.2.3.1.8 Focus Zoom Information [c]’.


Parameter

VB-S805D/S905F


c.1.home.focus:=<string> N/A



Parameter

VB-S805D/S905F


p.<Preset>.focus:=<string> N/A



Specifications’.

133



Parameter

VB-S805D/S905F


c.1.focus=<string> N/A

c.1.focus.value=<int> N/A


134

A.1.3 [VB-H43/VB-H630VE/VB-H630D/VB-H730F]




Parameter

VB-H43 VB-H630VE/H630D/H730F

Value Type/ Range

Attribute Value Type/ Range

Attribute

c.1.focus:=<string> Select from c.1.focus.list

RC-U Select from c.1.focus.list

RC-U

c.1.focus.list:= <string> “auto,infinity, manual”

R--- “infinity,manual” R---

c.1.focus.value:= <int> 0...2048 RC-U 0...2048 RC-U

c.1.focus.raw:= <int> R--U R--U



Parameter


Value Type/ Range


Attribute

c.1.home.focus:= <string> auto, infinity, manual:

<focus value>

R--- N/A



Parameter


Value Type/ Range


Attribute


<focus value>

R--U N/A



Specifications ’.

135



Parameter


Value Type/ Range


Attribute

c.1.focus=<string> auto, infinity,

manual, one_shot, stop, near, far

RC-U infinity, manual,

one_shot, stop, near, far

RC-U

c.1.focus.value= <int> 0...2048 RC-U 0...2048 RC-U


136

A.1.4 [VB-M42/VB-M620VE/VB-M620D/VB-M720F]




Parameter

VB-M42 VB-M620VE/M620D/M720F

Value Type/ Range


Attribute



RC-U







Parameter


Value Type/ Range


Attribute


<focus value>

R--- N/A



Parameter


Value Type/ Range


Attribute


<focus value>

R--U N/A



Specifications ’.

137



Parameter


Value Type/ Range


Attribute

c.1.focus=<string> auto, infinity, manual, one_shot, stop, near, far

RC-U infinity, manual, one_shot, stop, near, far

RC-U



138

A.1.5 [VB-R11VE/VB-R11/VB-M641VE/VB-M641V/VB-M741LE]




Parameter

VB-R11VE/R11 VB-M641VE/M641V/M741LE

Value Type/ Range


Attribute



RC-U







Parameter


Value Type/ Range


Attribute


<focus value>

R--- N/A



Parameter


Value Type/ Range


Attribute


<focus value>

R--U infinity, manual:

<focus value>

R--U



Specifications ’.

139



Parameter


Value Type/ Range


Attribute



RC-U



140

A.1.6 [VB-R10VE/VB-M640VE/VB-M640V/VB-M740E]




Parameter

VB-R10VE VB-M640VE/M640V/M740E

Value Type/ Range


Attribute



RC-U







Parameter


Value Type/ Range


Attribute


<focus value>

R--- N/A



Parameter


Value Type/ Range


Attribute


<focus value>

R--U infinity, manual:

<focus value>

R--U



Specifications ’.

141



Parameter


Value Type/ Range


Attribute



RC-U



142

A.2 Full HD Function

The differences in the Full HD function for models are listed by series.


There is no difference in the Full HD function between the models in this series and

‘5.2 Command Specifications ’.

A.2.2 [VB-S805D/VB-S905F]


Creating a Session [open.cgi]

Parameters:

Parameter

VB-S805D/S905F

Value Type/Range


null

See ‘5.2.1.1.1 Commands ’.

Changing Session Attributes [session.cgi]

Parameters:

Parameter

VB-S805D/S905F

Value Type/Range



Still Image Retrieval [image.cgi]

Parameters:

Parameter

VB-S805D/S905F

Value Type/Range



143

Video Stream Retrieval [video.cgi]

Parameters:

Parameter

VB-S805D/S905F

Value Type/Range





Parameter

VB-S805D/S905F



parameter list>

R--U

See ‘5.2.3.1.4 Video Information [v] ’.


Parameter

VB-S805D/S905F


w.<Video>.size:=<string> <video width>x

<video height>

320x240

640x480

1280x960

320x180

640x360

1280x720

R--U

See ‘5.2.3.1.5 Video Information [w] ’.

* For details on the <Video> array subscript abbreviation, see ‘5.2 Command

Specifications ’.

Note:

For the values of “<video width>x<video height>” specified with the <video

parameter> and <video stream parameter list> parameters, see the parameter values

of “w.<Video>.size” in the video stream number information.

The values “1920x1080”, “960x540”, and “480x270” can be specified for this series,

but the video size set cannot be used as is, so a video size that is close to the specified value

and is one size lower is applied.

144


There is no difference in the Full HD function between the models in this series and

‘5.2 Command Specifications ’.




Parameters:

Parameter

VB-M42/M620VE/

M620D/M720F

Value Type/Range


null



Parameters:

Parameter

VB-M42/M620VE/

M620D/M720F

Value Type/Range




Parameters:

Parameter

VB-M42/M620VE/

M620D/M720F

Value Type/Range



145


Parameters:

Parameter

VB-M42/M620VE/

M620D/M720F

Value Type/Range





Parameter

VB-M42/M620VE/

M620D/M720F



parameter list>

R--U



Parameter

VB-M42/M620VE/

M620D/M720F


w.<Video>.size:=<string> <video width>x <video height>

320x240

640 x 480

1280 x 960

320x180

640 x 360

1280 x 720

R--U



Specifications ’.

146

Note:

For the values of “<video width>×<video height>” specified with the <video




but the video size set cannot be used as-is, so a video size that is close to the specified value


147




Parameters:

Parameter

VB-R11VE/R11/M641VE/M641V/M741LE

Value Type/Range


null



Parameters:

Parameter


Value Type/Range




Parameters:

Parameter


Value Type/Range




Parameters:

Parameter


Value Type/Range



148



Parameter




parameter list>

R--U



Parameter



w.<Video>.size:=<string> <video width>x<video height>

320x240

640 x 480

1280 x 960

320x180

640 x 360

1280 x 720

R--U



Specifications ’.

Note:







149




Parameters:

Parameter

VB-R10VE/M640VE/M640V/M740E

Value Type/Range


null



Parameters:

Parameter


Value Type/Range




Parameters:

Parameter


Value Type/Range




Parameters:

Parameter


Value Type/Range



150



Parameter




parameter list>

R--U



Parameter



w.<Video>.size:=<string> <video width>x

<video height>

320x240

640 x 480

1280 x 960

320x180

640 x 360

1280 x 720

R--U


*For details on the <Video> array subscript abbreviation, see ‘5.2 Command

Specifications ’.

Note:







151

A.3 PTZ and Digital PTZ Function

The differences in the PTZ and Digital PTZ function for models are listed by series.




Parameters:

Parameter

VB-S30D VB-S31D VB-S800D/S900F

Value Type/Range Value Type/Range Value Type/Range

w=<int> 1...5 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...5 1...6

c.1.zoom=<string> <absolute position>

(518...7770),


(-7252...7252),

v[+]<magnification>

(0...1500)

<absolute position>

(2765...9500),


(-6735...6735),

v[+]<magnification>

(0...350)

N/A

152

Parameter



c.1.pan=<string> <absolute position>

(-17500...17500),


(-35000...35000),


(-100...100)

<absolute position>

(-17500...17500),


(-35000...35000),


(-100...100)

N/A

c.1.tilt=<string> <absolute position>

(-9000...0),


(-9000...9000),


(-100...100)

<absolute position>

(-9000...0),

d[±]<differential position> (-9000...9000),


(-100...100)

N/A



Parameters:

Parameter



w=<int> 1...5 1...5 1...6




Parameter

VB-S30D/S31D VB-S800D VB-S900F

Value Type/ Range



Attribute

w.count:=<int> 5 R--U 6 R--U 6 R--U

w.<Video>.crop:=<string>

off R--U off, on R--U off, on R--U

w.4.crop.area:=<string>

N/A <crop width>x <crop height>

R--U <crop width>x <crop height>

R--U

w.4.crop.x:=<int> N/A <crop position X>

R--U <crop position X>

R--U

153

Parameter


Value Type/ Range



Attribute

w.4.crop.y:=<int> N/A <crop position Y>

R--U <crop position Y>

R--U

w.4.zoom:=<int> N/A 633...4750 R--U 640...4800 R--U

w.4.zoom.min:=<int>

N/A 633...950 R--U 640...960 R--U

w.4.zoom.max:=<in

t>

N/A 3167...4750 R--U 3200...4800 R--U

w.4.zoom.limit.min:=<int>

N/A 633 R--- 640 R---

w.4.zoom.limit.max:=<int>

N/A 9500 R--- 9600 R---

w.4.pan:=<int> N/A -4433...4433 RC-U -4480...4480 RC-U

w.4.pan.min:=<int> N/A -4433...-3420 R--U -4480...-3465 R--U

w.4.pan.max:=<int>

N/A 3420...4433 R--U 3465...4480 R--U

w.4.pan.limit.min:=<int>

N/A -4750 R--- -4800 R---

w.4.pan.limit. max:=<int>

N/A 4750 R--- 4800 R---

w.4.tilt:=<int> N/A -2565...2565 RC-U -2599...2599 RC-U

w.4.tilt.min:=<int> N/A -2565...-2404 R--U -2599...-2430 R--U

w.4.tilt.max:=<int> N/A 2404...2565 R--U 2430...2599 R--U

w.4.tilt.limit. min:=<int>

N/A -2850 R--- -2888 R---

w.4.tilt.limit. max:=<int>

N/A 2850 R--- 2888 R---

w.4.home.pan:=<int>

N/A -4433...4433 R--U -4480...4480 R--U

w.4.home.tilt:=<int>

N/A -2565...2565 R--U -2599...2599 R--U

w.4.home.zoom:=<int>

N/A 633...4750 R--U 640...4800 R--U


* For details on the <Video> array subscript abbreviation, see ‘5.2 Command Specifications ’.

154


Parameter


Value Type/ Range



Attribute

c.1.zoom:=<int> 518...7770 RC-U 2765...9500 RC-U N/A

c.1.zoom.d:=<int> 2070 R--- 9500 R--- N/A

c.1.zoom.min:=<int>

518,2070 *1

R--U 2765 R--U N/A

c.1.zoom.max:=<int>

7770 R--U 9500 R--U N/A

c.1.zoom.limit.min:=<int>

518...2070

*1

R--- 2765 R--- N/A

c.1.zoom.limit.max:=<int>

7770 R--- 9500 R--- N/A

c.1.zoom.speed.pos:=<int>

0...7 RCS- 0...7 RCS- N/A

c.1.zoom.speed.dir:=<int>

0...7 RCS- 0...7 RCS- N/A

c.1.zoom.speed.min:

=<int>

0 R--- 0 R--- N/A


7 R--- 7 R--- N/A


Note:

*1 For the VB-S30D, the minimum value varies depending on the usability of the digital

zoom. When the digital zoom is not used, it is 518, and when the digital zoom is used, it

is 2070.

155


Parameter


Value Type/ Range



Attribute

c.1.pan:=<int> -17500...

17500

RC-U -17500...

17500

RC-U N/A

c.1.pan.min:=<int> -17500 R--U -17500 R--U N/A

c.1.pan.max:=<int> 17500 R--U 17500 R--U N/A

c.1.pan.limit.min:=

<int>

-17500 R--- -17500 R--- N/A

c.1.pan.limit.max:=

<int>

17500 R--- 17500 R--- N/A

c.1.pan.speed.pos:=<int>

1000...12000 RCS- 1000...12000 RCS- N/A

c.1.pan.speed.dir:=<int>

1000...12000 RCS- 1000...12000 RCS- N/A

c.1.pan.speed.min:=<int>

1000 R--- 1000 R--- N/A

c.1.pan.speed.max:=<int>

12000 R--- 12000 R--- N/A

c.1.tilt:=<int> -9000...0 RC-U -9000...0 RC-U N/A

c.1.tilt.min:=<int> -9000 R--U -9000 R--U N/A

c.1.tilt.max:=<int> 0 R--U 0 R--U N/A

c.1.tilt.limit.min:=<i

nt>

-9000 R--- -9000 R--- N/A

c.1.tilt.limit.max:=<

int>

0 R--- 0 R--- N/A

c.1.tilt.speed.pos:=<int>

3000...12000 RCS- 3000...12000 RCS- N/A

c.1.tilt.speed.dir:=<int>

3000...12000 RCS- 3000...12000 RCS- N/A

c.1.tilt.speed.min:=<int>

3000 R--- 3000 R--- N/A

c.1.tilt.speed.max:=<int>

12000 R--- 12000 R--- N/A

See ‘5.2.3.1.9 Pan/Tilt Information [c]’.

156


Parameter


Value Type/ Range



Attribute

c.1.home.pan:=<int>

-17500...17500 R--- -17500...17500 R--- N/A

c.1.home.tilt:=<int> -9000...0 R--- -9000...0 R--- N/A

c.1.home.zoom:=<i

nt>

518...7770 R--- 2765...9500 R--- N/A

c.1.home.focus:=<string>

auto, infinity, manual:

<focus value>

R--- N/A N/A

c.1.home.ae.brightness:=<int>

-8, -6, -4, -2, 0, 2, 4, 6, 8

R--- -8, -6, -4, -2, 0, 2, 4, 6, 8

R--- N/A

c.1.home.shade:=<string>

on, off, auto

R--- on, off, auto

R--- N/A

c.1.home.shade.par

am:=<int>

0...6 R--- 0...6 R--- N/A

c.1.home.wb:=<stri

ng>

auto, manual,

one_shot, sodium,

halogen, mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

R--- auto, manual,

one_shot, sodium,

halogen, mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

R--- N/A

c.1.home.wb.value:=<string>

<R gain value> -<B gain

value>

R--- <R gain value>

-<B gain

value>

R--- N/A


Note:

The “c.1.home.focus” parameter is listed in ‘A.1 Focus Function ’, but it is also listed here

so as not to create confusion if omitted.

157


Parameter

VB-S30D VB-S31D VB-S800D VB-S900F

Value Type/ Range


Attribute Value Type/Range Attribute Value Type/ Range

Attribute


-17500...17500 R--U -17500...17500 R--U -4433...4433 R--U -4480...4480 R--U

p.<Preset>.tilt:=<int>

-9000...0

R--U -9000...0 R--U -2565...2565 R--U -2599...2599 R--U


518...7770 R--U 2765...9500 R--U 633...4750 R--U 640...4800 R--U


auto, infinity, manual:

<focus value>

R--U N/A N/A N/A


-8, -6, -4, -2, 0, 2, 4, 6, 8

R--U -8, -6, -4, -2, 0, 2, 4, 6, 8

R--U N/A N/A


on, off, auto

R--U on, off, auto

R--U N/A N/A

p.<Preset>.shade.param:=<int>

0...6

R--U 0...6 R--U N/A N/A

158

Parameter

VB-S30D VB-S31D VB-S800D VB-S900F

Value Type/ Range


Attribute Value Type/Range Attribute Value Type/ Range

Attribute

p.<Preset>.wb:=<string>

auto, manual,

one_shot,

sodium,

halogen, mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

R--U auto, manual,

one_shot,

sodium,

halogen, mercury,

fluorescent_w,

fluorescent_l,

fluorescent_h

R--U N/A N/A


<R gain value>

-<B gain value>

R--U <R gain value>

-<B gain value>

R--U N/A N/A

See ‘5.2.3.1.15 Preset Information [p] ’ , ‘5.2.3.1.16 Extension Preset Information [p] ’.

* For details on the <Preset> array subscript abbreviation, see ‘5.2 Command Specifications ’.

Note:

The “p.<Preset>.focus” parameter is listed in ‘A.1 Focus Function ’, but it is also listed here so as not to create confusion if omitted.

159



Parameter


Value Type/ Range



Attribute


(518...7770),


(-7252...7252),

v[+]<magnification>

(0...1500),

stop,

tele,

wide

RC-U <absolute position>

(2765...9500),


(-6735...6735),

v[+]<magnification>

(0...350),

stop,

tele,

wide

RC-U N/A

c.1.zoom.speed.pos=<int>

0...7 RCS- 0...7 RCS- N/A

c.1.zoom.speed.dir=<int>

0...7 RCS- 0...7 RCS- N/A


160


Parameter


Value Type/ Range



Attribute


(-17500...17500),


(-35000...35000),


(-100...100),

stop,

left,

right


(-17500...17500),


(-35000...35000),


(-100...100),

stop,

left,

right

RC-U N/A

c.1.pan.speed=<int>

1000...12000 RC-U 1000...12000 RC-U N/A

c.1.pan.speed.pos=<int>

1000...12000 RC-U 1000...12000 RC-U N/A

c.1.pan.speed.dir=<

int> 1000...12000 RC-U 1000...12000 RC-U N/A


(-9000...0),


(-9000...9000),


(-100...100),

stop,

up,

down

RCS- <absolute position>

(-9000...0),


(-9000...9000),


(-100...100),

stop,

up,

down

RCS- N/A

c.1.tilt.speed=<int> 3000...12000 RCS- 3000...12000 RCS- N/A

c.1.tilt.speed.pos=<int>

3000...12000 RCS- 3000...12000 RCS- N/A

c.1.tilt.speed.dir=<int>

3000...12000 RCS- 3000...12000 RCS- N/A

See ‘5.2.4.1.5 Camera Platform-related [c]’.

161


Parameter


Value Type/ Range



Attribute

w.4.zoom=<string> N/A <absolute position>

(633...4750),


(-4117...4117),

v[+]<magnification>

(0...500)


(640...4800),


(-4160...4160),

v[+]<magnification>

(0...500)

RC-U

w.4.pan=<string> N/A <absolute position>

(-4433...

4433),


(-8866...

8866),


(-100...100)


(-4480...

4480),


(-8960...

8960),


(-100...100)

RC-U

w.4.tilt=<string> N/A <absolute position>

(-2565...2565),


(-5130...5130),


(-100...100)


(-2599...2599),


(-5198...5198),


(-100...100)

RC-U

See ‘5.2.4.1.10 Digital PTZ [w] ’.

162

A.3.2 [VB-S805D/VB-S905F]



Parameters:

Parameter VB-S805D/S905F

Value Type/Range

w=<int> 1...6



Parameters:


Value Type/Range

w=<int> 1...6



Parameters:


Value Type/Range

w=<int> 1...6

c.1.zoom=<string> N/A

c.1.pan =<string> N/A

c.1.tilt =<string> N/A



Parameters:


Value Type/Range

w=<int> 1...6


163



Parameter

VB-S805D VB-S905F

Value Type/Range Attribute Value Type/Range Attribute

w.count:=<int> 6 R--U 6 R--U

w.<Video>.crop:=<string> off, on R--U off, on R--U

w.4.crop.area:=<string> <crop width>x<crop height>

R--U <crop width>x<crop height>

R--U

w.4.crop.x:=<int> <crop position X> R--U <crop position X> R--U

w.4.crop.y:=<int> <crop position Y> R--U <crop position Y> R--U

w.4.zoom:=<int> 633...4750 R--U 640...4800 R--U

w.4.zoom.min:=<int> 633...950 R--U 640...960 R--U

w.4.zoom.max:=<int> 3167...4750 R--U 3200...4800 R--U

w.4.zoom.limit.min:=<int> 633 R--- 640 R---

w.4.zoom.limit.max:=<int> 9500 R--- 9600 R---

w.4.pan:=<int> -4433...4433 RC-U -4480...4480 RC-U

w.4.pan.min:=<int> -4433...-3420 R--U -4480...-3465 R--U

w.4.pan.max:=<int> 3420...4433 R--U 3465...4480 R--U

w.4.pan.limit.min:=<int> -4750 R--- -4800 R---

w.4.pan.limit. max:=<int> 4750 R--- 4800 R---

w.4.tilt:=<int> -2565...2565 RC-U -2599...2599 RC-U

w.4.tilt.min:=<int> -2565...-2404 R--U -2599...-2430 R--U

w.4.tilt.max:=<int> 2404...2565 R--U 2430...2599 R--U

w.4.tilt.limit. min:=<int> -2850 R--- -2888 R---

w.4.tilt.limit. max:=<int> 2850 R--- 2888 R---

w.4.home.pan:=<int> -4433...4433 R--U -4480...4480 R--U

w.4.home.tilt:=<int> -2565...2565 R--U -2599...2599 R--U

w.4.home.zoom:=<int> 633...4750 R--U 640...4800 R--U



164




c.1.zoom:=<int> N/A

c.1.zoom.d :=<int> N/A

c.1.zoom.min:=<int> N/A

c.1.zoom.max:=<int> N/A

c.1.zoom.limit.min:=<int> N/A

c.1.zoom.limit.max:=<int> N/A

c.1.zoom.speed.pos:=<int> N/A

c.1.zoom.speed.dir:=<int> N/A

c.1.zoom.speed.min:=<int> N/A

c.1.zoom.speed.max:=<int> N/A





c.1.pan:=<int> N/A

c.1.pan.min:=<int> N/A

c.1.pan.max:=<int> N/A

c.1.pan.limit.min:=<int> N/A

c.1.pan.limit.max:=<int> N/A

c.1.pan.speed.pos:=<int> N/A

c.1.pan.speed.dir:=<int> N/A

c.1.pan.speed.min:=<int> N/A

c.1.pan.speed.max:=<int> N/A

c.1.tilt:=<int> N/A

c.1.tilt.min:=<int> N/A

c.1.tilt.max:=<int> N/A

c.1.tilt.limit.min:=<int> N/A

c.1.tilt.limit.max:=<int> N/A

c.1.tilt.speed.pos:=<int> N/A

c.1.tilt.speed.dir:=<int> N/A

c.1.tilt.speed.min:=<int> N/A

c.1.tilt.speed.max:=<int> N/A

165





c.1.home.pan:=<int> N/A

c.1.home.tilt:=<int> N/A

c.1.home.zoom:=<int> N/A

c.1.home.focus:=<string> N/A

c.1.home.ae.brightness:=<int> N/A

c.1.home.shade:=<string> N/A

c.1.home.shade.param:=<int> N/A

c.1.home.wb:=<string> N/A

c.1.home.wb.value:=<string> N/A

See ‘5.2.3.1.13 Home Position Setting Information [c]’.

Note:




Parameter

VB-S805D VB-S905F


p.<Preset>.pan:=<int> -4433...4433 R--U -4480...4480 R--U

p.<Preset>.tilt:=<int> -2565...2565 R--U -2599...2599 R--U

p.<Preset>.zoom:=<int> 633...4750 R--U 640...4800 R--U

p.<Preset>.focus:=<string> N/A N/A


N/A N/A

p.<Preset>.shade

:=<string>

N/A N/A

p.<Preset>.shade.param

:=<int>

N/A N/A

p.<Preset>.wb:=<string> N/A N/A


N/A N/A



166

Note:

The “p.<Preset>.focus” parameter is listed in ‘A.1 Focus Function ’, but it is also listed

here so as not to create confusion if omitted.



Parameter

VB-S805D/S905F


c.1.zoom=<string> N/A

c.1.zoom.speed.pos=<int> N/A

c.1.zoom.speed.dir=<int> N/A

See ‘5.2.4.1.4 Camera Operation-related [c]’.


Parameter

VB-S805D/S905F


c.1.pan=<string> N/A

c.1.pan.speed=<int> N/A

c.1.pan.speed.pos=<int> N/A

c.1.pan.speed.dir=<int> N/A

c.1.tilt=<string> N/A

c.1.tilt.speed=<int> N/A

c.1.tilt.speed.pos=<int> N/A

c.1.tilt.speed.dir=<int> N/A

See ‘5.2.4.1.5 Camera Platform-related [c]’.

167


Parameter

VB-S805D VB-S905F


w.4.zoom=<string> <absolute position>

(633...4750),


(-4117...4117),

v[+]<magnification>

(0...500)


(640...4800),


(-4160...4160),

v[+]<magnification>

(0...500)

RC-U

w.4.pan=<string> <absolute position>

(-4433...4433),

d[±]<differential

position>

(-8866...8866),


(-100...100)


(-4480...4480),

d[±]<differential

position>

(-8960...8960),


(-100...100)

RC-U

w.4.tilt=<string> <absolute position>

(-2565...2565),

d[±]<differential

position>

(-5130...5130),


(-100...100)


(-2599...2599),

d[±]<differential

position>

(-5198...5198),


(-100...100)

RC-U

See ‘5.2.4.1.10 Digital PTZ [w]’.

168




Parameters:

Parameter


Value Type/Range Value Type/Range

w=<int> 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...6


(27...6040),


(-6013...6013),

v[+]<magnification>

(0...22370)

N/A

169

Parameter




(-17000...17000),


(-34000...34000),


(-100...100)

N/A


(-9000...1000),


(-10000...10000),


(-100...100)

N/A



Parameters:

Parameter



w=<int> 1...5 1...6




Parameter

VB-H43 VB-H630VE/H630D VB-H730F

Value Type/ Range



Attribute


w.<Video>.crop:= <string>

off R--U off,on R--U off,on R--U

w.4.crop.area:= <string>



R--U

170

Parameter


Value Type/ Range



Attribute



R--U



R--U

w.4.zoom:=<int> N/A 667...5000 R--U 687...5156 R--U

w.4.zoom.min:= <int>

N/A 667...1000 R--U 687...1031 R--U

w.4.zoom.max:= <int>

N/A 3333...5000 R--U 3437...5156 R--U

w.4.zoom.limit.min:

=<int>

N/A 667 R--- 687 R---

w.4.zoom.limit.max:

=<int>

N/A 10000 R--- 10311 R---


w.4.pan.min:=<int> N/A -4666...

-3654

R--U -4812...

-3703

R--U

w.4.pan.max:= <int>

N/A 3654...4666 R--U 3703...4812 R--U

w.4.pan.limit.min:=

<int>

N/A -5000 R--- -5156 R---

w.4.pan.limit.max:=

<int>

N/A 5000 R--- 5156 R---


w.4.tilt.min:=<int> N/A -2740...-2531 R--U -2777...

-2610

R--U

w.4.tilt.max:=

<int>

N/A 2531...274

0

R--U 2610...27

77

R--U

w.4.tilt.limit.min:=

<int>

N/A -3045 R--- -3086 R---

w.4.tilt.limit.max:=

<int>

N/A 3045 R--- 3086 R---

w.4.home.pan:= <int>

N/A -4666...4666 RC-U -4812...

4812

R--U

w.4.home.tilt:= <int>

N/A -2740...2740 RC-U -2777...

2777

R--U

171

Parameter


Value Type/ Range



Attribute

w.4.home.zoom:= <int>

N/A 667...5000 R--U 687...5156 R--U




Parameter


Value Type/ Range


Attribute

c.1.zoom:=<int> 27...6040 RC-U N/A

c.1.zoom.d:=<int> 320 R--- N/A

c.1.zoom.min:= <int>

27, 320 *1 R--U N/A

c.1.zoom.max:= <int>

6040 R--U N/A

c.1.zoom.limit.min:

=<int>

27...320 *1 R--- N/A

c.1.zoom.limit.max:

=<int>

6040 R--- N/A


0...7 RCS- N/A


0...7 RCS- N/A


0 R--- N/A

c.1.zoom.speed.max

:=<int>

7 R--- N/A


Note:

*1 For the VB-H43, the minimum value varies depending on the usability of the digital

zoom. When the digital zoom is used, it is 27, and when the digital zoom is not used, it

is 320.

172


Parameter


Value Type/ Range


Attribute

c.1.pan:=<int> -17000...

17000

RC-U N/A

c.1.pan.min:=<int> -17000 R--U N/A

c.1.pan.max:=<int> 17000 R--U N/A

c.1.pan.limit.min:=

<int>

-17000 R--- N/A

c.1.pan.limit.max:=

<int>

17000 R--- N/A


62...15000 RCSU N/A


62...15000 RCSU N/A


62 R--- N/A


15000 R--- N/A

c.1.tilt:=<int> -9000...1000 RC-U N/A

c.1.tilt.min:=<int> -9000 R--U N/A

c.1.tilt.max:=<int> 1000 R--U N/A

c.1.tilt.limit.min:=

<int>

-9000 R--- N/A

c.1.tilt.limit.max:=

<int>

1000 R--- N/A


62...15000 RCSU N/A

c.1.tilt.speed.dir:= <int>

62...15000 RCSU N/A


62 R--- N/A


15000 R--- N/A

See ‘5.2.3.1.9 Pan/Tilt Information [c] ’.

173


Parameter


Value Type/ Range


Attribute

c.1.home.pan:= <int>

-17000...

17000

R--- N/A

c.1.home.tilt:=<int> -9000...1000 R--- N/A

c.1.home.zoom:= <int>

27...6040 R--- N/A

c.1.home.focus:= <string>

auto,infinity,

manual: <focus value>

R--- N/A

c.1.home.ae. brightness:=<int>

-8,-6,-4,-2,0,2, 4,6,8

R--- N/A

c.1.home.shade:= <string>

on,off,auto R--- N/A

c.1.home.shade.

param:=<int>

0...6 R--- N/A

c.1.home.wb:= <string>

auto,manual,

one_shot, sodium,halogen, mercury,

fluorescent_w, fluorescent_l, fluorescent_h

R--- N/A


<R gain value> -<B gain value>

R--- N/A


Note:



174


Parameter


Value Type/ Range



Attribute

p.<Preset>.pan:= <int>

-17000...

17000

R--U -4666...4666 R--U -4812...4812 R--U


-9000...1000 R--U -2740...2740 R--U -2777...2777 R--U


27...6040 R--U 667...5000 R--U 687...5156 R--U


auto,infinity,


R--U N/A N/A

p.<Preset>.ae. brightness:=<int>

-8,-6,-4,-2,0,2, 4,6,8

R--U N/A N/A


on,off,auto R--U N/A N/A

p.<Preset>.shade. param:=<int>

0...6 R--U N/A N/A

p.<Preset>.wb:=

<string>

auto,manual,

one_shot, sodium,halogen, mercury, fluorescent_w, fluorescent_l, fluorescent_h

R--U N/A N/A

p.<Preset>.wb. value:=<string>

<R gain value> -<B gain value>

R--U N/A N/A



Note:



175



Parameter


Value Type/ Range


Attribute


(27...6040),


(-6013...6013),

v[+]<magnification>

(0...22370),

stop,

tele,

wide

RC-U N/A


0...7 RCS- N/A

c.1.zoom.speed.dir =<int>

0...7 RCS- N/A


176


Parameter


Value Type/ Range


Attribute


(-17000...17000),


(-34000...34000),


(-100...100),

stop,

left,

right

RC-U N/A

c.1.pan.speed=<int>

62...15000 RC-U N/A


62...15000 RC-U N/A

c.1.pan.speed.dir

= <int>

62...15000 RC-U N/A


(-9000...1000),


(-10000...

10000),


(-100...100),

stop,

up,

down

RCS- N/A

c.1.tilt.speed=<int>

62...15000 RCS- N/A

c.1.tilt.speed.pos= <int>

62...15000 RCS- N/A

c.1.tilt.speed.dir= <int>

62...15000 RCS- N/A

See ‘5.2.4.1.5 Camera Platform-related [c] ’.

177


Parameter


Value Type/ Range



Attribute


(667...5000),


(-4333... 4333),

v[+]<magnification>

(0...500)


(687...5156),


(-4469... 4469),

v[+]<magnification>

(0...500)

RC-U


(-4666... 4666),


(-9332...

9332),


(-100...100)


(-4812... 4812),


(-9624...

9624),


(-100...100)

RC-U


(-2740... 2740),


(-5480... 5480),


(-100...100)


(-2777... 2777),


(-5544... 5544),


(-100...100)

RC-U


178




Parameters:

Parameter



w=<int> 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...6


179


Parameters:

Parameter



w=<int> 1...5 1...6


(27...6040),


(-6013...6013),

v[+]<magnification>

(0...22370)

N/A


(-17000...17000),


(-

34000...34000),


(-100...100)

N/A


(-9000...1000),


(-10000...10000),


(-100...100)

N/A



Parameters:

Parameter



w=<int> 1...5 1...6


180



Parameter

VB-M42 VB-M620VE/M620D VB-M720F

Value Type/ Range



Attribute



off R--U off, on R--U off, on R--U




R--U



R--U



R--U

w.4.zoom:=<int> N/A 812...5000 R--U 823...5000 R--U


N/A 812...1000 R--U 823...1000 R--U


N/A 4060...5000 R--U 4115...5000 R--U

w.4.zoom.limit.min:

=<int>

N/A 812 R--- 823 R---

w.4.zoom.limit.max:

=<int>

N/A 10000 R--- 10000 R---


w.4.pan.min:=<int> N/A -4500...-3654 R--U -4500...-3703 R--U

w.4.pan.max:= <int>

N/A 3654...4500 R--U 3703...4500 R--U

w.4.pan.limit.min:=

<int>

N/A -5000 R--- -5000 R---

w.4.pan.limit.max:=

<int>

N/A 5000 R--- 5000 R---


w.4.tilt.min:=<int> N/A -2740...-2531 R--U -2777... -2531

R--U



<int>

N/A -3045 R--- -3086 R---


<int>

N/A 3045 R--- 3086 R---

181

Parameter


Value Type/ Range



Attribute


N/A -4500...4500

RC-U -4500...4500

R--U


N/A -2740...2740 RC-U -2777...2777 R--U


N/A 812...5000 R--U 823...5000 R--U




Parameter


Value Type/ Range


Attribute

c.1.zoom:=<int> 27...6040 RC-U N/A

c.1.zoom.d:=<int> 320 R--- N/A


27,320 *1 R--U N/A


6040 R--U N/A

c.1.zoom.limit.min:

=<int>

27...320 *1 R--- N/A

c.1.zoom.limit.max:

=<int>

6040 R--- N/A


0...7 RCS- N/A


0...7 RCS- N/A


0 R--- N/A


7 R--- N/A


Note:

*1 For the VB-M42, the minimum value varies depending on the usability of the digital


is 320.

182


Parameter


Value Type/ Range


Attribute

c.1.pan:=<int> -17000...

17000

RC-U N/A



c.1.pan.limit.min:=

<int>

-17000 R--- N/A

c.1.pan.limit.max:=

<int>

17000 R--- N/A


62...15000 RCSU N/A


62...15000 RCSU N/A


62 R--- N/A


15000 R--- N/A

c.1.tilt:=<int> -9000...1000 RC-U N/A




<int>

-9000 R--- N/A


<int>

1000 R--- N/A


62...15000 RCSU N/A


62...15000 RCSU N/A


62 R--- N/A


15000 R--- N/A


183


Parameter


Value Type/ Range


Attribute


-17000...

17000

R--- N/A


c.1.home.zoom:= <int>

27...6040 R--- N/A


auto,infinity, manual:

<focus value>

R--- N/A


-8,-6,-4,-2,0,2, 4,6,8

R--- N/A


on,off,auto R--- N/A

c.1.home.shade.

param:=<int>

0...6 R--- N/A

c.1.home.wb:=

<string>

auto,manual,

one_shot, sodium,halogen,mercury, fluorescent_w, fluorescent_l, fluorescent_h

R--- N/A


<R gain value>

-<B gain value>

R--- N/A

See ‘5.2.3.1.13 Home Position Setting Information [c] ’ .

Note:



184


Parameter


Value Type/ Range



Attribute


-17000...

17000

R--U -4500...4500 R--U -4500...4500 R--U


-9000...1000 R--U -2740...2740 R--U -2777...2777 R--U


27...6040 R--U 4060...5000 R--U 4115...5000 R--U


auto,infinity,


R--U N/A N/A


-8,-6,-4,-2,0,2, 4,6,8

R--U N/A N/A


on,off,auto R--U N/A N/A


0...6 R--U N/A N/A

p.<Preset>.wb:=

<string>

auto,manual,


R--U N/A N/A


<R gain value>

-<B gain value>

R--U N/A N/A

See ‘5.2.3.1.16 Extension Preset Information [p] ’ .


Note:



185



Parameter


Value Type/ Range


Attribute


(27...6040),


(-6013... 6013),

v[+]<magnification>

(0...22370),

stop,

tele,

wide

RC-U N/A


0...7 RCS- N/A


0...7 RCS- N/A


186


Parameter


Value Type/ Range


Attribute


(-17000... 17000),

d[±]<differential

position>

(-34000... 34000),


(-100...100),

stop,

left,

right

RC-U N/A

c.1.pan.speed=<int>

62...15000 RC-U N/A


62...15000 RC-U N/A

c.1.pan.speed.dir= <int>

62...15000 RC-U N/A


(-9000...1000),


(-10000... 10000),


(-100...100),

stop,

up,

down

RCS- N/A

c.1.tilt.speed= <int>

62...15000 RCS- N/A


62...15000 RCS- N/A


62...15000 RCS- N/A

See ‘5.2.4.1.5 Camera Platform-related [c] ’ .

187


Parameter


Value Type/ Range



Attribute


(812...5000),


(-4188...4188),

v[+]<magnification>

(0...500)


(823...5000),


(-4177... 4177),

v[+]<magnification>

(0...500)

RC-U


(-4500...4500),


(-9000... 9000),


(-100...100)


(-4500... 4500),


(-9000...

9000),


(-100...100)

RC-U


(-2740...2740),


(-5480...5480),


(-100...100)


(-2777... 2777),


(-5544... 5544),


(-100...100)

RC-U


188




Parameters:

Parameter



w=<int> 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...6


(11..5840),


(-5829...5829),

v[+]<magnification>

(0...53091)

N/A

189

Parameter




(-18000...17999),


(-35999...35999),


(-100...100)

N/A


(-18000...0),


(-18000...18000),


(-100...100)

N/A



Parameters:

Parameter



w=<int> 1...5 1...6


190



Parameter

VB-R11VE/R11 VB-M641VE/M641V VB-M741LE

Value Type/ Range



Attribute







R--U



R--U



R--U

w.4.zoom:=<int> N/A 1142...5710 R--U 1134...5670 R--U


N/A 1142 R--U 1134 R--U


N/A 5710 R--U 5670 R--U

w.4.zoom.limit.min:

=<int>

N/A 1142 R--- 1134 R---

w.4.zoom.limit.max:

=<int>

N/A 11420 R--- 11340 R---


w.4.pan.min:=<int> N/A -5710 R--U -5103 R--U

w.4.pan.max:= <int>

N/A 5710 R--U 5103 R--U

w.4.pan.limit.min:=

<int>

N/A -5710 R--- -5670 R---

w.4.pan.limit.max:=

<int>

N/A 5710 R--- 5670 R---


w.4.tilt.min:=<int> N/A -3854...-2890 R--U -3827... -2870

R--U



<int>

N/A -4283 R--- -4253 R---


<int>

N/A 4283 R--- 4253 R---

191

Parameter


Value Type/ Range



Attribute


N/A -5710...5710 RC-U -5103...5103 R--U


N/A -3854...4283 RC-U -3827...3827 R--U


N/A 1142...5710 R--U 1134...5670 R--U




Parameter


Value Type/ Range



Attribute

c.1.zoom:=<int> 11...5840 RC-U N/A N/A

c.1.zoom.d:=<int> 210 R--- N/A N/A


11,210 *1 R--U N/A N/A


6040 R--U N/A N/A

c.1.zoom.limit.min:

=<int>

11...210 *1 R--- N/A N/A

c.1.zoom.limit.max:

=<int>

5840 R--- N/A N/A


0...7 RCS- N/A N/A

c.1.zoom.speed.dir:

=<int>

0...7 RCS- N/A N/A


0 R--- N/A N/A


7 R--- N/A N/A


Note:

*1 For the VB-R11VE/R11, the minimum value varies depending on the usability of the

digital zoom. When the digital zoom is used, it is 11, and when the digital zoom is not

used, it is 210.

192


Parameter


Value Type/ Range


Attribute

c.1.pan:=<int> -18000...

17999

RC-U N/A



c.1.pan.limit.min:=

<int>

-18000 R--- N/A

c.1.pan.limit.max:=

<int>

17999 R--- N/A


30...45000 RCSU N/A


30...45000 RCSU N/A


30 R--- N/A


45000 R--- N/A

c.1.tilt:=<int> -18000...0 RC-U N/A




<int>

-18000 R--- N/A


<int>

0 R--- N/A


30...45000 RCSU N/A


30...45000 RCSU N/A


30 R--- N/A


45000 R--- N/A


193


Parameter


Value Type/ Range


Attribute


-18000...17999 R--- N/A


c.1.home.zoom:=

<int>

11...5840 R--- N/A



<focus value>

R--- N/A


-8,-6,-4,-2,0,2,4, 6,8

R--- N/A


on, off, auto R--- N/A

c.1.home.shade.

param:=<int>

0...6 R--- N/A


auto,manual,


R--- N/A


<R gain value>

-<B gain value>

R--- N/A


Note:



194


Parameter


Value Type/ Range



Attribute


-18000...17999 R--U -5710...5710 RC-U -5103...5103 R--U

p.<Preset>. tilt:= <int>

-18000...0 R--U -3854...4283 RC-U -3827...3827 R--U


11...5840 R--U 1142...5710 R--U 1134...5670 R--U


auto,infinity,


R--U infinity,


R--U infinity,


R--U


-8,-6,-4,-2, 0,2,4,6,8

R--U -8,-6,-4,-2, 0,2,4,6,8

R--U -8,-6,-4,-2, 0,2,4,6,8

R--U


on,off,auto R--U on,off,auto R--U on,off,auto R--U


0...6 R--U 0...6 R--U 0...6 R--U


auto,manual,

one_shot, sodium,halogen,

mercury, fluorescent_w, fluorescent_l, fluorescent_h

R--U auto,manual,



R--U auto,manual,



R--U


<R gain value>

-<B gain value>

R--U <R gain value>

-<B gain value>

R--U <R gain value>

-<B gain value>

R--U

See ‘5.2.3.1.16 Extension Preset Information [p]’.


Note:



195



Parameter


Value Type/ Range


Attribute


(11...5840),


(-5829... 5829),

v[+]<magnification>

(0...53091),

stop,

tele,

wide

RC-U N/A


0...7 RCS- N/A


0...7 RCS- N/A


196


Parameter


Value Type/ Range


Attribute


(-18000...17999),


(-35999...35999),


(-100...100),

stop,

left,

right

RC-U N/A

c.1.pan.speed=<int>

30...45000 RC-U N/A


30...45000 RC-U N/A

c.1.pan.speed.dir=

<int>

30...45000 RC-U N/A


(-18000...0),


(-18000...18000),


(-100...100),

stop,

up,

down

RCS- N/A


30...45000 RCS- N/A


30...45000 RCS- N/A


30...45000 RCS- N/A


197


Parameter


Value Type/ Range



Attribute


(1142...5710),


(-4568...4568),

v[+]<magnification>

(0...500)


(1134...5670),


(-4536...4536),

v[+]<magnification>

(0...500)

RC-U


(-5710...5710),


(-11420...11420),


(-100...100)


(-5670...5670),


(-11340...11340),


(-100...100)

RC-U


(-3854...4283),


(-8137...8137),


(-100...100)


(-3827...3827),


(-7654...7654),


(-100...100)

RC-U


198




Parameters:

Parameter



w=<int> 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...6



Parameters:

Parameter



w=<int> 1...5 1...6


(11...5840),


(-5829...5829),

v[+]<magnification>

(0...53091)

N/A

199

Parameter




(-18000...17999),


(-35999...35999),


(-100...100)

N/A


(-18000...0),


(-18000...18000),


(-100...100)

N/A



Parameters:

Parameter



w=<int> 1...5 1...6

See ‘5.2.2.2.1Commands ’.

200



Parameter

VB-R10VE VB-M640VE/M640V VB-M740E

Value Type/ Range



Attribute







R--U



R--U



R--U

w.4.zoom:=<int> N/A 1142...5710 R--U 1134...5670 R--U


N/A 1142 R--U 1134 R--U


N/A 5710 R--U 5670 R--U

w.4.zoom.limit.min:

=<int>

N/A 1142 R--- 1134 R---

w.4.zoom.limit.max:

=<int>

N/A 11420 R--- 11340 R---


w.4.pan.min:=<int> N/A -5710 R--U -5103 R--U

w.4.pan.max:= <int>

N/A 5710 R--U 5103 R--U

w.4.pan.limit.min:=

<int>

N/A -5710 R--- -5670 R---

w.4.pan.limit.max:=

<int>

N/A 5710 R--- 5670 R---


w.4.tilt.min:=<int> N/A -3854...-2890 R--U -3827...-2870 R--U



<int>

N/A -4283 R--- -4253 R---

201

Parameter


Value Type/ Range



Attribute


<int>

N/A 4283 R--- 4253 R---


N/A -5710...5710 RC-U -

5103...5103

R--U


N/A -3854...4283 RC-U -3827...3827 R--U


N/A 1142...5710 R--U 1134...5670 R--U




Parameter


Value Type/ Range



Attribute

c.1.zoom:=<int> 11...5840 RC-U N/A N/A

c.1.zoom.d:=<int> 210 R--- N/A N/A


11,210 *1 R--U N/A N/A


6040 R--U N/A N/A

c.1.zoom.limit.min:

=<int>

11...210 *1 R--- N/A N/A

c.1.zoom.limit.max:

=<int>

5840 R--- N/A N/A


0...7 RCS- N/A N/A


0...7 RCS- N/A N/A


0 R--- N/A N/A


7 R--- N/A N/A


202

Note:

*1 For the VB-R10VE, the minimum value varies depending on the usability of the digital


is 210.


Parameter


Value Type/ Range


Attribute

c.1.pan:=<int> -18000...17999 RC-U N/A



c.1.pan.limit.min:=

<int>

-18000 R--- N/A

c.1.pan.limit.max:=

<int>

17999 R--- N/A


30...45000 RCSU N/A


30...45000 RCSU N/A


30 R--- N/A


45000 R--- N/A

c.1.tilt:=<int> -18000...0 RC-U N/A




<int>

-18000 R--- N/A


<int>

0 R--- N/A


30...45000 RCSU N/A


30...45000 RCSU N/A


30 R--- N/A


45000 R--- N/A


203


Parameter


Value Type/ Range


Attribute


-18000...17999 R--- N/A

c.1.home.tilt:=<int>

-18000...0 R--- N/A

c.1.home.zoom:=

<int>

11...5840 R--- N/A



<focus value>

R--- N/A


-8,-6,-4,-2,0,2,4, 6,8

R--- N/A


on, off, auto R--- N/A

c.1.home.shade.

param:=<int>

0...6 R--- N/A


auto,manual,



R--- N/A


<R gain value>

-<B gain value>

R--- N/A


Note:



204


Parameter


Value Type/ Range



Attribute


-18000...17999 R--U -5710...5710 RC-U -5103...5103 R--U

p.<Preset>. tilt:= <int>

-18000...0 R--U -3854...4283 RC-U -3827...3827 R--U


11...5840 R--U 1142...5710 R--U 1134...5670 R--U


auto,infinity,


R--U infinity,


R--U infinity,


R--U


-8,-6,-4,-2,0,2, 4,6,8

R--U -8,-6,-4,-2,0,2, 4,6,8

R--U -8,-6,-4,-2,0,2, 4,6,8

R--U




0...6 R--U 0...6 R--U 0...6 R--U


auto,manual,



R--U auto,manual,



R--U auto,manual,

one_shot, sodium,haloge

n,mercury, fluorescent_w, fluorescent_l, fluorescent_h

R--U


<R gain value>

-<B gain value>

R--U <R gain value>

-<B gain value>

R--U <R gain value>

-<B gain value>

R--U

See ‘5.2.3.1.16 Extension Preset Information [p]’.


Note:



205



Parameter


Value Type/ Range


Attribute


(11...5840),


(-5829... 5829),

v[+]<magnification>

(0...53091),

stop,

tele,

wide

RC-U N/A


0...7 RCS- N/A


0...7 RCS- N/A


206


Parameter


Value Type/ Range


Attribute


(-18000...17999),


(-35999...35999),


(-100...100),

stop,

left,

right

RC-U N/A

c.1.pan.speed=<int>

30...45000 RC-U N/A


30...45000 RC-U N/A

c.1.pan.speed.dir=

<int>

30...45000 RC-U N/A


(-18000...0),


(-18000...18000),


(-100...100),

stop,

up,

down

RCS- N/A


30...45000 RCS- N/A


30...45000 RCS- N/A


30...45000 RCS- N/A


207


Parameter


Value Type/ Range



Attribute


(1142...5710),


(-4568...4568),

v[+]<magnification>

(0...500)


(1134...5670),


(-4536...4536),

v[+]<magnification>

(0...500)

RC-U


(-5710...5710),


(-11420...11420),


(-100...100)


(-5670...5670),


(-11340...11340),


(-100...100)

RC-U


(-3854...4283),


(-8137...8137),


(-100...100)


(-3827...3827),


(-7654...7654),


(-100...100)

RC-U


208

A.4 View Restrictions Function

The differences in the view restrictions function for models are listed by series.





Parameter

VB-S30D/S31D VB-S800D/S900F

Value Type/ Range


Attribute

c.1.view:=<string> <visible range> R--U N/A

c.1.view.restriction:=<string>

off,on RC-U

Administrator

N/A

See ‘5.2.3.1.11 View Restrictions Setting Information [c]’.



Parameter


Value Type/ Range


Attribute


off,on RC-U

Administrator

N/A


209

A.4.2 [VB-S805D/VB-S905F]

The models in this series do not support the view restrictions function.



Parameter

VB-S805D/S905F

Value Type/ Range

Attribute

c.1.view:=<string> N/A


N/A




Parameter

VB-S805D/S905F

Value Type/ Range

Attribute


N/A


210





Parameter


Value Type/ Range


Attribute

c.1.view:=<string> <visible range>

R--U N/A


off,on RC-U

Administrator

N/A

See ‘5.2.3.1.11 View Restrictions Setting Information [c] ’.



Parameter


Value Type/ Range


Attribute


off,on RC-U

Administrator

N/A


211





Parameter


Value Type/ Range


Attribute


R--U N/A


off,on RC-U

Administrator

N/A




Parameter


Value Type/ Range


Attribute


off,on RC-U

Administrator

N/A


212





Parameter


Value Type/ Range


Attribute


R--U N/A


off,on RC-U

Administrator

N/A




Parameter


Value Type/ Range


Attribute


off,on RC-U

Administrator

N/A


213





Parameter

VB-R10VE VB-M640VE/ M640V/ M740E

Value Type/ Range


Attribute


R--U N/A


off,on RC-U

Administrator

N/A




Parameter

VB-R10VE VB-M640VE/ M640V/ M740E

Value Type/ Range


Attribute


off,on RC-U

Administrator

N/A


214

A.5 Panorama Function

The differences in the panorama function for models are listed by series.





Parameter


Value Type/ Range


Attribute

c.1.panorama.count:=<int>

0...1 R--- 0 R---

c.1.panorama.1.view:=<string>

<visible range>

R--- N/A

c.1.panorama.1.image:

=<string>

<image

information> R--- N/A

c.1.panorama.1.timestamp:=<string>

<date and time>

R--U N/A

See ‘5.2.3.1.12 Panorama Image Information [c] ’.

Get Panorama Image [panorama.cgi]

Parameters:

Parameter



s=<string> N/A


215

A.5.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F


c.1.panorama.count:=<int>

0 R---


N/A

c.1.panorama.1.image:=<string>

N/A

c.1.panorama.1.timestamp:=<string>

N/A



Parameters:

Parameter

VB-S805D/S905F

Value Type/Range

s=<string> N/A


216





Parameter


Value Type/ Range


Attribute

c.1.panorama.count:= <int>

0...1 R--- 0 R---


<visible range>

R--- N/A


<image information>

R--- N/A

c.1.panorama.1. timestamp:=<string>

<date and time>

R--U N/A



Parameters:

Parameter



s=<string> N/A


217

A.5.4 VB-M42/VB-M620VE/VB-M620D/VB-M720F]




Parameter


Value Type/ Range


Attribute

c.1.panorama.count:= <int>

0...1 R--- 0 R---


<visible range>

R--- N/A


<image information>

R--- N/A

c.1.panorama.1. timestamp:=<string>

<date and time>

R--U N/A

See ‘ 5.2.3.1.12 Panorama Image Information [c] ’.


Parameters:

Parameter



s=<string> N/A


218





Parameter


Value Type/ Range


Attribute

c.1.panorama.count:=<int> 0...1 R--- 0 R---

c.1.panorama.1.view:=<string> <visible range>

R--- N/A

c.1.panorama.1.image:=<string> <image information>

R--- N/A

c.1.panorama.1.timestamp:=<string> <date and time>

R--U N/A



Parameters:

Parameter



s=<string> N/A


219





Parameter


Value Type/ Range


Attribute

c.1.panorama.count:=<int> 0...1 R--- 0 R---

c.1.panorama.1.view:=<string> <visible range>

R--- N/A

c.1.panorama.1.image:=<string> <image information>

R--- N/A

c.1.panorama.1.timestamp:=<string> <date and time>

R--U N/A



Parameters:

Parameter



s=<string> N/A


220

A.6 Angle of View Linkage Function

The differences in the angle of view linkage function for models are listed by series.


The models in this series do not support the angle of view linkage function.



Parameter

VB-S30D/S31D/S800D/S900F


c.1.pan.speed.mode. pos:=<string>

N/A

c.1.pan.speed.mode.dir:=<string>

N/A

c.1.pan.speed.mode.list:=<string>

N/A

c.1.pan.speed.ratio.pos:=<int>

N/A

c.1.pan.speed.ratio.dir:=<int>

N/A

c.1.pan.speed.ratio.min:=<int>

N/A

c.1.pan.speed.ratio. max:=<int>

N/A

c.1.tilt.speed.mode.pos:=<string>

N/A

c.1.tilt.speed.mode.dir:

=<string>

N/A

c.1.tilt.speed.mode.list:=<string>

N/A

c.1.tilt.speed.ratio.pos :=<int>

N/A

c.1.tilt.speed.ratio.dir :=<int>

N/A

c.1.tilt.speed.ratio.min :=<int>

N/A

c.1.tilt.speed.ratio.max:=<int>

N/A


221



Parameter


Value Type/ Range

Attribute

c.1.pan.speed.mode =<string>

N/A

c.1.pan.speed.mode. pos=<string>

N/A

c.1.pan.speed.mode.dir=<string>

N/A

c.1.pan.speed.ratio =<int>

N/A

c.1.pan.speed.ratio.pos=<int>

N/A

c.1.pan.speed.ratio.dir=<int>

N/A

c.1.tilt.speed.mode =<string>

N/A


N/A

c.1.tilt.speed.mode.dir=<string>

N/A

c.1.tilt.speed.ratio =<int>

N/A

c.1.tilt.speed.ratio.pos =<int>

N/A

c.1.tilt.speed.ratio.dir =<int>

N/A


222

A.6.2 [VB-S805D/VB-S905F]

The models in this series do not support the angle of view linkage function.



Parameter

VB-S805D/S905F

Value Type/ Range

Attribute

c.1.pan.speed.mode. pos:=<string>

N/A


N/A


N/A


N/A


N/A


N/A

c.1.pan.speed.ratio. max:=<int>

N/A


N/A

c.1.tilt.speed.mode.dir:=<string>

N/A

c.1.tilt.speed.mode.list:=<string>

N/A

c.1.tilt.speed.ratio.pos:

=<int>

N/A

c.1.tilt.speed.ratio.dir: =<int>

N/A

c.1.tilt.speed.ratio.min:=<int>

N/A

c.1.tilt.speed.ratio.max:=<int>

N/A


223



Parameter

VB-S805D/S905F

Value Type/ Range

Attribute

c.1.pan.speed.mode =<string>

N/A

c.1.pan.speed.mode. pos=<string>

N/A


N/A

c.1.pan.speed.ratio =<int>

N/A


N/A


N/A

c.1.tilt.speed.mode =<string>

N/A


N/A


N/A

c.1.tilt.speed.ratio =<int>

N/A

c.1.tilt.speed.ratio.pos =<int>

N/A

c.1.tilt.speed.ratio.dir =<int>

N/A


224





Parameter


Value Type/ Range


Attribute

c.1.pan.speed.mode.pos:=<string>

manual,auto1 RCSU N/A


manual,auto1

,

auto2

RCSU N/A


“manual,auto1” R--- N/A


1...500 RCSU N/A


1...500 RCSU N/A


1 R--- N/A

c.1.pan.speed.ratio.max:=<int>

500 R--- N/A




manual,auto1

,

auto2

RCSU N/A

c.1.tilt.speed.mode. list:=<string>


c.1.tilt.speed.ratio.

pos:=<int>

1...500 RCSU N/A

c.1.tilt.speed.ratio. dir:=<int>

1...500 RCSU N/A

c.1.tilt.speed.ratio. min:=<int>

1 R--- N/A

c.1.tilt.speed.ratio. max:=<int>

500 R--- N/A


225



Parameter


Value Type/ Range


Attribute

c.1.pan.speed.mode=<string>

manual,auto1 RCS- N/A

c.1.pan.speed.mode.pos=<string>





1...500 RCS- N/A


1...500 RCS- N/A


1...500 RCS- N/A

c.1.tilt.speed.mode=<string>






c.1.tilt.speed.ratio=<int>

1...500 RCS- N/A


pos=<int>

1...500 RCS- N/A

c.1.tilt.speed.ratio. dir=<int>

1...500 RCS- N/A


226





Parameter


Value Type/ Range


Attribute




manual,auto1

,

auto2

RCSU N/A




1...500 RCSU N/A


1...500 RCSU N/A


1 R--- N/A

c.1.pan.speed.ratio.max:=<int>

500 R--- N/A




manual,auto1

,

auto2

RCSU N/A

c.1.tilt.speed.mode. list:=<string>



pos:=<int>

1...500 RCSU N/A

c.1.tilt.speed.ratio. dir:=<int>

1...500 RCSU N/A

c.1.tilt.speed.ratio. min:=<int>

1 R--- N/A

c.1.tilt.speed.ratio. max:=<int>

500 R--- N/A


227



Parameter


Value Type/ Range


Attribute

c.1.pan.speed.mode=<string>


c.1.pan.speed.mode.pos=<string>





1...500 RCS- N/A


1...500 RCS- N/A


1...500 RCS- N/A

c.1.tilt.speed.mode=<string>






c.1.tilt.speed.ratio=<int>

1...500 RCS- N/A


pos=<int>

1...500 RCS- N/A

c.1.tilt.speed.ratio. dir=<int>

1...500 RCS- N/A


228





Parameter


Value Type/ Range


Attribute

c.1.pan.speed.mode.pos:=<string> manual,auto1 RCSU N/A

c.1.pan.speed.mode.dir:=<string> manual,auto1, auto2

RCSU N/A

c.1.pan.speed.mode.list:=<string> “manual,auto1” R--- N/A

c.1.pan.speed.ratio.pos:=<int> 1...1000 RCSU N/A

c.1.pan.speed.ratio.dir:=<int> 1...1000 RCSU N/A

c.1.pan.speed.ratio.min:=<int> 1 R--- N/A

c.1.pan.speed.ratio.max:=<int> 1000 R--- N/A

c.1.tilt.speed.mode.pos:=<string> manual,auto1 RCSU N/A

c.1.tilt.speed.mode.dir:=<string> manual,auto1, auto2

RCSU N/A

c.1.tilt.speed.mode.list:=<string> “manual,auto1” R--- N/A

c.1.tilt.speed.ratio.pos:=<int> 1...1000 RCSU N/A

c.1.tilt.speed.ratio.dir:=<int> 1...1000 RCSU N/A

c.1.tilt.speed.ratio.min:=<int> 1 R--- N/A

c.1.tilt.speed.ratio.max:=<int> 1000 R--- N/A




Parameter


Value Type/ Range


Attribute

c.1.pan.speed.mode=<string> manual,auto1 RCS- N/A

c.1.pan.speed.mode.pos=<string> manual,auto1 RCS- N/A

c.1.pan.speed.mode.dir=<string> manual,auto1 RCS- N/A

229

Parameter


Value Type/ Range


Attribute

c.1.pan.speed.ratio=<int> 1...1000 RCS- N/A

c.1.pan.speed.ratio.pos=<int> 1...1000 RCS- N/A

c.1.pan.speed.ratio.dir=<int> 1...1000 RCS- N/A

c.1.tilt.speed.mode=<string> manual,auto1 RCS- N/A

c.1.tilt.speed.mode.pos=<string> manual,auto1 RCS- N/A

c.1.tilt.speed.mode.dir=<string> manual,auto1 RCS- N/A

c.1.tilt.speed.ratio=<int> 1...1000 RCS- N/A

c.1.tilt.speed.ratio.pos=<int> 1...1000 RCS- N/A

c.1.tilt.speed.ratio.dir=<int> 1...1000 RCS- N/A






Parameter


Value Type/ Range


Attribute



c.1.pan.speed.mode.dir:=<string> manual,auto1,auto2 RCSU N/A



c.1.pan.speed.ratio.pos:=<int> 1...1000 RCSU N/A

c.1.pan.speed.ratio.dir:=<int> 1...1000 RCSU N/A

c.1.pan.speed.ratio.min:=<int> 1 R--- N/A

c.1.pan.speed.ratio.max:=<int> 1000 R--- N/A

c.1.tilt.speed.mode.pos:=<string> manual,auto1 RCSU N/A

c.1.tilt.speed.mode.dir:=<string> manual,auto1,auto2 RCSU N/A

c.1.tilt.speed.mode.list:=<string> “manual,auto1” R--- N/A

230

Parameter


Value Type/ Range


Attribute

c.1.tilt.speed.ratio.pos:=<int> 1...1000 RCSU N/A

c.1.tilt.speed.ratio.dir:=<int> 1...1000 RCSU N/A

c.1.tilt.speed.ratio.min:=<int> 1 R--- N/A

c.1.tilt.speed.ratio.max:=<int> 1000 R--- N/A




Parameter


Value Type/ Range


Attribute

c.1.pan.speed.mode=<string> manual,auto1 RCS- N/A

c.1.pan.speed.mode.pos=<string> manual,auto1 RCS- N/A

c.1.pan.speed.mode.dir=<string> manual,auto1 RCS- N/A

c.1.pan.speed.ratio=<int> 1...1000 RCS- N/A

c.1.pan.speed.ratio.pos=<int> 1...1000 RCS- N/A

c.1.pan.speed.ratio.dir=<int> 1...1000 RCS- N/A

c.1.tilt.speed.mode=<string> manual,auto1 RCS- N/A

c.1.tilt.speed.mode.pos=<string> manual,auto1 RCS- N/A

c.1.tilt.speed.mode.dir=<string> manual,auto1 RCS- N/A

c.1.tilt.speed.ratio=<int> 1...1000 RCS- N/A

c.1.tilt.speed.ratio.pos=<int> 1...1000 RCS- N/A

c.1.tilt.speed.ratio.dir=<int> 1...1000 RCS- N/A


231

A.7 Multilingual Support

The differences in multilingual support for models are listed by series.





Parameter


Value Type/ Range

Attribute

c.1.name.lang:= <string>

en,ja,fr,it,de,

es

R--U

See ‘5.2.3.1.6 Camera Information [c] ’.


Parameter


Value Type/ Range

Attribute

o.<Input>.name.lang:=<string>

en,ja,fr,it,de,

es

R--U

o.<Output>.name. lang:=<string>

en,ja,fr,it,de,

es

R--U

See ‘5.2.3.1.14 Contact Input/Output Information [i/o] ’.

*For details on the <Input>, <Output> array subscript abbreviation, see ‘5.2 Command

Specifications ’.


Parameter


Value Type/ Range

Attribute

p.<Preset>.name. lang:=<string>

en,ja,fr,it,de,

es

R--U

See ‘5.2.3.1.15 Preset Information [p] ’.

232



Parameter


Value Type/ Range

Attribute

r.<Rule>.name.lang:=<string>

en,ja,fr,it,de,

es

R--U

See ‘5.2.3.1.17 Intelligent Function Information [r] ’.


A.7.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F


c.1.name.lang:= <string>

en,ja,fr,it,de,es R--U



Parameter

VB-S805D/S905F


o.<Input>.name. lang:=<string>


o.<Output>.name. lang:=<string>




Specifications ’.

233


Parameter

VB-S805D/S905F


p.<Preset>.name. lang:=<string>





Parameter

VB-S805D/S905F


r.<Rule>.name.lang:=<string>








Parameter

VB-H43/H630VE/H630D/H730F


c.1.name.lang:=<string> en,ja,fr,it,de,es,zh R--U


234


Parameter



o.<Input>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U

o.<Output>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U



Specifications ’.


Parameter



p.<Preset>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U




Parameter



r.<Rule>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U



235





Parameter

VB-M42/M620VE/M620D/M720F


c.1.name.lang:=<string> en,ja,fr,it,de,es,zh R--U



Parameter



o.<Input>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U




Specifications ’.


Parameter



p.<Preset>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U




Parameter



r.<Rule>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U



236


There is no difference in the multilingual support between the models in this series

and ‘5.2 Command Specifications ’.


There is no difference in the multilingual support between the models in this series


237

A.8 Image Stabilizer

The differences in the image stabilizer function for models are listed by series.


The models in this series do not support the image stabilizer function.



Parameter


Value Type/ Range

Attribute

c.1.is:=<string> N/A

See ‘5.2.3.1.7 Camera Correction Information [c] ’.



Parameter


Value Type/ Range

Attribute

c.1.is=<string> N/A

See ‘5.2.4.1.3 Camera Correction-related [c] ’.

238

A.8.2 [VB-S805D/VB-S905F]

The models in this series do not support the image stabilizer function.



Parameter

VB-S805D/S905F

Value Type/ Range

Attribute

c.1.is:=<string> N/A




Parameter

VB-S805D/S905F

Value Type/ Range

Attribute

c.1.is=<string> N/A


239





Parameter


Value Type/ Range


Attribute

c.1.is:=<string> off,on1,on2 RC-U N/A




Parameter


Value Type/ Range


Attribute

c.1.is:=<string> off,on1,on2 RC-U

Privileged

N/A


240





Parameter


Value Type/ Range


Attribute

c.1.is:=<string> off,on1,on2 RC-U N/A




Parameter


Value Type/ Range


Attribute

c.1.is:=<string> off,on1,on2 RC-U

Privileged

N/A



There is no difference in the image stabilizer function between the models in this

series and ‘5.2 Command Specifications ’.


There is no difference in the image stabilizer function between the models in this


241

A.9 Exposure Function

The differences in the exposure function for models are listed by series.





Parameter



c.1.exp.list:=<string> “auto,flickerfree,tv,manual,flickerfree2” *1 R--U

c.1.me.iris:=<int> N/A

c.1.me.iris.min:= <int>

N/A

c.1.me.iris.max:= <int>

N/A

c.1.me.gain:=<int> 0...32 RC-U

c.1.me.gain.min:= <int>

0 R--U

c.1.me.gain.man:= <int>

32 R--U


Note:

*1 flickerfree2 can only be used, when the firmware version is 1.2.0 or later.

242



Parameter



c.1.exp=<string> auto,flickerfree,tv,manual,flickerfree2 *1 RC-U

c.1.me.iris=<int> N/A



Note:


A.9.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F


c.1.exp.list:=<string> auto,flickerfree,tv,manual,flickerfree2 *1 R--U

c.1.me.iris:=<int> N/A


N/A


N/A



0 R--U


32 R--U


Note:


243



Parameter

VB-S805D/S905F

Value Type/ Range

Attribute

c.1.exp=<string> auto,flickerfree,tv,manual,flickerfree2 *1 RC-U

c.1.me.iris=<int> N/A



Note:


244





Parameter


Value Type/ Range


Attribute

c.1.exp.list:=<string> “auto,flickerfree, tv,manual”

R--U “auto,flickerfree, tv,manual”

R--U

c.1.me.iris:=<int> 5...32 RC-U 2...32 RC-U


5 R--U 2 R--U


32 R--U 32 R--U

c.1.me.gain:=<int> 0...39 RC-U 0...39 RC-U


0 R--U 0 R--U


39 R--U 39 R--U




Parameter


Value Type/ Range


Attribute

c.1.exp=<string> auto,flickerfree, tv,manual

RC-U auto,flickerfree, tv,manual

RC-U

c.1.me.iris=<int> 5...32 RC-U 2...32 RC-U

c.1.me.gain:=<int> 0...39 R--U 0...39 RC-U


245





Parameter


Value Type/ Range


Attribute

c.1.exp.list:=<string> “auto,flickerfree, tv,manual”

R--U “auto,flickerfree, tv,manual”

R--U

c.1.me.iris:=<int> 5...32 RC-U 2...32 RC-U


5 R--U 2 R--U


32 R--U 32 R--U

c.1.me.gain:=<int> 0...39 RC-U 0...39 RC-U


0 R--U 0 R--U


39 R--U 39 R--U




Parameter


Value Type/ Range


Attribute

c.1.exp=<string> auto,flickerfree, tv,manual

RC-U auto,flickerfree, tv,manual

RC-U

c.1.me.iris=<int> 5...32 RC-U 2...32 RC-U

c.1.me.gain:=<int> 0...39 R--U 0...39 RC-U


246





Parameter


Value Type/ Range



Attribute

c.1.exp.list:=<string> “auto, flickerfree,tv, manual”

R--U “auto, flickerfree,tv, manual”


R--U

c.1.me.iris:=<int> 4...32 RC-U 2...32 RC-U 2...32 RC-U

c.1.me.iris.min:=<int> 4 R--U 2 R--U 2 R--U

c.1.me.iris.max:=<int> 32 R--U 32 R--U 32 R--U

c.1.me.gain:=<int> 0...47 RC-U 0...39 RC-U 0...47 RC-U

c.1.me.gain.min:=<int> 0 R--U 0 R--U 0 R--U

c.1.me.gain.man:=<int> 47 R--U 39 R--U 47 R--U




Parameter


Value Type/ Range



Attribute

c.1.exp=<string> auto,

flickerfree,tv, manual

RC-U auto,


RC-U auto,


RC-U

c.1.me.iris=<int> 4...32 RC-U 2...32 RC-U 2...32 RC-U

c.1.me.gain:=<int> 0...47 R--U 0...39 R--U 0...47 R--U


247





Parameter


Value Type/ Range



Attribute

c.1.exp.list:=<string> “auto, flickerfree,tv, manual”



R--U

c.1.me.iris:=<int> 4...32 RC-U 2...32 RC-U 2...32 RC-U

c.1.me.iris.min:=<int> 4 R--U 2 R--U 2 R--U

c.1.me.iris.max:=<int> 32 R--U 32 R--U 32 R--U

c.1.me.gain:=<int> 0...47 RC-U 0...39 RC-U 0...47 RC-U

c.1.me.gain.min:=<int> 0 R--U 0 R--U 0 R--U

c.1.me.gain.man:=<int> 47 R--U 39 R--U 47 R--U




Parameter


Value Type/ Range



Attribute

c.1.exp=<string> auto,


RC-U auto,


RC-U auto,


RC-U

c.1.me.iris=<int> 4...32 RC-U 2...32 RC-U 2...32 RC-U

c.1.me.gain:=<int> 0...47 R--U 0...39 R--U 0...47 R--U


248

A.10 Audio Function

The differences in the audio function for models are listed by series.





Parameter



a.count:=<int> 1 R--U

a.<Audio>.send:=<string> on,off R--U

a.<Audio>.recv:=<string> off R--U

a.<Audio>.detect:=<int> 0,1,-1 R--U

a.<Audio>.scream:=<int> N/A

See ‘5.2.3.1.18 Audio Device Information [a] ’.

A.10.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F




a.<Audio>.recv:=<string> off R--U




249





Parameter





a.<Audio>.recv:=<string> on,off R--U








Parameter VB-M42/M620VE/M620D/M720F




a.<Audio>.recv:= <string> on,off R--U




250


There is no difference in the audio function between the models in this series and ‘5.2

Command Specifications ’.


The difference specifications for models in this series are shown below.



Parameter




a.<Audio>.send:=<string> N/A

a.<Audio>.recv:=<string> N/A

a.<Audio>.detect:=<int> N/A



251

A.11 Haze Compensation Function

The differences in the Haze Compensation function for models are listed by series.


The models in this series do not support the Haze Compensation function.



Parameter



c.1.defog:=<string> N/A

c.1.defog.list:=<string> N/A

c.1.defog.param:=<int> N/A

c.1.defog.param.min:=<int> N/A

c.1.defog.param.max:=<int> N/A


Parameters: Home Position Information

Parameter



c.1.home.defog:=<string> N/A

c.1.home.defog.param:=<int> N/A



Parameter



p.<Preset>.defog:=<string> N/A

p.<Preset>.defog.param:=<int> N/A

See ‘5.2.3.1.16 Extension Preset Information [p] ’.


252



Parameter






A.11.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F









Parameter

VB-S805D/S905F





253


Parameter

VB-S805D/S905F








Parameter

VB-S805D/S905F









Parameter









254


Parameter







Parameter









Parameter






255





Parameter










Parameter







Parameter







256



Parameter




c.1.defog.param:= <int> N/A



There is no difference in the Haze Compensation function between the models in this



There is no difference in the Haze Compensation function between the models in this


257

A.12 Infrared Function

The differences in the Infrared function for models are listed by series.


The models in this series do not support the Infrared function.



Parameter



c.1.dn.irlight:=<string> N/A

c.1.dn.irlight.list:=<string> N/A

c.1.irlight:=<string> N/A

c.1.irlight.param:=<int> N/A

c.1.irlight.param.min:=<int> N/A

c.1.irlight.param.max:=<int> N/A



Parameter



p.<Preset>.dn.irlight:=<string> N/A

p.<Preset>.irlight.param:=<int> N/A



258



Parameter






A.12.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F










Parameter

VB-S805D/S905F






259



Parameter

VB-S805D/S905F









Parameter











Parameter







260



Parameter










Parameter











Parameter







261



Parameter






262





Parameter

VB-R11VE/R11/M641VE/M641V VB-M741LE

Value Type/Range Attribute Value Type/ Range

Attribute

c.1.dn.irlight:=<string> N/A Select from

c.1.dn.irlight. list

RC-U

c.1.dn.irlight.list:=<string> N/A “off,on” R---

c.1.irlight:=<string> N/A off,on R--U

c.1.irlight.param:=<int> N/A 0...4 RC-U

c.1.irlight.param.min:=<int> N/A 0 R---

c.1.irlight.param.max:=<int> N/A 4 R---



Parameter



Attribute

p.<Preset>.dn.irlight:=<string> N/A off,on R--U

p.<Preset>.irlight.param:=<int> N/A 0...4 R--U



263



Parameter



Attribute

c.1.dn.irlight:=<string> N/A off,on RC-U

c.1.irlight.param:=<int> N/A 0...4 RC-U






Parameter











Parameter







264



Parameter




c.1.irlight.param:= <int> N/A


265

A.13 Auto Flip Function

The differences in the Auto Flip function for models are listed by series.


The models in this series do not support the Auto Flip function.



Parameter



c.1.eflip:=<string> N/A

See ‘5.2.3.1.10 Auto Flip Setting Information [c] ’.


Parameter



c.1.home.eflip:=<string> N/A



Parameter



p.<Preset>.eflip:=<string> N/A



266

A.13.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F



See ‘5.2.3.1.10 Auto Flip Setting Information [c]’.


Parameter

VB-S805D/S905F





Parameter

VB-S805D/S905F





267





Parameter






Parameter






Parameter






268





Parameter






Parameter






Parameter






269





Parameter



c.1.eflip:=<string> off,on R--U N/A



Parameter



c.1.home.eflip:=<string> off,on R--U N/A



Parameter



p.<Preset>.eflip:=<string> off,on R--U N/A



270





Parameter



c.1.eflip:=<string> off,on R--U N/A



Parameter






Parameter



p.<Preset>.eflip:=<string> off,on R--U N/A



271

A.14 Home Position Function

The differences in the Home Position function for models are listed by series.

However, only parameters that are added or changed from VB-R11VE/VB-R11/VB-

M641VE/VB-M641V/VB-M741LE are listed.

Note:

The “c.1.home.eflip” parameter is listed in ‘A.13 Auto Flip Function ’ and the

“c.1.home.defog”, “c.1.home.defog.param” parameters are listed in ‘A.11 Haze

Compensation Function ’, but they are also listed here so as to explicitly specify the added

items.





Parameter




c.1.home.exp:=<string> N/A

c.1.home.ae.autoss:=<int> N/A

c.1.home.ae.shutter:=<int> N/A

c.1.home.ae.photometry:=<string> N/A

c.1.home.me.shutter:=<int> N/A

c.1.home.me.iris:=<int> N/A

c.1.home.me.gain:=<int> N/A

c.1.home.dn:=<string> N/A

c.1.home.dn.mode:=<string> N/A

c.1.home.nr:=<int> N/A

c.1.home.ac:=<int> N/A

c.1.home.saturation:=<int> N/A




272

A.14.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F


















273





Parameter



















274





Parameter



















275





Parameter




c.1.home.exp:=<string> auto,flickerfree,tv, manual

R--U N/A

c.1.home.ae.autoss:=<int> 2,4,8,15,30 R--U N/A

c.1.home.ae.shutter:=<int> 2,4,8,15,30,60,100,120,250,500,1000, 2000,4000,8000, 10000,16000

R--U N/A

c.1.home.ae.photometry:=<string>

center,average,spot R--U N/A

c.1.home.me.shutter:=<int> 1,2,4,8,15,30,60,

100,120,250,500, 1000,2000,4000, 8000,10000,16000

R--U N/A

c.1.home.me.iris:=<int> 4...32 R--U N/A

c.1.home.me.gain:=<int> 0...47 R--U N/A

c.1.home.dn:=<string> off,on R--U N/A

c.1.home.dn.mode:=<string> manual,auto1 R--U N/A

c.1.home.nr:=<int> 0...2 R--U N/A

c.1.home.ac:=<int> 0...6 R--U N/A

c.1.home.saturation:=<int> 0...6 R--U N/A

c.1.home.defog:=<string> on,off,auto R--U N/A

c.1.home.defog.param:=<int

> 0...6 R--U N/A


276





Parameter




c.1.home.exp:=<string> auto,flickerfree,tv,

manual R--U N/A

c.1.home.ae.autoss:=<int> 2,4,8,15,30 R--U N/A

c.1.home.ae.shutter:=<int> 2,4,8,15,30,60,100,

120,250,500,1000, 2000,4000,8000, 10000,16000

R--U N/A

c.1.home.ae.photometry:=<string>

center,average,spot R--U N/A

c.1.home.me.shutter:=<int> 1,2,4,8,15,30,60,

100,120,250,500, 1000,2000,4000, 8000,10000,16000

R--U N/A

c.1.home.me.iris:=<int> 4...32 R--U N/A

c.1.home.me.gain:=<int> 0...47 R--U N/A

c.1.home.dn:=<string> off,on R--U N/A

c.1.home.dn.mode:=<string> manual,auto1 R--U N/A

c.1.home.nr:=<int> 0...2 R--U N/A

c.1.home.ac:=<int> 0...6 R--U N/A

c.1.home.saturation:=<int> 0...6 R--U N/A

c.1.home.defog:=<string> on,off,auto R--U N/A

c.1.home.defog.param:=<int

> 0...6 R--U N/A


277


Model differences in the preset function are shown by series.

The following models support presets.

VB-S30D / VB-S31D / VB-S800D / VB-S900F / VB-S805F / VBS905F /

VB-H43 / VB-H630VE / VB-H630D / VB-H730F /

VB-M42 / VB-M620VE / VB-M620D / VB-M720F

The following models support extension presets.

VB-R11VE / VB-R11 / VB-M641VE / VB-M641V / VB-M741LE /

VB-R10VE / VB-M640VE / VB-M640V / VB-M740E

Only parameters that are added or changed from the extension presets are listed.





Parameter


Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

P 0...257 R--U 0...21 R--U 0...21 R--U

p.count:=<int> 0...257 R--U 0...21 R--U 0...21 R--U


R--U R--U R--U

p.<Preset>.eflip:=<string> off,on R--U N/A N/A

p.<Preset>.exp:=<string> auto,flickerfree,tv,manual

R--U auto,flickerfree,tv,manual


R--U

p.<Preset>.ae.autoss:=<int>

2,4,8,15,30 R--U 2,4,8,15,30 R--U 2,4,8,15,30 R--U

278

Parameter


Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute


2,4,8,15,30,60, 100,120,250, 500,1000,2000, 4000,8000, 10000,16000

R--U 2,4,8,15,30,60, 100,120,250, 500,1000,2000, 4000,8000, 10000,16000

R--U 2,4,8,15,30,60,100,120,250, 500,1000,2000,4000,8000, 10000,16000

R--U

p.<Preset>.ae.photometry:=<string>


R--U center,average, spot

R--U center,average, spot

R--U


1,2,4,8,15,30,6

0, 100,120,250, 500,1000,2000, 4000,8000, 10000,16000

R--U 1,2,4,8,15,30,60,

100,120,250, 500,1000,2000, 4000,8000, 10000,16000

R--U 1,2,4,8,15,30,6

0, 100,120,250, 500,1000,2000, 4000,8000, 10000,16000

R--U

p.<Preset>.me.iris:=<int> 4...32 R--U 2...32 R--U 2...32 R--U

p.<Preset>.me.gain:=<int> 0...47 R--U 0...39 R--U 0...47 R--U

p.<Preset>.dn:=<string> off,on R--U off,on R--U off,on R--U

p.<Preset>.dn.mode:=<string>

manual,auto1 R--U manual,auto1 R--U manual,auto1 R--U

p.<Preset>.dn.irlight:=<stri

ng> N/A N/A off,on R--U


N/A N/A 0...4 R--U

p.<Preset>.nr:=<int> 0...2 R--U 0...2 R--U 0...2 R--U

p.<Preset>.ac:=<int> 0...6 R--U 0...6 R--U 0...6 R--U


0...6 R--U 0...6 R--U 0...6 R--U

p.<Preset>.defog:=<string>


p.<Preset>.defog.param:=<int>

0...6 R--U 0...6 R--U 0...6 R--U



Note:

The “p.<Preset>.eflip” parameter is listed in ‘A.13 Auto Flip Function ’, the

“p.<Preset>.dn.irlight”, “p.<Preset>.dn.irlight.param” parameters are listed in ‘A.12

Infrared Function ’ and the “p.<Preset>.defog”, “p.<Preset>.defog.param” parameters

are listed in ‘A.11 Haze Compensation Function ’, but they are also listed here so as to

explicitly specify the added items.

279


Parameters: Preset

Parameter


Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

p =<int> 0...257 RC-U 0...21 RC-U 0...21 RC-U

See ‘5.2.4.1.8 Extension Presets [p] ’.





Parameter


Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

P 0...257 R--U 0...21 R--U 0...21 R--U

p.count:=<int> 0...257 R--U 0...21 R--U 0...21 R--U


R--U R--U R--U

p.<Preset>.eflip:=<string> off,on R--U N/A N/A

p.<Preset>.exp:=<string> auto,flickerfree,tv,manual

R--U auto,flickerfree,tv, manual


R--U

p.<Preset>.ae.autoss:=<int

>

2,4,8,15,30 R--U 2,4,8,15,30 R--U 2,4,8,15,30 R--U


2,4,8,15,30,60, 100,120,250,

500,1000,2000, 4000,8000, 10000,16000

R--U 2,4,8,15,30,60,100,

120,250,500,1000, 2000,4000,8000, 10000,16000

R--U 2,4,8,15,30,60,100,120,250,50

0,1000,2000,4000,8000,10000, 16000

R--U

p.<Preset>.ae.photometry:=<string>


R--U center,average,spot

R--U center,average,spot

R--U

280

Parameter


Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute


1,2,4,8,15,30,60, 100,120,250, 500,1000,2000, 4000,8000, 10000,16000

R--U 1,2,4,8,15,30,60, 100,120,250,500, 1000,2000,4000, 8000, 10000,16000

R--U 1,2,4,8,15,30,60, 100,120,250,500,1000,2000,4000,8000,10000, 16000

R--U

p.<Preset>.me.iris:=<int> 4...32 R--U 2...32 R--U 2...32 R--U

p.<Preset>.me.gain:=<int> 0...47 R--U 0...39 R--U 0...47 R--U

p.<Preset>.dn:=<string> off,on R--U off,on R--U off,on R--U

p.<Preset>.dn.mode:=<string>

manual,auto1 R--U manual,auto1 R--U manual,auto1 R--U

p.<Preset>.dn.irlight:=<string>

N/A N/A N/A


N/A N/A N/A

p.<Preset>.nr:=<int> 0...2 R--U 0...2 R--U 0...2 R--U

p.<Preset>.ac:=<int> 0...6 R--U 0...6 R--U 0...6 R--U


0...6 R--U 0...6 R--U 0...6 R--U

p.<Preset>.defog:=<string>

on,off,auto R--U off,on,auto R--U off,on,auto R--U

p.<Preset>.defog.param:=<int>

0...6 R--U 0...6 R--U 0...6 R--U



Note:

The “p.<Preset>.eflip” parameter is listed in ‘A.13 Auto Flip Function ’, the

“p.<Preset>.dn.irlight”, “p.<Preset>.dn.irlight.param” parameters are listed in ‘A.12

Infrared Function ’ and the “p.<Preset>.defog”, “p.<Preset>.defog.param” parameters

are listed in ‘A.11 Haze Compensation Function ’, but they are also listed here so as to

explicitly specify the added items.

281


Parameters: Preset

Parameter


Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

p =<int> 0...257 RC-U 0...21 RC-U 0...21 RC-U

See ‘5.2.4.1.8 Extension Presets [p] ’.

282

A.16 Contact Input/Output Function

The differences in the Contact Input/Output function for models are listed by series.





Parameter



i.count:=<int> 1 R---

i.<Input>:=<int> 0,1 R--U

i.<Input>.name.asc:=<string> R--U

i.<Input>.name.utf8:=<unicode> R--U

i.<Input>.name.lang:=<string> en,ja,fr,it,de,es R--U

o.count:=<int> 1 R---

o.<Output>:=<int> 0,1 RC-U

Privileged

o.<Output>.name.asc:=<string> R--U

o.<Output>.name.utf8:=<unicode> R--U

o.<Output>.name.lang:=<string> en,ja,fr,it,de,es R--U



Specifications ’.

283

A.16.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F






i.<Input>.name.lang:=<string> en,ja,fr,it,de,es R--U



Privileged



o.<Output>.name.lang:=<string> en,ja,fr,it,de,es R--U



Specifications ’.

284





Parameter



i.count:=<int> 1...2 R---




i.<Input>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U

o.count:=<int> 1...2 R---


Privileged






Specifications ’.

285





Parameter



i.count:=<int> 1...2 R---




i.<Input>.name.lang:=<string> en,ja,fr,it,de,es,zh R--U

o.count:=<int> 1...2 R---


Privileged






Specifications ’.


There is no difference in the Contact Input/Output function between the models in this


286





Parameter




i.<Input>:=<int> N/A

i.<Input>.name.asc:=<string> N/A

i.<Input>.name.utf8:=<unicode> N/A

i.<Input>.name.lang:=<string> N/A


o.<Output>:=<int> N/A

o.<Output>.name.asc:=<string> N/A

o.<Output>.name.utf8:=<unicode> N/A

o.<Output>.name.lang:=<string> N/A



Specifications ’.

287

A.17 Intelligent Function

The differences in the Intelligent function for models are listed by series.





Parameter



r.<Rule>.track:=<int> N/A

r.<Rule>.type:=<int> 0,1,2,3,4,5 R--U

See ‘5.2.3.1.17 Intelligent Function Information [r]’.

* For details on the <Rule> array subscript abbreviation, see ‘5.2 Command Specifications ’.

A.17.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F



r.<Rule>.type:=<int> 0,1,2,3,4,5 R--U



288





Parameter




r.<Rule>.type:=<int> 0,1,2,3,4,5 R--U







Parameter




r.<Rule>.type:=<int> 0,1,2,3,4,5 R--U



289





Parameter


Value Type/ Range


Attribute

r.<Rule>.track:=<int> 0, 1 R--U N/A

r.<Rule>.type:=<int> 0,1,2,3,4,5,6 R--U 0,1,2,3,4,5,6 R--U







Parameter


Value Type/ Range


Attribute

r.<Rule>.track:=<int> 0, 1 R--U N/A

r.<Rule>.type:=<int> 0,1,2,3,4,5,6 R--U 0,1,2,3,4,5,6 R--U



290

A.18 Linked Event Function

Model differences in the Linked Event function are shown by series.


The models in this series do not support the Linked Event function.



Parameter



l.count:=<int> N/A

l.<Joint>:=<int> N/A

See ‘5.2.3.1.20 Linked Event Information [l] ’.


A.18.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F


l.count:=<int> N/A




291





Parameter



l.count:=<int> N/A








Parameter



l.count:=<int> N/A




292


There is no difference in the Linked Event function between the models in this series






Parameter



l.count:=<int> 0 R---




293

A.19 External Memory Information

The differences in the External Memory Information for models are listed by series.





Parameter



f.sd.magic:=<int> N/A

See ‘5.2.3.1.21 External Memory Information [f] ’.

A.19.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F




294





Parameter









Parameter






There is no difference in the External Memory Information between the models in this



There is no difference in the camera control function between the models in this series


295

A.20 System Information

The differences in the System Information for models are listed by series.





Parameter



s.hardware.id:=<string> N/A

See ‘5.2.3.1.3 System Information [s] ’.

A.20.2 [VB-S805D/VB-S905F]




Parameter

VB-S805D/S905F




296





Parameter









Parameter





297





Parameter

VB-R11VE VB-R11 VB-M641VE VB-M641V VB-M741LE

Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

s.hardware.id:=<string>

2D R--- 2E R--- 31 R--- 32 R--- 45 R---






Parameter

VB-R10VE VB-M640VE VB-M640V VB-M740E

Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

Value Type/Range

Attribute

s.hardware.id:=<string>

4D R--- 47 R--- 48 R--- 4B R---


298

A.21 Array Valid Value Information

The differences in the Array Valid Value Information for models are listed by series.



Abbreviation


Valid Values Valid Values

<Video> 1…5 1…6

<Preset> 1…20 1…20

<Input> 1 1

<Output> 1 1

<Audio> 1 1

<Joint> N/A N/A

See ‘5.2 Command Specifications ’.

A.21.2 [VB-S805D/VB-S905F]


Abbreviation

VB-S805D/S905F

Valid Values

<Video> 1…6

<Preset> 1…20

<Input> 1

<Output> 1

<Audio> 1

<Joint> N/A


299



Abbreviation



<Video> 1…5 1…6

<Preset> 1…20 1…20

<Input> 1…2 1…2

<Output> 1…2 1…2

<Audio> 1 1

<Joint> N/A N/A




Abbreviation



<Video> 1…5 1…6

<Preset> 1…20 1…20

<Input> 1…2 1…2

<Output> 1…2 1…2

<Audio> 1 1

<Joint> N/A N/A


300



Abbreviation



<Video> 1…5 1…6

<Preset> 1…257 1…21

<Input> 1…2 1…2

<Output> 1…2 1…2

<Audio> 1 1

<Joint> 1…4 1…4




Abbreviation



<Video> 1…5 1…6

<Preset> 1…257 1…21

<Input> 0 0

<Output> 0 0

<Audio> 0 0

<Joint> 0 0


301

A.22 Video Quality

The differences in the Video Quality Information for models are listed by series.


The differences in specifications between the models of this series are listed below.

Create Session [open.cgi]

Parameter



w.<Video>.quality==<int> 1…5 1…5

See ‘5.2.1.1.2 Response’.

Change Session Attributes [session.cgi]

Parameter





Aquire Information [info.cgi]

Parameter




w.<Video>.quality==<int> 1…5 R--U 1…5 R--U

See ‘5.2.3.1.5 Video Information [w]’.

302

A.22.2 [VB-S805D/VB-S905F]



Parameter

VB-S805D/S905F

Value Type/Range

w.<Video>.quality==<int> 1…5



Parameter

VB-S805D/S905F

Value Type/Range

w.<Video>.quality==<int> 1…5



Parameter

VB-S805D/S905F


w.<Video>.quality==<int> 1…5 R--U


303




Parameter






Parameter






Parameter






304




Parameter






Parameter






Parameter







There is no difference in video quality, between this series and “5.2 Command

Specifications”.


There is no difference in video quality, between this series and “5.2 Command

Specifications”.

305

B Support for Commands of Older Models This section lists the compatibility between old commands used by older Canon

network camera models and WV-HTTP commands of models supported by this

specification.

Special Note:

Although old commands are supported also for models supported by this specification, operations

are not guaranteed, so use the WV-HTTP commands of this specification.

306

B.1 Compatibility of Information Items

Old retrieval commands are separated by function, and depending on the item,

information may not be able to be retrieved. The following lists a basic compatibility of

commands although the old command system and WV-HTTP commands are not fully

compatible.

Table B-1 Compatibility of WV-HTTP Commands and Old Commands

WV-HTTP Command Old Command Old Command Item Name

s OpenCameraServer connection_id

s.duration GetSystemInfo connection_time_limit

s.priority Priority priority

s.control GetNotice event 31 ... 34

s.epoch GetSystemInfo start_time

s.hardware GetCameraServerInfo modelNumber

GetSystemInfo version

s.firmware GetCameraServerInfo firmVersion

GetSystemInfo version

s.protocol GetProtocolVersion

v GetVideoInfo image_width

image_height

compression_type

image_quality

frame_rate

v.list GetCameraServerInfo image_size

image_quality

c GetCameraInfo camera_id

c.count GetCameraServerInfo number_of_available_cameras

GetCameraList number_of_cameras

c.1.type GetCameraInfo camera_type

c.1.status GetCameraInfo camera_status

c.1.name.asc GetCameraList camera_129 ...

c.1.name.utf8 GetCameraList camera_129 ...

c.1.name.lang N/A

c.1.exp Exposure

307


c.1.exp.list GetCameraInfoEx manual_ex

c.1.ae.autoss GetCameraInfoEx auto_slow_shutter_ex

c.1.ae.autoss.list N/A

c.1.ae.shutter OperateCameraEx shutter

c.1.ae.shutter.list N/A

c.1.ae.brightness OperateCameraEx brightness

GetCameraInfo back_light

c.1.ae.brightness.min N/A

c.1.ae.brightness.max N/A

c.1.ae.brightness.list N/A

c.1.ae.photometry N/A

c.1.ae.photometry.list N/A

c.1.me.shutter Exposure shutter

c.1.me.shutter.list GetCameraInfoEx shutter_speed_1 ...

c.1.me.iris Exposure iris

c.1.me.iris.min GetCameraInfoEx iris_min

c.1.me.iris.max GetCameraInfoEx iris_max

c.1.me.gain Exposure gain

c.1.me.gain.min GetCameraInfoEx gain_min

c.1.me.gain.max GetCameraInfoEx gain_max

c.1.dn NightMode night_mode

c.1.dn.list N/A

c.1.dn.mode N/A

c.1.dn.mode.list N/A

c.1.wb GetCameraInfo white_balance

c.1.wb.list N/A

c.1.wb.value GetCameraInfo rb_gain

c.1.is N/A

c.1.nr NRLevel nr_level

c.1.nr.min N/A

c.1.nr.max N/A

c.1.ac N/A

c.1.ac.min N/A

308


c.1.ac.max N/A

c.1.shade N/A

c.1.shade.param N/A

c.1.shade.param.min N/A

c.1.shade.param.max N/A

c.1.focus GetCameraInfo focus_mode

c.1.focus.value GetCameraInfo focus_value

c.1.focus.list GetCameraInfoEx far_fixed_focus

dome_focus

one_shot_focus

c.1.zoom GetCameraInfo zoom_current_value

c.1.zoom.d GetCameraInfoEx digital_zoom_boundary

c.1.zoom.min GetCameraInfo zoom_tele_limit

GetCameraInfo view_tele_boundary

c.1.zoom.max GetCameraInfo zoom_wide_limit

GetCameraInfo view_wide_boundary

c.1.zoom.limit.min GetCameraInfo zoom_tele_end

c.1.zoom.limit.max GetCameraInfo zoom_wide_end

c.1.zoom.speed.pos GetPTZSpeedInfo point_z

c.1.zoom.speed.dir GetPTZSpeedInfo direction_z

c.1.zoom.speed.min GetPTZSpeedInfo point_z_min / direction_z_min

c.1.zoom.speed.max GetPTZSpeedInfo point_z_max / direction_z_max

c.1.pan GetCameraInfo pan_current_vaue

c.1.pan.min GetCameraInfo pan_left_limit

c.1.pan.max GetCameraInfo pan_right_limit

c.1.pan.limit.min GetCameraInfo pan_left_end

c.1.pan.limit.max GetCameraInfo pan_right_end

c.1.pan.speed.pos GetPTZSpeedInfo point_p

c.1.pan.speed.dir GetPTZSpeedInfo direction_p

c.1.pan.speed.min GetPTZSpeedInfo point_p_min / direction_p_min

c.1.pan.speed.max GetPTZSpeedInfo point_p_max / direction_p_max

c.1.tilt GetCameraInfo tilt_current_vaue

309


c.1.tilt.min GetCameraInfo tilt_down_limit

c.1.tilt.max GetCameraInfo tilt_up_limit

c.1.tilt.limit.min GetCameraInfo tilt_down_end

c.1.tilt.limit.max GetCameraInfo tilt_up_end

c.1.tilt.speed.pos GetPTZSpeedInfo point_t

c.1.tilt.speed.dir GetPTZSpeedInfo direction_t

c.1.tilt.speed.min GetPTZSpeedInfo point_t_min / direction_t_min

c.1.tilt.speed.max GetPTZSpeedInfo point_t_max / direction_t_max

c.1.view GetCameraInfo view_left_boundary

view_right_boundary

view_up_boundary

view_down_boundary

c.1.view.restriction N/A

c.1.panorama.count GetPanoramaList number_of_panorama_images

c.1.panorama.1.view GetPanoamaInfo pano_left

GetPanoamaInfo pano_top

GetPanoamaInfo pano_width

GetPanoamaInfo pano_height

c.1.panorama.1.image GetPanoamaInfo image_width

GetPanoamaInfo image_height

GetPanoamaInfo image_quality

GetPanoamaInfo image_size

c.1.panorama.1.timestamp GetPanoamaInfo date_and_time

i.count ExternalIOConfig number_of_input

i.<Input> ExternalIOStatus i1 ...

i.<Input>.name.asc ExternalIOCaption i1 ...

i.<Input>.name.utf8 ExternalIOCaption i1 ...

i.<Input>.name.lang N/A

o.count ExternalIOConfig number_of_output

o.<Output> ExternalIOStatus o1 ...

o.<Output>.name.asc ExternalIOCaption o1 ...

o.<Output>.name.utf8 ExternalIOCaption o1 ...

310


o.<Output>.name.lang N/A

N/A *1 ExternalIOConfig md

N/A *1 ExternalIOStatus d1

p.count GetPresetList number_of_camera_positions

p.<Preset>.name.asc GetPresetList position_1 ...

p.<Preset>.name.utf8 GetPresetList position_1 ...

p.<Preset>.name.lang N/A

p.<Preset>.c GetPresetList camera_id

p.<Preset>.pan GetPresetList pan

p.<Preset>.tilt GetPresetList tilt

p.<Preset>.zoom GetPresetList zoom

p.<Preset>.focus GetPresetList focus_mode

GetPresetList focus_value

p.<Preset>.ae.brightness GetPresetList back_light

*For details on the <Input><Output><Preset> array subscript abbreviation, see ‘5.2

Command Specifications ’.

Note:

*1 The movement detection area setting is integrated into the Intelligence Function and is

not supported by WV-HTTP commands.

311

C JPEG Header Information This describes the JPEG image header information that is output by the Canon

network camera at still image or video transmission. The JPEG image header

information is a header segment that lists information in the JPEG area using an

APP0 marker.

C.1 JPEG Image Data Format

As shown below, the JPEG image data format starts with the leading SOI

(StartOfImage) followed by the APP0 segment, other segments, and scan data, and

ends with the EOI (EndOfImage).

The size of the APP0 segment output by the network camera is 82 bytes (0052 h).

Table C-1 JPEG Image Data Format

Marker Value Marker Name Segment Name Description

FFD8 h SOI Start of image

FFE0 h APP0 APP0 segment Header information output by network

camera

FFE7 h APP7 APP7 segment Reserved area

FFDB h DQT Define quantization

table

...

FFDA h SOS Start of scan

FFD9 h EOI End of image

C.2 JPEG Header Information [APP0]

The following lists the content of the APP0 segment output by the Canon network

camera.

Table C- 2 JPEG APP0 Segment Information

Attribute Information

Value Type Value Range Description

Marker Name <UInt>

2byte

FFE0 h APP0 marker

Segment Length <UInt>

2byte

0052 h APP0 field length (82byte)

Note: Excludes 2byte of APP0 marker

length.

312



Magic Number <UInt>

3byte

564200 h Header format identifier (“VB”)

Camera <UInt>

1byte

01 h Camera number

Note: Always fixed to 1.

Pan <UInt>

2byte

<Pan Angle>,

0000 h

Pan angle at capture *1


Tilt <UInt>

2byte

<Tilt Angle>,

0000 h

Tilt angle at capture *1


Zoom <UInt>

2byte

<Zoom Angle> Optical zoom angle at capture *2


Brightness <Int>

2byte

0000...0002 h Exposure setting at capture *3

Capture Time <UInt>

4byte

<Total Seconds> Total seconds from 1970/01/01

00:00:00GMT. *4

Time Zone <Int>

2byte

<Offset (minutes)>

Offset (minutes) from GMT *5

Video Quality <UInt>

1byte

00...04 h JPEG video quality

Note: Low quality 00 ←→ 04 High

quality

Model <UInt>

1byte

<Model ID> Model ID *6

External Device

Input Status

<BitField>

32bit

bit[0]:<Input 1>

bit[1]:<Input 2>

External device input status

Note: 0 = OFF / 1 = ON

External Device

Output Status

<BitField>

32bit

bit[0]:<Output 1> External device output status

Note: 0 = OFF / 1 = ON

File Format <UInt>

1byte

06 h File format


Authentication Tag Type

<UInt>

1byte

00 h No authentication tag


Video Width <UInt>

2byte

<Number of pixels of video width>

Number of pixels in horizontal direction

E.g. QVGA＝0140 h (320)

Video Height <UInt>

2byte

<Number of pixels of video height>

Number of pixels in vertical direction

E.g. QVGA＝00F0 h (240)

Capture Time Fraction

<UInt>

2byte

<msec> Fraction value of capture time in

milliseconds

Setting Value Identifier

<UInt>

4byte

0000 h Not used

313



Server identifier <BitField>

24bit

<MAC address>

Ethernet MAC address

Shade Control <UInt>

1byte

00, 01...07 h Shade control value

Note: 00=OFF, Low 01 ←→ 07 High

Electronic Zoom Magnification

<UInt>

2byte

0000, 0001 h... Electronic zoom magnification at

capture

Note: 00=OFF, Unit is 0.01 degrees.

Exposure

Compensation Value

<Int>

2byte

FFF8...0008 h Exposure compensation value at

capture

Note: -8 ←→ +8

MAC Address <BitField>

48bit

<MAC address> Ethernet MAC address

Reserved 1 <UInt>

2byte

0000 h Not used

Intelligent

Function Status

<BitField>

32bit

bit[0]:<Function State>

bit[1]:<Rule State>

bit[2]:<Fixed

State>

bit[3]:<Position State>

Intelligent Function status *7

Intelligent

Function Rule Status

<BitField>

32bit

bit[1]...[15]:

<Rule 01...15>

Intelligent Function rule detection

status

Note: 0 = No detection /

1 = Detecting

Note: bit00 is the work area.

Reserved 2 <UInt>

16byte

All 00h Not used

Value Type:

<BitField> : bit string. The bit sequence direction starts with MSB.

<Int> : Signed integer value. Set with big endian.

<UInt> : Unsigned integer value. Set with big endian.

Note:

*1 The starting point (0 degrees) is expressed as 18000. On fixed models, it is fixed at 0.

*2 A value expressing the viewing angle in the pan direction in units of 0.01 degrees is set.

*3 This is the exposure setting at capture.

0000 h : Disabled Cannot be operated. Models without the exposure compensation

function.

0001 h : Normal Exposure compensation OFF

0002 h : Bright Exposure compensation ON

314

*4 To be exact, the capture time indicates the time at which a JPEG image was created in

the camera. Note that it is not the time the camera transmitted the image to the

network.

*5 During daylight saving time, the offset (minutes) minus the time duration is returned.

*6 The ID value indicates the camera model.

1D h : VB-S30D

1E h : VB-S31D

1F h : VB-S800D

20 h : VB-S900F

3F h : VB-S805D

40 h : VB-S905F

25 h : VB-H43

26 h : VB-H630VE

27 h : VB-H630D

28 h : VB-H730F

35 h : VB-M42

36 h : VB-M620VE

37 h : VB-M620D

38 h : VB-M720F

2D h : VB-R11VE

2E h : VB-R11

31 h : VB-M641VE

32 h : VB-M641V

45 h : VB-M741LE

47 h : VB-M640VE

48 h : VB-M640V

4B h : VB-M740E

4D h : VB-R10VE

*7 The value indicates the Intelligent Function status.

bit[0] : Indicates whether the Intelligent Function is enabled or disabled.

(1: enabled, 0: disabled)

bit[1] : Indicates whether the Intelligent Function rule is enabled or disabled.


bit[2] : Indicates whether the preset fixed function is enabled or disabled.


bit[3] : Indicates whether the camera is at the present position.

(1: at preset position, 0: not at preset position)

315

D H.264 Transmission Function This describes the network camera H.264 video transmission functions supported by

the models supported by this specification.

D.1 H.264 Image Parameters

The following are the H.264 image parameters that the H.264 video transmission

functions support.

Table D-1 H.264 Image Parameters

Parameter Value Range Default Value

Video Size Set *1 1280x960

1280x720

1920x1080

1920x1080

Selectable Video Size

*The type of Selectable Video

Size varies depending on the

Video Size Set setting.

For 1280x960 Video Size Set:

1280x960, 640x480, 320x240

320x240


1280x720, 640x360, 320x180

320x180


1920x1080, 960x540, 480x270

480x270

Frame Rate (fps)

1, 2, 3, 5, 6, 10, 15, 30 30

I Frame Interval (sec) *2

0.5, 1, 1.5, 2, 3, 4, 5 1

Target Bit Rate (kbps) *3 64, 128, 256, 384, 512, 768, 1024,

2048, 3072, 4096, 6144, 8192,

10240, 12288, 14336, 16384

2048

Video Image Quality

(Q value) *4

1...5

3

316

Note:

*1 Changes to the video size set require that the system be restarted, so the client will be

disconnected. For models that do not support the Full HD function, the specified value

is “1280x720”.

*2 The specified interval may not be used due to the frame rate.

E.g. 1 fps / 0.5 sec.

*3 This is the target bit rate specification and does not guarantee the output at the set bit

rate.

The target bit rate and Q value settings have an exclusive relationship.

*4 The Q value setting does not affect the moov/moof header. The Q value is set to the

“slice_qp_delta” slice header. The target bit rate and Q value settings have an exclusive

relationship.

Special Note:

When the target bit rate is set low (small), large video images in particular may have a low

video image quality, and the block noise may be apparent.

317

D.2 Fragmented MP4

The H.264 transmission function of models supported by this specification transmits

video image data in the fragmented MP4 format. A stream with only one video track

can be handled, and this video stream forms a stream in the fragmented MP4 format.

Namely, a moov header and moof header are created, and these are sent coupled with

the picture data.

Note:

A stream in the fragmented MP4 format conforms to “ISO/IEC 14496-10” and “ISO/IEC

14496-15 ”. For details on the moov and moof headers, see these documents.

Fragment data structure

The following shows the fragmented data structure of models supported by this

specification. In addition to the HTTP header, there are moov and moof headers, and

picture data for the first fragment is sent for the mdat header.

1st fragment HTTP

Header

I

Picture

mdat

Header

moov

Header

wvhttp

Header

P

Picture

moof

Header

mdat

Header

P

Picture

moof

Header

mdat

Header

P

Picture

moof

Header

mdat

Header

P

Picture

moof

Header

mdat

Header

...

...

2nd fragment

3rd fragment

15th fragment

16th fragment

17th fragment

I

Picture

moof

Header

mdat

Header

Fig. D-1 Fragment Data Structure within a Fragmented MP4 Format Stream

318

moov header

The moov header is transmitted only once at the start of the fragment transmission.

This header mainly contains the initial setting items required for video playback. For

example, the setting values for the video image size, frame rate, and time information

are included in the moov header.

In addition, the file size of the pictures transmitted together with the moov header is

included in the stsz box, and the starting picture is always the I picture. The models

supported by this specification support H.264, and, therefore, [SPS], [PPS], and [VUI]

fields are added to the moov header. All of these fields are within the [avcC] box.

Time information at transmission start

The current time (in seconds) is stored in [mvhd][tkhd] in the MP4 header at the start

of transmission. This time varies for each client. This is not the video image capture

time. The starting point of the current time is 1900/01/01 00:00.

SPS (Sequence Parameter Set) field

SPS contains the profile and level for all sequences.

PPS (Picture Parameter Set) field

PPS contains information related to all pictures.

However, PPS does not contain the setting value of the Q value.

VUI (Video Usability Information) field

VUI contains information on the aspect ratio, brightness, and color space.

moof header

The moof header contains the sequence number and frame type. The file size of the

pictures transmitted together with the moof header is included in the trun box.

When [first_sample_flags] in the trun box is 0x0, the starting picture of the fragment is

the I picture; otherwise, it is the P picture.

319

E HTTP Upload Specifications This describes the network camera HTTP upload functions supported by the models

supported by this specification.

The network camera has an upload function for sending notification of a detected event

by HTTP, FTP, or email. The function for sending event notification by HTTP is called

the “HTTP upload function”. There are two HTTP upload types.

■ Event upload that accesses a set HTTP server by setting a set query string as the

argument

■ Image upload that, in addition to providing an event upload function, uploads

video image data when uploading

E.1 Upload Event Triggers

The following are the events that can be configured as upload triggers. For details, see

the operation guide of each model.

Volume Detection

Set an event that occurs at volume detection. Change the state by selecting a level

at or above or below the standard volume. A continuous time for the detection

condition can also be set.

External Device Input

Change the state of a sensor connected to the external device input terminal, for

example, by setting it as an event. Settings can be made for changes to the state at

both the time of an active event and inactive event.

Only one system of [Input 1] can be used for external device input on the models

supported by this specification.

Timer

Set an event that occurs at a regular interval using the start time, end time, and

repeat interval. Specify the timer using the following conditions.

- Set the start time and end time with hours and minutes in 24-hour format.

- The repeat interval can be specified with the following values. When “None” is

set, the event occurs only once at the start time. (In this case, the end time is

ignored.)

“1 sec, 5 sec, 10 sec, 30 sec, 1 min, 5 min, 10 min, 15 min, 20 min, 30 min, 1

hour, 3 hours, 6 hours, 12 hours”

320

Intelligent Function

Set an event that occurs when the Intelligent Function is detected.

E.2 Upload Settings

The following are the HTTP upload setting items in the WebView settings protocol.

Event settings

The events, external device input, timers, volume detection, and other settings that

can be set as upload triggers are managed with the following items.

WebView settings protocol: Audio Server


hb00 Disabled Audio Transmission setting

hb03 Disabled Input Voice Activity Detection

hb10 Disabled Audio Reception setting


WebView settings protocol: Volume Detection


sa00 Do not use Volume Detection Event setting


WebView settings protocol: Timer


sn10 Do not use Timer Event Setting


WebView settings protocol: External Device Input


sp94 Disable Video Record Setting


321

WebView settings protocol: Event


ev00 Upload Video Record Action


Upload settings

The upload function settings are managed with the following items.

WebView settings protocol: Upload


ja01 JPEG Upload video image type

ja03 Upload Disabled Upload operation setting *1

ja50 1 fps Video image storage frame rate

ja51 0 Number of video images stored before event

[JPEG]

ja52 0 Number of video images stored after event

[JPEG]

ja61 0 Number of video images stored before event

[H.264]

ja62 0 Number of video images stored after event

[H.264]

See ‘5.4.9 Uploading ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

Note:

*1 To upload with HTTP, set <Upload with HTTP> (ja03=2).

WebView settings protocol: Video capture


dr03 480 x 270 Upload video image size


322

HTTP upload settings

Among the upload functions, the HTTP upload settings are managed with the

following items.

WebView settings protocol: HTTP Upload


jc01 Notification Only with HTTP Notification content (upload content) *1

jc02 URI *2

jc04 User Name *3

jc05 Password *3

jc06 Proxy Server *4

jc07 80 Proxy Port Number *4

jc08 Proxy User Name *5

jc09 Proxy Password *5

jc21 Parameter (query string) *6

See ‘5.4.9 Uploading ’ in “Network Camera Server WebView Settings Protocol Specifications ”.

Note:

*1 To upload an event, set <Notification Only with HTTP> (jc01=1).

To upload an image, set <Video attached Notification with HTTP> (jc01=2).

*2 Set the URI of the HTTP server.

E.g. http://192.168.100.12:8080/cgi-bin/upload.cgi

*3 Set this if the HTTP server requires user authentication. Only Basic authentication can

be used.

*4 Set this to access the URI via a proxy server.

*5 Set this if the proxy server requires user authentication. Only Basic authentication can

be used.

*6 A URI-encoded string must be specified to the parameter.

For details on URI encoding, see “RFC2396 Uniform Resource Identifiers (URI):

Generic Syntax ”.

323

The following “%text” can be used as a modifier for the URI parameter (query string).

Table E-1 List of Modifiers Usable in the URI Parameter

Modifier Meaning Description Note

%n Reason for capture

(number)

0 (test) | 1 (contact input 1) | 2 (contact input 2) |

33 (timer 1) | 34 (timer 2) |

35 (timer 3) | 36 (timer 4) |

145 (volume detection) | 146 (scream detection) |

160 (auto track) |

161 (VOP rule 1) | 162 (VOP rule 2) |

163 (VOP rule 3) | 164 (VOP rule 4) |

165 (VOP rule 5) | 166 (VOP rule 6) |

167 (VOP rule 7) | 168 (VOP rule 8) |

169 (VOP rule 9) | 170 (VOP rule 10) |

171 (VOP rule 11) | 172 (VOP rule 12) |

173 (VOP rule 13) | 174 (VOP rule 14) |

175 (VOP rule 15)

201 (linked event 1) | 202 (linked event 2) |

203 (linked event 3) | 204 (linked event 4) |

*1

*2

*3

*4

%N Reason for capture

(character string) “External Device Name (alphanumeric characters)” |

“VOP rule number (alphanumeric characters)” |

“NULL (blank character/cases of interval timer and

test)”

*7

%O Reason for capture

(ON/OFF)

OFF｜ON *5

%X Width of image Number of pixels in horizontal direction

%Y Height of image Number of pixels in vertical direction

%C Camera number 1

%D Camera name Setting for “Camera Name (alphanumeric

characters)”

%P Pan position -179.99 – 180.00

%T Tilt position -179.99 – 180.00

%Z Zoom position 0.01 – 300.00

%R Rotation position 0 *8

%V Camera server Model Name *6

%y Year of capture time 2001 – 2031

%m Month of capture time 01 – 12

%d Day of capture time 01 – 31

%w Day of week of capture

time

0 – 6 (Sunday to Saturday)

%H Hour of capture time 00 – 23

%M Minute of capture

time

00 – 59

%S Second of capture time 00 – 59

%s Milliseconds of

capture time

000 – 999

324

Modifier Meaning Description Note

%z Time zone of capture

location

-1200 – +1300

%a Name of day of week

of capture time

Sun | Mon | Tue | Wed | Thu | Fri | Sat

%b Name of month of

capture time

Jan | Feb | Mar | Apr | May | Jun | Jul | Aug |

Sep | Oct | Nov | Dec

%h Host Name

Note:

*1 Reason for capture (number) 2 (contact input 2) cannot be used on the following models.

VB-S30D/VB-S31D/VB-S800D/VB-S900F/VB-S805D/VB-S905F

*2 Reason for capture (number) 145 (Scream Detection) cannot be used except on the

following models.


*3 Reason for capture (number) 160 (Auto track) cannot be used except on the following

models.

VB-R11VE/VB-R11/VB-R10VE

*4 Reason for capture (number) 201 (linked event 1), 202 (linked event 2), 203 (linked

event 3), and 204 (linked event 4) cannot be used except on the following models.


*5 Modifier “%O” reason for capture (ON/OFF) cannot be used except on the following

models.


VB-R10VE//VB-M640VE/VB-M640V/VB-M740E

*6 The model name of “ra00” is set for modifier “%V” camera server.

*7 Reason for capture (character string) “VOP rule number (alphanumeric characters)”

cannot be used on the following models.

VB-S30D/VB-S31D/VB-S800D/VB-S900F/VB-S805D/VB-S905F

VB-H43/VB-H630VE/VB-H630D/VB-H730F

VB-M42/VB-M620VE/VB-M620D/VB-M720F

*8 Modifier “%R” Rotation position, require different firmware versions for the following

models. This modifier can only be used with VB-S30D/VB-S31D/VB-S800D/VB-

S900F/VB-S805D/VB-S905F models installed with firmware version 1.2.0 or later, and

for VB-H43/VB-H630VE/VB-H630D/VB-H730F/VB-M42/VB-M620VE/VB-M620D/VB-

M720F models installed with 1.1.0 or later.

325

E.3 Request

HTTP upload is sent as an HTTP GET or POST request. The “Notification content”

setting determines whether a GET or POST request will be used.

When [Notification Only with HTTP] event upload is selected

GET <HTTPServerURI>[?<QueryString>…] HTTP/1.1

...

User-Agent: Canon Network Camera VB/4.0

When [Video attached Notification with HTTP] image upload is selected

E.g. When a JPEG image is attached

POST <HTTPServerURI>[?<QueryString>…] HTTP/1.1

...

User-Agent: Canon Network Camera VB/4.0 Content-Type: image/jpeg

Content-Length: <JpegDataLength>

<JpegData>

Special Note:

Generally, “<input type=“file” ...>” is used to upload files from the browser, but to

attach an image for the models supported by this specification, JPEG images are uploaded

with a different method.

326

F VB-Discovery VB-Discovery is an application protocol that is used to search for network camera

equipment implemented in UDP.

The network camera waits to receive a search request message with UDP port number

52220 and responds to the received message with its own device information.

The arrival of packets of the UDP specification is not guaranteed, so considerations

must be made, such as having the client make multiple requests.

Special Note:

VB-Discovery supports only IPv4 for the network layer protocol.

(IPv6 is not supported.)

F.1 Sequence

The client can obtain a response by specifying a unicast address if the device address is

known or a broadcast address if it is unknown.

Unicast

Broadcast

(1) Request

(2) Response

Client application

Network Camera

Network Camera

Network Camera

Fig. F-1 VB-Discovery Packet Request and Response of Unicast Address Specification

Fig. F-2 VB-Discovery Packet Request and Response of Broadcast Address Specification

(1) Request

(2) Response

Client application

Network Camera

327

F.2 Packet Format

This describes the packet format of the UDP data portion of VB-Discovery.

F.2.1 Request

The client sends a VB-Discovery device search request packet and receives a response

from the devices supporting VB-Discovery. By setting the address as the broadcast

address, it is possible to obtain information from all devices operating in the broadcast

domain, including unknown devices.

Packet Format:

MV-SEARCH<Space>*<Space>HTTPU<\r><\n> *1

ST:<Space>VB<\r><\n> *1

[OPTION:<Space>HOSTNAME] *2/*3

Note:

*1 Required field

*2 Optional field (Use this when requesting a host name.)

*3 A line break code at the end of syntax is not required.

Syntax:

MV-SEARCH * HTTPU

ST: VB

[OPTION: HOSTNAME]

328

F.2.2 Response

The network camera receives a VB-Discovery device search request packet and returns

a response if the device corresponds to a search target.

HTTPU 200 OK

LOCATION: /-wvhttp-01-/GetCameraServerInfo

SERVER: <ModelName>/<FirmVersion>

ST: VB

PORT: <HTTPPortNumber>

[HOSTNAME: <HostName>]

Return value:

Return Value

Value Type/Range Description

LOCATION: <URI> URI requesting detailed device information

SERVER: <Model Name>/<Firmware

Version>

Camera model name and firmware version

*1

ST: VB Search target identifier

PORT: 80 HTTP port number at the time of requesting

detailed device information

HOSTNAME: <Host Name>

Camera host name

*2

Note:

*1 The format of the firmware version is <major>.<minor>.<revision>.

*2 If [HOSTNAME:] of the camera is specified and the “Host Name Registration with

DDNS (ib20)” WebView settings protocol item is registered and specified, the character

string set to the “Host Name (ib10)” WebView settings protocol item is output. Nothing

is output if neither is specified.

For details on the WebView settings protocol items, see ‘5.3 Items Related to the

WebView Settings Protocol ’.

329


HTTPU 200 OK

LOCATION: /-wvhttp-01-/GetCameraServerInfo

SERVER: VB-S30/1.1.0

ST: VB

PORT: 80

B. Error [No response]

In the following cases, the request will become invalid, and the network camera will

not return a response.

- When a required field or data does not exist

- When the device does not correspond to the search target

Note:

If the description in the [OPTION:] field is invalid, the invalid field is ignored and a normal

response is returned.

330

G Linked Event Linked event links two events to create one event. For the conditions for linking two

events, you can specify AND or OR conditions. For the AND condition, you can specify

the order in which events occur (event order) and the time from when the first event

occurs to the time when the second event occurs (event gap).

The following are the events that can work with linked event.

Volume Detection

Scream Detection

External Device Input

Timer event

Intelligent Function

Because all Intelligent Functions are treated as one event, events cannot be linked

using multiple Intelligent Functions, such as Intrusion Detection and Removed Object

Detection.

You can register up to four linked events.

Linked events include linked on events that are issued when linked conditions are met

and linked off events that are issued when linked conditions are canceled.

Note:

For details on the linked event setting items, see ‘5.4.11.7 Linked Event ’ in “Network

Camera Server WebView Settings Protocol Specifications ”.

G.1 Linked Event Operation Example

This is explained using the time at which a linked on event and linked off event are

issued.

As a shared setting, the event gap is 4 seconds. Each cell in the figure represents 1

second, and the shaded cells indicate the event gap time.

The start of the event gap time is the time that an event first occurred. For details, see

the operation example figure.

■ When an AND condition is specified

The time at which a linked on event is issued varies depending on whether the event

order is or is not specified.

331

Operation example 1: Event order is not specified

Event Linking Method : AND

Event Order : None

Event Gap : 4 sec.

Event 1

Event 2

Linked

status

Fig. G - 1 Event order is not specified

At A, event 2 occurs, and at B, event 1 occurs, the event linked condition is met, and

the linked on event is issued.

At C, event 2 turns off, the event linked condition is no longer met, and a linked off

event is issued.

Operation example 2: Event order is specified, and events occur in order


Event Order : Event 1→2

Event Gap : 4 sec.

Event 1

Event 2

Linked

status

Fig. G - 2 Events occur in order

Event Gap

A B C

Event Gap

A B C

332

At A, event 1 occurs, and at B, event 2 occurs, the events occur in order, the event

linked condition is met, and the linked on event is issued.

At C, event 1 turns off, the event linked condition is no longer met, and a linked off

event is issued.

Operation example 3: Event order is specified, and event gap time elapses



Event Gap : 4 sec.

Event 1

Event 2

Linked

status

Fig. G - 3 Elapsed event gap

At A, event 1 occurs, and at B, event 2 occurs, the linked condition is met, and the

linked on event is issued. At C, the linked on event continues while the event condition

is met even if the event gap of 4 seconds elapses.

At D, event 2 turns off, the event condition is no longer met, and a linked off event is

issued.

Event Gap

B C A D

333

Operation example 4: Event order is specified, and events do not overlap



Event Gap : 4 sec.

Event 1

Event 2

Linked

status

Fig. G - 4 Two events do not overlap within the event gap

When event 1 occurs at A, 4 seconds are specified for the event gap, so even if the

event turns off at B, the linked condition of the event is treated as being in the on

state until E 4 seconds later.

In addition, event 2 is treated as being in the on state from C to E because A, where

the event first occurred, is the starting point of the event gap.

Therefore, the linked event becomes linked on at C and becomes linked off at E.

Event Gap

A B C D E

334

■ When an OR condition is specified

When either set event occurs, a linked on event is issued. In an OR condition, the

event order and event gap are ignored.

Operation example 1: Only one event is on

Event 1

Event 2

Linked

status

Fig. G - 5 Only one event is on

At A, event 1 occurs, the event linked condition is met, and the linked on event is

issued. At B, event 1 turns off, the event linked condition is no longer met, and a

linked off event is issued.

Operation example 2: Both events are on

Event 1

Event 2

Linked

status

Fig. G - 6 Both events are on

At A, event 1 occurs, the event linked condition is met, and the linked on event is

issued. At B, event 2 occurs, and at C, event 2 turns off, but because the event linked

condition is met, the linked on state continues.

At D, event 2 turns off, the event linked condition is no longer met, and a linked off

event is issued.

(End)

B A

A B C D

Network Camera Server WebView HTTP Protocol Specifications...

Documents

Transcript of Network Camera Server WebView HTTP Protocol Specifications...