VIVOTEK VC8201

Video Integration Guide

V1.0

 2014 VIVOTEK INC. All Rights Reserved

VIVOTEK may make changes to specifications and product descriptions at any time,
without notice.
The following trademark belongs to VIVOTEK INC., and may only be used to identify
VIVOTEK products: VIVOTEK. Other products and company names contained herein
may be the trademarks of their respective owners.
No part of this publication may be reproduced or employed in any form or by any
means, electronic or mechanical, including photocopying and microfilm, without
written authorization from VIVOTEK INC.
Revision History
Version
1.0

Issue date

Editor

Comment

2014/07/29 Dave, Tsai First version

Table of Contents
1.

Introduction ....................................................................................................................... 4

2.

Channel and Sensor Information....................................................................................... 4

2.1.

Mounted Sensor Module ......................................................................................... 4

2.2.

Resolution Options................................................................................................... 5

2.3.

Maximum Frame Rate.............................................................................................. 7

3.

Video Setting ..................................................................................................................... 9

4.

Image Setting ..................................................................................................................... 9

5.

Streaming Service ............................................................................................................ 12

1. Introduction
VC8201 is the first among VIVOTEK products equipped with "changeable sensors"
and "multi-channel architecture.". All APIs follow the rules described in the following
document: VIVOTEK_WebAPI_VideoStreaming_20131225.docx. The following guide
contains simple cases, limitations, and notices to assist rapid VC8201 integration.

2. Channel and Sensor Information

VC8201 detects sensors during booting; however, the following two limitations are
present:
1. The sensor module must be connected to VC8201 prior to power-on.
2. Remove/Change sensor following boot-up will trigger VC8201 reboot to
re-detect the sensor.
When launching, two sensor modules are available: CU8171 and CU8131.
Module

Type

Resolution

FPS

CU8171

3 Mega-pixel sensor with fisheye lens

1696x1696

15

CU8131

1 Mega-pixel WDR sensor

1280x800

30

Two channels of VC8201 can be mounted with identical or different sensors. A

service provided by a channel is dependent on the sensor. As described in the
following document, the channel's information is recorded in the "Video Mode"
structure: VIVOTEK_WebAPI_VideoStreaming_20131225.docx
The following sections includes sample cases for relevant information.

2.1. Mounted Sensor Module

The mounted sensor can be accessed through the following CGI request:
http://<IP>/cgi-bin/viewer/getparam.cgi?capability_videoin_c<n>_lens
<n> donates the channel index.

For CU8171, the return message is presented as follows:

capability_videoin_c0_lens_type='fisheye'
capability_videoin_c0_lens_modelname='CU8171_VC8201'
capability_videoin_c1_lens_type='fisheye'
capability_videoin_c1_lens_modelname='CU8171_VC8201'
type='fisheye' indicates that this module is equipped with fisheye lens.
modelname='CU8171_VC8201' indicates CU8171 on VC8201.

For CU8131, the return message is presented as follows:

capability_videoin_c0_lens_type='fixed'
capability_videoin_c0_lens_modelname='CU8131_VC8201'
capability_videoin_c1_lens_type='fixed'
capability_videoin_c1_lens_modelname='CU8131_VC8201'
type='fixed' indicates that this module is equipped with fixed-focus lens.
modelname='CU8131_VC8201' indicates CU8131 on VC8201.

For empty (no sensor mounted), the return message is presented as follows:
capability_videoin_c0_lens_type='-'
capability_videoin_c0_lens_modelname='-'
capability_videoin_c1_lens_type='-'
capability_videoin_c1_lens_modelname='-'
'-' indicates that no information is available.

2.2. Resolution Options

Available resolution options can be accessed through the following CGI request:
http://<IP>/cgi-bin/viewer/getparam.cgi?capability_videoin_c<n>_nresolution&
capability_videoin_c<n>_resolution
<n> donates the channel index.
The resolution options can be used to set stream's size with following CGI request:
http://<IP>/cgi-bin/admin/setparam.cgi?videoin_c<n>_s<m>_resolution
<n> donates the channel index, and <m> donates the stream index.
5

For CU8171, the return message is presented as follows:

capability_videoin_c0_nresolution='8'
capability_videoin_c0_resolution='192x192,256x256,384x384,512x512,76
8x768,1056x1056,1536x1536,1696x1696'
capability_videoin_c1_nresolution='8'
capability_videoin_c1_resolution='192x192,256x256,384x384,512x512,76
8x768,1056x1056,1536x1536,1696x1696'
nresolution='8' indicates that there are a total of 8 resolutions available and the
resolutions are listed in the subsequent parameter.

For CU8131, the return message is presented as follows:

capability_videoin_c0_nresolution='5'
capability_videoin_c0_resolution='176x144,320x200,640x400,1280x720,1
280x800'
capability_videoin_c1_nresolution='5'
capability_videoin_c1_resolution='176x144,320x200,640x400,1280x720,1
280x800'
nresolution='5' indicates that there are a total of 5 resolutions available and the
resolutions are listed in the subsequent parameter..
*Note: "1280x720" is a scale down from "1280x800". This option provides superior
display on a 16:9 screen. That is, a full-screen image is presented without blanks on
the left and right sides. However, the image is slightly distorted. When corping
"1280x720" from "1280x800", Region of Interest (ROI) API (or viewing window in
WebUI) should be employed. For further details, please refer to the ROI chapter in
the following document: VIVOTEK_WebAPI_VideoStreaming_20131225.docx

For empty (no sensor mounted), the return message is presented as follows:
capability_videoin_c0_nresolution='1'
capability_videoin_c0_resolution='320x240'
capability_videoin_c1_nresolution='1'
capability_videoin_c1_resolution='320x240'
When no sensors are mounted to a channel, the channel remains available. A
predefined "No Video" image will be produced to the channel.
6

2.3. Maximum Frame Rate

VC8201 opens the frame rate range from 1 to 999 for easy integration.
Frame rate can be set with the following CGI request:
http://<IP>/cgi-bin/admin/setparam.cgi?videoin_c<n>_s<m>_<codec>_maxframe
<n> donates the channel index, and <m> donates the stream index.
<codec> indicates the codec type; VC8201 supports "h264" and "mjpeg".
Setting "maxframe" to a value higher exceeding what the product supports is
equivalent to applying no frame rate limit on the stream. The maximum encoded
frame rate is stored in the "Video Mode" structure. For further information, please
refer to the following section:
The maximum frame rate can be accessed through the following CGI request:
http://<IP>/cgi-bin/viewer/getparam.cgi?capability_videoin_c<n>_<codec>_maxframerate
<n> donates the channel index.
<codec> is the codec type: "h264", "mjpeg" and "mpeg4".

For CU8171, the return message is presented as follows:

At 60 Hz:
capability_videoin_c0_mpeg4_maxframerate='-'
capability_videoin_c0_mjpeg_maxframerate='15,15,15,15,15,15,15,15'
capability_videoin_c0_h264_maxframerate='15,15,15,15,15,15,15,15'
capability_videoin_c1_mpeg4_maxframerate='-'
capability_videoin_c1_mjpeg_maxframerate='15,15,15,15,15,15,15,15'
capability_videoin_c1_h264_maxframerate='15,15,15,15,15,15,15,15'
At 50 Hz:
capability_videoin_c0_mpeg4_maxframerate='-'
capability_videoin_c0_mjpeg_maxframerate='12,12,12,12,12,12,12,12'
capability_videoin_c0_h264_maxframerate='12,12,12,12,12,12,12,12'
capability_videoin_c1_mpeg4_maxframerate='-'
capability_videoin_c1_mjpeg_maxframerate='12,12,12,12,12,12,12,12'
capability_videoin_c1_h264_maxframerate='12,12,12,12,12,12,12,12'
7

The maximum frame rate is one-to-one mapping to the resolution listed in

"capability_videoin_c<n>_resolution".
VC8201 does not support MPEG4; thus, the "maxframerate" is set as "-".

For CU8131, the return message is presented as follows:

At 60 Hz:
capability_videoin_c0_mpeg4_maxframerate='-'
capability_videoin_c0_mjpeg_maxframerate='30,30,30,30,30'
capability_videoin_c0_h264_maxframerate='30,30,30,30,30'
capability_videoin_c1_mpeg4_maxframerate='-'
capability_videoin_c1_mjpeg_maxframerate='30,30,30,30,30'
capability_videoin_c1_h264_maxframerate='30,30,30,30,30'
At 50 Hz:
capability_videoin_c0_mpeg4_maxframerate='-'
capability_videoin_c0_mjpeg_maxframerate='25,25,25,25,25'
capability_videoin_c0_h264_maxframerate='25,25,25,25,25'
capability_videoin_c1_mpeg4_maxframerate='-'
capability_videoin_c1_mjpeg_maxframerate='25,25,25,25,25'
capability_videoin_c1_h264_maxframerate='25,25,25,25,25'
The maximum frame rate is one-to-one mapping to the resolution listed in
"capability_videoin_c<n>_resolution".
VC8201 does not support MPEG4; thus, the "maxframerate" is set as "-".

For empty (no sensor mounted), the return message is presented as follows:
At 50/60 Hz:
capability_videoin_c0_mpeg4_maxframerate='-'
capability_videoin_c0_mjpeg_maxframerate='1'
capability_videoin_c0_h264_maxframerate='1'
capability_videoin_c1_mpeg4_maxframerate='-'
capability_videoin_c1_mjpeg_maxframerate='1'
capability_videoin_c1_h264_maxframerate='1'
VC8201 does not support MPEG4; thus, the "maxframerate" is set as "-".

3. Video Setting
The video settings between sensor modules and channels are individual.
Each video channel of VC8201 saves settings by using the sensor module. That is,
when CU8171 is mounted to CH1, CH1 uses the CU8171 settings. When CU8131 is
mounted to CH1, CH1 uses the CU8131 settings. Settings can only be changed when
the related sensor module is mounted.
*Note: During FW upgrading, only settings of the current mounted sensor modules
are maintained. Additional sensor modules are restored to default.

4. Image Setting
The Image settings between sensor modules and channels are individual. similar to
video, the settings can only be accessed when the related sensor module is mounted.
Image APIs also differ between sensor modules. Information regarding available
image functions is recorded at the following group: capability_image_c<n>, where n
donates the channel index. The information can be accessed through the following
CGI request:
http://<IP>/cgi-bin/viewer/getparam.cgi?capability_image_c<n>
<n> donates the channel index.
The following is a preliminary information structure. A formal structure will be
released shortly.
To date, the information of each sensor module is presented as follows:
For CU8171:
capability_image_c<n>_basicsetting='15'
capability_image_c<n>_wdrpro='0'
capability_image_c<n>_wdrc='1'
capability_image_c<n>_wdrstr='1'
capability_image_c<n>_wdraffect='-'
capability_image_c<n>_dnr='1'
9

capability_image_c<n>_wbmode='auto,manual,rbgain'
capability_image_c<n>_iristype='-'
capability_image_c<n>_exposure_mode='1'
capability_image_c<n>_exposure_levelrange='0,12'
capability_image_c<n>_exposure_winmode='auto,custom,blc'
capability_image_c<n>_exposure_windomain='qvga,std,px'
capability_image_c<n>_exposure_wintype='inclusive,exclusive'
capability_image_c<n>_exposure_winnum='9'
capability_image_c<n>_exposure_maxrange='5,32000'
capability_image_c<n>_exposure_minrange='5,32000'
capability_image_c<n>_agc_maxgain='0,100'
capability_image_c<n>_agc_mingain='0,100'
capability_image_c<n>_flickerless='1'
capability_image_c<n>_blc='0'
capability_image_c<n>_gammacurve='1'
capability_image_c<n>_lowlightmode='1'
capability_image_c<n>_backfocus='0'
capability_image_c<n>_focusassist='0'
capability_image_c<n>_remotefocus='0'

For CU8131:
capability_image_c<n>_basicsetting='15'
capability_image_c<n>_wdrpro='1'
capability_image_c<n>_wdrc='0'
capability_image_c<n>_wdrstr='1'
capability_image_c<n>_wdraffect='exposurelevelFIX6'
capability_image_c<n>_dnr='1'
capability_image_c<n>_wbmode='auto,manual,rbgain'
capability_image_c<n>_iristype='-'
capability_image_c<n>_exposure_mode='1'
capability_image_c<n>_exposure_levelrange='1,8'
capability_image_c<n>_exposure_winmode='auto,custom,blc'
capability_image_c<n>_exposure_windomain='qvga,std,px'
capability_image_c<n>_exposure_wintype='inclusive'
capability_image_c<n>_exposure_winnum='1'
capability_image_c<n>_exposure_maxrange='-'
capability_image_c<n>_exposure_minrange='-'
10

capability_image_c<n>_agc_maxgain='0,100'
capability_image_c<n>_agc_mingain='-'
capability_image_c<n>_flickerless='0'
capability_image_c<n>_blc='0'
capability_image_c<n>_gammacurve='0'
capability_image_c<n>_lowlightmode='1'
capability_image_c<n>_backfocus='0'
capability_image_c<n>_focusassist='0'
capability_image_c<n>_remotefocus='0'

For empty (no sensor mounted):

capability_image_c<n>_basicsetting='0'
capability_image_c<n>_wdrpro='0'
capability_image_c<n>_wdrc='0'
capability_image_c<n>_wdrstr='0'
capability_image_c<n>_wdraffect='-'
capability_image_c<n>_dnr='0'
capability_image_c<n>_wbmode='-'
capability_image_c<n>_iristype='-'
capability_image_c<n>_exposure_mode='0'
capability_image_c<n>_exposure_levelrange='-'
capability_image_c<n>_exposure_winmode='-'
capability_image_c<n>_exposure_windomain='-'
capability_image_c<n>_exposure_wintype='-'
capability_image_c<n>_exposure_winnum='0'
capability_image_c<n>_exposure_maxrange='-'
capability_image_c<n>_exposure_minrange='-'
capability_image_c<n>_agc_maxgain='-'
capability_image_c<n>_agc_mingain='-'
capability_image_c<n>_flickerless='0'
capability_image_c<n>_blc='0'
capability_image_c<n>_gammacurve='0'
capability_image_c<n>_lowlightmode='0'
capability_image_c<n>_backfocus='0'
capability_image_c<n>_focusassist='0'
capability_image_c<n>_remotefocus='0'

11

For further details, please refer to the document: VivotekCameraWebAPI_Image.doc

(not released)

5. Streaming Service
Streaming APIs is compatible with both multi-channel and single-channel versions.
However, the multi-channel version is recommended.
Using RTSP access name as an example:
Multi-Channel

Single-channel

network_rtsp_c0_s0_accessname='live.sdp'

network_rtsp_s0_accessname='live.sdp'

network_rtsp_c0_s1_accessname='lives2.sdp'

network_rtsp_s1_accessname='lives2.sdp'

network_rtsp_c0_s2_accessname='lives3.sdp'

network_rtsp_s2_accessname='lives3.sdp'

network_rtsp_c1_s0_accessname='live2.sdp'

network_rtsp_s3_accessname='live2.sdp'

network_rtsp_c1_s1_accessname='live2s2.sdp'

network_rtsp_s4_accessname='live2s2.sdp'

network_rtsp_c1_s2_accessname='live2s3.sdp'

network_rtsp_s5_accessname='live2s3.sdp'

In this analogy, network_rtsp_c0_s0_accessname and network_rtsp_s0_accessname

are mapped to the identical setting.
Using server push access name as an example:
Multi-Channel

Single-channel

network_http_c0_s0_accessname='video.mjpg'

network_http_s0_accessname='video.mjpg'

network_http_c0_s1_accessname='videos2.mjpg'

network_http_s1_accessname='videos2.mjpg'

network_http_c0_s2_accessname='videos3.mjpg'

network_http_s2_accessname='videos3.mjpg'

network_http_c1_s0_accessname='video2.mjpg'

network_http_s3_accessname='video2.mjpg'

network_http_c1_s1_accessname='video2s2.mjpg'

network_http_s4_accessname='video2s2.mjpg'

network_http_c1_s2_accessname='video2s3.mjpg'

network_http_s5_accessname='video2s3.mjpg'

In this analogy, network_http_c0_s0_accessname and network_http_s0_accessname

are mapped to the identical setting.

12