POVCAM Interface Specifications

Video Transmission / Clip Operation
Target Models
AG-UCK20, AG-UMR20
AG-MDC20, AG-MDR25

Version 1.0
Panasonic Corporation

Change History
Date
September 11, 2017

Version
V1.0

Description
Initial Release

POVCAM Interface Specifications Video Transmission / Clip Operation

2

Table of Contents
Change History ............................................................................................................................................. 2
1. Introduction............................................................................................................................................... 5
2. CGI List for Video Transmission ............................................................................................................... 6
2.1. Transmission User Management ........................................................................................................ 6
2.2. Device Information Acquisition ........................................................................................................... 8
2.3. Specific Information (Capability) Acquisition ..................................................................................... 10
2.4. JPEG-based Image Transmission .................................................................................................... 13
2.5. Image Transmission Sequence based on MJPEG ........................................................................... 16
2.6. Image Transmission Sequence based on JPEG Image 1 shot ......................................................... 17
2.7. H264/AUDIO-based Image Transmission......................................................................................... 18
2.8. Unicast Image Transmission Sequence based on H264 .................................................................. 19
3. CGI List for Camera Control ................................................................................................................... 20
3.1. Camera control ................................................................................................................................ 20
4. CGI List for Various Settings................................................................................................................... 21
4.1. Priority Mode / Basic Settings........................................................................................................... 21
4.2. NTP / Clock Settings ........................................................................................................................ 224.3. Video over IP Settings ...................................................................................................................... 24
4.4 Audio Settings ................................................................................................................................... 28
4.5. Multi-screen Settings ........................................................................................................................ 30
4.6. rk Settings ........................................................................................................................................ 31
4.7. UPnP Settings.................................................................................................................................. 33
4.8. Restarting......................................................................................................................................... 33
5. CGI List for Acquisition of Different Types of Information ........................................................................ 34
5.1. Priority Mode Settings Information Acquisition ................................................................................. 34
5.2. Basic Settings Information Acquisition.............................................................................................. 34
5.3. NTP Settings Information Acquisition ............................................................................................... 35
5.4. Clock Settings Information Acquisition ............................................................................................. 35
5.5. VideoOverIP Screen Information Acquisition .................................................................................... 36
5.6. Audio Settings Information Acquisition ............................................................................................. 37
5.7. Multi-screen Settings Information Acquisition ................................................................................... 37
5.8. Network Settings Information Acquisition ......................................................................................... 38
5.9. UPnP Settings Information Acquisition ............................................................................................. 38
5.10. UPnP Execution Results Acquisition .............................................................................................. 39
5.11. System Log Information Acquisition ............................................................................................... 39
5.12. Other Setting Values Acquisition .................................................................................................... 40
6. Acquiring the List of Setting Values ........................................................................................................ 43
7. CGI List for HTTPS Control .................................................................................................................... 47
7.1. Setting Information and Acquiring Certification ................................................................................. 47
7.2. Information Acquisition ..................................................................................................................... 48
8. CGI List for SD Card Recording .............................................................................................................. 49
8.1. Video Recording Mode Settings ....................................................................................................... 49
8.2. Video Recording Mode Acquisition ................................................................................................... 50
8.3. Video Recording Media Settings ...................................................................................................... 50
8.4. Video Recording Media Acquisition .................................................................................................. 50
8.5. Video Folder Name and File Name Settings for MP4 Format ........................................................... 51
8.6. Video Folder Name and File Name Acquisition for MP4 Format ....................................................... 51
POVCAM Interface Specifications Video Transmission / Clip Operation

3

8.7. Video Recording Start/End Control .................................................................................................. 52
9. CGI List for SD Card Status Acquisition and Formatting (Initialization) ................................................... 53
9.1. SD Card Relationship Status Acquisition .......................................................................................... 53
9.2. SD Card Format (Initialization) Control ............................................................................................. 54
9.3. SD Card Format (Initialization) Progress Confirmation ..................................................................... 54
10. CGI List for Recorded Clips (MP4/AVCHD) .......................................................................................... 55
10.1. Clip (MP4/AVCHD) List Search ...................................................................................................... 55
10.2. Clip (MP4/AVCHD) Deletion ........................................................................................................... 56
10.3. Clip (MP4/AVCHD) Download Control ............................................................................................ 57
10.4. Clip (MP4/AVCHD) Download Sequence ....................................................................................... 57
11. CGI List for FTP Control ....................................................................................................................... 58
11.1. FTP Overview ................................................................................................................................ 58
11.2. Transfer Destination FTP Server Settings ...................................................................................... 59
11.3. FTP Server Information Acquisition ................................................................................................ 59
11.4. Issuing/Canceling Transfer Start Command with List ..................................................................... 60
11.5. Transfer Progress Confirmation ..................................................................................................... 61
11.6. FTP Control Sequence ................................................................................................................... 62
11.7. About Folder Settings at the FTP Server Side ................................................................................ 63
12. About Control Based on RTSP ............................................................................................................. 64
12.1. About URLs for RTSP Request ...................................................................................................... 64
12.2. About the RTSP Methods............................................................................................................... 65
13. About Acquisition of Stream from RTSP ............................................................................................... 66
13.1. UDP Unicast .................................................................................................................................. 66
13.2. UDP Multicast ................................................................................................................................ 70
13.3. TCP Unicast ................................................................................................................................... 74
13.4. About the rtpmap Attribute ............................................................................................................. 78
14. About Control Based on RTCP ............................................................................................................. 79
15. About RTP/Data Format ....................................................................................................................... 80
15.1. RTP Header Format ....................................................................................................................... 80
15.2. Relationship with H.264/ES Data ................................................................................................... 81
15.3. H.264 Syntax ................................................................................................................................. 82
15.4. Audio Data Format ......................................................................................................................... 82

POVCAM Interface Specifications Video Transmission / Clip Operation

4

1. Introduction
This document describes the specifications for video transmission and clip operation when operating amemory card portable recorder and special optional compact camera head via the network. For details on
general operation, see the instruction manual.
There is some compatibility with HD integrated cameras in terms of the command system.
The memory card portable recorder and special optional compact camera head may be referred to as
simply "camera" in some sequence diagrams and explanations.
Panasonic shall not take any responsibility for damages caused as a result of the use of this information.
This information may be changed without prior notice due to the upgrade of the product version in the future.
The usage examples are only reference examples for this series. Support cannot be offered for eachprogram. Moreover, some information of the communication between the camera and browser is notdisclosed.

About the access levels
In this document, "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 memory card portable recorder and special optional
compact camera head.
When User auth. is OFF (factory setting):
Live (Video acquisition and camera control):Admin (Various SETUP controls):
When User auth. is ON:
Live (Video acquisition and camera control):Admin (Various SETUP controls):

Authentication not necessary
ID/password for Administrator authority are necessary

ID/password for camera control or Administrator
authority are necessary
ID/password for Administrator authority are necessary

About the priority mode
The types of CGI that can be executed and the range of parameter values differ depending on the priority
mode of the memory card portable recorder and special optional compact camera head.
For details, see the instruction manual.
Example) When the priority mode (/cgi-bin/set_priority_mode, /cgi-bin/get_priority_mode) is REC/PB
priority=> Control cannot be performed for H.264 (2).

POVCAM Interface Specifications Video Transmission / Clip Operation

52. CGI List for Video Transmission
2.1. Transmission User Management
MethodAccess level: GET: LiveURL

CGI item name
Transmission user

/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

replybrowser

Command response format

info

specification (can be omitted)
browser: for the camera browser
info: for the application

Usage example) Acquisition of user ID (during H264(1) transmission)
http://192.168.0.10/cgi-bin/getuid?FILE=2&vcodec=h264* When the transmission mode specified with the vcodec parameter cannot be used, 204 No Content isissued as the response.

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, 60Max. frame rate

StreamMode

1

Fixed value

iBitrate

Numeric value

Bit rate setting of H.264

iResolution

640,1280,1920,3840

Horizontal resolution setting of H.264

iQuality

fine, low

Image quality setting of H.264

sDelivery

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

POVCAM Interface Specifications Video Transmission / Clip Operation

6

Item

Value of response

Description

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, inoff: Audio OFF

aEnc

2

Fixed value (2: AAC)

aBitrate

128,96,64

Bit rate setting of audio

aBitrate2

64

Fixed value

aInterval

20

Fixed value

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

disableFixed value

iHttpPort

Numeric value

HTTP port number

iMultiAuto_h264

0

Fixed value

iMultiAuto_h264_2

0

Fixed valuesRtspMode_h264

0

Fixed valuesRtspMode_h264_2

0

Fixed value

in: Audio ON (reception)

POVCAM Interface Specifications Video Transmission / Clip Operation

7

2.2. Device Information Acquisition
MethodAccess level: GET: LiveCGI item name
Device informationURL/cgi-bin/getinfo

Parameter

Parameter

name

value

FILE

Description

1

1 (Fixed)

acquisition

Usage example) Device information acquisition
http://192.168.0.10/cgi-bin/getinfo?FILE=1

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

AG-XXXX

Product number

SDrec

disableFixed value

SDrec2disableFixed value

sAlarmoff

Fixed value

sAUX

off

Fixed value

ePort

31004

Fixed value

aEnableoff, inoff: Audio OFF

aEnc

2

Fixed value (2: AAC)

aBitrate

128,96,64

Bit rate setting of audio

aBitrate2

64

Fixed value

aInterval

20

Fixed value

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 numbersRtspMode_h264

0

Fixed valuesRtspMode_h264_2

0

Fixed value

ImageCaptureMode2m

Fixed value

ratio

16_9

Fixed value

Maxfps30, 60Max. frame rate

StreamMode

1

Fixed value

iTransmit_h264

1

Fixed value,

in: Audio ON (reception)

POVCAM Interface Specifications Video Transmission / Clip Operation

8

Item
sDelivery_h264

Value of response

Description

uni,

uni: Unicast (auto)

multi,

multi:

uni_manual

uni_manualiBitrate_h264

Numeric value

Bit rate setting of H.264(1)iResolution_h264

640,1280,1920,3840

Horizontal resolution setting of H.264(1)iQuality_h264

fine, low

Image quality setting of H.264(1)iMultiAuto_h264

0

Fixed value

iTransmit_h264_2

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

POVCAM Interface Specifications Video Transmission / Clip Operation

92.3. Specific Information (Capability) Acquisition
MethodAccess level: POST,GET: LiveCGI item nameSpecific informationURL/cgi-bin/get_capability

Parameter

Parameter

name

value

-

-

Description
Explained under the next item

(capability)
acquisition

Usage example) Specific information (capability) acquisition
http://192.168.0.10/cgi-bin/get_capability

The description of the response data is as shown below.
Group nameParameter nameParameter

Description

valuecommonvideo_server.basic
video_server.basic.analogue_in

capability_version

1.00

Version of the capability format

categorycameraCategory

type

fixed_dome

Product shapefisheyenoFisheye camera

supported

ntsc,palSupported video signals of the analog

put
video_server.cam_ctrl.ptz

camera (encoder)supportedyes

Availability of PTZ function

zoom

20

Zoom magnification

el_zoom

30

Electronic zoom magnificationcommandcamctrl

Supported PTZ commands

direct_16
direct_256d
direct_256r
video_server.cam_ctrl.brightne

supported

yes

Support for brightness control commandss

commandcamctrl_brightTypes of supported commands

camctrl_IRIS
video_server.cam_ctrl.abf

supported

noSupport for ABF commandvideo_server.cam_ctrl.focus

supported

yes

Support for focus commandvideo_server.cam_ctrl.auto_foc

supported

yes

Support for auto-focus command

supported

noSupport for black and white selection

usvideo_server.cam_ctrl.bw

commandvideo_server.cam_ctrl.auto_mo

supported

noSupport for auto mode

video_server.cam_ctrl.preset

supported

noSupport for preset movement commandvideo_server.image.sensor

aspect_ratio

16_9

Aspect ratio of sensor

video_server.image

formatjpeg, mjpeg,

Supported image transmission format

de

h264
mode

2m_r16_9

Supported imaging mode

POVCAM Interface Specifications Video Transmission / Clip Operation

10Group nameParameter nameParameter

Description

value
video_server.image.jpeg

resolution

640x360

Resolution parameters supported in the
JPEG1 shot

quality

0 to 9Image quality parameters supported in the
JPEG1 shot

video_server.image.jpeg.resolu

2m_r16_9

640x360

Transmission-enabled JPEG resolution2m_r16_9

640x360

Transmission-enabled JPEG resolution

640x360

60,60,60,60,60,

Max. data size of one JPEG image per

30,30,30,30,30,

resolutiontion_each_mode
video_server.image.jpeg.resolu
tion_each_mode_all
video_server.image.jpeg.max_size

Unit [Kbyte]
Values are separated by a comma andenumerated.
Configuration: <Value 1>,<Value
2>,<Value 3>,<Value 4>,<Value
5>,<Value 6>, ,,, ,<Value (n)>, ,,When video_server.image.jpeg.quality(JPEG image quality setting parameter) is
0,1,2,3,4,5,6,7,8,9, it indicates the
below-mentioned meaning.
<Value 1>: Max. data size when the JPEG
image quality setting is "0"<Value 2>: Max. data size when the JPEG
image quality setting is "1"...
<Value 10>: Max. data size when the
JPEG image quality setting is "9"video_server.image.mjpeg

resolution

640x360

Resolution parameters supported in the
JPEG stream

quality

0 to 9Image quality parameters supported in the
JPEG stream

framerate

1 to 30

Frame rates supported in the JPEG
stream Rounded down to the nearest
whole number

NTSC: 1 to 30

PAL: 1 to25
video_server.image.mjpeg.max

2m_r16_930

Max. frame rate of JPEG stream

2m_r16_9

640x360

Setting-enabled JPEG resolution2m_r16_9

640x360

Setting-enabled JPEG resolution

resolution

3840x2160,

Resolution parameters supported in

1920x1080,

H.264(1)_framerate
video_server.image.mjpeg.reso
lution_each_mode
video_server.image.mjpeg.reso
lution_each_mode_all
video_server.image.h264

1280x720,
640x360

POVCAM Interface Specifications Video Transmission / Clip Operation

11

Group nameParameter nameParameter

Description

value
stream_mode

bitrate,Transmission modes supported inframerate,

H.264(1)best_effort
qualityfine, normal

Image quality parameters supported in
H.264(1)bandwidth

1024,1536,2048

Bit rate parameters supported in H.264(1),3072,4096,614
4,8192,10240,1
2288,14336,163
84,20480,24576,32768,40960,5
1200
framerate
video_server.image.h264.resol2m_r16_9

ution_each_mode

5,12.5,15,25,30,

Frame rate parameters supported in

50,60

H.264(1)3840x2160,

Supported H.264(1) resolutions

1920x1080,
1280x720,
640x360

video_server.image.h264.max_

2m_r16_960

Supported max. H.264(1) frame rate

framerate
video_server.image.h264-2

Same as H264-1

video_server.image.h264-2.res
olution_each_mode
video_server.image.h264-2.ma
x_framerate
video_server.audio

transmission

input

Audio transmission setting mode

video_server.audio.audio_input

number

1

Audio microphone input number

encode_typeaac-1c_64K

Supported audio input encoding typeaac-1c_96K
aac-1c_128K
video_server.sdcard
video_server.sdcard.replay_mp

supported

yes

Support for SD memory card function

media_typesd, sdhc, sdxc

Supported SD memory card typesupported

noSupport for the function for playing back4

MP4 files saved in the SD memory card
inside the camera

video_server.network

nw_bandwidth

1024,2048,4096

Parameters supported in the overall,8192,16384,32

transmission volume setting

768
video_server.network.ipv6

supportednoIPv6 support status

video_server.network.httpssupported

yes

HTTPS (SSL) support status

video_server.vmd

supportedno

VMD support status

POVCAM Interface Specifications Video Transmission / Clip Operation

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

URL/cgi-bin/jpeg

Parameter

Parameter

name

value

connecttransmission

Description

start

start: Starts JPEG image

stop

transmission stop: Stops JPEG

(MJPEG)

image transmission
framerate

1

1 fps

5

5 fps

15(12.5)

15 (12.5) fps

30(25)

30 (25) fps
The values within () are for the casewhen the system frequency is 50 Hz

resolution

640

640: 640x360

UID

Numeric value

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

JPEG image/cgi-bin/mjpeg

transmission

resolution

640

640: 640x360

framerate

1

1 fps

5

5 fps

15(12.5)

15 (12.5) fps

30(25)

30 (25) fps(MJPEG)The values within () are for the casewhen the system frequency is 50 Hz
JPEG image 1 shot

/cgi-bin/view.cgi

actionsnapshotsnapshot: Acquires one JPEG image

start

start: Starts JPEG transmission

stop

stop: Stops JPEG transmissionnNumeric value

Dummy for disabling cache

resolution

640

640: 640x360

page

Numeric value

Dummy for disabling cacherequestJPEG image 1 shot
request/cgi-bin/camera

POVCAM Interface Specifications Video Transmission / Clip Operation

13

[Notes]
In a memory card portable recorder and special optional compact camera head, various techniques areprovided for acquisition of 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 receivingside.

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 is used when calling JPEG(1).
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 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

POVCAM Interface Specifications Video Transmission / Clip Operation

14

The characteristics of each CGI of JPEG image 1 shot are as described below.
/cgi-bin/view.cgi
When CGI is called once, only one JPEG image is transmitted.
Before calling, the acquisition of UID with /cgi-bin/getuid is not necessary.
Used when calling a JPEG image without the use of plug-in software in Internet Explorer.
Usage example) When acquiring a 640 x 360 video through a JPEG image 1 shot request:
http://192.168.0.10/cgi-bin/view.cgi?action=start
http://192.168.0.10/cgi-bin/view.cgi?action=snapshot&n=3333<Appropriate standby time>
http://192.168.0.10/cgi-bin/view.cgi?action=snapshot&n=3334<Appropriate standby time>
http://192.168.0.10/cgi-bin/view.cgi?action=snapshot&n=3335
While the "start" command is mandatory after turning the power supply ON, the "stop" command is
not mandatory. The "start" command may be issued any number of times without any problem.

/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 is used 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.
When the WEB menu/Video over IP/JPEG/JPEG transmission are OFF, the response may be in theform of a pitch black JPEG image.

POVCAM Interface Specifications Video Transmission / Clip Operation

15

2.5. Image Transmission Sequence based on MJPEG

MJPEG Sequence

POVCAM Interface Specifications Video Transmission / Clip Operation

16

2.6. Image Transmission Sequence based on JPEG Image 1 shot

JPEG 1Shot Sequence

POVCAM Interface Specifications Video Transmission / Clip Operation

17

2.7. H264/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

stream1

1:

Stream 1

2

2:

Stream 2

start

start: Starts audio transmission

stop

stop: Stops audio transmission

rtp

rtp: RTP transmission

httphttp: HTTP transmission

Numeric value

Reception port number of audio data

* UID acquired by /cgi-bin/getuid

Audio transmission/cgi-bin/audio

connect
protocolmy_port*Only when protocol = rtp
Can be omitted during HTTP
transmission
UID

Numeric value

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

Keep alive/cgi-bin/keep_

mode

in

in: Fixed

mode

h.264

h.264: H.264 keep alive

h.264_2

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

jpeg

jpeg: JPEG keep alive

audio

audio: Audio keep alive

rtp

rtp: RTP transmission

httphttp: HTTP transmission

Numeric value

User ID

alive

protocolUID* UID acquired by /cgi-bin/getuid
stream1

1:

Stream 1

2

2:

Stream 2

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
POVCAM Interface Specifications Video Transmission / Clip Operation

18

2.8. Unicast Image Transmission Sequence based on H264

H264 Sequence

POVCAM Interface Specifications Video Transmission / Clip Operation

193. CGI List for Camera Control
3.1. Camera control
MethodAccess level
CGI item name
Camera control: GET: LiveURL/cgi-bin/camctrl

Parameter

Parameter

name

value

times

1

1: Return to default settingup

up: ZOOM UP one level

down

down: ZOOM DOWN one level00: Return to default setting

1

1: Return to default settingup

up: ZOOM UP one level

down

down: ZOOM DOWN one level00: Return to default setting

1

1: Return to default settingup

up: Turn brightness one level UP

down

down: Turn brightness one level DOWN

-2

-2: Turn brightness two levels DOWN

0

0: Return brightness to standard value (reset)22: Turn brightness two levels UP

1

1: Return to default settingup

up: Turn brightness one level UP

down

down: Turn brightness one level DOWN

-2

-2: Turn brightness two levels DOWN

0

0: Return brightness to standard value (reset)22: Turn brightness two levels UP

focus-3,3,on-3: Near, 3: Far, on: Autoaf

-3,3,on-3: Near, 3: Far, on: Autozoom

-4 to 4

A negative value indicates ZOOM DOWN andzoombrightiris

Camera control/cgi-bin/directctrl

Description

directa positive value indicates ZOOM UP
focus-4 to 4

A negative value indicates near and a positive
value indicates far* Control will be of the special optional compact camera head.
* This CGI is for backward compatibility. In a compact camera head, the use of cgi-bin/aw_ptz enables
high-functionality control.

POVCAM Interface Specifications Video Transmission / Clip Operation

20

4. CGI List for Various Settings
4.1. Priority Mode / Basic Settings
MethodAccess level: POST: Admin

CGI item namePriority mode settingURL/cgi-bin/set_priori

Parameter

Parameter

name

value

mode

ip

IP

rec_pb

REC/PB

ip_4k

IP(4K)

rec_pb_4k

REC/PB(4K)

cam_title

StringCamera title (within 20 characters)

plugin_downl

enableAuto installation of plug-in softwareoaddisableenable: Allowed

ty_modeBasic settings/cgi-bin/set_basic

Description

disable: Not allowed
plugin_disp

00: Real time consideration (Off)1

1: Smooth display (On)Usage example) Set the priority mode to IP
http://192.168.0.10/cgi-bin/set_priority_mode?mode=ip

Usage example) Set the camera title
http://192.168.0.10/cgi-bin/set_basic?cam_title=UCK20POVCAM Interface Specifications Video Transmission / Clip Operation

21

4.2. NTP / Clock Settings
MethodAccess level: POST: Admin

CGI item name
NTP settings

Clock settings

URL/cgi-bin/time/cgi-bin/date_tim

Parameter

Parameter

name

value

time_adjust

Description0

0: Manual

1

1: Synchronized with the NTP server

ntp_addr_dhc

0

0: OFF (manual input)p1

1: ON (acquired from DHCP)

ntp_addr

StringIP address (IPv4)

ntp_port

Numeric value

1 to 65535

ntp_interval

Numeric value

1 to 24 (hours)

display

0

0:off

1

1:on

date_year

2013 to 2035

Year

date_month

1 to 12Monthdate_day

1 to 31Day

date_hour

0 to 23

Hour

date_min0 to 59

Minutes

date_sec

0 to 59

Seconds

timezone

1 to 33

1:GMT-11:00

e

2:GMT-10:00
3:GMT-09:00
4:GMT-08:00
5:GMT-07:00
6:GMT-06:00
7:GMT-05:00
8:GMT-04:30
9:GMT-04:00
10:GMT-03:30
11:GMT-03:00
12:GMT-02:00
13:GMT-01:00
14:GMT
15:GMT+01:00
16:GMT+02:00
17:GMT+03:00
18:GMT+03:30
19:GMT+04:00
20:GMT+04:30
21:GMT+05:00
22:GMT+05:30
23:GMT+05:45
24:GMT+06:00
25:GMT+06:30
26:GMT+07:00

POVCAM Interface Specifications Video Transmission / Clip Operation

22

CGI item name

URL

Parameter

Parameter

name

value

Description
27:GMT+08:00
28:GMT+09:00
29:GMT+09:30
30:GMT+10:00
31:GMT+11:00
32:GMT+12:00
33:GMT+12:45

summer_time

00: Summer time is not set (Out)1

1: Summer time is set (In)2

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

1 to 12

1: January to 12:

Decemberstart_week

1 to 5

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

start_dotw

0 to 6

0: Sunday to 6:

Saturdaystart_hour

0 to 23

0 to 23

end_month

1 to 12

1: January to 12:

end_week

1 to 5

1: First week, 2: Second week,

December

3: Third week, 4: Fourth week,
5: Last week
end_dotw

0 to 6

0: Sunday to 6: Saturday

end_hour

0 to 23

0 to 23

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
Usage example) Clock settings
http://192.168.0.10/cgi-bin/date_time?display=0&date_year=2018&date_month=1&date_day=1&date_ho
ur=0&date_min=0&date_sec=0&summer_time=0

POVCAM Interface Specifications Video Transmission / Clip Operation

23

4.3. Video over IP Settings
MethodAccess level: POST: Admin

CGI item name
JPEG settings

URL/cgi-bin/set_jpeg

Parameter

Parameter

name

value

Description

jpeg_quality

0 to 90 to 4: High image quality

resol_stream1

640

640 : 640x360

jpeg_transmit

00: OFF

Do not transmit

1

1

1: ON

Transmit

jpeg_interval1

5

Frame rate of JPEG(1)15(12.5)

5:5 fps30(25)

15 (12.5): 15 (12.5) fps

5 to 9: Low image quality

30 (25): 30 (25) fps* The values within () are for the casewhen the system frequency is 50 Hz
JPEG stream/cgi-bin/setdata

settings

LIVESIZE

640

Resolution of JPEG(1)LIVEQUAL

0 to 9Image quality of JPEG(1)0 to 4: High image quality
5 to 9: Low image quality

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

h264_transmit

00: OFF

Do not transmit

1

1: ON

Transmit

h264_rtsp_m0

Internet mode settingsode

1

0: OFFsettings

1: ON
h264_resoluti

640

640: 640x360

on

1280

1280: 1280x720

1920

1920: 1920x1080

3840

3840: 3840x2160

00: Fixed bit rate

1

1: Frame rate priority

2

2: Best effort transmission

5

5: 5 fps

15(12.5)

15 (12.5): 15 (12.5) fps

30(25)

30 (25): 30 (25) fps

60(50)

60 (50): 60 (50) fps

f_priority

framerate* The values within () are for the casewhen the system frequency is 50 Hz

POVCAM Interface Specifications Video Transmission / Clip Operation

24

CGI item name

URL

Parameter

Parameter

name

value

Description

h264_bandwi

1024

1024:1024(kbps)

dth

1536

1536：1536(kbps)

2048

2048：2048(kbps)

3072

3072：3072(kbps)

4096

4096：4096(kbps)

6144

6144:6144(kbps)

8192

8192：8192(kbps)

10240

10240:10240(kbps)

12288

12288:12288(kbps)

14336

14336:14336(kbps)

16384

16384:16384(kbps)

20480

20480:20480(kbps)

24576

24576:24576(kbps)

32768

32768:32768(kbps)

40960

40960:40960(kbps)

51200

51200:51200(kbps)

h264_bandwi

1024 to* Can be set when f_priority = 2 (Bestdth_min

51200

effort transmission)

h264_quality

Finefine: Image quality priority

low

low: Motion priority

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

1024 to 50000

Port number: 1024 to 50000

224 to 239

224.0.0.0 - 239.255.255.255

h264_unimulti_port
multicast_add
r1
multicast_add

0 to 255

r2
multicast_add

0 to 255

r3
multicast_add

0 to 255

r4
multicast_add*.*.*.* format*.*.*.* format

multicast_port

1024 to 50000

1024 to 50000

multicast_ttl

1 to 254

1 to 254

h264_transmit

00: OFF

Do not transmit
Transmitr

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

settings

_2

1

1: ON

h264_rtsp_m0

Internet mode settingsode

1

0: OFF 1: ON

h264_resoluti

640

640:640x360

on

1280

1280:1280x720

POVCAM Interface Specifications Video Transmission / Clip Operation

25

CGI item name

URL

Parameter

Parameter

name

value

f_priority

framerate

Description

0

0: Fixed bit rate

1

1: Frame rate priority

2

2: Best effort transmission

5

5: 5 fps

15(12.5)

15 (12.5): 15 (12.5) fps

30(25)

30 (25): 30 (25) fps* The values within () are for the casewhen the system frequency is 50 Hz

h264_bandwi

1024

1024:1024(kbps)

dth

1536

1536：1536(kbps)

2048

2048：2048(kbps)

3072

3072：3072(kbps)

4096

4096：4096(kbps)

6144

6144:6144(kbps)

8192

8192：8192(kbps)

10240

10240:10240(kbps)

12288

12288:12288(kbps)

14336

14336:14336(kbps)

16384

16384:16384(kbps)

20480

20480:20480(kbps)

24576

24576:24576(kbps)

h264_bandwi

1024 to* Can be set when f_priority = 2 (Bestdth_min24576

effort transmission)

h264_quality

fine

fine: Image quality priority

low

low: Motion priority

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

1024 to 50000

Port number: 1024 to 50000

224 to 239

224.0.0.0 - 239.255.255.255

h264_unimulti_port
multicast_add
r1
multicast_add

0 to 255

r2
multicast_add

0 to 255

r3
multicast_add

0 to 255

r4
multicast_add*.*.*.* format*.*.*.* format

multicast_port

1024 to 50000

1024 to 50000

multicast_ttl

1 to 254

1 to 254

r

POVCAM Interface Specifications Video Transmission / Clip Operation

26

CGI item name
RTSP settings

URL/cgi-bin/set_rtsp

Parameter

Parameter

name

value

rtsp_port

1 to 65535

Description
1 to 65535* Set to 554 according to factory
settings

Live screen initial/cgi-bin/set_livest

stream selection

art

h264_rtsp_m0

Internet mode settings of H264(1)ode10: OFF

Do not Transmit

1: ON

Transmit

h264_rtsp_m0

Internet mode settings of H264(2)

ode2

1

0: OFF

Do not Transmit

1: ON

Transmit

streamh264

h264：H264(1)h264_2

h264_2：H.264(2)jpeg

jpeg：JPEG(1)POVCAM Interface Specifications Video Transmission / Clip Operation

27

4.4 Audio Settings
MethodAccess level: POST/GET: Admin

CGI item name
Audio settings

URL/cgi-bin/set_audi

Parameter

Parameter

name

value

audio

o

Description

off

off

：OFF

in

in

：ON

0

0：OFF

1

1：ON
* Set this with audio_sens as a set.

audio_encode

aac

Encoder settings AAC (fixed)

lmiddlemiddle: Microphoneline_middle

line_middle: Line

sdi

sdi:SDIr
audio_sens* Set this with audio = 1 as a set.
audio_bitrate

64

64: 64 Kbps

96

96: 96 Kbps

128128: 128 Kbps

00: ALC settings OFF

1

1: ALC settings ON

0

0 : Off

1

1 : Onaudio_transmi

0

0 : Offt

1

1 : Onequalizer

off

off: Off

low_cut

low_cut: Low cut

0

0: Off (manual setting)1

1: On (auto setting)external

external External microphoneinternal

internal

audio_alc
plugin_power

audio_lv_auto
mic_selectMethodAccess level

Internal microphone: POST: Admin

CGI item nameVolume level settingURL/cgi-bin/set_volu

Parameter

Parameter

name

value

volume_lv

0 to 23

Description
0 to 23 levels

me_lv

POVCAM Interface Specifications Video Transmission / Clip Operation28

* When enabling audio input, set audio and audio_sens as a set.
If audio_sens is not specified, an error will be returned.

Usage example) Setting audio input to the internal microphone when using the camera head
http://192.168.0.10/cgi-bin/set_audio?audio=1&audio_sens=middle&mic_select=internal

Usage example) Setting audio input to the external microphone when using the recorder
http://192.168.0.10/cgi-bin/set_audio?audio=1&audio_sens=middle&mic_select=external

Usage example) Setting audio input to LINE when using the recorder
http://192.168.0.10/cgi-bin/set_audio?audio=1&audio_sens=line_middle

Usage example) Setting audio input to SDI when using the recorder
http://192.168.0.10/cgi-bin/set_audio?audio=1&audio_sens=sdi

Usage example) Setting audio input to a plug-in powered microphone when using the recorder
http://192.168.0.10/cgi-bin/set_audio?audio=1&audio_sens=middle&mic_select=external&plugin_powe
r=1

Usage example) Setting audio input to OFF
http://192.168.0.10/cgi-bin/set_audio?audio=0

POVCAM Interface Specifications Video Transmission / Clip Operation29

4.5. Multi-screen Settings
MethodAccess level: POST: Admin

CGI item nameMulti-screen settings

URL

Parameter

Parameter

Description

name

value

/cgi-bin/multi_scr

multi_addr1"*.*.*.*" format"*.*.*.*" format oreen

multi_addr2

or"*.*.*.*: 1 to 65535" ormulti_addr3"*.*.*.*: 1 to"String" ormulti_addr465535" or"String": 1 to 65535"

multi_addr5"String" ormulti_addr6"String": 1 tomulti_addr765535"

multi_addr8
multi_addr9
multi_addr10
multi_addr11
multi_addr12
multi_addr13
multi_addr14
multi_addr15
multi_addr16
multi_name1

String (within

multi_name2

20 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/UCK20 in the first frame.
http://192.168.0.10/cgi-bin/multi_screen?multi_addr1=192.168.0.100&multi_name1=UCK20POVCAM Interface Specifications Video Transmission / Clip Operation30

4.6. rk Settings
MethodAccess level: POST: Admin

CGI item name
Network settings

URL/cgi-bin/network

Parameter

Parameter

name

value

dhcp

Description

0

0: DHCP OFF (Static settings)

1

1: DHCP ON

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

0 to 255

Primary server address (DNS)

pri_server1

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)First octet

sec_server2

0 to 255

Secondary server address (DNS)
Second octet

sec_server3

0 to 255

Secondary server address (DNS)
Third octet

sec_server4

0 to 255

Secondary server address (DNS)
Fourth octet

rtp_packet_m

1500

RTP packet max. transmission size

ax

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)

POVCAM Interface Specifications Video Transmission / Clip Operation

31

CGI item name

URL

Parameter

Parameter

name

value

time

Description

20

Effective limit

unlimited

20: 20 minutes
unlimited: Unlimited

bandwidth0Transmission volume of entire

1024

network2048

0: Unlimited

4096

1024: 1024kbps

8192

2048: 2048kbps

16384

4096: 4096kbps

32768

8192: 8192kbps

1000016384: 16384kbps
32768: 32768kbps
10000: Unlimited* When 10000 is received, an error is
not issued, and the operation is
performed by assuming "Unlimited".

Easy IP Setup/cgi-bin/easyipset

rtsp_port

1 to 65535

The RTSP waiting port

timeunlimited,

Time period during which Easy IP

20

Setup can be performed from theprotocol settings

time power is turned ON
unlimited: Unlimited
20: 20 minutes
Transmission/cgi-bin/set_band

volume of entire

width

bandwidth

network

0

Transmission volume of entire

1024

network2048

0: Unlimited

4096

1024: 1024kbps

8192

2048: 2048kbps

16384

4096: 4096kbps

32768

8192: 8192kbps

1000016384: 16384kbps
32768: 32768kbps
10000: Unlimited* When 10000 is received, an error is
not issued, and the operation is
performed by assuming "Unlimited".

Max. packet length
settings/cgi-bin/set_rtp

rtp_size

1280

1280: Max. packet length limit

1500

1500: Normal packet length

POVCAM Interface Specifications Video Transmission / Clip Operation

32

4.7. UPnP Settings
MethodAccess level: POST: Admin

CGI item nameUPnP settings

URL/cgi-bin/upnp

Parameter

Parameter

name

value

Description

upnp_portma

0Auto port-forwardingp1

0: Disabled
1: Enabled

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

4.8. Restarting
MethodAccess level: POST: Admin

CGI item name
InitializationURL/cgi-bin/initial

Parameter

Parameter

name

value

Description

cmd

reset

Camera restart

Randomnum

Hexadecimal

16 single-byte character string

stringUsage example) Restarting
http://192.168.0.10/cgi-bin/initial?cmd=reset&Randomnum=12345

POVCAM Interface Specifications Video Transmission / Clip Operation

33

5. CGI List for Acquisition of Different Types of Information
5.1. Priority Mode Settings Information Acquisition
MethodAccess level: GET: LiveCGI item name

URL

Priority mode

/cgi-bin/get_prioriacquisition

ty_modeParameter

Parameter

name

value

Description

The response data is as shown below.
priority_mode = xxx* For details on the value notified by xxx, see the parameters of set_priority_mode.

5.2. Basic Settings Information Acquisition
MethodAccess level: GET: LiveCGI item name

URL

Basic settings/cgi-bin/get_basi

informationc

Parameter

Parameter

name

value

Description

acquisition

The response data is as shown below.
cam_title = Camera title
plugin_download = enable/disable
plugin_disp = 0/1

POVCAM Interface Specifications Video Transmission / Clip Operation

34

5.3. NTP Settings Information Acquisition
MethodAccess level: GET: Admin

CGI item name
NTP settings

URL

Parameter

Parameter

name

value

Description/cgi-bin/get_time

information acquisition

The response data is as shown below.
time_adjust = 0/1
ntp_addr_dhcp = 0/1
ntp_addr = String
ntp_port = Numeric value (1 to 65535)
ntp_interval = Numeric value (1 to 24)

5.4. Clock Settings Information Acquisition
MethodAccess level: GET: LiveCGI item name

URL

Clock settings/cgi-bin/get_date_

information acquisition

time

Parameter

Parameter

name

value

Description

The response data is as shown below.
display = 0/1
date_year = Numeric value
date_month = Numeric value
date_day = Numeric value
date_hour = Numeric value
date_min = Numeric value
date_sec = Numeric value
timezone = Numeric value (1 to 74)
summer_time = 0/1/2
start_month = Numeric value
start_week = Numeric value (1 to 5)
start_dotw = Numeric value (0 to 6)
start_hour = (0 to 23)
end_month = Numeric value
end_week = Numeric value (1 to 5)
end_dotw = Numeric value (0 to 6)
end_hour = Numeric value (0 to 23)
is_summer_time = 0/1 (0: OFF, 1: ON)
POVCAM Interface Specifications Video Transmission / Clip Operation

35

5.5. VideoOverIP Screen Information Acquisition
MethodAccess level: GET: LiveParameter

Parameter

name

value

CGI item name

URL

VideoOverIP screen/cgi-bin/get_vide▪ Responses are issued in a random order.

informationo_over_ip▪ If transmission for a specific channel isacquisition

Description

not possible due to the specifications, theresponse for the desired channel is not
returned or is an invalid value.

The response data is as shown below.
livestart_stream=h264/h264_2/jpeg
jpeg_quality=1/5
resol_stream1=640
jpeg_transmit1=0/1
jpeg_interval1=5/15(12.5)/30(25)h264_transmit_ch1=0/1
h264_transmit_ch2=0/1
h264_rtsp_mode_ch1=0/1
h264_rtsp_mode_ch2=0/1
h264_resolution_ch1=640/1280/1920/3840
h264_resolution_ch2=640/1280
h264_f_priority_ch1=0/1/2
h264_f_priority_ch2=0/1/2
h264_framerate_ch1=5/15(12.5)/30(25)/60(50)h264_framerate_ch2=5/15(12.5)/30(25)h264_bandwidth_ch1 = Numeric value
h264_bandwidth_ch2 = Numeric value
h264_bandwidth_min_ch1 = Numeric value
h264_bandwidth_min_ch2 = Numeric value
h264_quality_ch1=fine/low1/5
h264_quality_ch2=fine/low1/5
h264_unimulti_ch1=uni/multi/uni_manualh264_unimulti_ch2=uni/multi/uni_manualh264_unicast_port_ch1 = Numeric value (1024 to 50000)
h264_unicast_port_ch2 = Numeric value (1024 to 50000)
h264_unicast_audio_port_ch1 = Numeric value (1024 to 50000)
h264_unicast_audio_port_ch2 = Numeric value (1024 to 50000)
h264_multicast_addr_ch1=xxx.xxx.xxx.xxx
h264_multicast_addr_ch2=xxx.xxx.xxx.xxx
h264_multicast_port_ch1 = Numeric value (1024 to 50000)
h264_multicast_port_ch2 = Numeric value (1024 to 50000)
h264_multicast_ttl_ch1 = Numeric value (1 to 254)
h264_multicast_ttl_ch2 = Numeric value (1 to 254)

POVCAM Interface Specifications Video Transmission / Clip Operation

36

5.6. Audio Settings Information Acquisition
MethodAccess level: GET: LiveCGI item name

URL

Audio settings/cgi-bin/get_audi

informationoParameter

Parameter

name

value

Description

acquisition

For the response data, see /cgi-bin/set_audio.

5.7. Multi-screen Settings Information Acquisition
MethodAccess level: GET: LiveCGI item name

URL

Multi-screen settings/cgi-bin/get_multi

information_screenParameter

Parameter

name

value

Description

acquisition

The response data is as shown below.
multi_addr1 = "*.*.*.*" format/"*.*.*.*: 1 to 65535"/"String"/"String": 1 to 65535"
multi_name1 = String (within 20 double-byte characters)
multi_addr2 = "*.*.*.*" format/"*.*.*.*: 1 to 65535"/"String"/"String": 1 to 65535"
multi_name2 = String (within 20 double-byte characters)
multi_addr3 = "*.*.*.*" format/"*.*.*.*: 1 to 65535"/"String"/"String": 1 to 65535"
multi_name3 = String (within 20 double-byte characters)
multi_addr4 = "*.*.*.*" format/"*.*.*.*: 1 to 65535"/"String"/"String": 1 to 65535"...
multi_addr16 = "*.*.*.*" format/"*.*.*.*: 1 to 65535"/"String"/"String": 1 to 65535"
multi_name16 = String (within 20 double-byte characters)

POVCAM Interface Specifications Video Transmission / Clip Operation

37

5.8. Network Settings Information Acquisition
MethodAccess level: GET: Admin

CGI item name

URL

Network settings/cgi-bin/get_netw

information

ork

Parameter

Parameter

name

value

Description

acquisition

The response data is as shown below.
ip4_dhcp=0/1
ip4_addr=*.*.*.*
ip4_netmask=*.*.*.*
ip4_gateway=*.*.*.*
ip4_pri_server=*.*.*.*
ip4_sec_server=*.*.*.*
port = Numeric value (1 to 65535)
dns=auto/manual
rtp_packet_max=1500/1280
mss=1024/1280/1460
bandwidth=0/64/128/256/384/512/768/1024/2048/4096/8192
time=20/unlimited
rtsp_port=0 (Fixed)

5.9. UPnP Settings Information Acquisition
MethodAccess level
CGI item nameUPnP settings: GET: Admin
URL

Parameter

Parameter

name

value

Description/cgi-bin/get_upnp

informationacquisition

The response data is as shown below.
upnp_portmap = 0/1

POVCAM Interface Specifications Video Transmission / Clip Operation

38

5.10. UPnP Execution Results Acquisition
MethodAccess level: GET: Admin

CGI item name
Status acquisitionURL/cgi-bin/get_statu

Parameter

Parameter

name

value

-

-

Description
UPnP execution results

The response data is as shown below.
http_port = Numeric value
http_status = enable/disable
https_port = Numeric value
https_status = enable/disable
addr = String

5.11. System Log Information Acquisition
MethodAccess level: GET: Admin

CGI item name
System log

URL

Parameter

Parameter

name

value

Description/cgi-bin/get_syst

type

eventlog

eventlog: Event log

emlog

num

Numeric value

Acquisition number(1 to 300)
index

Numeric value

Acquisition start position(1 to 300)

Usage example) Event log acquisition
http://192.168.0.10/cgi-bin/get_systemlog?type=eventlog

The response data is as shown below.
no¥mm/dd/yyyy hh:mm¥event code¥description$no¥mm/dd/yyyy hh:mm¥event code¥description$・・・* No line feed.
A "¥" is entered between two parameters.
A "$" is entered between numbers, such as between no1 and no2.

POVCAM Interface Specifications Video Transmission / Clip Operation

39

5.12. Other Setting Values Acquisition
MethodAccess level
CGI item name
Setting value: GET: AdminURL/cgi-bin/getdata

Parameter
namereqParameter value-

acquisition CGI

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
livesize

livesize: JPEG(1) image resolution

livequal

livequal: JPEG(1) image qualityh264

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

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
numberPOVCAM Interface Specifications Video Transmission / Clip Operation

40

CGI item name

URL

Parameter
name

Parameter value

Description

h264profile

H.264 profile

h264codind

H.264 encoding system

h264_2h.264_2: h.264 transmission ON/OFF2

h264bwc_2

h.264bwc_2: Bit rate 2 per client

h264size_2

h.264size_2: h.264 resolution 2

h264qual_2

h.264qual_2: h.264 image 2

h264rint_2

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

h264mtd_2

h.264mtd: h.264 transmission method2h264mladd1_2

h.264mladd1_2: h.264 multicast
address First 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

h.264uniport2_2: Unicast (for audio)
port number 2

h264profile_2

H.264 profile 2

h264codind_2

H.264 encoding system 2

h264mlauto

H264(1) multicast auto start

h264mlauto_2

H264(2) multicast auto startaudio_level

audio_level: Audio authorization andauthentication level setting

audio_sensaudio_sens: Sound collection
sensitivity

nrlivequal

nrlivequal: JPEG image quality at
which transmission does not stop

nrh264size

nrh264size: H.264 resolution at whichtransmission does not stop

nrh264qual

nrh264qual: H.264 image quality at
which transmission 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

POVCAM Interface Specifications Video Transmission / Clip Operation

41

CGI item name

URL

Parameter
name

Parameter value
nrh264qual_2

Description
nrh264qual_2: H.264 image quality 2
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(None)

h264nrframerate_

h264nrframerate_2: H.264(2) frame

2

rate

h264bwcmin_2

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

livequalbase

JPEG default image quality

liveframerate

Live screen initial frame rate (JPEG)

plugin_halftone_jp

Enabling/disabling of half-tone functioneg

for JPEG images in Active X

plugin_halftone_h

Enabling/disabling of half-tone function

264

for H.264 movies in Active X－

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

For details, see "Acquiring the List of Setting Values."

POVCAM Interface Specifications Video Transmission / Clip Operation

42

6. Acquiring the List of Setting Values
MethodAccess level: GET: LiveCGI item nameAcquisition of list of

URL

Parameter

Parameter

name

value

/cgi-bin/setdata

Description
Parameters are not required.

setting values

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

Value

Description

CAMTITLE

StringCamera name

IMAGESELECT

2m

Imaging mode 2m: 2 M pixel

IMAGERATIO

16_9

Image ratio 16_9: 16:9 mode

IMAGEFPS

30

Frame rate 30: 30 fps

LIVESTREAM

h264

Live screen initial stream selection

h264_2

h264:H264(1)jpeg

h264_2:H264(2)jpeg:JPEG(1)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 thesystem frequency is 50 Hz

LIVEQUALBASE

1

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

LIVESIZE

640

JPEG(1) image resolution
640:640x360

LIVEQUAL

1

JPEG(1) image quality

5

1: Fine
5: Normal

STREAMMODE

1

Movie transmission method
1: H264

H264
H264_20

H264 transmission ON/OFF

1

0: OFF
1: ON

H264RTSPMODE

0Internet mode ON/OFF

H264RTSPMODE_2

1

0: OFF
1: ON

H264BWC

512,768,1024,1536,

Bit rate per client

POVCAM Interface Specifications Video Transmission / Clip Operation

43

Setting name
H264BWC_2

H264BWCMIN

H264BWCMIN_2

NRH264BWC

Value

Description

2048,3072,4096,6144,

512 (kbps)

8192,10240,12288,

to14336,16384,20480,

24576 (kbps)

24576,32768,40960,

to

51200

51200(kbps)

512,768,1024,1536,

Minimum bit rate per client

2048,3072,4096,6144,

512 (kbps)

8192,10240,12288,

to14336,16384,20480,

24576 (kbps)

24576,32768,40960,

to

51200

51200(kbps)

Numeric value

Bit rate per client at which transmission does not
stop

NRH264BWC_2

Unit [kbps]* The value acquired by setdata depends on theminimum bit rate per client.

H264SIZE

H264SIZE_2

640

H264(1) resolution

1280

640:640x360

1920

1280:1280x720

3840

1920:1920x1080

640

H264(2) resolution

1280

640:640x360
1280:1280x720

NRH264SIZE

640

H264(1) resolution at which transmission does not

1280

stop

1920

640:640x360

3840

1280:1280x720
1920:1920x1080
3840:3840x2160
The value acquired by setdata depends on the valueof H264(1).

NRH264SIZE_2

640

H264(2) resolution at which transmission does not

1280

stop
640:640x360
1280:1280x720
The value acquired by setdata depends on the valueof H264(2).

H264FPRIORITY
H264FPRIORITY_2

0

Transmission mode

1

0:Constant bit rate2

1:Frame rate

H264NRFRAMERAT

5E

15(12.5)30(25)
60(50)

2:Best effort
H264(1) frame rate
5:5fps15(12.5):15(12.5)fps
30(25):30(25)fps
60(50):60(50)fps* The values within () are for the case when thesystem frequency is 50 Hz

POVCAM Interface Specifications Video Transmission / Clip Operation

44

Setting name

Value

Description

H264NRFRAMERAT5

H264(2) frame rate

E_2

15(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 thesystem frequency is 50 Hz

H264QUAL
H264QUAL_2
NRH264QUAL

fine

H264 image quality

lowfine: Image quality priority
low: Motion priority

normalH264 image quality at which transmission does not
stop

NRH264QUAL_2

normal: Standard
H264RINT1

1: 1 second

H264RINT_2
H264MTD
H264MTD_2

Refresh cycleuni

H264 transmission method

uni_manual

uni:Unicast port(AUTO)

multi

uni_manual:Unicast port(MANUAL)
multi:Multicast

H264MLADD1

Numeric value

H264MLADD2

Numeric value

H264(1) multicast address First octet
224 to 239
H264(1) multicast address Second octet
0 to 255

H264MLADD3

Numeric value

H264(1) multicast address Third octet
0 to 255

H264MLADD4

Numeric value

H264(1) multicast address Fourth octet
0 to 255

H264MLADD1_2

Numeric value

H264(2) multicast address First octet
224 to 239

H264MLADD2_2

Numeric value

H264(2) multicast address Second octet
0 to 255

H264MLADD3_2

Numeric value

H264(2) multicast address Third octet
0 to 255

H264MLADD4_2

Numeric value

H264(2) multicast address Fourth octet
0 to 255

H264MLADD

IPv4 address

H264 multicast address

Numeric value

H264 multicast port

H264MLADD_2
H264MLPORT1024 to 50000

H264MLPORT_2
H264MLTTL

Numeric value

H264UNIPORT

Numeric value
Numeric value

H264PROFILE_2

H264 unicast (for audio) port number
1024 to 50000 (only even numbers)

H264UNIPORT2_2
H264PROFILE

H264 unicast (for video) port number
1024 to 50000 (only even numbers)

H264UNIPORT_2
H264UNIPORT2

H264 multicast TTL
1 to 254

H264MLTTL_2

0

H264 profile
0: High profile

POVCAM Interface Specifications Video Transmission / Clip Operation

45

Setting name

Value

Description

RTSPPORT

Numeric value

RTSP server port number

H264MLAUTO

0

Multicast delivery is started automatically.
0: OFF

H264MLAUTO_2
AUDIO

in

Audio settings

offin: ON
off: OFF

AUDIOSENS

middleSee section 5.6.

line_middle
sdi
PLUGIN_POWER

0

See section 5.6.

1
AUDIOMIC

external

See section 5.6.

internal
AUDIOBITRATE

64

Audio bit rate96

64: 64 Kbps

128

96: 96 Kbps
128: 128 Kbps

AUDIOENC

2

Encoder settings
2: AACPLUGIN_HALFTONE

0

_JPEG

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

PLUGIN_HALFTONE
_H264

0

Enabling/disabling of half-tone function for H264 in
Active X
0: Disabled

POVCAM Interface Specifications Video Transmission / Clip Operation46

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

CGI item nameURL

HTTPS self-signed

https_self_signe

certificated

HTTPS CAhttps_signed

Parameter

Parameter

name

value

mode
mode

certificate
HTTPS CRT key

https_crt_key

mode

get_info

get_info: Information confirmation

deletedelete: Delete

get_info

get_info: Information confirmation

deletedelete: Delete

refreshProcessing of CRT key

history usage
HTTPS connection

Description

refresh: Update
set_https

live

methodhttphttp :HTTP

https

https: HTTPS

https_port

1 to 65535

HTTPS port number

StringHost namecountry

StringCountry namestate

StringPrefecture namelocality

String

Locality nameorganization

StringOrganization nameorganization_

StringDepartment name

StringHost namecountry

StringCountry namestate

StringPrefecture namelocality

String

Locality nameorganization

StringOrganization nameorganization_

StringDepartment name

-

-

-

rsa_length

2048

2048: 2048bit

cgi_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

HTTPS self-signed

https_creat_self_common_nam

certificate generate

signedeunit
HTTPS CSR

https_creat_sign

common_nam

generate

ed

e

unit
HTTPS CSR

/cgi-bin/https_dodownload

wnload_csr

HTTPS CAhttps_install_sign

certificate installed

HTTPS CRT key

https_change_crt

generate_key

Status update

renewalstatuskey_create: CRT key generation status

POVCAM Interface Specifications Video Transmission / Clip Operation

47

7.2. Information Acquisition
MethodAccess level: GET: LiveCGI item nameHTTPS settings

URL

Parameter

Parameter

name

value

Description/cgi-bin/get_https

informationacquisition
HTTPS CRT key/cgi-bin/get_crt_k

informationeyacquisition

It is recommended to implement the HTTPS settings through GUI from the WEB menu.
Some models may not have the HTTPS function.

POVCAM Interface Specifications Video Transmission / Clip Operation48

8. CGI List for SD Card Recording
8.1. Video Recording Mode Settings
MethodAccess level: POST: Admin

CGI item name

URL

Parameter

Parameter value

Descriptio

name
SD card recording/cgi-bin/set_sdre

mode settings

c_modemodenmp4_2160_30p_50m

This can be

mp4_2160_24p_50m

set when

mp4_2160_25p_50m

using acamerahead for
REC/PB(4K).

avchd_ps_1080_60p_28m
avchd_ph_1080_60i_21m
avchd_ph_1080_24p_21m
avchd_ha_1080_60i_17m
avchd_he_1080_60i_6m
avchd_ph_720_60p_21m
avchd_pm_720_60i_8m
avchd_ps_1080_50p_28m
avchd_ph_1080_50i_21m
avchd_ha_1080_50i_17m
avchd_he_1080_50i_6m
avchd_ph_720_50p_21m
avchd_pm_720_50i_8m
avchd_ph_1080_60i_21m_from_720

This can be

avchd_ha_1080_60i_17m_from_720

set whenavchd_he_1080_60i_6m_from_720

using theavchd_ph_1080_50i_21m_from_720

recorderavchd_ha_1080_50i_17m_from_720

independe

avchd_he_1080_50i_6m_from_720

ntly.

Usage example) Setting to PS1080/59.94p
http://192.168.0.10/cgi-bin/set_sdrec_mode?mode=avchd_ps_1080_60p_28m

POVCAM Interface Specifications Video Transmission / Clip Operation

49

8.2. Video Recording Mode Acquisition
MethodAccess level: GET: LiveCGI item nameURL

SD card recording/cgi-bin/get_sdre

mode acquisition

c_modeParameter

Parameter

name

value

Description

For the response data, see the setting side.

8.3. Video Recording Media Settings
MethodAccess level: POST: Admin

CGI item name

URL

Video recording/cgi-bin/set_sdre

media settingsc_targetParameter

Parameter

name

value

deviceDescription

sd1

sd1: SD card slot 1

sd2

sd2: SD card slot 2

8.4. Video Recording Media Acquisition
MethodAccess level: GET: Admin

CGI item name

URL

Video recording/cgi-bin/get_sdre

media settingsc_targetParameter

Parameter

name

value

Description

For the response data, see the setting side.

POVCAM Interface Specifications Video Transmission / Clip Operation

50

8.5. Video Folder Name and File Name Settings for MP4 Format
MethodAccess level: POST: Admin

CGI item nameRecorder ID settings

URL/cgi-bin/set_recor

Parameter

Parameter

name

value

recorder_num

0 to 16

der_num

Description
The folder name of video data in MP4
format can be changed. For details,
see the instruction manual.

Clip number reset/cgi-bin/contentn

The folder number for the next

um_resetrecorded MP4 clip is newly updated,
and the file number begins from0001.

For details, see each function in the instruction manual.

8.6. Video Folder Name and File Name Acquisition for MP4 Format
MethodAccess level: GET: Admin

CGI item name

URL

Recorder ID/cgi-bin/get_recor

acquisition

der_num

Parameter

Parameter

name

value

Description

For the response data, see the setting side.

POVCAM Interface Specifications Video Transmission / Clip Operation

51

8.7. Video Recording Start/End Control
MethodAccess level: GET: LiveCGI item nameVideo RecordingURL/cgi-bin/sdctrl

Parameter

Parameter

name

value

save

Start/End Control

Description

start

start: Recording start

end

end: Recording end

Usage example) Starting video recording to the SD card
http://192.168.0.10/cgi-bin/sdctrl?save=start
Usage example) Ending video recording to the SD card
http://192.168.0.10/cgi-bin/sdctrl?save=end

・ Both recording start and recording end require a few seconds as processing time. Secure some interval
time during operation.
・ When recording started/stopped correctly, "204 No Content" is issued as the response.
・ When, a command such as the recording start command is issued in the state of no SD card inserted,"500 Internal Server Error" is issued as the response. It is also issued as the response if the recording
start command is issued while recording is in progress.
・ For the query of whether or not recording is in progress, see section 9.1.

POVCAM Interface Specifications Video Transmission / Clip Operation52

9. CGI List for SD Card Status Acquisition and Formatting (Initialization)
9.1. SD Card Relationship Status Acquisition
MethodAccess level: GET: LiveCGI item nameURL

SD card relationship/cgi-bin/get_stateParameter

Parameter

name

value

Description

status acquisition

Usage example) Acquiring SD card relationship status (enabled only in imaging mode, disabled in playback
mode and standby)
http://192.168.0.10/cgi-bin/get_state

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

Value of response

Description

recoff,onon: Video recording in progress

pre_rec

off,onon: PRE-REC menu is ON

rec_counter

00:00:00

Recording elapsed time

ftp_send

off,onon: FTP transfer in progress

play

off

(Fixed value)del_file

off,onon: Clip (MP4/AVCHD) deletion in progress

download

off,onon: Clip (MP4/AVCHD) downloading in progress

sd_format

off,onon: SD card formatting (initialization) in progress

sd_insert

off,onon: SD card slot 1 is inserted

sd_repairoff,onon: SD card slot 1 repair in progress

sd_erroroff,onon: SD card slot 1 in error statesd_rem

*****SD card slot 1 media remaining amount (unit: Gbyte)

sd_org*****SD card slot 1 media capacity (unit: Gbyte)

sd2_insert

off,onon: SD card slot 2 is inserted

sd2_repair

off,onon: SD card slot 2 repair in progress

sd2_error

off,onon: SD card slot 2 in error statesd2_rem*****

SD card slot 2 media remaining amount (unit: Gbyte)

sd2_org*****

SD card slot 2 media capacity (unit: Gbyte)

The recording status and counter information can be acquired by polling this CGI at regular intervals.
Leaving a gap of at least 1000 msec between each polling is recommended.

POVCAM Interface Specifications Video Transmission / Clip Operation

53

9.2. SD Card Format (Initialization) Control
MethodAccess level: POST: Admin

CGI item nameSD card format

URL/cgi-bin/sdcard

Parameter

Parameter

name

value

cmd

formatDescription
Formatting (initialization) of SD cardin slot 1

format2

Formatting (initialization) of SD cardin slot 2

Usage example) Starting formatting (initialization) of SD card in slot 1
http://192.168.0.10/cgi-bin/sdcard?cmd=format* If you perform formatting during the use of the SD card, "ErrorNo=3" is returned in the main text. You
cannot perform formatting in such a case.
* Depending on the type and state of the card, formatting (initialization) of the SD card may be
performed after complete erasure of the SD card. In such a case, a maximum processing time of
approximately 120 seconds is required. Issue the next command after confirming completion offormatting with cgi-bin/get_progress.

9.3. SD Card Format (Initialization) Progress Confirmation
MethodAccess level: GET: Admin

CGI item name

URL

Progress/cgi-bin/get_prog

confirmation

ress

Parameter

Parameter

name

value

type

formatDescription
Acquisition of formatting progress of
SD memory card

The response data is as shown below.
progress=xxx* Value to be entered in xxx
prepare: Preparation in progress
exec: Processing in progress
finish: Completed
cancel: Cancellation in progress
error: Termination with an error

POVCAM Interface Specifications Video Transmission / Clip Operation

54

10. CGI List for Recorded Clips (MP4/AVCHD)
10.1. Clip (MP4/AVCHD) List Search
MethodAccess level: GET: LiveCGI item name

URL

Clip list search of SD/cgi-bin/get_clip_l

card

ist

Parameter

Parameter

name

value

maxmatches

1 to 15

Description
Upper-limit of number of lists to beacquired* Can be omitted

index

Numeric value

List search start position
1 to 65535

devicesd1

sd1: SD card of slot 1

sd2

sd2: SD card of slot 2
Equivalent to sd1 when omitted.

formatmp4

mp4: MP4 format

avchd

avchd: AVCHD format

Usage example) Acquiring AVCHD format list from SD card in slot 2
http://192.168.0.10/cgi-bin/get_clip_list?index=1&device=sd2&format=avchd
The response data is as shown below.
no,filename,mm/dd/yyyy hh:mm:ss,duration[CR][LF]・・・
ClipfileNum = Numeric value (acquired number of lists) [CR][LF]
ClipfileALLNum = Numeric value (total number of files) [CR][LF]
list_id = Numeric value
The response data example is as shown below.
no,filename,mm/dd/yyyy hh:mm:ss,duration
1,S1AA001000000160,06/26/2017 20:12:02,00:00:12
2,S1AA001000000260,06/26/2017 20:13:10,00:00:02
ClipfileNum=2
ClipfileALLNum=2
list_id=5777
Note that mm/dd/yyyy hh:mm:ss and duration indicate the recording start date and time and recording
elapsed time of the corresponding clip.
list_id on the last line is a unique value for the acquired file list. It is used for deletion, download, and FTP
transfer.

POVCAM Interface Specifications Video Transmission / Clip Operation

55

10.2. Clip (MP4/AVCHD) Deletion
MethodAccess level: GET: LiveCGI item name

URL

Deletion of stored/cgi-bin/del_clip_f

data

ile

Parameter

Parameter

name

value

filenoNumeric value

Description
File No. acquired by/cgi-bin/get_clip_list* A max. of up to 50 files can be
specified.

list_id

Numeric value

List ID acquired by/cgi-bin/get_clip_list

Usage example) Delete file no. 1 and 2
http://192.168.0.10/cgi-bin/del_clip_file?fileno=1,2&list_id=5777

POVCAM Interface Specifications Video Transmission / Clip Operation

56

10.3. Clip (MP4/AVCHD) Download Control
MethodAccess level: GET: LiveCGI item name

URL

Download through/cgi-bin/get_clip_

file specification

file

Parameter

Parameter

name

value

filename

StringDescription
File name acquired by/cgi-bin/get_clip_list

list_id

Numeric value

List ID acquired by/cgi-bin/get_clip_list

Usage example) Download the file 000120150101.
http://192.168.0.10/cgi-bin/get_clip_file?filename=S1AA001000000160&list_id=5799

10.4. Clip (MP4/AVCHD) Download Sequence

During downloading, a response is issued by assuming the file name (ex. S0M40010000001A0) acquiredby /cgi-bin/get_clip_list as the default file name. After completion of the download, it is recommended torename to the date acquired by /cgi-bin/get_clip_list.

POVCAM Interface Specifications Video Transmission / Clip Operation

57

11. CGI List for FTP Control
11.1. FTP Overview
The following shows the relationship between an FTP server and the memory card portable recorder andspecial optional compact camera head. This document describes the case of using a PC or other device forexternal control.

Transfer Destination FTP Server
Settings
Clip (MP4/AVCHD) List Search

Transfer Content Decision
Issuing Transfer Start Commandwith List
Transfering Clips

Transfer Progress Confirmation

Transfer Progress Confirmation

・ The memory card portable recorder and special optional compact camera head cannot be an FTP
server. They are for sending out only.

POVCAM Interface Specifications Video Transmission / Clip Operation

5811.2. Transfer Destination FTP Server Settings
MethodAccess level: POST: Admin

CGI item name
FTP server settings

URL/cgi-bin/set_ftp

Parameter

Parameter

Description

name

value

server_addr*.*.*.* format*.*.*.* format

username

StringString (within 32 single-bytealphanumeric characters)

password

StringString (within 32 single-bytealphanumeric characters)

port_num

1 to 65535

1 to 65535

mode

activeactive: Active modepassivepassive: Passive mode

StringName of folder to prepare in the user

dirnameroot directory after logging in to the
FTP server (string [within 256
characters])* Characters that can be entered:
Double-byte and single-byte symbols(", &, :)* See section 11.7.

Usage example) Setting FTP server "192.168.0.121." Set ID/PASS of the FTP server as user1/password
and the folder as user1_dir.
http://192.168.0.10/cgi-bin/set_ftp?server_addr=192.168.0.121&username=user1&password=passwor
d&port_num=21&mode=active&dirname=user1_dir

11.3. FTP Server Information Acquisition
MethodAccess level: GET: Admin

CGI item name
FTP server settings

URL

Parameter

Parameter

name

value

Description/cgi-bin/get_ftp

information acquisition

The response data is as shown below.
server_addr=*.*.*.* format
dirname = Stringusername = String
port_num = Numeric value
mode = active/passive

POVCAM Interface Specifications Video Transmission / Clip Operation

5911.4. Issuing/Canceling Transfer Start Command with List
MethodAccess level: POST/GET: Admin

CGI item name

URL

Issuing transfer start/cgi-bin/send_ftp

command with list

serverParameter

Parameter

name

value

filenoNumeric value

Description
File No. acquired by/cgi-bin/get_clip_list* Up to 50 file numbers can be
specified When specifying multiple
files, separate the File No. with a ",".

select_type

filenofileno: File No.

all

all: Specify all* When "all" is specified, do not
specify the File No. to be transferred.

list_id

Numeric value

List ID acquired by/cgi-bin/get_clip_list

Cancellation of/cgi-bin/cancel_stransfer to FTP

end_ftpserver

server* cgi-bin/get_clip_list needs to be used. See section 10.1.

Usage example) Transfer File No. 1 by specifying the file no.
http://192.168.0.10/cgi-bin/send_ftpserver?fileno=1&select_type=fileno&list_id=100
Usage example) Transfer File No. 2 and No. 3 by specifying the file no.
http://192.168.0.10/cgi-bin/send_ftpserver?fileno=2,3&select_type=fileno&list_id=100
Usage example) Transfer all files
http://192.168.0.10/cgi-bin/send_ftpserver?select_type=all&list_id=100
Usage example) Cancel transfer
http://192.168.0.10/cgi-bin/cancel_send_ftpserver

POVCAM Interface Specifications Video Transmission / Clip Operation60

11.5. Transfer Progress Confirmation
MethodAccess level: GET: Admin

CGI item name

URL

Transfer progress/cgi-bin/get_prog

confirmation

ress

Parameter

Parameter

name

value

type

send_ftp

Description
Acquisition of progress of FTP servertransfer

The response data is as shown below.
progress=xxx
rate = Numeric value (%)* Value to be entered in xxx
prepare: Preparation in progress
exec: Processing in progress
finish: Completed
cancel: Cancellation in progress
error: Termination with an error* "rate" indicates the rate of progress.

POVCAM Interface Specifications Video Transmission / Clip Operation

61

11.6. FTP Control Sequence

POVCAM Interface Specifications Video Transmission / Clip Operation

62

11.7. About Folder Settings at the FTP Server SideThe camera transfers the clip (MP4/AVCHD) files inside the SD card to below the designated folder(dirname in FTP server settings) in the transfer-destination FTP server each time a transfer start command(/cgi-bin/send_ftpserver) is issued to the FTP server.

User home folder determined on the FTP server side
Designated folder to be set on camera
side (dirname in FTP server settings)

AW000001
1st FTP transfer
DCIM/AVCHD

AW000002

DCIM/AVCHD

2nd FTP transfer

If the designated folder (dirname in FTP server settings) to be set on the camera side does not exist on the
FTP server side, the camera automatically creates a new folder when transfer starts. **In addition, a sequence number folder starting with "AW" is created under the designated folder, and an SD
card folder image starting with DCIM/AVCHD is transferred into that folder.
If a sequence number folder starting with "AW" exists when the transfer begins, a new folder with thatnumeric value + 1 is created automatically.
Note that if the AW999999 folder exists, FTP transfer cannot be started.

**noteIf FTP transfer fails, the designated folder (dirname in FTP server settings) to be set on the camera side
may not exist. We recommend creating the folder in advance on the FTP server side.

POVCAM Interface Specifications Video Transmission / Clip Operation

6312. About Control Based on RTSP
The memory card portable recorder and special optional compact camera head support general RTSP
protocols as well. This chapter illustrates usage methods based on RTSP. When using such usage methods,
you must have knowledge of RTSP/RTP/RTCP.

12.1. About URLs for RTSP Request
The URLs for RTSP requests of the memory card portable recorder and special optional compact camera
head are as follows.
Request URL
Description
Videos set in WEB menu H264(1) of the camera can
rtsp://<cam_ip>/mediainput/h264/stream_1
be requested.
Videos set in WEB menu H264(2) of the camera can
rtsp://<cam_ip>/mediainput/h264/stream_2
be requested.
The RTSP port on the camera (RTSP Server) side is set to 554 in the factory settings. If it needs to bechanged, use cgi-bin/set_rtsp (POST command).

The relationship between "H.264 transmission" and "Audio Transmission" in the WEB menu of the memory
card portable recorder and special optional compact camera head is as follows.
Audio Transmission
ON
OFF
Both video and audio can be used. Only video can be used.
* As for DESCRIBE,* As for DESCRIBE,ONthe SDP information of video +only the SDP information ofaudio is issued as response.
video is issued as response.
H.264 transmission
OFF

Both video and audio cannot be used.
* As for SETUP, 503 is issued as response.

When "Audio Transmission" is ON, the 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 thecontrary, if the SETUP command is not issued, only the video can be transmitted. Moreover, if "Audio" in the
WEB menu of the camera is "OFF," or nothing is connected to the "Audio IN terminal," it results intransmission without sound.
In this document, descriptions are with "H.264 transmission" and "Audio Transmission" in the ON state.

POVCAM Interface Specifications Video Transmission / Clip Operation

6412.2. About the RTSP Methods
The RTSP methods supported in the 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.

POVCAM Interface Specifications Video Transmission / Clip Operation

65

13. About Acquisition of Stream from RTSPThe RTSP communication methods supported in the camera are as described below. No matter which
method is used, TCP communication (554 is set as the waiting port at the camera side) is used during initialnegotiation of RTSP.
1.UDP Unicast▪ Used for transmitting video/audio to a single client in one 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 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 camera.
▪ The video and audio data communicated via RTP/UDP can be transmitted via TCP.

13.1. UDP Unicast
You must make the settings described below in the WEB menu as preparations at the camera side.
▪ Set H264(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 camera in the 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 camera):
The camera responds to the client with a 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 H264(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 is ignored, and thus is not used normally.
The acquisition method of video and audio stream by the UDP Unicast method is illustrated below.

POVCAM Interface Specifications Video Transmission / Clip Operation

66

UDP Unicast Sequence

POVCAM Interface Specifications Video Transmission / Clip Operation

67

UDP Unicast Packets(1/2)

POVCAM Interface Specifications Video Transmission / Clip Operation

68

UDP Unicast Packets(2/2)

POVCAM Interface Specifications Video Transmission / Clip Operation

69

13.2. UDP Multicast
You must make the settings described below in the WEB menu as preparations at the camera side.
▪ Set H264(X)/Transmission type to Multicast.
▪ Set H264(X)/Multicast address (set to 239.192.0.20 for H264(1) according to factory settings)▪ Set H264(X)/Multicast port (set to 37004 for H264(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 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.

POVCAM Interface Specifications Video Transmission / Clip Operation

70

UDP Multicast Sequence

POVCAM Interface Specifications Video Transmission / Clip Operation

71

UDP Multicast Packets(1/2)

POVCAM Interface Specifications Video Transmission / Clip Operation

72

UDP Multicast Packets(2/2)

POVCAM Interface Specifications Video Transmission / Clip Operation7313.3. TCP Unicast
You must make the settings described below in the WEB menu as preparations at the camera side.
▪ Set H264(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 becomes thereceiving 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 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.

POVCAM Interface Specifications Video Transmission / Clip Operation

74

TCP Unicast Sequence

POVCAM Interface Specifications Video Transmission / Clip Operation

75

TCP Unicast Packets 1/2

POVCAM Interface Specifications Video Transmission / Clip Operation

76

TCP Unicast Packets 2/2

POVCAM Interface Specifications Video Transmission / Clip Operation

7713.4. About the rtpmap Attribute
The response of "rtpmap" with respect to the RTSP "DESCRIBE" request is as described below.
Codec
H.264
AAC

rtpmap Attribute Value
a=rtpmap:98 H264/90000
a=rtpmap:99 mpeg4-generic/48000/2

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

POVCAM Interface Specifications Video Transmission / Clip Operation

78

14. About Control Based on RTCP
The camera also supports dynamic control of bit rate and frame rate according to the line status using
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 camera side.
▪ Set H264(X)/Transmission priority to Best effort.
* In the case of the frame rate (factory settings) and constant bit rate, an RTCP/SR istransmitted and an RTCP/RR is received, but these are not used for controlling the bit rate
and frame rate.
▪ Select H264(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 camera, an RTCP/SR is transmitted every five seconds, and of the RTCP/RRs, only thoserelated to VIDEO are used.

POVCAM Interface Specifications Video Transmission / Clip Operation

7915. About RTP/Data Format
15.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

16

Extension length
Additional Information (1)Additional 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) (*)

POVCAM Interface Specifications Video Transmission / Clip Operation8015.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

#2

#3

Ether/IPh/UDPh

RTPh SPS#4

Ether/IPh/UDPh

RTPh PPS#5Ether/IPh/UDPh

RTPh

SEI

#6

Ether/IPh/UDPh

RTPh

FUi

FUh

RBSP

#N

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(1Byte)Fui:FU identifier(1Byte)Fuh:FU header (1Byte)

Ether/IPh/UDPh:Ether/IP header/UDP header

RTPh:RTP header

POVCAM Interface Specifications Video Transmission / Clip Operation8115.3. H.264 Syntax
In the camera, the Codec information to be used changes depending on the resolution/frame rate.
The following information is used when 59.94 Hz is set.
Resolution / Frame rate
640x360/5p,15p,30p
1280x720/5p,15p,30p,60p
1920x1080/5p,15p,30p

Codec Info
H.264/High profile (no B frame/CAVLC)GOP interval approx 1 sec.
H.264/High profile (no B frame/CABAC)GOP interval approx 1 sec.
H.264/High profile (no B frame/CABAC)GOP interval approx 0.5 sec.
H.264/High profile (B frame present/CABAC)GOP interval approx 0.5 sec.

1920x1080/60p
3840x2160/5p,15p
3840x2160/30p

15.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:
An AU header (2 bytes) is inserted between the RTP header and audio data, and then transmitted.

RTP Header

AU Header

ES(AUDIO data)

POVCAM Interface Specifications Video Transmission / Clip Operation

82

Memo:POVCAM Interface Specifications Video Transmission / Clip Operation

83