Panasonic VC1600 Manual
  1. Manuals
  2. Brands
  3. Panasonic Manuals
  4. Touch terminals
  5. VC1600
  6. Manual
Panasonic VC1600 Manual

Panasonic VC1600 Manual

External control interface
Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
KXVC160608
External Control Interface – user's
manual
Ver 1.00
30
Jun. 2016
th
Panasonic System Networks Co., Ltd.
AV Systems Business Unit
1/80

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the VC1600 and is the answer not in the manual?

Questions and answers

Related Manuals for Panasonic VC1600

Summary of Contents for Panasonic VC1600

  • Page 1 KXVC160608 External Control Interface – user’s manual Ver 1.00 Jun. 2016 Panasonic System Networks Co., Ltd. AV Systems Business Unit 1/80...

  • Page 2: Table Of Contents

    KXVC160608 Contents Contents Contents Contents INTRODUCTION ................................6 INTRODUCTION INTRODUCTION INTRODUCTION 1. 1. 1. 1..1.1. URPOSE OF THIS MANUAL ............................6 ..1.2. RITING MATERIALS ..............................6 ..1.3. RODUCTS ..................................6 ..1.4. HARING INFORMATION ............................. 6 EXTERNAL CONTROL OUTLINE EXTERNAL CONTROL OUT LINE ..........................
  • Page 3 KXVC160608 6.1.15. Collect conference information ........................... 28 6.1.16. Confirmation for the camera control propriety (Collect each function) .............. 29 6.1.17. Confirmation for the camera control propriety (Collect all functions in once) ........... 30 6.1.18. Aspect ratio retrieve ............................31 6.1.19. CPn retrieve ................................
  • Page 4 KXVC160608 6.3.1. Pan tilt control ..............................51 6.3.2. Zoom control............................... 51 6.3.3. Recalling registered preset ..........................52 6.3.4. Preset registration ............................... 52 6.3.5. Temporarily prohibition for camera control from other site ................53 6.3.6. Camera setting instruction ..........................53 6.3.7. Focus mode setting .............................
  • Page 5 KXVC160608 NOTES ON THE PC APPL NOTES ON THE PC APPL NOTES ON THE PC APPL NOTES ON THE PC APPLICATION DEVELOPMENT ICATION DEVELOPMENT ICATION DEVELOPMENT ICATION DEVELOPMENT ................... 72 PERIODIC POLLING (RE PERIODIC POLLING (REFERENCE METHOD) FERENCE METHOD) ....................72 PERIODIC POLLING (RE PERIODIC POLLING (RE FERENCE METHOD)

  • Page 6: Introduction

    Version File Link Note 1.3. 1.3. P P P P roducts roducts 1.3. 1.3. roducts roducts There are VC1300 and VC1600. 1.4. 1.4. 1.4. 1.4. S S S S harin harin harin haring g g g information information information information PSN &...

  • Page 7: External Control Outline External Control Out Line

    KXVC160608 2. 2. 2. 2. External control outline 2.1. 2.1. 2.1. 2.1. S S S S ystem ystem ystem ystem construction construction construction construction On the external control interface, it is possible to acquire the HDVC status or control HDVC with PC which is loaded the exclusive application.

  • Page 8: Preparation For The Preparation For The External Control Int Preparation For The External Control Int External Control Interface Function (Cli External Control Int Erface Function (Cli) ) ) )

    KXVC160608 3. 3. 3. 3. Preparation for the external control interface function (CLI) To use this function, the following confirmations/settings are needed with CLI beforehand. See the manual (Settings) for PC settings with using CLI. In addition, when you use this function, port 80 is opened which need to be careful on the security.
  • Page 9 KXVC160608 *In case setting is done by the GUI mode, confirm whether set it up right or not. Carry out “> network get auto”, confirm the network setting.（0: Manual / 1:Auto） 1) When you set up the network setting（0:Manual）, carry out the following commands. >...
  • Page 10 KXVC160608 (9) Setting for device name. Carry out “> devinfo get name”, and the following command if it is set up right names. VALUE > devinfo set name (10) Touch panel login password setting (to change) VALUE Carry out “> tpcpasswd set ”, change the password.

  • Page 11: Management Method

    KXVC160608 4. 4. 4. 4. Management method 4.1. 4.1. 4.1. 4.1. J J J J udge udge udge udge the the command command command propriety command propriety propriety propriety When HDVC activate GUI mode, All CLI command and Remote control emulation are available. If you use external IF in GUI mode, Limitation are exist.

  • Page 12: Cgi Execution Result

    KXVC160608 4.3. 4.3. CGI CGI execution execution result result 4.3. 4.3. execution execution result result 4.3.1. 4.3.1. Format 4.3.1. 4.3.1. CLI command execution result outputs as a XML 1.0 text information. XML data character is the UTF-8. Return code which is included to command retrieve value becomes the LF (0x0A). XML format of using CGI execution result is shown on below chart.

  • Page 13: Special Character Strings Conversion

    KXVC160608 4.3.2. 4.3.2. 4.3.2. 4.3.2. Special character strings conversion Special character in XML converts a based on XML1.0 regulations. Character string in the execution result XML converts a based on the XML regulations. It is avoid collapsing XML format which is included command execution result output’s character strings. PC application can convert to the displayed character with using normal XML library.

  • Page 14: Uthentication Method

    KXVC160608 4.4. 4.4. Authentication Authentication method method 4.4. 4.4. Authentication Authentication method method Authentication is used the digest authentication method. When it required CGI execution to a unit from PC application, it returns the response code “401”with the digest authentication method from unit HTTP server to PC application which requires the authentication, therefore PC application need to send account and password.

  • Page 15: Http Response / Management Result

    KXVC160608 4.6. 4.6. 4.6. 4.6. HTTP HTTP HTTP HTTP response response response / / / / Management response Management Management Management result result result result When this CGI carried out, the following HTTP responses are replied. Factor HTTP status Success Fail to certificate Non-login Login to another system...
  • Page 16 KXVC160608 In addition, on each external control interface command which is for upload or except upload, management result is returned by the XML as a CGI execution result except HTTP response. Management result list is shown on below chart. Value Meaning Explanation/Handling Normal end...

  • Page 17: Rror During Command Execution

    KXVC160608 4.7. 4.7. Error during command execution Error during command execution 4.7. 4.7. Error during command execution Error during command execution In case error occurred during command execution, this code is set up on XML. It shows error during command execution as follows. Value(DEC) Value(HEX) Meaning Explanation/Procedure...

  • Page 18: Ommand List

    KXVC160608 4.8. 4.8. 4.8. 4.8. Command list Command list Command list Command list Ver4.25 Chapter & Section Command name -Ver4.15 Ver4.20 Ver4.30 6 CLI commands 6.1 Get commands 6.1.1 Unit version retrieve version ✔ ✔ ✔ 6.1.2 Firmware ID retrieve fdlfwid ✔...
  • Page 19 KXVC160608 6.2.7 CPn setting cpnlayout ✔ ✔ ✔ 6.2.8 Site name display setting sitename ✔ ✔ ✔ 6.2.9 Audio mixture setting audiofmute ✔ ✔ ✔ 6.2.10 Specified site for audio mixture setting audiomixsite ✔ 6.2.11 Specified position setting profilesitesel ✔ 6.2.12 MCU operation mode setting mcumode...

  • Page 20: Login/Logout

    KXVC160608 5. 5. 5. 5. Login/Logout 5.1. 5.1. L L L L ogin ogin 5.1. 5.1. ogin ogin Carry out “pcLogin.cgi” for login, “pcLogout.cgi” for logout from the PC. Login needs execution before carry out each function. If you do not carry out login, connection information which a unit holds does not update, therefore command interface does not accept unit CGI.

  • Page 21: Ogout

    KXVC160608 5.2. 5.2. 5.2. 5.2. L L L L ogout ogout ogout ogout Command Name Logout CGI execution None parameter Examples for CGI <returns> execution result <cgireturn> (Response value <ret>0</ret> XML) </cgireturn> </returns> Response value Other explanations 1) Carry out in logout. 2) “ret”...

  • Page 22: Cli Commands

    XML) </val> </cmdreturn> Response value 00-04-00-00 : KX-VC1300JP 00-05-00-00 : KX-VC1600JP 02-04-00-00 : KX-VC1300CH 02-05-00-00 : KX-VC1300CH 06-04-00-00 : KX-VC1300(Global, SX) 06-05-00-00 : KX-VC1300(Global, SX) Other explanations 6.1.3. 6.1.3. 6.1.3. 6.1.3. Current value of connection mode retrieve Command Name Connection Mode Retrieve...

  • Page 23: Incoming Call Setting Retrieve

    KXVC160608 6.1.4. 6.1.4. Incoming call setting retrieve 6.1.4. 6.1.4. Command Name Incoming Call Setting Retrieve CGI execution cgicmd=incoming get parameter Examples for CGI <cmdreturn param="incoming get"> execution result <ret>0</ret> (Response value <val>incoming = 1 XML) </val> </cmdreturn> Response value 0：manual answer,1：Auto answer Other explanations 6.1.5.

  • Page 24: Conference Profile Retrieve

    KXVC160608 6.1.7. 6.1.7. Conference Profile retrieve 6.1.7. 6.1.7. Command Name Current conference Profile retrieve execution cgicmd= profile get parameter Examples for CGI <cmdreturn param=”profile get”> execution result <ret>0</ret> (Response value <val>profile = 1 XML) </val> </cmdreturn> Response value Return current profile number. Available in active state only.

  • Page 25: Av Connection State Retrieve

    KXVC160608 6.1.9. 6.1.9. AV connection state retrieve 6.1.9. 6.1.9. Command Name AV Connection State Retrieve CGI execution cgicmd=avstate get n parameter Examples for CGI <cmdreturn param="avstate get terminalinfo vinhdmi1 vinhdmi2 execution result vinhdmipc vinvga vouthdmi1 vouthdmi2 vouthdmi3 vouthdmi (Response value micnum">...

  • Page 26: Screen Layout Information Retrieve

    KXVC160608 6.1.10. 6.1.10. Screen layout information retrieve 6.1.10. 6.1.10. Command Name Screen Layout Information Retrieve CGI execution cgicmd=curlayout get parameter Examples for CGI <cmdreturn param="curlayout get "> execution result <ret>0</ret> (Response value <val>curlayout = 30 XML) </val> </cmdreturn> Response value 30:Other site Main camera, Own main camera (*1)(*2) 31:Own main camera, Other site camera (*1)(*2) 32:Other site Main camera, Other site Main camera(*1)

  • Page 27: Pinp Status Retrieve

    KXVC160608 6.1.11. 6.1.11. PinP status retrieve 6.1.11. 6.1.11. Command Name PinP status retrieve execution cgicmd=displaypip get parameter Examples for CGI <cmdreturn param="displaypip get"> execution result <ret>0</ret> (Response value <val>pattern = 1 XML) </val> </cmdreturn> Response value parameter: Display location 0：Non-display(No PinP) 1:Upper right 2:Lower right 3:Lower left 4:Upper left Other explanations Available at conference only...

  • Page 28: System Management State Retrieve

    KXVC160608 6.1.14. 6.1.14. System management state retrieve 6.1.14. 6.1.14. Command Name System Management State(Trouble Information) Retrieve CGI execution cgicmd=state get unit parameter Examples for CGI <cmdreturn param="state get unit"> execution result <ret>0</ret> (Response value <val>unit = shutdown XML) </val> </cmdreturn> Response value init ：initialization...

  • Page 29: Confirmation For The Camera Control Propriety (Collect Each Function)

    KXVC160608 2: Incoming call 3:Conference 4: Sending the sharing content 5: Receiving the sharing content Or, receiving H.239 dualstream 6: Disconnection However, it is “0” in the self-diagnosis. DTMF propriety（dtmf） on: valid(available to carry out) off: invalid(impossible to carry out) However, "off"...

  • Page 30: Confirmation For The Camera Control Propriety (Collect All Functions In Once)

    KXVC160608 n=wbalance 0=not available to adjust white balance 1=availanle to adjust white balance n=bright 0=not available to adjust brightness 1=available to adjust brightness n=backlight 0=not available to repair back light 1=available to repair backlight n=digitalzoom 0=not available to use digital zoom 1=available to use digital zoom n=pinp 0=not available to use magnifier 1=available to use magnifier n=flicker...

  • Page 31: Aspect Ratio Retrieve

    KXVC160608 0=not available to use zoom 1=available to use zoom presetcall=0 or 1 0=not available to use preset call 1=available to use preset call presetstore=0 or 1 0=not available to use preset registration 1=available to use preset registration focusmode=0 or 1 0=not available to change focus mode 1=available to change focus mode focusarea=0 or 1...

  • Page 32: Cpn Retrieve

    KXVC160608 6.1.19. 6.1.19. CPn retrieve 6.1.19. 6.1.19. Command Name CPn retrieve execution cgicmd=cpnlayout get parameter Examples for CGI <cmdreturn param="cpnlayout get"> execution result <ret>0</ret> (Response value <val>cpn =6 XML) </val> </cmdreturn> Response value cpn:0(auto),1,2,4,6,8,9,10, Other explanations Available at conference 6.1.20. 6.1.20.

  • Page 33: Specified Site For Mixture Audio Retrieve

    <val>0x07000101 sip:192.168.0.106 0 0 2000 0 0 0 202 202 202 112 112 XML) 112 1616 607 0 1792 64 126 0 64 1920 1080 0 1920 1080 3000 0 48 Panasonic KX-VC600 3.21 Rev1 (Profile=5,4,3,2,1)<¥n></val> </cmdreturn> Response value If id is indicated, index can't indicate simultaneously.
  • Page 34 KXVC160608 ・See below for the information in detail. Session ID SIP-URI or H.323 name, H.323 extension number [Character strings] Connect mode(IP mode:0,NAT Traversal mode:2) Communication type( SIP:0,H.323:1) Arbitrated IP rate [kbps] Arbitrated Video rate [kbps] for H.323 only Arbitrated Audio rate [kbps] for H.323 only Encryption(No:0,Yes:1) Arbitration receive codec (Video[Main stream]) *1 Arbitration send codec (Video[Main stream]) *1...

  • Page 35: Static Information Retrieve： Sub Stream

    Receiving frame rate=30, Frequency=0, UserAgent byte=48, UserAgent=" Panasonic KX-VC600 3.21 Rev1 (Profile=5,4,3,2,1)" 0x07000101 sip:192.168.172.140 0 0 2000 0 0 0 202 202 202 117 117 117 1656 605 10 1776 80 125 5 80 1920 1080 0 1920 1080 3000 0 48 Panasonic KX-VC600 3.21 Rev1 (Profile=5,4,3,2,1)<¥n>...
  • Page 36 KXVC160608 ・See below for the information in detail. MCU site [Endpoint is transmitting dual stream.] Session ID Arbitrated receive codec (Video[Main stream]) *1 (Fixed value : 0 ) Arbitrated send codec (Video[Main stream]) *1 (Fixed value : 0 ) Using send codec (Video[Main stream]) *1 Video receiving rate [kbps] : average 5 seconds (including IP header) Video receiving packet (receiving number every 5 seconds) Video receiving packet loss (receiving number every 5 seconds)
  • Page 37 KXVC160608 Horizontal resolution for sending side Vertical resolution for sending side Sending frame rate (100 times value of the real frame rate) (Fixed value : 0 ) Horizontal resolution for receiving side (Fixed value : 0 ) Vertical resolution for receiving side (Fixed value : 0 ) Receiving frame rate (100 times value of the real frame rate) (Fixed value : 0 ) Frequency (Fixed value : 0 )

  • Page 38: Standby State Retrieve

    KXVC160608 -In case of Endpoint [Endpoint is transmitting dual stream.] SessionID = 0x07000001, Negotiated received video codec = 0, Negotiated transmitted video codec H.264 Baseline Profile (Non-Interleaved), Actual transmitted video codec = H.264 Baseline Profile (Non-Interleaved), Received video rate = 0, Received video packet number = 0, Received Video packet loss number = 0, Transmitted video rate = 1368, Transmitted picture width = 1280, Transmitted picture height = 720, Transmitted video rate = 0, Received picture width = 0,...

  • Page 39: Communicating Encoder Information Retrieve

    KXVC160608 6.1.27. 6.1.27. Communicating encoder information retrieve 6.1.27. 6.1.27. Command Name Communicating Encoder Information Retrieve execution cgicmd=videoencodeinfo parameter Examples for CGI <cmdreturn param=" videoencodeinfo "> execution result <ret>0</ret> (Response value <val>1 202 1920x1080 1500<¥n> XML) 2 0 0 0<¥n></val> </cmdreturn> Response value ・See below for the information in detail.

  • Page 40: Ipv4 Address Of Lan1 Retrieve

    KXVC160608 bit9 : Mobile Connection ------------------------------------------------- mask : 0x00000000 - 0x3FFFFFFF *Below is bit operation. ------------------------------------------------- bit0 - 6 : always 0 ------------------------------------------------- bit7 : effective bit for info parameter ------------------------------------------------- bit8 : effective bit for info parameter ------------------------------------------------- bit9 : effective bit for info parameter ------------------------------------------------- Other explanations 6.1.29.

  • Page 41: Ipv6 Address Of Lan1 Retrieve

    KXVC160608 ip : IPv4 address netmask : Subnet mask Other explanations KX-VC1600 only It is not possible to set the network address that is the same as LAN1. When not in use or when not is set, the return value is blank. 6.1.31.

  • Page 42: Ipv4 Dns Retrieve

    KXVC160608 6.1.33. 6.1.33. IPv4 DNS retrieve 6.1.33. 6.1.33. Command Name IPv4 DNS retrieve execution cgicmd=curdns get n parameter n = primary : Primary DNS server n = secondary : Secondary DNS server n = domain : Domain name Examples for CGI <cmdreturn param="curdns get ">...

  • Page 43: Network Status Of Lan2 Retrieve

    KXVC160608 6.1.36. 6.1.36. Network status of LAN2 retrieve 6.1.36. 6.1.36. Command Name Network status of LAN2 retrieve execution cgicmd=nwstate2 get n parameter n = link : Link status n = interface : Interface status Examples for CGI <cmdreturn param=" nwstate2 get "> execution result <ret>0</ret>...

  • Page 44: Etting Commands

    KXVC160608 6.2. 6.2. 6.2. 6.2. Setting Setting Setting Setting c c c c om ommand mand mand mands s s s 6.2.1. 6.2.1. Layout Settings 6.2.1. 6.2.1. Command Name Layout Setting CGI execution cgicmd=layout ( set pattern n) parameter n：30~205 Examples for CGI <cmdreturn param="layout">...

  • Page 45: Master Volume Settings

    KXVC160608 6.2.2. 6.2.2. Master volume settings 6.2.2. 6.2.2. Command Name Volume Setting CGI execution cgicmd=mastervol set n m parameter n：up down m：0-20 (Indicate volume value) Examples for CGI <cmdreturn param="mastervol set down 1"> execution result <ret>0</ret> (Response value <val></val> XML) </cmdreturn>...

  • Page 46: Pinp Setting

    Response value Other explanations ・Indicate start,stop ・Indicate cam2(sub camera),personal computer(pc) ・ This command enables while communication between Panasonic HDVC series. 《In case of The HDVC is not communicating》 Exchange main input image （Same activation as [vsource]. The HDVC don't send DTMF(*10 or *11)）...

  • Page 47: Site Name Display Setting

    KXVC160608 parameter n(分割数 0 means auto. )：0,1,2,4,6,8,9,10 Examples for CGI <cmdreturn param=”cpnlayout set 4”> execution result <ret>0</ret> (Response value <val></val> XML) </cmdreturn> Response value Other explanations ・Available at conference. ・Not available during Multicast. ・If command indicate CPn=0（auto）, CPn change automatically depend on number of connection site.

  • Page 48: Specified Position Setting

    KXVC160608 execution cgicmd= audiomixsite set num n SessionID1 [ SessionID2 ] parameter [ SessionID3 ] [ SessionID4 ] n: number of specified sites for audio mixture (1-4) SessionID1- 4: Session ID 0x07000001-0x0700000a, 0x07000101-0x0700010a, 0x08000001-0x0800000a, 0x08000101-0x0800010a, 0 (own site) Examples for CGI <cmdreturn param="audiomixsite set num 4 0 0x08000101 0x070000003 execution result 0x080000004">...

  • Page 49: Aspect Ratio Settings

    KXVC160608 6.2.13. 6.2.13. Aspect ratio settings 6.2.13. 6.2.13. Command Name Aspect Ratio Settings CGI execution cgicmd= aspect set mode n parameter n：0(=Auto),1(=16:9),2(=4:3) Examples for CGI <cmdreturn param=”aspect set mode 1”> execution result <ret>0</ret> (Response value <val></val> XML) </cmdreturn> Response value Other explanations ・Available at conference and 1:1 connection.

  • Page 50: System Reset

    KXVC160608 set to 2(Voice activation2(site specified)). “0” cannot be set as specified site. ・“3” is available at Ver4.25 or later. *) If own site image mute function enable, This command operation is shown as below 《Indicate site》 Even if the command indicate own site, The HDVC don't change own site to main screen.

  • Page 51: Commands For Camera Control

    KXVC160608 6.3. 6.3. 6.3. 6.3. Commands for Camera control Commands for Camera control Commands for Camera control Commands for Camera control 6.3.1. 6.3.1. Pan tilt control 6.3.1. 6.3.1. Command Name Pan Tilt Control CGI execution cgicmd=cameramove target n mode m direction l parameter n：0 (local site), 1 (opposite site) m：start, stop, adjust...

  • Page 52: Recalling Registered Preset

    KXVC160608 “detail information for each point” of “confinfo” command. mode： start ： activation starts. （ after activation starts, it continues to activate until indication of activation stop. （within the range of camera activation） ） stop：activation stops. adjust：tiny activation（after activation starts, it stops immediately.） *It needs “stop”...

  • Page 53: Temporarily Prohibition For Camera Control From Other Site

    KXVC160608 6.3.5. 6.3.5. Temporarily prohibition for camera control from other site 6.3.5. 6.3.5. Command Name Temporarily prohibition for camera control from other site execution cgicmd=cameraoccupy n parameter n:start, or end CGI execution <cmdreturn param=” cameraoccupy start”> result example <ret>0</ret> (Response value <val></val>...

  • Page 54: Focus Mode Setting

    KXVC160608 6.3.7. 6.3.7. Focus mode setting 6.3.7. 6.3.7. Command Name Focus Mode Setting execution cgicmd=camerafocusmode set n parameter n: auto（Auto）or manual（Manual） CGI execution <cmdreturn param=”camerafocusmode set auto”> result example <ret>0</ret> (Response value <val></val> XML) </cmdreturn> Response value Return Value(ret)： 0:Successful, except 0：Fail （ Mistake for specified parameter or camera without the function, etc.）...

  • Page 55: White Balance Setting

    KXVC160608 which stops the activation (within the camera activation range).） stop：Stop moving the focus adjust ： Tiny movement of focus （ After started activation, stop immediately） ※After “start”, “stop” is necessary ※”adjust” is available to use itself 6.3.10. 6.3.10. White balance setting 6.3.10.

  • Page 56: Brightness Level Setting

    KXVC160608 6.3.12. 6.3.12. Brightness level setting 6.3.12. 6.3.12. Command Name Brightness Level Setting execution cgicmd=camerabrightlevel set n parameter n: Specified direction down（to dark）, up（to bright） CGI execution <cmdreturn param=”camerabrightlevel set down”> result example <ret>0</ret> (Response value <val></val> XML) </cmdreturn> Response value Return Value(ret)：...

  • Page 57: Trimming Zoom Setting

    KXVC160608 6.3.15. 6.3.15. Trimming zoom setting 6.3.15. 6.3.15. Command Name Trimming zoom Setting execution cgicmd=camerapinp set n parameter n: 0(not-display), 1（display） CGI execution <cmdreturn param=”camerapinp set 0”> result example <ret>0</ret> (Response value <val></val> XML) </cmdreturn> Response value Return Value(ret)： 0: Successful, except 0 ： Fail （Mistake for specified parameter or camera without the function, etc.）...
  • Page 58 KXVC160608 All function setting in a lump：not specified n CGI execution <cmdreturn param="camerainfo get focusmode "> result example <ret>0</ret> (Response value <val> XML) focusmode= 1 </val> </cmdreturn> Response value Return Value(ret)： 0:Successful xx: managing setting（TBD） In case of other value Camera is not connected or not supported this function.

  • Page 59: Camera Initialization

    KXVC160608 6.3.18. 6.3.18. Camera initialization 6.3.18. 6.3.18. Command Name Camera Initialization execution cgicmd=camerainit n parameter n: cam1（HDMI main）, cam2（HDMI sub） CGI execution <cmdreturn param=”camerainit cam1”> result example <ret>0</ret> (Response value <val></val> XML) </cmdreturn> Response value Return Value(ret)： 0: Successful, except 0 ： Fail （Mistake for specified parameter or camera without the function, etc.）...

  • Page 60: Acquire Camera Function Status

    KXVC160608 After done setting with procedure 3, confirm the status with procedure 4. See each command specification for procedure 3: setting instruction details and procedure 4: specify n. 6.3.19.2. Acquire Camera Function Status Setting with following sequences, and confirm execution result. cameraoccupy start cameracecinfo get camerainfo get n (Specify target function)

  • Page 61: Commands For Communication

    KXVC160608 6.4. 6.4. 6.4. 6.4. Commands for communication Commands for communication Commands for communication Commands for communication 6.4.1. 6.4.1. Start conference, Add terminal 6.4.1. 6.4.1. Command Name Start conference(Start conference, Add terminal) execution Basic format parameter cgicmd=invitemember dest p [mode m] [addrnum n] [bitrate o] p: Destination URI ・In case of use SIP server and communication type=0（SIP) Indicate IP address or SIP user name@SIP domain format...

  • Page 62: End Conference, Leave Terminal

    KXVC160608 Other explanations ・Return value is Session ID for execution result Session ID will be usable for related communication command. Example: disconnect request ・Not available during Multicast. 6.4.2. 6.4.2. End conference, Leave terminal 6.4.2. 6.4.2. Command Name End conference(End conference, Leave terminal) execution Cgicmd=dropmember m [n] [o] [p] parameter...

  • Page 63: Connection Response

    KXVC160608 6.4.3. 6.4.3. Connection response 6.4.3. 6.4.3. Command Name Connection Response(Answer Incoming Call) CGI execution cgicmd=invitememrsp n parameter n：Session ID 0x07000001～0x0700000a、0x08000001～0x0800000a Examples for CGI <cmdreturn ="invitememrsp 0x07000001"> execution result <ret>0</ret> (Response value <val>OK 0x07000001</val> XML) </cmdreturn> Response value Other explanations ・Session ID can be obtained by callsessionid.

  • Page 64: Session Id Acquirement

    KXVC160608 6.4.5. 6.4.5. Session ID acquirement 6.4.5. 6.4.5. Command Name Session ID Acquirement execution cgicmd=callsessionid get parameter Examples for CGI <cmdreturn =" callsessionid get"> execution result <ret>0</ret> (Response value <val>callsessionid = 0x07000001 XML) callsessionid = 0x07000002 </val> </cmdreturn> Response value Session ID 0x07000001～0x0700000a、0x08000001～0x0800000a 0x07000101～0x0700010a、0x08000101～0x0800010a Other explanations...

  • Page 65: Remote Control Emulation Remote Control Emula Tion

    KXVC160608 7. 7. 7. 7. Remote control emulation This command only activates on GUI mode. Command Name Remote Controller Emulation CGI execution cgicmd=button n parameter n=KeyID meanings parameter standby standby display fullscreen layout layout sub-camera subcamera end sharing maincamera menu menu start callstart...
  • Page 66 KXVC160608 Other explanations ・It is impossible to carry out command except GUI mode. → SVAP_RET_ERR_NOTAVAILABLE (unavailable execution) ・In case of succeed to notice GUI, even though management result by GUI, it returns “SVAP_RET_SUCCESS”. (success) ・In case of operating self-diagnosis on this function, it is impossible to stop because session is disconnected.

  • Page 67: Upload/Download

    KXVC160608 8. 8. 8. 8. Upload/Download 8.1. 8.1. 8.1. 8.1. Download Download Download Download 8.1.1. 8.1.1. Download Call history 8.1.1. 8.1.1. Command Name Download Call History CGI execution kind=cnf parameter Examples for CGI It is returned download file. execution result (Response value XML) Response value...

  • Page 68: Log Download In A Lump

    KXVC160608 8.1.4. 8.1.4. Log Download in a lump 8.1.4. 8.1.4. Command Name Log Download in a lump CGI execution None parameter Examples for CGI execution result (Response value XML) Response value Other explanations File name： 「 hdvclogall_V<v1>_<v2><v3>_Rev<n>_<IPaddress>_YYMMDD_24HH MISS.tar」 （ v1 ＝ major version 、 v2 ＝ minor version 、 v3 ＝ revision 、 n ＝ 1or2 、 IPaddress＝IP address of the own site、YYMMDD_24HHMISS＝date and hour）...

  • Page 69: Upload

    KXVC160608 8.2. 8.2. 8.2. 8.2. Upload Upload Upload Upload 8.2.1. 8.2.1. Upload contact list 8.2.1. 8.2.1. Command Name Upload contact list CGI execution None parameter Examples for CGI <returns > execution result <cgireturn> (Response value <ret>0</ret> XML) </cgireturn> </returns> Response value Other explanations Not available during conference.

  • Page 70: Encryption Data Upload

    KXVC160608 8.2.4. 8.2.4. Encryption data upload 8.2.4. 8.2.4. Command Name Encryption data upload execution None parameter Examples for CGI <returns > execution result <cgireturn> (Response value <ret>0</ret> XML) </cgireturn> </returns> Response value Other explanations Not available during conference. 70/80...

  • Page 71: Other Notes

    KXVC160608 9. 9. 9. 9. Other notes ・It is not possible to use this interface during activate safe mode. ・Reboot is surely necessary in case of switching GUI mode and touch panel PC mode. ・When initial digest authentication is only shown POST on HDVC Web server, the connection is disconnected in case of 401 error comes to “Connection: close”.

  • Page 72: Notes On The Pc Appl Notes On The Pc Application Development Ication Development

    KXVC160608 10. Notes on the PC application development ・It needs the following step to avoid connecting with HTTP wastefully during activate Virus Buster. (1) It should be Keep-Alive for Connection header during requesting HTTP. *Reference：In case of Visual Basic, current sample application has no problem because it comes to Keep-Alive as a default setting if you do not specify “close”...
  • Page 73 KXVC160608 Microphone mute 0: OFF Keep information inside 1: ON conference control (“confinfo” command)) Failure information System management status “state” command 73/80...

  • Page 74: Http Sample

    KXVC160608 12. HTTP sample 12.1. 12.1. Login Login 12.1. 12.1. Login Login It shows sample in login. 12.1.1. 12.1.1. 12.1.1. 12.1.1. PC→HDVC (First access) It is a frame which PC sends first for login. 12.1.2. 12.1.2. 12.1.2. 12.1.2. HDVC→PC (Reply 401 Unauthorized) This time, it is chosen digest authentication but 401(Unauthorized) is replied as an authentication requirement from HDVC.

  • Page 75: Pc→Hdvc (Send Certificated Information)

    KXVC160608 12.1.3. 12.1.3. 12.1.3. 12.1.3. PC→HDVC (Send certificated information) PC which received 401 needs to send certificated information for HDVC. 12.1.4. 12.1.4. 12.1.4. 12.1.4. HDVC→PC (Reply 200OK) HDVC replays 200OK if certificated information is right. Then, login is complete. 75/80...

  • Page 76: External Control Command Execution

    KXVC160608 12.2. 12.2. 12.2. 12.2. External control command execution External control command execution External control command execution External control command execution It shows HTTP sample during carry out external control command as follows 12.2.1. 12.2.1. 12.2.1. 12.2.1. PC→HDVC (External control command execution) It enters parameter (command) to data part, and send to HDVC.

  • Page 77: Ownload Og )

    KXVC160608 12.3. 12.3. 12.3. 12.3. Download Download Download Download (Log) (Log) (Log) (Log) It shows a sample of Log download. 12.3.1. 12.3.1. 12.3.1. 12.3.1. PC→HDVC (Log requirement) File is downloaded by GET. In case of GET, “? Parameter” is added after URL. 12.3.2.

  • Page 78: Xml Sample

    KXVC160608 13. XML sample 13.1. 13.1. Contact list Contact list 13.1. 13.1. Contact list Contact list Contact list XML sample is shown as follows. <?xml version="1.0" encoding="UTF-8"?> <Book> Address book version <AddressVersion>2.00</AddressVersion> *It is different from system version. <NormalMode> <Address> <AddressNumber>1</AddressNumber>...

  • Page 79: All History

    KXVC160608 13.2. 13.2. Call history Call history 13.2. 13.2. Call history Call history It shows call history XML sample as follows. <?xml version="1.0" encoding="UTF-8"?> <CallHist> Call history version. <HistVersion>2.00</HistVersion> *It is different from system version. <Talktime> <StartDate>2014/10/14 14:00:03</StartDate> <TotalTalktime>124151</TotalTalktime> <TotalOutgoingCalls>18</TotalOutgoingCalls> Accumulation <TotalIncomingCalls>2</TotalIncomingCalls>...
  • Page 80 KXVC160608 <HistIPRate1>3000</HistIPRate1> <HistResult1>1</HistResult1> <HistDisconReason1>0</HistDisconReason1> <HistProductName1>KX-VC1300_HDVC-MPCS</HistProductName1> </Hist> <Hist> ・ </Hist> ・ </HistSend> <HistRecv> <Hist> ・ </Hist> ・ </HistRecv> </NormalMode> <NGNMode> <HistSend><Hist> ･･･ </Hist>･･･ </HistSend> <HistRecv><Hist> ･･･ </Hist>･･･ </HistRecv> These XML tags are remained but not used. </NGNMode> <NATMode> <HistSend><Hist> ･･･ </Hist>･･･ </HistSend> <HistRecv><Hist>...

Table of Contents