Integrated Camera Interface Specifications

Supplement for Web Control
Target Models
AW-HE130 (Network: V02.00)
AW-HR140 (Network: V01.00)

V2.00
Panasonic Corporation

Change History
February 19, 2016

V1.00 Release

June 23, 2017

V2.00 Release

Network-based CGI Specifications

1

Table of Contents
Change History ............................................................................................................................................. 1
1. Introduction............................................................................................................................................... 4
2. CGI List for Video Transmission ............................................................................................................... 5
2.1. Transmission User Management ........................................................................................................ 5
2.2. Device Information Acquisition ........................................................................................................... 92.3. JPEG-based Image Transmission .................................................................................................... 13
2.4. Image Transmission Sequence based on MJPEG ........................................................................... 17
2.5. Image Transmission Sequence based on JPEG Image 1 shot ......................................................... 18
2.6. H.264/AUDIO-based Image Transmission........................................................................................ 19
2.7. Unicast Image Transmission Sequence based on H.264 ................................................................. 21
3. CGI List for Camera Control ................................................................................................................... 22
3.1. Pan/Tilt/Zoom ................................................................................................................................... 22
4. CGI List for Update Notification .............................................................................................................. 24
4.1. Starting/Stopping Update Notification ............................................................................................... 24
5. CGI List for Various Settings................................................................................................................... 25
5.1. Basic Settings .................................................................................................................................. 25
5.2. NTP Settings .................................................................................................................................... 27
5.3. Video over IP Settings ...................................................................................................................... 29
5.4. Audio Settings .................................................................................................................................. 42
5.5. Multi-screen Settings ........................................................................................................................ 43
5.6. Priority Stream Settings.................................................................................................................... 44
5.7. Network Settings .............................................................................................................................. 46
5.8. UPnP Settings.................................................................................................................................. 49
5.9. SNMP Settings ................................................................................................................................. 49
5.10. Diffserv Settings ............................................................................................................................. 51
5.11. Data Upload ................................................................................................................................... 52
5.12. Initialization/Restart ........................................................................................................................ 52
5.13. User Authentication Settings .......................................................................................................... 53
5.14. Host Authentication Settings .......................................................................................................... 54
6. CGI List for Acquisition of Different Types of Information ........................................................................ 55
6.1. Basic Settings Information Acquisition.............................................................................................. 55
6.2. Preset position information Acquisition ............................................................................................. 61
6.3. Data Download ................................................................................................................................ 62
6.4 Log Acquisition .................................................................................................................................. 63
7. CGI List for HTTPS Control .................................................................................................................... 64
7.1. Setting Information and Acquiring Certification ................................................................................. 64
8. Acquiring the List of Setting Values ........................................................................................................ 65
9. About Control Based on RTSP ............................................................................................................... 84
9.1. About the URLs for an RTSP Request ............................................................................................. 84
9.2. About the rtsp Methods .................................................................................................................... 85
10. About Acquisition of Stream from RTSP ............................................................................................... 86
10.1. UDP Unicast .................................................................................................................................. 86
10.2. UDP Multicast ................................................................................................................................ 90
10.3. TCP Unicast ................................................................................................................................... 94
10.4 About the rtpmap Attribute .............................................................................................................. 98
11. About Control Based on RTCP ............................................................................................................. 99
12. About RTP/Data Format ..................................................................................................................... 100
Network-based CGI Specifications2

12.1. RTP Header Format ..................................................................................................................... 100
12.2. Relationship with H.264/ES Data ................................................................................................. 101
12.3. H.264 Syntax ............................................................................................................................... 102
12.4. Audio Data Format ....................................................................................................................... 102

Network-based CGI Specifications3

1. Introduction
This manual describes the specifications for video transmission and network application operation when aremote camera is operated via the network. For details on the general camera operations of the remotecamera, see the separate volume "HD Integrated Camera_Interface Specifications".
Panasonic shall not take any responsibility of damages caused as a result of the use of this information.
This information may be changed without prior notice due to upgrade of product version in future. The usage
examples are only reference examples for this series. Support cannot be offered for each program.
Moreover, some information may not be disclosed about communication between the camera and browser.

About the access levels
In this manual, "Live" and "Admin" are defined as the access levels. The necessity of the ID/password during
CGI execution is changed from the User auth. menu of the remote camera.
When User auth. is OFF (factory settings):
Live (Video acquisition and camera control)
Admin (All SETUP controls)
When User auth. is ON:
Live (Video acquisition and camera control)

Admin (All SETUP controls)

Network-based CGI Specifications... Authentication not necessary... ID/password for Administrator authority are necessary... ID/password for Live (only video acquisition
allowed), camera control, or Administrator authority arenecessary... ID/password for Administrator authority are necessary42. CGI List for Video Transmission
2.1. Transmission User Management
MethodAccess level
CGI item name
Transmission user

: GET
: LiveURL/cgi-bin/getuid

management

Parameter

Parameter

name

value

Description

FILE

2

2 (Fixed)vcodecjpeg

jpeg: During JPEG transmission

h264

h264: During H.264(1) transmission

h264_2

h264_2: During H.264(2) transmission

h264_3h264_3: During H.264(3) transmission

h264_4

h264_4: During H.264(4) transmission

page

-

Dummy for disabling cache

replybrowser

Command response format specificationinfo(can be omitted)
browser: for the camera browser
info: for the application

resolution

160

Resolution

320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

quality1

1: Image quality 1

2

2: Image quality 2

Usage example) Acquisition of user ID (during H264(1) transmission)
http://192.168.0.10/cgi-bin/getuid?FILE=2&vcodec=h264

Network-based CGI Specifications

5

The response data is as shown below.
UID=< User ID >[CR][LF]
ImageFormat=< Video format >[CR][LF]
ImageCaptureMode=< Image Capture Mode >[CR][LF]
ratio=< Aspect ratio >[CR][LF]
Maxfps=< Max fps >[CR][LF]
StreamMode=< Stream mode >[CR][LF]
iBitrate=< H.264 bitrate >[CR][LF]
iResolution=< H.264 resolution >[CR][LF]
iQuality=<H.264 quality >[CR][LF]
sDelivery=< setting >[CR][LF]
iUniPort=< Unicast port number >[CR][LF]
iMultiAdd1=< 1st octet of multicast address >[CR][LF]
iMultiAdd2=< 2nd octet of multicast address >[CR][LF]
iMultiAdd3=< 3rd octet of multicast address >[CR][LF]
iMultiAdd4=< 4th octet of multicast address >[CR][LF]
iMultiAdd=< multicast address >[CR][LF]
iMultiPort=< Multicast port number >[CR][LF]aEnable=< Audio mode>[CR][LF]
aEnc=< Audio enc >[CR][LF]
aBitrate=< Audio bit rate >[CR][LF]
aBitrate2=< Audio bit rate >[CR][LF]
aInterval=< Audio input interval >[CR][LF]
aInPort=< Audio unicast port number >[CR][LF]
aOutInterval=< Audio output interval >[CR][LF]
aOutPort=< Audio output port >[CR][LF]
aOutStatus=< Audio output status >[CR][LF]
aOutUID=< Audio output UID >[CR][LF]
ePort=< Event notification port number >[CR][LF]
sAlarm=< Alarm status >[CR][LF]
SDrec=< Recording status >[CR][LF]
SDrec2=< Recording status >[CR][LF]
sAUX=< Aux status >[CR][LF]
iHttpPort=< HTTP port number >[CR][LF]
iMultiAuto_h264=< Multicast auto H.264(1) >[CR][LF]
iMultiAuto_h264_2=< Multicast auto H.264(2) >[CR][LF]
iMultiAuto_h264_3=< Multicast auto H.264(3) >[CR][LF]
iMultiAuto_h264_4=< Multicast auto H.264(4) >[CR][LF]
sRtspMode_h264=< Control mode H.264(1) >[CR][LF]
sRtspMode_h264_2=< Control mode H.264(2) >[CR][LF]
sRtspMode_h264_3=< Control mode H.264(3) >[CR][LF]
sRtspMode_h264_4=< Control mode H.264(4) >[CR][LF]

Network-based CGI Specifications

6

The description of the response data is as shown below.
Item

Value of response

Description

UID

Numeric value

User ID

ImageFormat

jpeg

During JPEG transmission

h264

During H.264(1) transmission

h264_X

During H.264(X) transmission

ImageCaptureMode2m

Fixed value

ratio

16_9

Fixed value

Maxfps30

Max. frame rate

60
StreamMode

1

Fixed value

iBitrate

Numeric value

Bit rate setting of H.264

iResolution

160

Horizontal resolution setting of H.264

320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

iQuality

fine

Image quality setting of H.264

lownormalsDelivery

uni

uni：unicast(auto)

multi

multi：multicast

uni_manual

uni_manual：unicast(manual)

iUniPort

1024 to 50000

Unicast port number (image)iMultiAdd1

224 to 239

First octet of multicast address

iMultiAdd2

0 to 255

Second octet of multicast address

iMultiAdd3

0 to 255

Third octet of multicast address

iMultiAdd4

0 to 255

Fourth octet of multicast address

iMultiAdd(IP address)

H.264 multicast address

iMultiPort

Numeric value

Multicast port numberaEnableoff

off: Audio OFF

in

in: Audio ON (reception)

3

Audio encoder settingsaEnc

0:G.726
3: AAC-LC(High quality)
aBitrate

128

Bit rate setting of audio

96[G.726]64

128,96,64

32[AAC-LC(High quality)

16

32,16

aBitrate2

64

Fixed value

aInterval

20

Audio transmission interval (For G.726)

40
80
160

Network-based CGI Specifications

7

Item

Value of response

Description

aInPort1024 to 50000

Unicast port number (audio)aOutInterval

640

Fixed value

aOutPort

34004

Fixed value

aOutStatus

Off

Fixed value

aOutUID

0

Fixed value

ePort

31004

Fixed value

sAlarmOFF

Fixed value

SDrec

disableFixed value

SDrec2disableFixed value

sAUX

off

Fixed value

iHttpPort

Numeric value

HTTP port number

iMultiAuto_h264

0

Fixed value

iMultiAuto_h264_2

0

Fixed value

iMultiAuto_h264_3

0

Fixed value

iMultiAuto_h264_4

0

Fixed valuesRtspMode_h264

0

Fixed valuesRtspMode_h264_2

0

Fixed valuesRtspMode_h264_3

0

Fixed valuesRtspMode_h264_4

0

Fixed value

Network-based CGI Specifications82.2. Device Information Acquisition
MethodAccess level: GET: LiveCGI item name

URL

Device information acquisition/cgi-bin/getinfo

Parameter name
FILE

Parameter value
1

Description
1 (Fixed)

Usage example) Acquisition of user ID (during H264(1) transmission)
http://192.168.0.10/cgi-bin/getinfo?FILE=1

The response data is as shown below.
MAC=< Mac address >[CR][LF]
SERIAL=< Serial number >[CR][LF]
VERSION=< Firmware version >[CR][LF]
NAME=< Model name >[CR][LF]
SDrec=< Recording status >[CR][LF]
SDrec2=< Recording status >[CR][LF]
sAlarm=< Alarm status >[CR][LF]
sAUX=< Aux status >[CR][LF]
ePort=< Event notification port number >[CR][LF]aEnable=< Audio mode>[CR][LF]
aEnc=< Audio enc >[CR][LF]
aBitrate=< Audio bit rate >[CR][LF]
aBitrate2=< Audio bit rate >[CR][LF]
aInterval=< Audio input interval >[CR][LF]
aOutInterval=< Audio output interval >[CR][LF]
aOutPort=< Audio output port >[CR][LF]
aOutStatus=< Audio output status >[CR][LF]
aOutUID=< Audio output UID >[CR][LF]
aInPort_h264=< Audio with H.264 1st stream unicast port number >[CR][LF]
aInPort_h264_2=< Audio with H.264 2nd stream unicast port number >[CR][LF]
aInPort_h264_3=< Audio with H.264 3rd stream unicast port number >[CR][LF]
aInPort_h264_4=< Audio with H.264 4th stream unicast port number >[CR][LF]
sRtspMode_h264=< Control mode H.264(1) >[CR][LF]
sRtspMode_h264_2=< Control mode H.264(2) >[CR][LF]
sRtspMode_h264_3=< Control mode H.264(3) >[CR][LF]
sRtspMode_h264_4=< Control mode H.264(4) >[CR][LF]
ImageCaptureMode=< Iimage Capture Mode >[CR][LF]
ratio=< Aspect ratio >[CR][LF]
Maxfps=< Max fps >[CR][LF]
StreamMode=< Stream mode >[CR][LF]
iTransmit_h264=< H.264 1st stream ON/OFF setting >sDelivery_h264=< H.264 1st stream setting >[CR][LF]
iBitrate_h264=< H.264 1st stream bit rate >[CR][LF]
iResolution_h264=< H.264 1st stream resolution >[CR][LF]
iQuality_h264=< H.264 1st stream quality >[CR][LF]

Network-based CGI Specifications

9

iMultiAuto_h264=< Multicast auto H.264(1) >[CR][LF]
iTransmit_h264_2=< H.264 2nd stream ON/OFF setting >sDelivery_h264_2=< H.264 2nd stream setting >[CR][LF]
iBitrate_h264_2=< H.264 2nd stream bit rate >[CR][LF]
iResolution_h264_2=< H.264 2nd stream resolution >[CR][LF]
iQuality_h264_2=< H.264 2nd stream quality >[CR][LF]
iMultiAuto_h264_2=< Multicast auto H.264(2) >[CR][LF]
iTransmit_h264_3=< H.264 3rd stream ON/OFF setting >sDelivery_h264_3=< H.264 3rd stream setting >[CR][LF]
iBitrate_h264_3=< H.264 3rd stream bit rate >[CR][LF]
iResolution_h264_3=< H.264 3rd stream resolution >[CR][LF]
iQuality_h264_3=< H.264 3rd stream quality >[CR][LF]
iMultiAuto_h264_3=< Multicast auto H.264(3) >[CR][LF]
iTransmit_h264_4=< H.264 4th stream ON/OFF setting >sDelivery_h264_4=< H.264 4th stream setting >[CR][LF]
iBitrate_h264_4=< H.264 4th stream bit rate >[CR][LF]
iResolution_h264_4=< H.264 4th stream resolution >[CR][LF]
iQuality_h264_4=< H.264 4th stream quality >[CR][LF]
iMultiAuto_h264_4=< Multicast auto H.264(4) >[CR][LF]

The description of the response data is as shown below.
Item

Value of response

Description

MAC

XX-XX-XX-XX-XX-XX

MAC address

SERIALXXXXXXXXX

Product serial number

VERSION

Software version

NAME

AW-XXXX

Product number

SDrec

disableFixed value

SDrec2disableFixed value

sAlarmOFF

Fixed value

sAUX

off

Fixed value

ePort

31004

Fixed value

aEnableoff

off: Audio OFF

in

in: Audio ON (reception)

3

Audio encoder settingsaEnc

0: G.726
3: AAC-LC(High quality)
aBitrate

aBitrate2

128

Bit rate setting of audio

96[G.726]64

128,96,64

32[AAC-LC(High quality)]

16

32,16

64

Fixed value

Network-based CGI Specifications

10

aInterval

20

Audio transmission interval (For G.726)

40
80
160
aOutInterval

640

Fixed value

aOutPort

34004

Fixed value

aOutStatus

off

Fixed value

aOutUID

0

Fixed value

aInPort_h2641024 to 50000

H.264(1) Audio reception port number

aInPort_h264_2

1024 to 50000

H.264(2) Audio reception port number

aInPort_h264_3

1024 to 50000

H.264(3) Audio reception port number

aInPort_h264_4

1024 to 50000

H.264(4) Audio reception port numbersRtspMode_h264

0

Fixed valuesRtspMode_h264_2

0

Fixed valuesRtspMode_h264_3

0

Fixed valuesRtspMode_h264_4

0

Fixed value

ImageCaptureMode2m

Fixed value

ratio

16_9

Fixed value

Maxfps30

Max. frame rate

60
StreamMode

1

Fixed value

iTransmit_h264

1

Fixed valuesDelivery_h264

uni

uni: Unicast (auto)

multi

multi: Multicast

uni_manual

uni_manual: Unicast (manual)iBitrate_h264

Numeric value

Bit rate setting of H.264(1)iResolution_h264

160

Horizontal resolution setting of H.264(1)320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

iQuality_h264

fineImage quality setting of H.264(1)lownormaliMultiAuto_h264

0

Fixed value

iTransmit_h264_2

see.H.264(1)see.H.264(1)sDelivery_h264_2
iBitrate_h264_2
iResolution_h264_2
iQuality_h264_2
iMultiAuto_h264_2

Network-based CGI Specifications

11

iTransmit_h264_3

see.H.264(1)see.H.264(1)see.H.264(1)see.H.264(1)sDelivery_h264_3
iBitrate_h264_3
iResolution_h264_3
iQuality_h264_3
iMultiAuto_h264_3
iTransmit_h264_4
sDelivery_h264_4
iBitrate_h264_4
iResolution_h264_4
iQuality_h264_4
iMultiAuto_h264_4

Network-based CGI Specifications

122.3. JPEG-based Image Transmission
MethodAccess level: GET: LiveCGI item name
JPEG image

URL/cgi-bin/jpeg

Parameter

Parameter value

nameconnect

start

transmission (MJPEG)

Description
start: Starts JPEG image transmission
stop: Stops JPEG image transmission

stopframerate

When the system

Image refresh interval (during JPEG

frequency is 60 Hz

server push) (fps)

1
2
3
5
6
10
15
30
When the systemfrequency is 50 Hz
1
2
5
10
12.5
25
resolution

160

Resolution

320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

quality

1

Image quality

2

1:

Image quality 1

2:

Image quality 2

UID

Numeric value

User ID

resolution

160

160：160x90

320

320：320x180

640

640：640x360

1280

1280：1280x720

1920

1920：1920x1080* UI acquired by /cgi-bin/getuid
JPEG image/cgi-bin/mjpeg

transmission (MJPEG)

Network-based CGI Specifications

13

CGI item name

URL

Parameter

Parameter value

nameframerate

Description

When the system

Image refresh interval (during JPEG

frequency is 60 Hz

server push) (fps)

1
2
3
5
6
10
15
30
When the systemfrequency is 50 Hz
1
2
5
10
12.5
25
JPEG image 1 shot

/cgi-bin/camera

resolution

requestquality

page

160

160：160x90

320

320：320x180

640

640：640x360

1280

1280：1280x720

1920

1920：1920x1080

1

1:

Image quality 1

2

2:

Image quality 2

Numeric value

Dummy for disabling cache[Notes]In a remote camera, various techniques are provided for acquisition of a JPEG video.
Use the technique suitable to your purpose.
MJPEG
By continuously displaying the videos that arrive, a movie display can be realized.
The frame rate is decided based on the arguments.
Depending on the software and hardware at the receiving side, some frame rates may not be supported.
JPEG image 1 shot
By repeating the processes of acquisition, display, and standby for a single JPEG image, a movie
display can be realized.
The frame rate is decided according to the standby time in the software and hardware at the receiving
side.

Network-based CGI Specifications

14

The characteristics of each CGI of MJPEG are as described below.
/cgi-bin/jpeg
When CGI is called once, the MJPEG stream is transmitted continuously.
Before calling, the acquisition of UID with /cgi-bin/getuid is necessary.
In Internet Explorer, the plug-in software uses when calling JPEG(1) to (3).
Specific usage examples and sequences are described in the next chapter.

/cgi-bin/mjpeg
When CGI is called once, the MJPEG stream is transmitted continuously.
Before calling, the acquisition of UID with /cgi-bin/getuid is not necessary.
It is used when calling JPEG from some mobile terminals.
In Safari, movie display is possible by entering only this CGI in the URL field of the browser.
Not supported by Internet Explorer.
Usage example) When acquiring a 320 x 180 video in 30 fps in the MJPEG format:
http://192.168.0.10/cgi-bin/mjpeg?resolution=320&framerate=30
Usage example) When acquiring a 640 x 360 video in 15 fps in the MJPEG format:
http://192.168.0.10/cgi-bin/mjpeg?resolution=640&framerate=15
Usage example) When acquiring a video of approx. 5 fps in the MJPEG format(parameter omitted):
http://192.168.0.10/cgi-bin/mjpeg

Network-based CGI Specifications

15

The characteristics of each CGI of JPEG image 1 shot are as described below.
/cgi-bin/camera
When CGI is called once, only one JPEG image is transmitted.
Before calling, the acquisition of UID with /cgi-bin/getuid is not necessary.
In Internet Explorer, the plug-in software uses when acquiring a screen shot.

The notes common for each CGI are as described below.
When a video is acquired simultaneously by several PCs and receivers, the best effort judgment isperformed at the camera side.
Therefore, the expected frame rate display may not be achieved.
As for the resolution and frame rate, the content registered in the WEB menu/Video over IP/JPEG isgiven priority.
Therefore, even if the resolution is specified in the arguments, the response may be issued with an
unexpected resolution and frame rate.
Example) If JPEG(1) = 640 x 360/30 fps, JPEG(2) = 1280 x 720/5 fps, JPEG(3) = 320 x 180/15 fps,
/cgi-bin/mjpeg?resolution=320&framerate=15=> As instructed, the response is in the form of content of the 320 x 180 JPEG(3).
/cgi-bin/mjpeg?resolution=640&framerate=15=> As instructed, the response is issued by subtracting the frame rate from the content of the 640 x
360 JPEG(1).
/cgi-bin/mjpeg?resolution=1280&framerate=15=> The response is issued with a resolution of 1280 x 720, but the frame rate is 5 fps, which is theupper limit of JPEG(2).
/cgi-bin/mjpeg?resolution=320&framerate=1920=> Because no content is registered in JPEG(1) to (3), the response is issued with the resolution ofJPEG(1) and a frame rate of 5 fps.
/cgi-bin/mjpeg=> Because there are no parameters, the response is issued with the resolution of JPEG(1) and aframe rate of 5 fps.

Network-based CGI Specifications

16

2.4. Image Transmission Sequence based on MJPEG

MJPEG Sequence

Network-based CGI Specifications

17

2.5. Image Transmission Sequence based on JPEG Image 1 shot

JPEG 1 shot Sequence

Network-based CGI Specifications18

2.6. H.264/AUDIO-based Image Transmission
MethodAccess level: GET: LiveCGI item name
H.264 image

URL/cgi-bin/h264

Parameter

Parameter

name

value

my_port

Numeric valuetransmission

Description
Reception port number of H.264* This parameter cannot be omitted if
unicast is set.

connectstart

start: Starts H.264 transmission

stop

stop: Stops H.264 transmission

protocolrtp

rtp: RTP format (can be omitted)

UID

Numeric value

User ID* UI acquired by /cgi-bin/getuid

streamForced insertion of I

/cgi-bin/h264_I_inser

frame

t

H.264 SDP

/cgi-bin/h264_sdp

stream-1

1: Stream 1

2

2: Stream 2

3

3: Stream 3

4

4: Stream 4

1

1: Stream 1

2

2: Stream 2

3

3: Stream 3

4

4: Stream 4-

Sends SDP information in the HTTP

notification

response to the SDP request from theclientAudio transmission/cgi-bin/audio

connect
protocolmy_portstart

start: Starts audio transmission

stop

stop: Stops audio transmission

rtp

rtp: RTP transmission

httphttp: HTTP transmission

Numeric value

Reception port number of audio data
* Only when protocol = rtp
Can be omitted during HTTP
transmission

UID

Numeric value

User ID* UI acquired by /cgi-bin/getuid

Keep alive/cgi-bin/keep_alive

Network-based CGI Specifications

mode

in

in: Sound collection

stream1

1: Stream 1

2

2: Stream 2

3

3: Stream 3

4

4: Stream 4

h.264

h.264: H.264 keep alive

h.264_2

h.264_2: H.264(2) keep alive

h.264_3

h.264_3: H.264(3) keep alive

h.264_4

h.264_4: H.264(4) keep alive

jpeg

jpeg: JPEG keep alive

audio

audio: Audio keep alive

mode

19

CGI item name

URL

Parameter

Parameter

name

value

protocolUID

Description

rtp

rtp: RTP transmission

httphttp: HTTP transmission

Numeric value

User ID* UI acquired by /cgi-bin/getuid

stream1

1:

Stream 1

2

2:

Stream 2

3

3:

Stream 3

4

4:

Stream 4* Can be omitted

Usage example) H264(1) image transmission start (when the port number is "40000" and User ID is "263")
http://192.168.0.10/cgi-bin/h264?my_port=40000&connect=start&protocol=rtp&UID=263&stream=1

Usage example) Audio transmission start
http://192.168.0.10/cgi-bin/audio?my_port=38004&connect=start&protocol=rtp&UID=263&mode=in

Usage example) Keep alive (JPEG)
http://192.168.0.10/cgi-bin/keep_alive?mode=jpeg&protocol=http&UID=263

Network-based CGI Specifications20

2.7. Unicast Image Transmission Sequence based on H.264

H264 Sequence

Network-based CGI Specifications21

3. CGI List for Camera Control
3.1. Pan/Tilt/Zoom
MethodAccess level: GET: LiveCGI item name
Camera control (Web)URL/cgi-bin/camctrl

Parameter

Parameter

name

value

pan

-5~5

Description
Specification of distance moved in the left
and right directions
Negative: Movement in left direction
Positive: Movement in right direction

tilt

-4~4

Specification of distance moved in the
upward and downward directions
Negative: Movement in upward direction
Positive: Movement in downward
direction

times

1

Magnification specification

down

1: Actual sizeup

down: Adjustment in Wide direction
up: Adjustment in Tele direction

focus

-3

Focus adjustment

3

Negative: Adjustment in Far direction
Positive: Adjustment in Near direction* No operation is performed when
AutoFocus is set.

af

onAuto focus adjustment

bright1

Brightness

2

1: Standard

3

2. Reduce brightness
3: Increase brightness* No operation is performed when
AutoIris is set.

presetCamera control/cgi-bin/directctrl(main monitor)

pan

0,

0: Home position

1 to 256

1 to 256: Specify number-16 to 16

Specification of distance moved in the left
and right directions(speed control in 16 levels)
Negative: Movement in left direction
Positive: Movement in right direction

Network-based CGI Specifications

22

tilt

-16 to 16

Specification of distance moved in the
upward and downward directions(speed control in 16 levels)
Negative: Movement in upward direction
Positive: Movement in downward
direction

dpan-256 to 256

Specification of distance moved in the left
and right directions(speed control in 256 levels)
Negative: Movement in left direction
Positive: Movement in right direction

dtilt-256 to 256

Specification of distance moved in the
upward and downward directions(speed control in 256 levels)
Negative: Movement in upward direction
Positive: Movement in downward
directionzoom-4 to 4

Zoom
Negative: Adjustment in Wide direction
Positive: Adjustment in Tele direction

focus-4 to 4Focus adjustment
Negative: Adjustment in Far direction
Positive: Adjustment in Near direction

Usage example) Enable auto focus adjustment by moving the camera five levels in the right direction andtwo levels in the downward direction.
http://192.168.0.10/cgi-bin/camctrl?pan=5&tilt=2&af=on

Usage example) Perform zoom by moving the camera 128 levels in the right direction and 128 levels in the
downward direction.
http://192.168.0.10/cgi-bin/directctrl?dpan=128&dtilt=128&zoom=2

Network-based CGI Specifications23

4. CGI List for Update Notification
4.1. Starting/Stopping Update Notification
MethodAccess level: GET: LiveCGI item nameStart/stop update

URL/cgi-bin/event

Parameter

Parameter

name

value

connect

notification

Description

start

start: Start update notification

stop

stop: Stop update notification

myport1 to 65535

Port number

uidTransmission

0 to maximum value of unsigned int

user(depends on OS)

Usage example) Start update notification
http://192.168.0.10/cgi-bin/event?connect=start&my_port=30000&uid=100

Network-based CGI Specifications24

5. CGI List for Various Settings
5.1. Basic Settings
MethodAccess level
CGI item name
Basic settings: POST: AdminURL/cgi-bin/set_basic

Parameter

Parameter name
cam_title

Description

valueStringCamera title(within 20 double-byte characters)

set_year2013～2035

Year setting

set_month

1～12Month setting

set_day

1～31

Day setting

set_hour00～23

Hour setting

set_min

00～59

Minute setting

set_sec

00～59

Second setting

set_time

0

Change time setting or not

1

0:Time setting is not changed.
1: Time setting is changed.

timezone

1～74

timezone settings
Firmware for domestic use
63(GMT+09:00)
Other than the above:26(GMT+0:00)

summer_time

0

Summer time1

0: Summer time is not set (Out)2

1: Summer time is set (In)2: Summer time is auto-adjusted
according to (Start/End) (Auto)start_month

1～12

Summer time start monthstart_week

1～5

Summer time start week
1: First week, 2: Second week
3: Third week 4: Fouth week
5: Last week

start_dotw

0～6

Summer time start day of the week
0: Sunday

1: Monday

2: Tuesday

3: Wednesday

4: Thursday

5: Friday

6: Saturday
start_hour

1～12Summer time start hour

start_ampm

0Summer time start am/pm

1

0: AM
1: PM

end_month

1～12

Summer time end month

end_week

1～5Summer time end week
1: First week, 2: Second week

Network-based CGI Specifications

25

CGI item name

URL

Parameter

Parameter name

Descriptionvalue

3: Third week 4: Fouth week
5: Last week
end_dotw

0～6Summer time end day of the week
0: Sunday

1: Monday

2: Tuesday

3: Wednesday

4: Thursday

5: Friday

6: Saturday
end_hour

1～12

Summer time end hour

end_ampm

0Summer time end am/pm

1

0: AM
1: PM

led

0

Tally lamp control

1

0: light off
1: light onplugin_download

enableAuto installation of plug-in software

disableenable: Allowed
disable: Not allowed

plugin_disp

upsidedown

0

0: Real time consideration (Off)1

1: Smooth display (On)0

Upside down

1

0：OFF (ceiling)
1：ON (desktop)

Usage example) Set the camera title
http://192.168.0.10/cgi-bin/set_basic?cam_title=AW-HE130

Network-based CGI Specifications

26

5.2. NTP Settings
Method: POST
Access level: Admin
CGI item name
NTP settings

URL/cgi-bin/time

Parameter

Parameter name

Description

value

time_adjust

1

1: Synchronized with the NTP server

ntp_addr_dhcp00: OFF (manual input)

1

1: ON (acquired from DHCP)

ntp_addr

StringIP address

ntp_port

Numeric value

1 to 65535

ntp_interval

Numeric value

1 to 24 (hours)

timezone

1 to 74

Timezone settings(fixed as 1)

Firmware for domestic use:
63 (GMT + 09:00)
Other than the above:
26 (GMT + 0:00)
summer_time

0

Summer time1

0: Summer time is not set (Out)2

1: Summer time is set (In)2: Summer time is auto-adjusted
according to (Start/End) (Auto)start_month

1 to 12

Summer time start monthstart_week

1 to 5

Summer time start week1: First week, 2:
Second week
3: Third week, 4: Fourth week
5: Last week

start_dotw

0 to 6

Summer time start day of the week
0: Sunday, 1: Monday
2: Tuesday, 3: Wednesday
4: Thursday, 5: Friday
6: Saturday

start_hour

1 to 12

Summer time start hour

start_ampm

0Summer time start am/pm

1

0: AM
1: PM

end_month

1 to 12

Summer time end month

end_week

1 to 5

Summer time end week
1: First week, 2: Second week
3: Third week, 4: Fourth week
5: Last week

end_dotw

0 to 6

Summer time end day of the week0:
Sunday, 1: Monday
2: Tuesday, 3: Wednesday
4: Thursday, 5: Friday

Network-based CGI Specifications

27

CGI item name

URL

Parameter

Parameter name

Descriptionvalue
6: Saturday

end_hour

1 to 12

Summer time end hour

end_ampm

0Summer time end am/pm

1

0: AM
1: PM

Usage example) NTP settings
http://192.168.0.10/cgi-bin/time?time_adjust=1&ntp_addr_dhcp=0&ntp_addr=192.168.0.1&ntp_port=123&ntp_interval=12

Network-based CGI Specifications28

5.3. Video over IP Settings
MethodAccess level
CGI item name
JPEG settings: POST: AdminParameter

URL/cgi-bin/set_jpeg

Parameter value

namejpeg_transmit1

jpeg_transmit2

jpeg_transmit3

jpeg_interval

Description0

JPEG(1) transmission

1

0: OFF

Do not transmit

1: ON

Transmit

0

JPEG(2) transmission

1

0: OFF

Do not transmit

1: ON

Transmit

0

JPEG(3) transmission

1

0: OFF

Do not transmit

1: ON

Transmit

When the system

Image refresh interval

frequency is 60 Hz

3, 6, 15, and 30 can be set only when the1system frequency is 60 Hz

2

12.5 and 25 can be set only when the3system frequency is 50 Hz

5
6
10
15
30
When the systemfrequency is 50 Hz
1
2
5
10
12.5
25
jpeg_resolution

160

Default resolution

320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

jpeg_base_quali

1

Default image quality

ty

2

1:

Image quality 1

2:

Image quality 2

jpeg_quality

Network-based CGI Specifications

0 to 90 to 4: High image quality

superfine

5 to 9: Low image quality

finesuperfine: Same image quality as 0

normalfine: Same image quality as 1

29

CGI item nameParameter

URL

name

Parameter value
low

Description
normal: Same image quality as 5
low: Same image quality as 9

nr_jpeg_quality

0 to 90 to 4: High image quality

superfine

5 to 9: Low image quality

finesuperfine: Same image quality as 0

normalfine: Same image quality as 1

lownormal: Same image quality as 5
low: Same image quality as 9

160
320
640
1280
1920

160：160x90
320：320x180
640：640x360
1280：1280x720
1920：1920x1080

quality_1280_1

0 to 9superfine
finenormallow

quality_1280_2

0 to 9superfine
finenormallow

Image quality setting 1 for 1280 X 720
0 to 4: High image quality
5 to 9: Low image quality
superfine: Same image quality as 0
fine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9
Image quality setting 2 for 1280 X 720
0 to 4: High image quality
5 to 9: Low image quality
superfine: Same image quality as 0
fine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9

quality_640_1

0 to 9superfine
finenormallow

quality_640_2

0 to 9superfine
finenormallow

quality_320_1

0 to 9superfine
finenormallow

quality_320_2

0 to 9superfine
finenormalnr_jpeg_resoluti
onNetwork-based CGI Specifications

Image quality setting 1 for 640 X 320
0 to 4: High image quality
5 to 9: Low image quality
superfine: Same image quality as 0
fine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9
Image quality setting 2 for 640 X 320
0 to 4: High image quality
5 to 9: Low image quality
superfine: Same image quality as 0
fine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9
Image quality setting 1 for 320 X 180
0 to 4: High image quality
5 to 9: Low image quality
superfine: Same image quality as 0
fine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9
Image quality setting 2 for 320 X 180
0 to 4: High image quality
5 to 9: Low image quality
superfine: Same image quality as 0

30

CGI item name

URL

Parameter

resol_stream1

resol_stream2

resol_stream3

JPEG stream/cgi-bin/setdata

Parameter value

name

LIVEINT

settings

Description

lowfine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9160

160：160x90

320

320：320x180

640

640：640x360

1280

1280：1280x720

1920

1920：1920x1080

160

160：160x90

320

320：320x180

640

640：640x360

1280

1280：1280x720

1920

1920：1920x1080

160

160：160x90

320

320：320x180

640

640：640x360

1280

1280：1280x720

1920

1920：1920x1080

When the system

JPEG refresh interval

frequency is 60 Hz

3, 6, 15, and 30 can be set only when the1system frequency is 60 Hz

2

12.5 and 25 can be set only when the3system frequency is 50 Hz

5
6
10
15
30
When the systemfrequency is 50 Hz
1
2
5
10
12.5
25
LIVESIZE

160

Resolution of JPEG(1)320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

LIVESIZE2

Network-based CGI Specifications

160

Resolution of JPEG(2)320

160：160x90

640

320：320x180

31

CGI item nameParameter

URL

name

Parameter value

Description

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

LIVESIZE3

160

Resolution of JPEG(3)320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

LIVEQUAL1280

0 to 9Image quality of JPEG(1)superfine

0 to 4: High image quality

fine

5 to 9: Low image quality

normalsuperfine: Same image quality as 0

lowfine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9

LIVEQUAL1280

0 to 9Image quality (2) of JPEG(1)_2superfine

0 to 4: High image quality

fine

5 to 9: Low image quality

normalsuperfine: Same image quality as 0

lowfine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9

LIVEQUAL640

0 to 9Image quality of JPEG(2)superfine

0 to 4: High image quality

fine

5 to 9: Low image quality

normalsuperfine: Same image quality as 0

lowfine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9

LIVEQUAL640_

0 to 9Image quality (2) of JPEG(2)2superfine

0 to 4: High image quality

fine

5 to 9: Low image quality

normalsuperfine: Same image quality as 0

lowfine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9

LIVEQUAL320

0 to 9Image quality of JPEG(3)superfine

0 to 4: High image quality

fine

5 to 9: Low image quality

normalsuperfine: Same image quality as 0

lowfine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9

Network-based CGI Specifications

LIVEQUAL320_

0 to 9Image quality (2) of JPEG(3)2superfine

0 to 4: High image quality

32

CGI item nameParameter

URL

Parameter value

name

Description

fine

5 to 9: Low image quality

normalsuperfine: Same image quality as 0

lowfine: Same image quality as 1
normal: Same image quality as 5
low: Same image quality as 9

H.264(1) stream/cgi-bin/set_h264

h264_transmit

00: OFF

Do not transmit

1

1: ON

Transmit

h264_rtsp_mod0

Internet mode settingse1

0: OFFsettings

1: ON
h264_resolution

f_priority

nr_framerate

1280

1280：1280x720

1920

1920：1920x1080

0

0: Fixed bit rate

1

1: Frame rate priority

2

2: Best effort transmission

3

3: AVBR

4

4: VBR

When the system

JPEG refresh interval

frequency is 60 Hz
60When the systemfrequency is 50 Hz
50avbr_bandwidth0

Maximum bit rate (during burst)

_max

1

0: High2

1: Medium2: Low

avbr_control_cy

1 to 168

AVBR control cycle (hour)

h264_bandwidt

256Transmission volume per client (kbps)

h

384

cle

512
768
1024
1536
2048
3072
4096
6144
8192
10240
12288
14336

Network-based CGI Specifications

33

CGI item nameParameter

URL

Parameter value

name

Description

16384
20480
24576

h264_bandwidt

256Transmission volume per client

h_min

384

(minimum) (kbps)

512
768
1024
1536
2048
3072
4096
6144
8192
10240
12288
14336
16384
20480
24576
h264_quality

h264_Ivop

fine

fine: Image quality priority

normalnormal: normal standard

low

low: Motion priority

0.2

Refresh cycle

0.25

0.2 (sec)

0.33

0.25 (sec) (can be set only when the

0.5

system frequency is 60 Hz)

10.33 (sec) (can be set only when the2system frequency is 60 Hz)

3

0.5 (sec)

4

1 (sec)52 (sec)3 (sec)4 (sec)5 (sec)h264_unimulti

uni

uni：unicast(auto)

multi

multi：multicast

uni_manual

uni_manual：unicast(manual)

unicast_port

1024 to 50000

Port number: 1024 to 50000

unicast_audio_p1024 to 50000

Port number: 1024 to 50000

multicast_addr1

224 to 239

224.0.0.0 - 239.255.255.255

multicast_addr2

0 to 255

224.0.0.0 - 239.255.255.255

ort

Network-based CGI Specifications

34

CGI item nameParameter

URL

Parameter value

name

Description

multicast_addr3

0 to 255*.*.*.* format

multicast_addr4

0 to 255*:*:*:*:*:*:*:* format

multicast_addr*.*.*.* format*:*:*:*:*:*:*:* format

multicast_port

1024 to 50000

1024 to 50000

multicast_ttl

1 to 254

1 to 254

nr_h264_bandw

256

Transmission volume per client (kbps)

idth

384

(transmission is not stopped)

512
768
1024
1536
2048
3072
4096
6144
8192
10240
12288
14336
16384
20480
24576
nr_h264_resolut

1280

Live screen resolution

ion

1920

(transmission is not stopped)
1280：1280x960
1920：1920x1440

nr_h264_quality

multicast_auto

fine

fine: Image quality priority

normalnormal: normal standard

low

low: Motion priority

0

Multicast AutoStart settings

1
H.264(2) stream/cgi-bin/set_h264_2

h264_transmit

settings0

H.264 transmission 2

1

0: OFF

Do not transmit

1: ON

Transmit

h264_rtsp_mod0

Internet mode setting 2e1

0: ON - CGI
1: ON - RTSP

h264_resolution

160

Live screen resolution 2

320

160：160x90

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

Network-based CGI Specifications

35

CGI item nameParameter

URL

Parameter value

namef_priority

Description

0

Live screen Transmission mode 2

1

0: Fixed bit rate2

1: Frame rate priority

3

2: Best effort transmission

4

3: AVBR
4: VBR

nr_framerate

When the system

Live screen Frame rate 2

frequency is 60 Hz

3, 7.5, 12, 15, 20, and 30

1

can be set only when the system3

frequency is 60 Hz

5

12.5 and 25 can be set only when the

7.5

system frequency is 50 Hz

10
12
15
20
30
When the systemfrequency is 50Hz
1
5
10
12.5
25
avbr_bandwidth

1 to 168

AVBR control cycle 2 (hour)

h264_bandwidt

64

H.264 Transmission volume per client 2h128(kbps)

_max

256
384
512
768
1024
1536
2048
3072
4096
6144
8192
10240
12288

Network-based CGI Specifications

36

CGI item nameParameter

URL

name

Parameter value

Description

14336

h264_bandwidt

64

H.264 Transmission volume per client 2

h_min

128

(minimum) (kbps)

256
384
512
768
1024
1536
2048
3072
4096
6144
8192
10240
12288
14336
h264_quality

h264_Ivop

0 to 9Live screen Image quality 2

fine

fine: Image quality priority

normalnormal: normal standard

low

low: Motion priority

When the system

Refresh cycle 2 (sec)frequency is 60 Hz
0.2
0.33
0.5
1 to 5
When the systemfrequency is 50 Hz
0.2
0.25
0.5
1 to 5h264_unimultiuniTransfer setting 2

multi

uni：unicast(auto)

uni_manual

multi：multicast
uni_manual：unicast(manual)

unicast_port

1024 to 50000

Video transmission destination port
number 2

unicast_audio_p1024 to 50000

ort
multicast_addr1

Network-based CGI Specifications

Audio transmission destination port
number 2

224 to 239

Multicast address 2

37

CGI item nameParameter

URL

Parameter value

namemulticast_addr2

0 to 255

multicast_addr3

0 to 255

multicast_addr4

0 to 255

multicast_addr*.*.*.* format

Description
224.0.0.0 to 239.255.255.255

Multicast address 2*:*:*:*:*:*:*:* format
multicast_port

1024 to 50000

Multicast port number 2

multicast_ttl

1 to 254

Multicast TTL/HOPLimit value 2

nr_h264_bandw

64

Transmission volume per client (kbps)

idth

128

(transmission is not stopped)

256
384
512
768
1024
1536
2048
3072
4096
6144
8192
10240
12288
14336
multicast_auto0Multicast AutoStart settings

1
H.264(3) stream/cgi-bin/set_h264_3

Same as H.264(2) stream settings.

settings
H.264(4) stream/cgi-bin/set_h264_4

settings
RTSP settings/cgi-bin/set_rtsp

rtsp_port

1 to 65535

RTSP port number

h264_rtsp_mod0

Internet mode settings of H.264(1)e10: OFF

Do not transmit

1: ON

Transmit

h264_rtsp_mod0

Internet mode settings of H.264(2)e210: OFF

Do not transmit

1: ON

Transmit

h264_rtsp_mod0

Internet mode settings of H.264(3)e310: OFF

Do not transmit

1: ON

Transmit

h264_rtsp_mod0

Internet mode settings of H.264(4)e410: OFF

Do not transmit

1: ON

Transmit

h264_rtsp_req_uri1

StringH.264(1) RTSP URI
String(within 255 single-byte alphanumericcharacters andNetwork-based CGI Specifications

/

-

)

38

CGI item name

URL

Parameternameh264_rtsp_req

Parameter value

String_uri2

Description

H.264(2) RTSP URI
String(within 255 single-byte alphanumericcharacters and

h264_rtsp_req

String

_uri3

/

-

)

H.264(3) RTSP URI
String(within 255 single-byte alphanumericcharacters and

h264_rtsp_req_uri4

String/-)H.264(4) RTSP URI
String(within 255 single-byte alphanumericcharacters andNetwork-based CGI Specifications

/

-

)

39

CGI item name

URL

Live screen initial/cgi-bin/set_livestart

Parameter

Parameter value

namestreamstream selection

h264

Description
Live screen initial stream selection

h264_2
h264_3h264_4
jpeg
jpeg_2
jpeg_3
jpeg_interval

1

JPEG image refresh interval

2

1: 1 fps3

2: 2 fps

5

3: 3 fps (only when the system frequency

6

is 60 Hz)10

5: 5 fps

12.5

6: 6 fps (only when the system frequency

15

is 60 Hz)25

10: 10 fps

30

12.5: 12.5 fps (only when the systemfrequency is 50 Hz)
15: 15 fps (only when the systemfrequency is 60 Hz)
25: 25 fps (only when the systemfrequency is 50 Hz)
30: 30 fps (only when the systemfrequency is 60 Hz)

jpeg_quality

1

JPEG image quality selection

2

1: Image quality 1
2: Image quality 2

H.264 I frame/cgi-bin/h264_I_interinsertion intervalvalinterval

0.2

The following values can be set only

0.25

when the system frequency is 60 Hz.

0.33

0.25

0.5

0.33

1
2
3
4
5
streamMovie/cgi-bin/set_stream

h264_mode

1

1: Stream 1

2

2: Stream 2

3

3: Stream 3

4

4: Stream 4

1

Movie transmission format

transmission
method settings

1: H.264
h264_profile

0

Profile type specification1

0: High profile
1: Baseline profile

Network-based CGI Specifications

40

CGI item name

URL

Live screen/cgi-bin/set_pswbuff

smooth displayer

Parameter

Parameter value

name
disp

Description

0

Live screen smooth display selection

1

0: Real time consideration (Off)with plug-in

1: Smooth display (On)software(buffering)
Preset position/cgi-bin/camposiset

presetset

1 to 256

Preset position registration

presetdel

1 to 256

Preset position deletion

Usage example) Change the resolution of H.264(4) to 320 x 180.
http://192.168.0.10/cgi-bin/set_h264_4?h264_resolution=320
Usage example) Change the RTSP waiting port at the remote camera side from 554 (factory settings)
to 555.
http://192.168.0.10/cgi-bin/set_rtsp?&rtsp_port=555* The h264_rtsp_mode of set_rtsp is a mirror of the WEB menu. RTSP/RTP does not change to TCP even if
turned ON.

Network-based CGI Specifications

41

5.4. Audio Settings
MethodAccess level
CGI item name
Audio settings: POST: AdminURL/cgi-bin/set_audio

Parameter

Parameter nameaudio
audio_encoder

Description

value
off

off: OFFin

in: ON

G726

Encoder settings

AAC_HIGH

G726: G.726
AAC_HIGH: AAC-LC(High quality)

audio_sens

low

low: Mic Low

middlemiddle: Mic Middle

highhigh: Mic High

line_low

line_low: Line Low

line_middle

line_middle: Line Middle

line_highline_high: Line High
(Note) Not supported by the AW-HR140.

audio_bitrateaudio_interval

16

16: 16 kbps(G.726)

32

32: 32kbps(G.726)

64

64: 64 kbps(AAC-LC(High quality)96

96: 96 kbps(AAC-LC(High quality)

128

128: 128 kbps(AAC-LC(High quality)

20

Audio transmission interval

40
80
160
multicast_addr*.*.*.* format

Audio multicast address*:*:*:*:*:*:*:*
formatplugin_power

0

0：Off

1

1：On
(Note) Not supported by the AW-HR140.

Audio LR output/cgi-bin/set_audio_lr

switchingmode

0

Audio LR switching

1

0：L
1：R

Usage example) Turn ON the Audio input signal from the device connected to the AUDIO IN terminal.
http://192.168.0.10/cgi-bin/set_audio?audio=in

Network-based CGI Specifications

42

5.5. Multi-screen Settings
MethodAccess level: POST: AdminParameter

Parameter

name

value

CGI item name

URL

Description

Multi-screen settings/cgi-bin/multi_scree

multi_addr1"*.*.*.*" format or"*.*.*.*" format ornmulti_addr2"*.*.*.*: 1 to"*.*.*.*: 1 to 65535" ormulti_addr365535" or"String" ormulti_addr4"String" or"String": 1 to 65535"

multi_addr5"String": 1 tomulti_addr665535"

multi_addr7
multi_addr8
multi_addr9
multi_addr10
multi_addr11
multi_addr12
multi_addr13
multi_addr14
multi_addr15
multi_addr16
multi_name1

String (within 20

multi_name2

double-byte

multi_name3

characters)

Name of the camera

multi_name4
multi_name5
multi_name6
multi_name7
multi_name8
multi_name9
multi_name10
multi_name11
multi_name12
multi_name13
multi_name14
multi_name15
multi_name16

Usage example) Set 192.168.0.100/he130 in the first frame.
http://192.168.0.10/cgi-bin/multi_screen?multi_addr1=192.168.0.100&multi_name1=he130

Network-based CGI Specifications

43

5.6. Priority Stream Settings
MethodAccess level: POST: Admin

CGI item name

URL

Priority stream settings/cgi-bin/set_priority

Parameter

Parameter

name

value

priority

ip_addrDescription00: Priority Stream OFF

1

1: Priority Stream ON*:*:*:*:*:*:**:*:*:*:*:*:* format

formatip4_addr1

0 to 255

Transmission destination IP address(IPv4)First octet

ip4_addr2

0 to 255

Transmission destination IP address(IPv4)
Second octet

ip4_addr3

0 to 255

Transmission destination IP address(IPv4)
Third octet

ip4_addr4

0 to 255

Transmission destination IP address(IPv4)
Fourth octet

ip_addr_2"*.*.*.*" format or"*.*.*.*" format or"*:*:*:*:*:*:*""*:*:*:*:*:*:*" format

formatip4_addr1_2

0 to 255

Transmission destination IP address 2(IPv4)First octet

ip4_addr2_2

0 to 255

Transmission destination IP address 2(IPv4)
Second octet

ip4_addr3_2

0 to 255

Transmission destination IP address 2(IPv4)
Third octet

ip4_addr4_2

0 to 255

Transmission destination IP address 2(IPv4)
Fourth octet

kind

jpeg

Stream type

jpeg2

jpeg：JPEG(1)jpeg3

jpeg2：JPEG(2)stream_1

jpeg3：JPEG(3)stream_2

stream_1：H.264(1)stream_3

stream_2：H.264(2)stream_4

stream_3：H.264(3)stream_4：H.264(4)Network-based CGI Specifications

44

CGI item name

URL

Parameter

Parameter

name

value

jpeg_interval

Description

When theImage refresh interval (ips)system3, 6, 15, and 30 can be set only when thefrequency is 60

system frequency is 60 Hz

Hz

12.5 and 25 can be set only when the1system frequency is 50 Hz

2
3
5
6
10
15
30
When thesystemfrequency is
50Hz
1
2
5
10
12.5
25

Usage example) The transmission of H.264(1) to 192.168.0.99 is implemented on priority.
http://192.168.0.10/cgi-bin/set_priority? priority=1&ip_addr=192.168.0.99&ip_addr_2=&kind=stream_1

Network-based CGI Specifications45

5.7. Network Settings
MethodAccess level: POST: Admin

CGI item name
Network settings

URL/cgi-bin/network (*)

Parameter

Parameter

name

value

dhcp

Description

0

0: Static1

1: DHCP2

2: Auto (Auto IP)

3

3: Auto (Advanced)

IP_addr1

0 to 255

IP address First octet

IP_addr2

0 to 255

IP address Second octet

IP_addr3

0 to 255

IP address Third octet

IP_addr4

0 to 255

IP address Fourth octet

netmask1

0 to 255

Subnet mask First octet

netmask2

0 to 255

Subnet mask Second octet

netmask3

0 to 255

Subnet mask Third octet

netmask4

0 to 255

Subnet mask Fourth octet

gateway1

0 to 255

Default gateway First octet

gateway2

0 to 255

Default gateway Second octet

gateway3

0 to 255

Default gateway Third octet

gateway4

0 to 255

Default gateway Fourth octet

port

1 to 65535

1 to 65535

dns

manualmanual: Manual setting

auto

auto: Auto setting

pri_server1

0 to 255

Primary server address (DNS) First octet

pri_server2

0 to 255

Primary server address (DNS) Second
octet

pri_server3

0 to 255

Primary server address (DNS) Third octet

pri_server4

0 to 255

Primary server address (DNS) Fourth
octet

sec_server1

0 to 255

Secondary server address (DNS) Firstoctet

sec_server2

0 to 255

Secondary server address (DNS) Second
octet

sec_server3

0 to 255

Secondary server address (DNS) Thirdoctet

sec_server4

0 to 255

Secondary server address (DNS) Fourth
octet

speed

1

Communication speed settings

2

1: Auto3

2: 100 Mbps (full-duplex)

4

3: 100 Mbps (half-duplex)

5

4: 10 Mbps (full-duplex)
5: 10 Mbps (half-duplex)

Network-based CGI Specifications

46

CGI item name

URL

Parameter

Parameter

name

value

ip6_auto

Description

0

IPv6 address manual setting

1

1：off
0：on

ip6_addr*:*:*:*:*:*:*:*IP addressformatsub_prefix

0 to 128

Subnet prefix length

ip6_gateway*:*:*:*:*:*:*:*

Default gateway

formatpri_server*:*:*:*:*:*:*:*

Primary server (shared between IPv4 andformatIPv6)*.*.*.* format
sec_server*:*:*:*:*:*:*:*

Secondary server (shared between IPv4

formatand IPv6)*.*.*.* format
ip6_pri_server*:*:*:*:*:*:*:*

Primary server (IPv6 only)

formatip6_sec_server*:*:*:*:*:*:*:*

Secondary server (IPv6 only)

formatip6_dhcp0

0: DHCPv6 OFF

1

1: DHCPv6 ON

rtp_packet_ma

1500

RTP packet max. transmission size

x

1280

1500: Unlimited (1500 byte)
1280: Limited (1280 byte)

mss

1460

Max. segment size of TCP (MSS)

1280

1460: Unlimited (1460 byte)

1024

1280: Limited (1280 byte)
1024: Limited (1024 byte)

time

20

Effective limit

unlimited

20: 20 minutes
unlimited: Unlimited

Network-based CGI Specifications

47

CGI item name

URL

Parameter

Parameter

name

value

bandwidth

Description

0

Transmission volume of entire

64

network

128

0: Unlimited

256

64：64kbps

384

128：128kbps

512

256：256kbps

768

384：384kbps

1024

512：512kbps

2048

768：768kbps

4096

1024：1024kbps

8192

2048：2048kbps
4096：4096kbps
8192：8192kbps

ftpserver

FTP server settings/cgi-bin/set_serv

ftpserverer

Easy IP Setup/cgi-bin/easyipset

protocol settings

time

0

0: FTP server OFF

1

1: FTP server ON

0

0: FTP server OFF

1

1: FTP server ON

unlimited

Time period during which Easy IP

20

Setup can be performed from thetime power is turned ON
unlimited: Unlimited
20: 20 minutes* If you send this command from a browser such as Internet Explorer, the remote camera (encoder)will return an error (400 Bad request). (Operation is not performed normally.)
This operation has been specified for strengthening the security.
If you use this command from other than a browser such as the Internet Explorer (for example, a uniqueapplication), operation will be performed without any problem.

Network-based CGI Specifications48

5.8. UPnP Settings
MethodAccess level: POST: Admin

CGI item nameUPnP settings

URL/cgi-bin/upnp

Parameter

Parameter

name

value

upnp_portmap

Description

0

Auto port-forwarding

1

0: Disabled
1: Enabled

upnp_icon

0

Shortcut to camera

1

0: Disabled
1 : Enabled

Usage example) Set UPnP to ON
http://192.168.0.10/cgi-bin/upnp?upnp_portmap=1

5.9. SNMP Settings
MethodAccess level
CGI item name
SNMP settings: POST: AdminURL/cgi-bin/set_snmp

Parameter

Parameter

name

value

snmp_verDescription

v1_v2

SNMP versionv3

v1_v2: SNMPv2/v2

v1_v2_v3

v3: SNMPv3
v1_v2_v3: SNMPv1/v2/v3

community

StringCommunity name (For SNMPv1/v2)
String(within 32 single-byte alphanumericcharacters)

auth_methodmd5

Authentication method

sha-1(For SNMPv3)

encryption

desEncryption method

aes(For SNMPv3)

StringDevice namesysnameString(within 32 single-byte alphanumericcharacters)
syslocation

StringPhysical location of device
String(within 32 single-byte alphanumericcharacters)

Network-based CGI Specifications49

syscontact

StringContact
String(within 256 single-byte alphanumericcharacters)

Usage example) Set community name to "TEST" and device name to "TEST1".
http://192.168.0.10/cgi-bin/set_snmp?community=TEST&sysname=TEST1

Network-based CGI Specifications50

5.10. Diffserv Settings
MethodAccess level: POST: Admin

CGI item name
Diffserv settings

URL/cgi-bin/set_diffserv

Parameter

Parameter

name

value

dscp

0 to 63e

Description"DSCP"(differentiated services code point)
0: Default
10: Class 1 - Drop precedence low
12: Class 1 - Drop precedence medium
14: Class 1 - Drop precedence high
18: Class 2 - Drop precedence low
20: Class 2 - Drop precedence medium
22: Class 2 - Drop precedence high
26: Class 3 - Drop precedence low
28: Class 3 - Drop precedence medium
30: Class 3 - Drop precedence high
34: Class 4 - Drop precedence low
36: Class 4 - Drop precedence medium
38: Class 4 - Drop precedence highUsage example) Set DSCP to Class 1 - Drop precedence highhttp://192.168.0.10/cgi-bin/set_diffserve?dscp=14

Network-based CGI Specifications51

5.11. Data Upload
MethodAccess level: POST: Admin

CGI item name

URL

Data upload/cgi-bin/data_upload (*)

Parameter

Parameter

name

value

kind

datascorp

Description

setupdata

setupdata: Setting value fileawcamdataawcamdata: Camera setting file0

Setting value reflection range

1

0: No change in network settings
1: Change in network settings

res_data

normalResponse body format during normal

simpleresponse
normal: HTML format
simple: Text format/cgi-bin/dataupl--

Same operation as that forkind = awcamdata, res_mode = normalof /cgi-bin/data_upload* If you send this command from a browser such as Internet Explorer, the remote camera (encoder) will
return an error (400 Bad request). (Operation is not performed normally.)
This operation has been specified for strengthening the security.
If you use this command from other than a browser such as the Internet Explorer (for example, a uniqueapplication), operation will be performed without any problem.

5.12. Initialization/Restart
MethodAccess level: POST: Admin

CGI item name
InitializationURL/cgi-bin/initial (*)

Parameter

Parameter

name

value

cmd

Description

data

data: Setting data initialization

html

html: HTML initialization

all

all: Setting data/HTML initialization

reset

reset: Camera restart* If you send this command from a browser such as Internet Explorer, the remote camera (encoder) will
return an error (400 Bad request). (Operation is not performed normally.)
This operation has been specified for strengthening the security.
If you use this command from other than a browser such as the Internet Explorer (for example, a uniqueapplication), operation will be performed without any problem.

Network-based CGI Specifications52

5.13. User Authentication Settings
MethodAccess level: POST: Admin

CGI item name

URL

User authentication/cgi-bin/reg_user (*)

Parameter

Parameter

name

value

user

settings

Description

0

User authentication

1

0: User authentication OFF
1: User authentication ON

auth_method0User authentication method

1

0：Digest or Basic

2

1：Digest
2：Basic

nameStringUser name
String within 32 single-byte alphanumericcharacterspassword

StringPassword
String within 32 single-byte alphanumericcharacters

repassword

StringPassword reconfirmation
String within 32 single-byte alphanumericcharacters

access_level

1

Access level2

1：admin3

2：control
3：liveUser deletion/cgi-bin/del_user (*)

name

StringUser name* If you send this command from a browser such as Internet Explorer, the remote camera (encoder) will
return an error (400 Bad request). (Operation is not performed normally.)
This operation has been specified for strengthening the security.
If you use this command from other than a browser such as the Internet Explorer (for example, a uniqueapplication), operation will be performed without any problem.

Network-based CGI Specifications53

5.14. Host Authentication Settings
MethodAccess level
CGI item nameHost authentication: POST: AdminURL/cgi-bin/reg_host (*)

Parameter

Parameter

name

value

host

settings

Description0

Host authentication

1

0: Host authentication OFF
1: Host authentication ON

host_addr*.*.*.* format

Host authentication IP address*.*.*.*/mask*.*.*.* format

length format*.*.*.*/mask length format(within 128 single-byte alphanumericcharacters)

access_level

1

Access level2

1：admin3

2：control
3：liveHost deletion/cgi-bin/del_host (*)

host_addr*.*.*.* format

Host authentication IP deletion*.*.*.*/mask
length format* If you send this command from a browser such as Internet Explorer, the remote camera (encoder) will
return an error (400 Bad request). (Operation is not performed normally.)
This operation has been specified for strengthening the security.
If you use this command from other than a browser such as the Internet Explorer (for example, a uniqueapplication), operation will be performed without any problem.

Network-based CGI Specifications54

6. CGI List for Acquisition of Different Types of Information
6.1. Basic Settings Information Acquisition
MethodAccess level
CGI item name
Setting value: GET: AdminParameter

URL/cgi-bin/getdata

acquisition CGIParameter value

name
req

-

-

Description
Specify the item name of the setting
value to be acquired.

img_mode

Imaging mode

imgratio

Image ratio

img_fpsFrame rate

livestream

Live screen initial stream selection

liveint

liveint: JPEG(1) refresh interval

livequalbase

livequalbase: JPEG(1) default image
quality

livebasequal

livebasequal: JPEG default image quality

Livesize

livesize: JPEG(1) image resolution

Livequal

livequal: JPEG(1) image quality

liveframerate

Live screen initial frame rate (JPEG)

livejpeg

Resolution of JPEG(1)livejpeg2

Resolution of JPEG(2)livejpeg3

Resolution of JPEG(3)livequal1280

JPEG(1) image quality (1)livequal1280_2

JPEG(1) image quality (2)livequal640

JPEG(2) image quality (1)livequal640_2

JPEG(2) image quality (2)livequal320

JPEG(3) image quality (1)livequal320_2

JPEG(3) image quality (2)livequalbase

JPEG default image quality

livestream

Live screen initial stream selection

liveframerate

Live screen initial frame rate (JPEG)

h264

H.264(1) transmission ON/OFF

h264rtspmodeInternet mode (H.264 transmission 1)
ON/OFFh264bwc

Bit rate per client

nrh264bwc

Bit rate per client at which transmission
does not stop

h264bwcmin

H.264(1) Bit rate per client (minimum)

h264rtspmode_2

h264rtspmode_2: Internet mode (H.264
transmission 2) ON/OFF

h264rtspmode_3

h264rtspmode_3: Internet mode (H.264
transmission 3) ON/OFF

h264rtspmode_4

Network-based CGI Specifications

h264rtspmode_4: Internet mode (H.264

55

CGI item name

URL

Parameter
name

Parameter value

Description
transmission 4) ON/OFF

rtspport

rtspport: RTSP server port number

h264size

h.264size: h.264 resolution

h264qual

h.264qual: h.264 image quality

h264rint

h.264rint: Refresh cycle (I frame cycle)

h264mtd

h.264mtd: h.264 transmission method

h264mladd1

h.264mladd1: h.264 multicast addressFirst octet

h264mladd2

h.264mladd2: h.264 multicast address
Second octet

h264mladd3

h.264mladd3: h.264 multicast address
Third octet

h264mladd4

h.264mladd4: h.264 multicast address
Fourth octet

h264mlporth.264mlport: h.264 multicast
transmission destination port number

h264mlttl

h.264mlttl: h.264 multicast TTL

h264uniporth.264uniport: Unicast (for video) port
numberh264uniport2

h.264uniport2: Unicast (for audio) port
numberh264profile

H.264 profile

h264codind

H.264 encoding system

h264_2h.264_2: h.264 transmission ON/OFF 2

h264bwc_2

h.264bwc_2: Bit rate per client 2

h264size_2

h.264size_2: h.264 resolution 2

h264qual_2

h.264qual_2: h.264 image quality 2

h264rint_2

h.264rint_2: Refresh cycle (I frame cycle)2

h264mtd_2

h.264mtd: h.264 transmission method 2

h264mladd1_2

h.264mladd1_2: h.264 multicast addressFirst octet 2

h264mladd2_2

h.264mladd2_2: h.264 multicast address
Second octet 2

h264mladd3_2

h264mladd3_2: h264 multicast address
Third octet 2

h264mladd4_2

h264mladd4_2: h264 multicast address
Fourth octet 2

h264mlport_2

h264mlport_2: h264 multicast
transmission destination port number 2

h264mlttl_2

h264mlttl_2: h264 multicast TTL2

h.264uniport_2

h.264uniport_2: Unicast (for video) port
number 2

h264uniport2_2

Network-based CGI Specifications

h.264uniport2_2: Unicast (for audio) port

56

CGI item name

URL

Parameter
name

Parameter value

Description
number 2

h264profile_2

H.264 profile 2

h264codind_2

H.264 encoding system 2

h264_3h.264_3: h.264 transmission ON/OFF 3

h264bwc_3

h.264bwc_3: Bit rate per client 3

h264size_3

h.264size_3: h.264 resolution 3

h264qual_3

h.264qual_3: h.264 image quality 3

h264rint_3

h.264rint_3: Refresh cycle (I frame cycle)
3

h264mtd_3

h.264mtd_3: h.264 transmission method3h264mladd1_3

h.264mladd1_3: h.264 multicast addressFirst octet 3

h264mladd2_3

h.264mladd2_3: h.264 multicast address
Second octet 3

h264mladd3_3

h264mladd3_3: h.264 multicast address
Third octet 3

h264mladd4_3

h264mladd4_3: h.264 multicast address
Fourth octet 3

h264mlport_3

h264mlport_3: h.264 multicast
transmission destination port number 3

h264mlttl_3

h264mlttl_3: h.264 multicast TTL3

h.264uniport_3

h.264uniport_3: Unicast (for video) port
number 3

h264uniport2_3

h.264uniport2_3: Unicast (for audio) port
number 3

h264profile_3

H.264 profile 3

h264codind_3

H.264 encoding system 3

h264_4h.264_4: h.264 transmission ON/OFF 4

h264bwc_4

h.264bwc_4: Bit rate per client 4

h264size_4

h.264size_4: h.264 resolution 4

h264qual_4

h.264qual_4: h.264 image quality 4

h264rint_4

h.264rint_4: Refresh cycle (I frame cycle)
4

h264mtd_4

h.264mtd_4: h.264 transmission method4h264mladd1_4

h.264mladd1_4: h.264 multicast addressFirst octet 4

h264mladd2_4

h.264mladd2_4: h.264 multicast address
Second octet 4

h264mladd3_4

h264mladd3_4: h.264 multicast address
Third octet 4

h264mladd4_4

h264mladd4_4: h264 multicast address
Fourth octet 4

Network-based CGI Specifications

57

CGI item name

URL

Parameter
name

Parameter value
h264mlport_4

Description
h264mlport_4: h.264 multicast
transmission destination port number 4

h264mlttl_4

h264mlttl_4: h.264 multicast TTL4

h.264uniport_4

h.264uniport_4: Unicast (for video) port
number 4

h264uniport2_4

h.264uniport2_4: Unicast (for audio) port
number 4

h264profile_4

H.264 profile 4

h264codind_4

H.264 encoding system 4

h264mlauto

H.264(1) multicast auto start

h264mlauto_2

H.264(2) multicast auto start

h264mlauto_3

H.264(3) multicast auto start

h264mlauto_4

H.264(4) multicast auto startaudio_level

audio_level: Audio authorization andauthentication level setting

audio_sensaudio_sens: Sound collection sensitivity

g726.audio

g726.audio: G.726 audio setting

g726.bitrate

g726.bitrate: G.726 bit rate

g726.interval

g726.interval: G.726 audio transmissioninterval

g726.multicast

g726.multicast: G.726 audio multicast
address

nrlivequal

nrlivequal: JPEG image quality at whichtransmission does not stop

nrh264size

nrh264size: H.264 resolution at whichtransmission does not stop

nrh264qual

nrh264qual: H.264 image quality at whichtransmission does not stop

nrh264bwc

nrh264bwc: Bit rate per client at whichtransmission does not stop

nrh264bwc_2

nrh264bwc_2: Bit rate per client 2 atwhich transmission does not stop

nrh264size_2

nrh264size_2: H.264 resolution 2 atwhich transmission does not stop

nrh264qual_2

nrh264qual_2: H.264 image quality 2 atwhich transmission does not stop

nrh264bwc_3

nrh264bwc_3: Bit rate per client 3 atwhich transmission does not stop

nrh264size_3

nrh264size_3: H.264 resolution 3 atwhich transmission does not stop

nrh264qual_3

nrh264qual_3: H.264 image quality 3 atwhich transmission does not stop

nrh264bwc_4

nrh264bwc_4: Bit rate per client 4 at
which transmission does not stop

Network-based CGI Specifications

58

CGI item name

URL

Parameter

Parameter value

namenrh264size_4

Description
nrh264size_4: H.264 resolution 4 at
which transmission does not stop

nrh264qual_4

nrh264qual42: H.264 image quality 4 at
which transmission does not stop

h264fpriority

h264fpriority: H.264(1) transmission
mode

h264nrframerate

h264nrframerate: H.264(1) frame rate

h264fpriority_2

h264fpriority_2: H.264(2) transmission
mode

h264nrframerate_2

h264nrframerate_2: H.264(2) frame rate

h264fpriority_3

h264fpriority_3: H.264(3) transmission
mode

h264nrframerate_3

h264nrframerate_3: H.264(3) frame rate

h264fpriority_4

h264fpriority_4: H.264(4) transmission
mode

h264nrframerate_4

h264nrframerate_4: H.264(4) frame rate

h264bwcmin

H.264 Bit rate per client (minimum)

h264bwcmin_2

H.264(2) Bit rate per client (minimum)

h264bwcmin_3

H.264(3) Bit rate per client (minimum)

h264bwcmin_4

H.264(4) Bit rate per client (minimum)

h264avbrbwc

H.264(1) Maximum bit rate (during burst)

h264avbrbwc_2

H.264(2) Maximum bit rate (during burst)

h264avbrbwc_3

H.264(3) Maximum bit rate (during burst)

h264avbrbwc_4

H.264(4) Maximum bit rate (during burst)

h264avbrcyc

H.264(1) AVBR control period

h264avbrcyc_2

H.264(2) AVBR control period

h264avbrcyc_3

H.264(3) AVBR control period

h264avbrcyc_4

H.264(4) AVBR control period

plugin_halftone_jpeg

Enabling/disabling of half-tone function
for JPEG images in Active X

plugin_halftone_h26

Enabling/disabling of half-tone function

4for H.264 movies in Active X-

If there is no parameter specification,issue the list of setting data in a batch, as
the response.

Acquisition of session/cgi-bin/man_ses

information

sion

commandreleaserelease: Release of the specified UID

getget: Information response

release_all

release_all: Release of all UIDs

aw_getaw_get: Acquisition of the number ofexternal terminals in the remote camera

Network-based CGI Specifications

59

CGI item name

URL

Parameter
name

Parameter value

Description
to which update notification is to betransfereduid0~65535

User ID* Although parameters that have not been specified above may be included in the response, suchparameters are not supported.
For details, see "Acquiring the List of Setting Values".

Network-based CGI Specifications60

6.2. Preset position information Acquisition
MethodAccess level：GET：AdminCGI item name

URL

Preset position/cgi-bin/get_pr

information acquisition

eposi

Parameter
namecommandParameter value

list

Description

list: Acquisition of preset position
registration

The response data is as shown below.
PRESET_POSITION_REGISTRATION=String
HOME=0POSI1_ID=xxx
POSI2_ID=xxx
・・・
POSI100ID=xxx

Network-based CGI Specifications

61

6.3. Data Download
MethodAccess level
CGI item name
Data download: GET: AdminURL/cgi-bin/data_download/cgi-bin/datadownl

Parameter

Parameter

name

value

kind
-

Description

setupdata

setupdata: Setting value fileawcamdataawcamdata: Camera setting file-

Same operation as that forkind = awcamdata
of /cgi-bin/data_download* If you send this command from a browser such as Internet Explorer, the remote camera (encoder) will
return an error (400 Bad request). (Operation is not performed normally.)
This operation has been specified for strengthening the security.
If you use this command from other than a browser such as the Internet Explorer (for example, a uniqueapplication), operation will be performed without any problem.

Network-based CGI Specifications

62

6.4 Log Acquisition
MethodAccess level：GET：AdminCGI item name

URL

System log/cgi-bin/get_acceacquisition

sslog

System log
deletion/cgi-bin/del_acce

Parameter

Parameter

name

value

Description--

Acquisition of system log--

Deletion of system log

sslog

Network-based CGI Specifications63

7. CGI List for HTTPS Control
7.1. Setting Information and Acquiring Certification
MethodAccess level: GET: Admin

CGI item nameHTTPS self-signed

URL
https_self_signed

mode

https_signed

mode

certificate
HTTPS CA
certificate
HTTPS CRT key

https_crt_key

Parameter

Parameter namemode

get_info

get_info: Information checkdeletedelete: Deletion

get_info

get_info: Information checkdeletedelete: Deletion

refreshProcessing of CRT key

history usage
HTTPS connection

Description

value

refresh: Update
set_https

live

methodhttphttp: HTTP

https

https: HTTPS

https_port

1 to 65535

HTTPS port number

HTTPS self-signed

https_creat_self_sign

common_name

StringHost namecertificate generateedcountry

StringCountry namestate

StringPrefecture namelocality

String

Locality nameorganization

StringOrganization nameorganization_unit

StringDepartment namecommon_name

StringHost namecountry

StringCountry namestate

StringPrefecture namelocality

String

Locality nameorganization

StringOrganization nameorganization_unit

StringDepartment name

-

-

-

HTTPS CSR

https_creat_signed

generate

HTTPS CSR

/cgi-bin/https_downlo

download

ad_csrHTTPS CAhttps_install_signed

-

-

-

https_change_crt_key

rsa_length1024

1024：1024bit

2048

2048：2048bit

renewalcgi_name

self_create

self_create: Self-signed certificate

csr_create

creation status

ca_install

csr_create: CSR creation status

key_create

ca_install: CA certificate installation status

certificate install
HTTPS CRT key
generate
Status update

key_create: CRT key generation status

It is recommended to implement the HTTPS settings through GUI from the WEB menu.

Network-based CGI Specifications64

8. Acquiring the List of Setting Values
MethodAccess level: GET: LiveCGI item nameAcquisition of list ofURL/cgi-bin/setdata

Parameter

Parameter

name

value

Description
Parameters are not required.

setting values

The response data is as shown below.
CAMTITLE,"AW-HE130"
TIMEDATE,"2013,1,1,2,52,11"
TIMEFORMAT,"5"
TIMEDISP,"24"
TIMEZONE,"26"
STIME,"0"STIMES_MON,"1"
STIMES_WEEK,"1"
STIMES_DOTW,"0"STIMES_HOUR,"1"
STIMES_AMPM,"0"
STIMEE_MON,"1"
STIMEE_WEEK,"1"
STIMEE_DOTW,"0"STIMEE_HOUR,"1"
STIMEE_AMPM,"0"
UPSIDEDOWN,"0"
LED,"0"PLUGINDISP,"0"FRONTOPTION,"0"
BACKOPTION,"0"
IMAGEFPS,"60"
LIVESTREAM,"h264"
LIVEINT,"5"
LIVEQUALBASE,"1"
LIVESIZE,"1920"
LIVEQUAL,"5"
LIVEQUAL_2,"8"
LIVESIZE2,"640"
LIVEQUAL2,"5"
LIVEQUAL2_2,"8"
LIVESIZE3,"320"LIVEQUAL3,"5"
LIVEQUAL3_2,"8"
STREAMMODE,"1"
H264,"1"

Network-based CGI Specifications65

H264RTSPMODE,"0"
H264BWC,"4096"
NRH264BWC,"4096"
H264BWCMIN,"1024"
H264SIZE,"1280"
NRH264SIZE,"1280"
H264FPRIORITY,"1"
H264NRFRAMERATE,"60"
H264AVBRBWC,"2"
H264AVBRCYC,"24"
H264QUAL,"normal"
NRH264QUAL,"normal"
H264RINT,"1"
H264MTD,"uni"
H264MLADD1,"239"
H264MLADD2,"192"
H264MLADD3,"0"
H264MLADD4,"20"
H264MLADD,"239.192.0.20"
H264MLPORT,"37004"
H264MLTTL,"16"
H264UNIPORT,"32004"
H264UNIPORT2,"33004"
H264ENCTYPE,"0"
H264_2,"1"
H264RTSPMODE_2,"0"H264BWC_2,"1536"
NRH264BWC_2,"1536"
H264BWCMIN_2,"512"
H264SIZE_2,"1920"
NRH264SIZE_2,"1920"
H264FPRIORITY_2,"1"
H264NRFRAMERATE_2,"30"
H264AVBRBWC_2,"2"
H264AVBRCYC_2,"24"
H264QUAL_2,"normal"
NRH264QUAL_2,"normal"
H264RINT_2,"1"
H264MTD_2,"uni"
H264MLADD1_2,"239"
H264MLADD2_2,"192"
H264MLADD3_2,"0"
H264MLADD4_2,"21"
H264MLADD_2,"239.192.0.21"
H264MLPORT_2,"37004"
H264MLTTL_2,"16"
H264UNIPORT_2,"32014"
H264UNIPORT2_2,"33014"

Network-based CGI Specifications66

H264ENCTYPE_2,"0"
H264_3,"1"
H264RTSPMODE_3,"0"
H264BWC_3,"1024"
H264BWCMIN_3,"128"
H264SIZE_3,"320"
H264FPRIORITY_3,"1"
H264NRFRAMERATE_3,"30"
H264AVBRBWC_3,"2"
H264AVBRCYC_3,"24"
H264QUAL_3,"normal"
H264RINT_3,"1"
H264MTD_3,"uni"
H264MLADD1_3,"239"
H264MLADD2_3,"192"
H264MLADD3_3,"0"
H264MLADD4_3,"22"
H264MLADD_3,"239.192.0.22"
H264MLPORT_3,"37004"
H264MLTTL_3,"16"
H264UNIPORT_3,"32024"
H264UNIPORT2_3,"33024"
H264ENCTYPE_3,"0"
H264_4,"1"
H264RTSPMODE_4,"0"H264BWC_4,"512"
H264BWCMIN_4,"128"
H264SIZE_4,"160"
H264FPRIORITY_4,"1"
H264NRFRAMERATE_4,"30"
H264AVBRBWC_4,"2"
H264AVBRCYC_4,"24"
H264QUAL_4,"normal"
H264RINT_4,"1"
H264MTD_4,"uni"
H264MLADD1_4,"239"
H264MLADD2_4,"192"
H264MLADD3_4,"0"
H264MLADD4_4,"23"
H264MLADD_4,"239.192.0.23"
H264MLPORT_4,"37004"
H264MLTTL_4,"16"
H264UNIPORT_4,"32034"
H264UNIPORT2_4,"33034"
H264ENCTYPE_4,"0"
RTSPPORT,"554"
H264MLAUTO,"0"
H264MLAUTO_2,"0"Network-based CGI Specifications67H264MLAUTO_3,"0"
H264MLAUTO_4,"0"
AUDIO,"in"
AUDIOSENS,"line_high"
AUDIOENC,"3"
AUDIOBITRATE,"32"
AUDIOINT,"40"
AUDIOSTATUS,"off"
AUDIOAUTH,"all"
UAUTH,"1"
UAUTHMTD,"0"
UNAME,""admin",1,"Live",3,"Cam",2"
HAUTH,"0"HADD,""192.168.0.80",1"
PRIORITY,"1"
PRIP4ADDR1,""
PRIP4ADDR2,""
PRIP4ADDR3,""
PRIP4ADDR4,""
PRIP6ADDR,""
PRIP4ADDR1_2,""
PRIP4ADDR2_2,""
PRIP4ADDR3_2,""
PRIP4ADDR4_2,""
PRIP6ADDR_2,""
PRKIND,"jpeg"
PRJPEGINTERVAL,"10"
NW,"0"
EIP1,"192"
EIP2,"168"EIP3,"0"EIP4,"10"EMASK1,"255"
EMASK2,"255"
EMASK3,"255"
EMASK4,"0"
EDGW1,"192"
EDGW2,"168"EDGW3,"0"EDGW4,"1"
DNS,"manual"
PRISRV1,"0"
PRISRV2,"0"
PRISRV3,"0"
PRISRV4,"0"
SECSRV1,"0"
SECSRV2,"0"
SECSRV3,"0"Network-based CGI Specifications

68

SECSRV4,"0"
IP6_AUTO,"1"
IP6,"fe80::280:45ff:fe0d:222,,,,,,"
IP6_DGW,""
IP6_DHCP,"0"
PRISRV_V6,""SECSRV_V6,""HTTPPORT,"80"SPEED,"1"
RTPSIZE,"1500"
MSS,"1460"
BWC,"0"EASYIPSETUP,"unlimited"
FTPS,"0"TIMEADJUST,"1"
NTPSVR,"1"
NTPADD,"192.168.0.188"
NTPPORT,"123"
NTPINTERVAL,"1"
PORTFORWARD,"0"
CAM_SC,"0"DDNS,"0"DDHOST,""
DDINT,"1440"
SNMPCOM,"TEST"SNMPTITLE,"TEST1"
SNMPLOCATION,""
SNMPCONTACT,""
DSCP,"14"PLUGIN_HALFTONE_JPEG,"0"
PLUGIN_HALFTONE_H264,"0"
PTZENDLESS,"0"Network-based CGI Specifications

69

The description of the response data is as shown below.
Setting name

Value

Description

CAMTITLE

StringCamera name

TIMEDATE

StringEncoder unit name

TIMEFORMAT

1

Date and time display format

2

1：DD/MM/YYYY HH：MM：SS

3

2：MM/DD/YYYY HH：MM：SS

4

3：DD/Mmm/YYYY HH：MM：SS

5

4：YYYY/MM/DD HH：MM：SS
5：Mmm/DD/YYYY HH：MM：SS

TIMEDISP

12

Hour display format

24

12: 12-hour format
24: 24-hour format

TIMEZONE

Numeric value

Timezone
1 to 74STIME

0Summer time1

1:

Set the time according to the summer time0:

Cancel the summer time

STIMES_MON

1 to 12

Summer time auto setting (start month)

STIMES_WEEK

1 to 5

Summer time auto setting
Start date and time setting (week number)
1: First week, 2: Second week
3: Third week, 4: Fourth week
5: Last week

STIMES_DOTW

0 to 6

Summer time auto setting
Start date and time setting (day of the week)
0: Sunday, 1: Monday
2: Tuesday, 3: Wednesday
4: Thursday, 5: Friday
6: Saturday

STIMES_HOUR

1 to 12

Summer time auto setting
Start date and time setting (hour)
1 to 12

STIMES_AMPM

0Summer time auto setting

1

Start date and time setting (AM/PM)
0: AM (before noon)
1: PM (after noon)

STIMEE_MON

1 to 12

Summer time auto setting
End date and time setting (month)
1: January, 2: February, 3: March
4: April, 5: May, 6: June
7: July, 8: August, 9: September
10: October, 11: November, 12: December

STIMEE_WEEK

1 to 5

Summer time auto setting
End date and time setting (week number)
1: First week, 2: Second week
3: Third week, 4: Fourth week

Network-based CGI Specifications

70

Setting name

Value

Description
5: Last week

STIMEE_DOTW

0 to 6

Summer time auto setting
End date and time setting (day of the week)
0: Sunday, 1: Monday
2: Tuesday, 3: Wednesday
4: Thursday, 5: Friday
6: Saturday

STIMEE_HOUR

1 to 12

Summer time auto setting
Start date and time setting (hour)
1 to 12

STIMEE_AMPM

0Summer time auto setting

1

Start date and time setting (AM/PM)
0: AM (before noon)
1: PM (after noon)

UPSIDEDOWN

0

Upside down

1

0: OFF
1: ON

LED

0

Tally lamp

1

0: light off
1: light on

PLUGINDISP

0

Live screen smooth display with plug-in software

1(buffering)
0: Real time consideration (Off)
1: Smooth display (On)

IMAGESELECT

2m

Imaging mode2m: 2 M pixel

IMAGERATIO

16_9

Image ratio
16_9: 16:9 mode

IMAGEFPS

60

Frame rate
60: 60 fps

LIVESTREAM

h264

Live screen initial stream selection

h264_2

h264：H.264(1)h264_3h264_2：H.264(2)h264_4

h264_3：H.264(3)jpeg

h264_4：H.264(4)jpeg_2

jpeg：JPEG(1)jpeg_3

jpeg_2：JPEG(2)jpeg_3：JPEG(3)LIVEINT

1

JPEG(1) refresh interval

5

1：1fps15(12.5)

5：5fps30(25)

15(12.5)：15(12.5)fps
30(25)：30(25)fps* The values within () are for the case when the systemfrequency is 50 Hz

LIVEQUALBASE

1

JPEG(1) default image quality
1: Image quality 1

Network-based CGI Specifications

71

Setting nameLIVESIZE

Value

Description

320

JPEG(1) image resolution

640

320：320x180

1280

640：640x360

1920

1280：1280x720
1920：1920x1080

LIVESIZE2

320

JPEG(2) image resolution

640

320：320x180

1280

640：640x360
1280：1280x720

LIVESIZE3320

JPEG(3) image resolution

640

320：320x180

1280

640：640x360
1280：1280x720

LIVEQUAL

1

JPEG(1) image quality (1)5

1：Fine5：Normal

LIVEQUAL2

1

JPEG(2) image quality (1)5

1：Fine5：Normal

LIVEQUAL3

1

JPEG(3) image quality (1)5

1：Fine5：Normal

LIVEQUAL_2

1

JPEG(1) image quality (2)5

1：Fine5：Normal

LIVEQUAL2_2

1

JPEG(2) image quality (2)5

1：Fine5：Normal

LIVEQUAL3_2

1

JPEG(3) image quality (2)5

1：Fine5：Normal

STREAMMODE

1

Movie transmission method
1：H.264H264

0

H.264 transmission ON/OFF

H264_2

1

0：OFF
1：ON

H264_3
H264_4
H264RTSPMODE

0Internet mode ON/OFF

H264RTSPMODE_2

1

0：OFF
1：ON

H264RTSPMODE_3
H264RTSPMODE_4
H264BWC
H264BWC_2
H264BWC_3

512,768,1024,1536,

Bit rate per client

2048,3072,4096,6144,

512 (kbps)

8192,10240,12288,~

14336,16384,20480,

24576 (kbps)

24576,～

Network-based CGI Specifications

72

Setting name
H264BWC_4

Value
32768(*1),

Description
51200 (kbps)

40960(*1),
51200(*1)

Network-based CGI Specifications(*1): Only for AW-UE70

73

Setting name
H264BWCMIN
H264BWCMIN_2
H264BWCMIN_3
H264BWCMIN_4
NRH264BWC

Value

Description

512,768,1024,1536,

Minimum bit rate per client

2048,3072,4096,6144,

512 (kbps)

8192,10240,12288,~

14336,16384,20480,

24576 (kbps)

24576,~

32768(*1),

51200 (kbps)

40960(*1),
51200(*1)(*1): Only for AW-UE70

Numeric value

Bit rate per client at which transmission does not stop

NRH264BWC_2

Unit [kbps]

NRH264BWC_3* The value acquired by setdata depends on the minimum

NRH264BWC_4

bit rate per client.

H264SIZE

320

H.264(1) resolution

640

320：320x180

1280

640：640x360

1920

1280：1280x720

3840(*1)

1920：1920x1080(*1): Only for AW-UE70

H264SIZE_2

320

H.264(2) resolution

640

320：320x180

1280

640：640x360
1280：1280x720

H264SIZE_3

320

H.264(3) resolution

640

320：320x180

1280

640：640x360
1280：1280x720

H264SIZE_4

320

H.264(4) resolution

640

320：320x180

1280

640：640x360
1280：1280x720

NRH264SIZE

320

H.264(1) resolution at which transmission does not stop

640

320：320x180

1280

640：640x360

1920

1280：1280x720

3840(*1)

1920：1920x1080
3840：3840x2160(*1)(*1): Only for AW-UE70
The value acquired by setdata depends on the value of
H.264(1)

Network-based CGI Specifications

74

Setting name
NRH264SIZE_2

Value

Description320

H.264(2) resolution at which transmission does not stop

640

320：320x180

1280

640：640x360
1280：1280x720
The value acquired by setdata depends on the value of
H.264(2)

NRH264SIZE_3

320

H.264(3) resolution at which transmission does not stop

640

320：320x180

1280

640：640x360
1280：1280x720
The value acquired by setdata depends on the value of
H.264(3)

NRH264SIZE_4

320

H.264(4) resolution at which transmission does not stop

640

320：320x180

1280

640：640x360
1280：1280x720
The value acquired by setdata depends on the value of
H.264(4)H264FPRIORITY

0

Transmission mode

H264FPRIORITY_2

1

0：Constant bit rate

H264FPRIORITY_3

2

1：Frame rate
2：Best effort

H264FPRIORITY_4
H264NRFRAMERATE

5

H264(1) frame rate15(12.5)

5：5fps30(25)

15(12.5)：15(12.5)fps

60(50)

30(25)：30(25)fps
60(50)：60(50)fps* The values within () are for the case when the systemfrequency is 50 Hz

H264NRFRAMERATE_2

5

H264(2) frame rate15(12.5)

5：5fps30(25)

15(12.5)：15(12.5)fps
30(25)：30(25)fps* The values within () are for the case when the systemfrequency is 50 Hz

H264NRFRAMERATE_3

5

H264(3) frame rate15(12.5)

5：5fps30(25)

15(12.5)：15(12.5)fps
30(25)：30(25)fps* The values within () are for the case when the systemfrequency is 50 Hz

H264NRFRAMERATE_4

5

H.264(4) frame rate15(12.5)

5：5fps30(25)

15(12.5)：15(12.5)fps
30(25)：30(25)fps* The values within () are for the case when the systemfrequency is 50 Hz

Network-based CGI Specifications

75

Setting name

Value

Description

H264AVBRBWC

0H.264 Maximum bit rate (during burst)

H264AVBRBWC_2

1

0: Four times the target bit rate, or the upper-limit clip value

H264AVBRBWC_3

2(whichever is smaller)
1: Three times the target bit rate, or the upper-limit clip value

H264AVBRBWC_4(whichever is smaller)
2: Twice the target bit rate, or the upper-limit clip value(whichever is smaller)
H264AVBRCYC

1 to 168

H.264 AVBR control period

H264AVBRCYC_2

The period during which the total bit rate of a compressed

H264AVBRCYC_3

video stream is to be converged in AVBR.

H264AVBRCYC_4

1 hour to 168 hours (one week)

H264ENCTYPE

0

H.264 encoding system

H264ENCTYPE_2

1

0：CABAC
1：CAVLCH264ENCTYPE_3
H264ENCTYPE_4
H264QUAL

fine

H.264 image quality

H264QUAL_2

lowfine：Image quality priority
low：Motion priority

H264QUAL_3
H264QUAL_4
NRH264QUAL

normalH264 image quality at which transmission does not stop
normal: Standard

NRH264QUAL_2
NRH264QUAL_3
NRH264QUAL_4
H264RINT

1

Refresh cycle
1: 1 second

H264RINT_2
H264RINT_3
H264RINT_4
H264MTDuni

H.264 transmission method

H264MTD_2

uni_manual

uni：Unicast port(AUTO)

H264MTD_3

multi

uni_manual：Unicast port(MANUAL)
multi：Multicast

H264MTD_4
H264MLADD1

Numeric value

H.264(1) multicast address First octet
224 to 239

H264MLADD2

Numeric value

H.264(1) multicast address Second octet
0 to 255

H264MLADD3

Numeric value

H.264(1) multicast address Third octet
0 to 255

H264MLADD4

Numeric value

H.264(1) multicast address Fourth octet
0 to 255

H264MLADD1_2

Numeric value

H.264(2) multicast address First octet
224 to 239

H264MLADD2_2

Numeric value

H.264(2) multicast address Second octet
0 to 255

H264MLADD3_2

Numeric value

H.264(2) multicast address Third octet
0 to 255

Network-based CGI Specifications76

Setting name
H264MLADD4_2

Value
Numeric value

Description
H.264(2) multicast address Fourth octet
0 to 255

H264MLADD1_3

Numeric value

H264MLADD2_3

Numeric value

H.264(3) multicast address First octet
224 to 239
H.264(3) multicast address Second octet
0 to 255

H264MLADD3_3

Numeric value

H.264(3) multicast address Third octet
0 to 255

H264MLADD4_3

Numeric value

H264MLADD1_4

Numeric value

H.264(3) multicast address Fourth octet
0 to 255
H.264(4) multicast address First octet
224 to 239

H264MLADD2_4

Numeric value

H.264(4) multicast address Second octet
0 to 255

H264MLADD3_4

Numeric value

H264MLADD4_4

Numeric value

H.264(4) multicast address Third octet
0 to 255
H.264(4) multicast address Fourth octet
0 to 255

H264MLADD(IPv4 address)

H264MLADD_2

or

H264MLADD_3(IPv6 address)

H.264 multicast address

H264MLADD_4
H264MLPORT

Numeric value

H.264 multicast port
1024 to 50000

H264MLPORT_2
H264MLPORT_3
H264MLPORT_4
H264MLTTL

Numeric value

H.264 multicast TTL
1 to 254

H264MLTTL_2
H264MLTTL_3
H264MLTTL_4
H264UNIPORT

Numeric value

H.264 unicast (for video) port number
1024 to 50000 (only even numbers)

H264UNIPORT_2
H264UNIPORT_3
H264UNIPORT_4
H264UNIPORT2

Numeric value

H264UNIPORT2_2

H.264 unicast (for audio) port number
1024 to 50000 (only even numbers)

H264UNIPORT2_3
H264UNIPORT2_4

Network-based CGI Specifications

77Setting name
H264PROFILE

Value
0

Description
H.264 profile
0: High profile

H264PROFILE_2
H264PROFILE_3
H264PROFILE_4
RTSPPORT

Numeric value

RTSP server port number

H264MLAUTO

0

Multicast delivery is started automatically
0: OFF

H264MLAUTO_2
H264MLAUTO_3
H264MLAUTO_4
AUDIO

in

Audio settings

off

in：ON
off：OFFAUDIOSENS

lowSound collection sensitivity

middlelow: Mic Low

high

middle: Mic Middle

line_low

high: Mic High

line_middle

line_low: Line Low

line_highline_middle: Line Middle
line_high: Line HighAUDIOBITRATE

AUDIOENC

16

16: 16kbps(G.726)

32

32: 32kbps(G.726)

64

64：64kbps(AAC-LC(High quality))96：96kbps(AAC-LC(High96

quality))128

128：128kbps(AAC-LC(High quality))0

Audio encoder settings

3

0: G.726
3：AAC-LC(High quality)

AUDIOINT

20

Audio receiving interval (camera -> PC)

40

20: 20 millisecond

80

40: 40 millisecond

160

80: 80 millisecond
160: 160 millisecond

AUDIOSTATUS

on

Audio transmission status (PC -> camera)

off

on：ON
off：OFFAUDIOAUTH

level1

Audio permission level

level2

all: Allow all

all

level1: 1. Administrator only
level2: 2. Camera control and above

UAUTH

0

User authentication settings ON/OFF

1

1：ON
0：OFF

Network-based CGI Specifications

78

Setting name
UAUTHMTD

Value

Description

0

User authentication method

1

0：Digest or Basic

2

1：Digest
2：Basic

UNAME

StringUser authentication user name

HAUTH

0

Host authentication settings ON/OFF

1

1：ON
0：OFF

HADD

IP address

Host authentication IP address

IP address/mask
lengthString
PRIORITY

0Priority stream

1

0: Do not use
1: UsePRIP4ADDR1

Numeric value

Priority stream transmission destination IP address (IPv4)First to fourth octet

PRIP4ADDR2
PRIP4ADDR3
PRIP4ADDR4
PRIP4ADDR1_2

Numeric value

Priority stream transmission destination IP address 2 (IPv4)First to fourth octet

PRIP4ADDR2_2
PRIP4ADDR3_2
PRIP4ADDR4_2
PRIP6ADDR

IP address (IPv6)

Priority stream transmission destination IP address (IPv6)

jpeg

Priority stream typestream_1

jpeg：JPEG

stream_2

stream_1：H.264(1)PRIP6ADDR_2
PRKIND

stream_2：H.264(2)Network-based CGI Specifications

79

Setting name
PRJPEGINTERVAL

Value
When the system

Description
Priority stream JPEG frame rate (ips)frequency is 60 Hz
1
2
3
5
6
10
15
30
When the systemfrequency is 50 Hz
1
2
5
10
12.5
25
NW

EIP1

0

0: Static1

1: DHCP2

2: Auto (Auto IP)

3

3: Auto (Advanced)

Numeric value

IP addressFirst to fourth octet

EIP2
EIP3
EIP4
EMASK1

Numeric value

Subnet mask
First to fourth octet

EMASK2EMASK3EMASK4EDGW1

Numeric value

Default gateway
First to fourth octet

EDGW2
EDGW3
EDGW4
DNS

manualDNS

automanual：MANUAL
auto：AUTO

PRISRV1

Numeric value

PRISRV2

Primary server address (DNS)First to fourth octet

PRISRV3PRISRV4

Network-based CGI Specifications

80Setting name
SECSRV1

Value
Numeric value

Description
Secondary server address (DNS)First to fourth octet

SECSRV2SECSRV3
SECSRV4
IP6_AUTO

0

Manual setting (IPv6)

1

0: ON (manual setting)
1: OFF (auto setting)

IP6

IP address (IPv6)

IP address (IPv6)

IP6_DGW

IP address (IPv6)

Default gateway (IPv6)

IP6_DHCP

0

IPv6 DHCP settings

1

0：OFF
1：ON

PRISRV_V6

IP address (IPv6)

IPv6 primary server

SECSRV_V6

IP address (IPv6)

IPv6 secondary server

HTTPPORT

Numeric value

HTTP port number

SPEED

1

Communication speed

2

1：AUTO3

2：100M-FULL

4

3：100M-HALF

5

4：10M-FULL
5：10M-HALF

RTPSIZE

1280

Maximum packet length setting during RTP transmission

1500

1500: Normal packet length
1280: Maximum packet length limit

MSS

1024

HTTP maximum segment size (MSS)

1280

1460：Unlimited(1460byte)

1460

1280：Limited(1280byte)
1024：Limited(1024byte)

BWC

0Transmission volume control

64

0: No limit

128

64：64 kbps

256

128：128kbps

512

256：256kbps

1024

512：512kbps

2048

1024：1024kbps

4096

2048：2048kbps

100004096：4096kbps
10000：10Mbps

Network-based CGI Specifications

81

Setting name
EASYIPSETUP

Value

Description

unlimited

Time period during which Easy IP Setup can be performed

20

from the time power is turned ON
unlimited: Unlimited (default value)
20: 20 minutes

FTPS

0

FTP access to camera

1

1: Allowed
0: Prohibited

TIMEADJUST

0Time adjustment method

10: Manual setting
1: Synchronized with the NTP server

NTPSVR
NTPADD0

0：Auto1

1：Manual

IP address

NTP server address

StringNTPPORT

Numeric value

NTP port number

NTPINTERVAL

Numeric value

Interval of acquisition to NTP server
1 to 24 (hours)

PORTFORWARD

0

Auto port-forwarding

1

0：OFF
1：ON

CAM_SC0

Shortcut to camera

1

0：OFF
1：ON

HTTPS_TYPE

0

HTTPS setting ON/OFF

1

0：OFF
1：ON

HTTPS_MIE_CAMURLSEL

0

Self-signed certificate status

FSTATE1

0: Not created2

1: Invalid (CA certificate already installed)

3

2: Valid self-signed certificate
3: Validity period expired

HTTPS_CASTATE0

CA certificate status1

0: Not installed

2

1: Not installed (signature request already created)

3

2: Valid CA certificate
3: Validity period expired

HTTPS_PORT

1 to 65535

HTTPS port number

DDNS

0

DDNS setting ON/OFF

1

0：OFF
1：ON

DDHOST

StringNetwork-based CGI Specifications

Host name82Setting name
DDINT

Value

Description

1

Interval of access to server10

1: 1 minute30

10: 10 minutes

60

30: 30 minutes

360

60: 1 hour

1440

360: 6 hours
1440: 24 hours

SNMPCOM

StringCommunity name

SNMPTITLE

StringDevice name

SNMPLOCATION

StringPhysical location of device

SNMPCONTACT

StringContact

DSCP

0 to 63

DSCP value of Diffserv

PLUGIN_HALFTONE_JPE

0

Enabling/disabling of half-tone function for JPEG images inG

Active X
0: Disabled

PLUGIN_HALFTONE_H264

0

Enabling/disabling of half-tone function for H.264 in Active X
0: Disabled* Although parameters that have not been specified above may be included in the response, suchparameters are not supported.

Network-based CGI Specifications83

9. About Control Based on RTSP
The remote camera supports general RTSP protocols as well. This chapter illustrates usage methods
based on RTSP. The customer must have knowledge of RTSP/RTP/RTCP when using such usage
methods.

9.1. About the URLs for an RTSP Request
The default URLs for RTSP requests of the remote camera are as described below.
If you need to change, please use /cgi-bin/set_rtsp command.
Request URL
Description
Videos set in WEB menu H.264(1) of the remote
rtsp://<cam_ip>/mediainput/h264/stream_1
camera can be requested.
Videos set in WEB menu H.264(2) of the remote
rtsp://<cam_ip>/mediainput/h264/stream_2
camera can be requested.
Videos set in WEB menu H.264(3) of the remote
rtsp://<cam_ip>/mediainput/h264/stream_3
camera can be requested.
Videos set in WEB menu H.264(4) of the remote
rtsp://<cam_ip>/mediainput/h264/stream_4
camera can be requested.
The RTSP port at the remote camera (RTSP Server) side is set to 554 according to the factory settings. If it
is to be changed, use the cgi-bin/set_rtsp (POST command).

The relationship between "H.264 transmission" and "Audio Transmission" in the WEB menu of the remotecamera is as shown below.
Audio Transmission
ON
OFF
Both video and audio can be used.
Only video can be used.
* As for DESCRIBE, the SDP* As for DESCRIBE, only the SDP
ON
information of video + audio is issued
information of video is issued as
H.264
as response.
response.
transmission
Both video and audio cannot be used.
OFF* As for SETUP, 503 is issued as response.

When "Audio Transmission" is ON, the remote camera issues a response by adding Audio information to
the DESCRIBE information. If necessary, the audio can be transmitted by issuing the SETUP command. On
the contrary, if the SETUP command is not issued, only the video can be transmitted. Moreover, if "Audio" in
the WEB menu of the remote camera is "OFF", or nothing is connected to the "Audio IN terminal", it resultsin silent transmission.
In this manual, the description is provided by assuming that "H.264 transmission" and "Audio
Transmission" are in the ON state.

Network-based CGI Specifications849.2. About the rtsp Methods
The RTSP methods supported in the remote camera are as described below.
Supported Method
OPTIONSDESCRIBE
SETUP
PLAY
PAUSE

GET_PARAMETERTEARDOWN

Description
Check for the corresponding command
Acquisition of session information and Audio support
Initialization of the session and mutual exchange ofport information
Transfer started
Transfer paused* Transmission is stopped, and this method isignored during multicast.
Acquisition of session parameter* Operation is performed by assuming Keep Alive.
Transfer end/session end

SET_PARAMETER is not supported. 501 is issued as response.
The timeout based on GET_PARAMETER is 120 seconds. If Keep Alive from all clients is blocked
including during multicast, the remote camera stops transmission.

Network-based CGI Specifications8510. About Acquisition of Stream from RTSPThe RTSP communication methods supported in the remote camera are as described below. No matter
which method is used, TCP communication (554 is set as the waiting port at the remote camera side) isused during initial negotiation of RTSP.
1. UDP Unicast
 Used for transmitting video/audio to a single client in one remote camera.
 Although transmission to multiple clients is also supported, network bandwidth is needed for eachconnection.
2. UDP Multicast
 Used for transmitting video/audio simultaneously to multiple clients in one remote camera.
 The network bandwidth at the camera side does not increase even when transmission is
performed to multiple clients.
 A separate router that supports multicast is needed.
3. TCP Unicast
 Used for transmitting video/audio to a single client in one remote camera.
 The video and audio data communicated via RTP/UDP can be transmitted via TCP.

10.1. UDP Unicast
You must make the settings described below in the WEB menu as preparations at the remote camera side.
 Set H.264(X)/Transmission type to Unicast (AUTO).
The port number during transmission of video and audio stream is decided as described below.
 client_port (receiving port at the client side):
The client explicitly issues a command to the remote camera in an RTSP "SETUP" sequence.
* The methods of deciding the port number differ according to the client, and include random
settings and dedicated menu.
 server_port (transmitting port of the remote camera):
The remote camera issues a response to the client through response in the RTSP "SETUP"
sequence.
* The port number is decided randomly.
Note that if you want to fix the client_port forcibly, you can do so by making the WEB menu settings
described below.
 Set H.264(X)/Transmission type to Unicast (MANUAL).
 Set Unicast port (Image)/Unicast port (Audio).
* However, in the RTSP "SETUP" sequence, the content instructed explicitly by the client to theremote camera are ignored, and therefore, it is not used normally.
The acquisition method of video and audio stream by the UDP Unicast method is illustrated below.

Network-based CGI Specifications

86

UDP Unicast Sequence

Network-based CGI Specifications

87

UDP Unicast Packets (1/2)

Network-based CGI Specifications

88UDP Unicast Packets (2/2)

Network-based CGI Specifications8910.2. UDP Multicast
You must make the settings described below in the WEB menu as preparations at the remote camera side.
 Set H.264(X)/Transmission type to Multicast.
 Set H.264(X)/Multicast address (set to 239.192.0.20 for H.264(1) according to factory settings)
 Set H.264(X)/Multicast port (set to 37004 for H.264(1) according to factory settings)

The port number and multicast address during transmission of the video and audio stream depend on thevalues of the WEB menu of the remote camera, and the commands from the client side are ignored.

The acquisition method of video and audio stream by the UDP Multicast method is illustrated below.

Network-based CGI Specifications

90

UDP Multicast Sequence

Network-based CGI Specifications

91

UDP Multicast Packets (1/2)

Network-based CGI Specifications

92

UDP Multicast Packets (2/2)

Network-based CGI Specifications9310.3. TCP Unicast
You must make the settings described below in the WEB menu as preparations at the remote camera side.
 Set H.264(X)/Transmission type to Unicast (AUTO).
The port number during transmission of video and audio stream is decided as described below.
 client_port (receiving port at the client side):
The transmission-side port of the client that is used in the RTSP "PLAY" sequence becomesthe receiving port at the client side.
* The methods of deciding the port number differ according to the client, and include random
settings and dedicated menu.
 server_port (transmitting port of the remote camera):
The RTSP waiting port (set to 554 according to factory settings) is used.
The interleave header specified from the client side is ignored at the camera side, and a new interleave
header is issued.
The acquisition method of video and audio stream by the TCP Unicast method is illustrated below.

Network-based CGI Specifications

94

TCP Unicast Sequence

Network-based CGI Specifications

95

TCP Unicast Packets 1/2

Network-based CGI Specifications

96

TCP Unicast Packets 2/2

Network-based CGI Specifications9710.4 About the rtpmap Attribute
The response of "rtpmap" with respect to the RTSP "DESCRIBE" request is as described below.
Codec
H.264
AAC-LC(Highquality)
G.726(32kbps)
G.726(16kbps)

rtpmap Attribute Value
a=rtpmap:98 H264/90000
a=rtpmap:99 mpeg4-generic/48000/2
a=rtpmap:97 G726-32/8000
a=rtpmap:97 G726-16/8000

The values described above are used for both video and audio regardless of the bit rate.

Network-based CGI Specifications9811. About Control Based on RTCP
The remote camera also supports dynamic control of bit rate and frame rate according to the line statususing RTCP. As a prerequisite, a client that supports RTCP/SR (Sender Report) and RTCP/RR (Receiver
Report) is necessary.
You must make the settings described below in the WEB menu as preparations at the remote camera side.
 Set H.264(X)/Transmission priority to Best effort.
* In the case of the frame rate (factory settings) and constant bit rate, an RTCP/SR is transmitted
and an RTCP/RR is received, but these are not used for controlling the bit rate and frame rate.
 Select H.264(X)/Image quality from Motion priority or Image quality priority.
Motion priority: This is the motion priority mode.
The bit rate is actively changed and supported.
Image quality priority: This is the image quality priority mode.
The frame rate is actively changed.

The sequence during RTCP control is illustrated below:

Note that in the remote camera, an RTCP/SR is transmitted every five seconds, and of the RTCP/RRs, only
those related to VIDEO are used.

Network-based CGI Specifications9912. About RTP/Data Format
12.1. RTP Header Format
Bit

0.

8.

Byte

2

1

1

0

V

P

X

4

1
CC

16.
7

24.

8

M

PT

8
Sequence number

4

Timestamp

8

SSRC (Synchronization Source Identifier)

12

Defined by profile

Extension length

Additional Information (1)16Additional Information (N)Parameter namelength(Bit)

Values and comments

V (Version)

2

2 (fixed)

P (Padding)1

0 (fixed)

X (Extension)

1

0: false , 1: true

CC (CSRC Count)

40 (fixed)

M (Marker)

1

In case of the last RTP packet of a picture, this value is set to 1

PT (Payload Type)

7

Sequence number

16

Timestamp

32

Time stamp

SSRC

32

0x0000 0000 (fixed)

CSRC

0

UnusedDefined by profile(*)

16

0 (fixed)

Extension length(*)

16

Length of the Header Extension (Unit of 32bit word)

98 (fixed for H.264)
99 (fixed for AAC)
The value in which one increment is done in each RTP packet is set.
An initial value is generated at random.

meta information(Additional
Information) (*)

Network-based CGI Specifications

10012.2. Relationship with H.264/ES Data
The structure of ES data and RTP packet of H.264 is as shown below.
Parameter set
AU

PPS

SEI

NALh

#1

Ether/IPh/UDPh

RTPh

AU

#2

Ether/IPh/UDPh

RTPh SPS#3

Ether/IPh/UDPh

RTPh PPS#4Ether/IPh/UDPh

RTPh

SEI

#5

Ether/IPh/UDPh

RTPh

FUi

FUh

RBSP

#6

Ether/IPh/UDPh

RTPh

FUi

FUh

RBSP

#N

Ether/IPh/UDPh

RTPh

FUi

FUh

Structure of ES data

RTP packet

SPS

Encoded data
RBSP

(FU-A)

RBSP[Notes]NALh: NAL header(1 byte)Fui: FU identifier(1 byte)Fuh: FU header(1 byte)Ether/IPh/UDPh: Ether/IP header/UDP header

RTPh: RTP header

Network-based CGI Specifications

10112.3. H.264 Syntax
In the remote camera, the Codec information described below is applicable regardless of theresolution/frame rate.
Codec Info
H.264/High profile (no B frame/CABAC)

12.4. Audio Data Format
The structure of the audio ES data and RTP packet differs depending on the audio compression method.
When the audio compression method is AAC-LC(High quality)
An AU header (2 bytes) is inserted between the RTP header and audio data, and then transmitted.

RTP header

AU Header

Network-based CGI Specifications

ES (AUDIO data)102

Memo:

Network-based CGI Specifications

103