Download Print this page

Advertisement

4ch Network Encoder
VN-E4
API GUIDE
This document provides a description of protocols and API of VN-E4.
Refer Readme file in the CD-ROM for updated information.
LST0288-001A

Advertisement

   Also See for JVC VN-E4U - 4 Channel Network Encoder

   Related Manuals for JVC VN-E4U - 4 Channel Network Encoder

   Summary of Contents for JVC VN-E4U - 4 Channel Network Encoder

  • Page 1

    4ch Network Encoder VN-E4 API GUIDE This document provides a description of protocols and API of VN-E4. Refer Readme file in the CD-ROM for updated information. LST0288-001A...

  • Page 2

    Getting Started Custom Application Software Development Guide VN-E4 can be used from a custom application software by utilizing the API and protocols for VN-E4. The following operations are possible. ● Acquisition of JPEG from VN-E4. ● Acquisition of audio from VN-E4. ●...

  • Page 3: Table Of Contents

    Content 1. Acquiring JPEG from VN-E4 via HTTP Setting Alarm Action for VN-E4 ........29 Acquiring Alarm Trigger from VN-E4 ......30 1.1. Basic Procedures..............5 Setting Alarm Trigger for VN-E4 ........30 1.2. API Format................6 5.5. Alarm Environment Setting ..........31 Structure ................6 Acquiring SMTP Server Address Setting Parameter Description............6 from VN-E4..............31 1.3.

  • Page 4

    Content Acquiring Subnet Mask from VN-E4 ......44 5.14. Maintenance ..............60 Setting Subnet Mask for VN-E4 ........44 Initialization ..............60 Acquiring Default Gateway from VN-E4 .......44 Version Upgrade .............60 Setting Default Gateway for VN-E4 .......45 5.15. Acquiring Status..............61 Acquiring Host Name from VN-E4 ........45 Acquiring Sending Status..........61 Setting Host Name for VN-E4 ........45 Acquiring Log ..............62...

  • Page 5: Acquiring Jpeg From Vn-e4 Via Http

    1. Acquiring JPEG from VN-E4 via HTTP 1. Acquiring JPEG from VN-E4 via HTTP _ 1.1. Basic Procedures 1.1. Basic Procedures 1) The client establishes a TCP connection to port number 8009. 2) The client sends out API. Example GET /api/video?input=1&framerate=30&framesize=vga HTTP/1.1<CRLF> Host: 10.0.0.1<CRLF><CRLF>...

  • Page 6: Api Format

    1. Acquiring JPEG from VN-E4 via HTTP _ 1.2. API Format 1.2. API Format Structure Space API Character String Space HTTP/1.1 0x0D 0x0A Host: Space IP Address of VN-E4 0x0D 0x0A 0x0D 0x0A Unlike parameter acquisition/setting, Accept line is not required. Basic authentication is also not necessary. Example /api/video?input=1&framesize=vga&framerate=30&header=0&assured=0&send buffer=128 HTTP/1.1<CRLF>...

  • Page 7: Response

    1. Acquiring JPEG from VN-E4 via HTTP _ 1.3. Response 1.3. Response When API is successfully received VN-E4 will return 200 OK. Content-length indicates file size of first JPEG in bytes. The x-vne4_response line indicates current values of all parameters used for JPEG encoding. Example HTTP/1.1 200 OK<CRLF>...

  • Page 8: Restrictions

    1. Acquiring JPEG from VN-E4 via HTTP _ 1.4. Restrictions 1.4. Restrictions Access restriction VN-E4 comes with a feature that enables it to deny access from a specific IP address. If access from the IP address of the client is denied, VN-E4 will disconnect the TCP connection immediately after TCP is connected via the port number 8009.

  • Page 9: Jpeg File Format Sent Out By Vn-e4

    The following information is stored in the comment segment. Each item has a fixed length. Item Size Example Description Version Information JVC V1.0 Indicates the version of information stored in the comment segment File Size size = 123456 The number of bytes of the JPEG file. Width width = 640 Width of JPEG.

  • Page 10: Acquiring Audio Data From Vn-e4 Via Http

    2. Acquiring Audio Data from VN-E4 via HTTP 2. Acquiring Audio Data from VN-E4 via HTTP _ 2.1. Basic Procedures 2.1. Basic Procedures 1) The client establishes a TCP connection to port number 8009. 2) The client sends out API. Example GET /api/audio?assured=1&lowdelay=0 HTTP/1.1<CRLF>...

  • Page 11: Api Format

    2. Acquiring Audio Data from VN-E4 via HTTP _ 2.2. API Format 2.2. API Format Structure Space API Character String Space HTTP/1.1 0x0D 0x0A Host: Space IP Address of VN-E4 0x0D 0x0A 0x0D 0x0A Unlike parameter acquisition/setting, Accept line is not required. Basic authentication is also not necessary. Example GET /api/audio?assured=1&lowdelay=0 HTTP/1.1<CRLF>...

  • Page 12: Response

    2. Acquiring Audio Data from VN-E4 via HTTP _ 2.3. Response 2.3. Response Unlike JPEG acquisition, there is no Content-length. The last line indicates the actual parameters set at VN-E4. Example HTTP/1.1 200 OK<CRLF> Connection: Keep-Alive<CRLF> Content-Type: audio/ulaw<CRLF> Date: Fri, 13 MAY 2005 07:33:12 GMT<CRLF> Server: VN-E4 Jpeg &...

  • Page 13: Restrictions

    2. Acquiring Audio Data from VN-E4 via HTTP _ 2.4. Restrictions 2.4. Restrictions Access restriction VN-E4 comes with a feature that enables it to deny access from a specific IP address. If access from the IP address of the client is denied, VN-E4 will disconnect the TCP connection immediately after TCP is connected via the port number 8009.

  • Page 14: Acquiring Alarm From Vn-e4

    3. Acquiring Alarm from VN-E4 3. Acquiring Alarm from VN-E4 _ 3.1 Procedure 3.1 Procedure 1) The client establishes a TCP connection to port number 32040. 2) When motion is detected from the video image of VN-E4, or when there are changes to the alarm input (make or break), VN-E4 will send out alarm information in the following format.

  • Page 15: Restrictions

    3. Acquiring Alarm from VN-E4 _ 3.2. Restrictions 3.2. Restrictions Access restriction VN-E4 comes with a feature that enables it to deny access from a specific IP address. If access from the IP address of the client is denied, VN-E4 will disconnect the TCP connection immediately after TCP is connected via the port number 32040. Maximum number of clients The maximum number of clients that may acquire alarm is 4.

  • Page 16: Using Api That Requires Basic Authentication

    4. Using API that Requires Basic Authentication 4. Using API that Requires Basic Authentication _ 4.1. Procedure Basic authentication is required for APIs which are explained in Section 5. This section provides basic explanation of the uses of APIs that require basic authentication.

  • Page 17: Restrictions

    4. Using API that Requires Basic Authentication _ 4.2. Restrictions 4.2. Restrictions Access restriction VN-E4 comes with a feature that enables it to deny access from a specific IP address. If access from the IP address of the client is denied, VN-E4 will disconnect the TCP connection immediately after TCP is connected via the port number 80.

  • Page 18: Api For Acquiring/changing Parameters Of Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 5. API for Acquiring/Changing Parameters of VN-E4 _ 5.1. Explanatory Notes This section provides a description of API for acquiring/changing the parameters of VN-E4. Make use of the API explained in this section in the way as mentioned in Section 4.

  • Page 19: Signal Input

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.2. Signal Input 5.2. Signal Input This API is related to signal input. This is equivalent to the feature on the Input page of the WEB setting page. Refer to the instruction manual for details on the Input page.

  • Page 20: Setting Brightness For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.2. Signal Input Setting Brightness for VN-E4 Format /api/param?video.input(Number).brightness =data When setting Brightness of video input channel 1 Example /api/param?video.input(1).brightness=50 Example of response video.input(1).brightness&200 OK Change the Brightness set value of the specified video input channel. Specify the video input channel between Interpretation the range of 1 to 4.

  • Page 21: Setting Saturation For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.2. Signal Input Setting Saturation for VN-E4 Format /api/param?video.input(Number).saturation=data When setting Saturation of video input channel 1 Example /api/param?video.input(1).saturation=50 Example of response video.input(1).saturation&200 OK Change the Saturation set value of the specified video input channel. Specify the video input channel between Interpretation the range of 1 to 4.

  • Page 22: Setting Turnover For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.2. Signal Input Setting Turnover for VN-E4 Format /api/param?video.input(Number).turnover=data When setting Turnover of video input channel 1 Example /api/param?video.input(1).turnover=on Example of response video.input(1).turnover&200 OK Change the Turnover set value of the specified video input channel. Turnover refers to flags that are stored in Interpretation the JPEG header.

  • Page 23: Jpeg Encoding

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding 5.3. JPEG Encoding This API is related to JPEG encoding. This is equivalent to the feature on the Encoding page of the WEB setting page. Refer to the instruction manual for details on the Encoding page.

  • Page 24: Setting Jpeg Frame Rate For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding Setting JPEG Frame Rate for VN-E4 Format /api/param?encode(Number).framerate=data When setting frame rate of Encoding No. 1 Example /api/param?encode(1).framerate=30 Example of response encode(1).framerate&200 OK Change frame rate of the specified encoding number. Note that encoding numbers are different from video Interpretation input channels.

  • Page 25: Acquiring File Size Setting From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding Acquiring File Size Setting from VN-E4 Format /api/param?encode(Number).quality When acquiring file size setting of Encoding No. 1 Example /api/param?encode(1).quality Example of response encode(1).quality=40k&200 OK Acquire the file size setting of the specified encoding number. Note that encoding numbers are different from Interpretation video input channels.

  • Page 26: Setting Interpolation For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding Setting Interpolation for VN-E4 Format /api/param?encode(Number).interpolate=Data When setting interpolation of Encoding No. 1 Example /api/param?encode(1).interpolate=on Example of response encode(1).interpolate&200 OK Change interpolation of the specified encoding number. Note that encoding numbers are different from video Interpretation input channels.

  • Page 27: Alarm Setting

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting 5.4. Alarm Setting The APIs below are related to alarm setting. These are equivalent to the features on the Alarm page of the WEB setting page. Refer to the instruction manual for details on the Alarm page.

  • Page 28: Setting Jpeg Parameters Added To Ftp From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting When acquiring setting of Object 1 Example Acquisition of input CH: /api/param?application.object(1).source Acquisition of frame size: /api/param?application.object(1).framesize Acquisition of frame rate: /api/param?application.object(1).framerate Acquisition of BeforeTrigger: /api/param?application.object(1).prerec Acquisition of AfterTrigger: /api/param?application.object(1).postrec Example of Response Acquisition of input CH:...

  • Page 29: Setting Alarm Action For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting Acquire the alarm action of the specified alarm number. Up to 10 alarm actions can be specified, and therefore Interpretation the number of alarm(number) can also be set between the range of 1 to 10. Note that alarm numbers are different from the alarm input pin numbers.

  • Page 30: Acquiring Alarm Trigger From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting Setting Example /api/param?application.event(1).action=tcpto/10.0.0.100/20000/Message Specify udpto, IP address, port number and the character string to be sent when sending via UDP. Segments are indicated by /. The upper limit of the character string to be sent is 40 bytes. Specify using the 3 characters %20 when inserting a space in the character string.

  • Page 31: Alarm Environment Setting

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.5. Alarm Environment Setting 5.5. Alarm Environment Setting The APIs below are related to alarm environment setting. These are equivalent to the features on the Alarm Environment page of the WEB setting page. Refer to the instruction manual for details on the Alarm Environment page. Acquiring SMTP Server Address Setting from VN-E4 Format /api/param?application.smtp.host...

  • Page 32: Acquiring "pop Before Smtp" Setting From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.5. Alarm Environment Setting Acquiring "POP before SMTP" Setting from VN-E4 Format /api/param?application.smtp.type Example of Response application.smtp.type=pbs&200 OK Acquire the "POP before SMTP" setting. simple is returned when this is set to off. pbs is returned when this is Interpretation set to on.

  • Page 33: Setting Pop Server Port Number For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.5. Alarm Environment Setting Setting POP Server Port Number for VN-E4 Format /api/param?application.pop.port=data Example /api/param?application.pop.port=110 Example of Response application.pop.port&200 OK Change the port number setting of the POP server. Interpretation admin, operator Allowed users Acquiring POP Server User Name Setting from VN-E4 Format...

  • Page 34: Acquiring Ftp Server Address Setting From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.5. Alarm Environment Setting Acquiring FTP Server Address Setting from VN-E4 Format /api/param?application.ftp.host Example of Response application.ftp.host=10.0.0.200&200 OK Response example application.ftp.host=&200 OK when setting field is left blank Acquire the FTP server address setting used for FTP transmission via alarm. Interpretation admin, operator, user Allowed users...

  • Page 35: Acquiring Ftp Server User Name Setting From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.5. Alarm Environment Setting Acquiring FTP Server User Name Setting from VN-E4 Format /api/param?application.ftp.user Example of Response application.ftp.user=somename&200 OK Response example application.ftp.user=&200 OK when setting field is left blank Acquire the FTP server user name setting used for FTP transmission via alarm. Interpretation admin, operator Allowed users...

  • Page 36: Setting Chattering Guard Time Of Alarm Input For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.5. Alarm Environment Setting Setting Chattering Guard Time of Alarm Input for VN-E4 Format /api/param?peripheral.input_pin.pin(Number).chatter=data When setting the chattering guard time for alarm input 1 Example /api/param?peripheral.input_pin.pin(1).chatter=150 Example of response peripheral.input_pin.pin(1).chatter&200 OK Change the time setting to prevent chattering in the alarm input.

  • Page 37: Motion Detect

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.6. Motion Detect 5.6. Motion Detect The APIs below are related to motion detection. These are equivalent to the features on the Motion Detection page of the WEB setting page. Refer to the instruction manual for details on the Motion Detection page. Acquiring Motion Detect On/Off Status from VN-E4 Format /api/param?video.input(Number).detection.status...

  • Page 38: Acquiring Motion Parameters Of Motion Detect From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.6. Motion Detect Acquiring Motion Parameters of Motion Detect from VN-E4 Format /api/param?video.input(Number).detection.velocity When acquiring motion parameters of motion detect for video input channel 1 Example /api/param?video.input(1).detection.velocity Example of response video.input(1).detection.velocity=10&200 OK Acquire the motion parameters of motion detect.

  • Page 39: Setting Motion Detect Mask For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.6. Motion Detect Setting Motion Detect Mask for VN-E4 Format /api/param?video.input(Number).detection.area=data When setting the motion detect mask of video input channel 1 Example /api/ param?video.input(1).detection.area=000102030405060708091011121314151617 Example of response (1).detection.area&200 OK Change the motion detect mask. VN-E4 enables motion detect to be adjusted for each of the 4 video inputs. Interpretation Specify a value between 1 to 4 for the number.

  • Page 40: Serial Port

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.7. Serial Port 5.7. Serial Port The APIs below are related to the serial port. These are equivalent to the features on the Serial Port page of the WEB setting page. However, specification of control device and camera address are not supported by API.

  • Page 41: Acquiring Serial Port Parity Setting From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.7. Serial Port Acquiring Serial Port Parity Setting from VN-E4 Format /api/param?peripheral.serial(Number).parity When acquiring parity of Serial Port 1 Example /api/param?peripheral.serial(1).parity Example of response peripheral.serial(1).parity=none&200 OK Acquire the parity of the serial port. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports. Interpretation Value returned will be none, odd or even.

  • Page 42: Acquiring Serial Port Comment From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.7. Serial Port Acquiring Serial Port Comment from VN-E4 Format /api/param?peripheral.serial(Number).comment When acquiring comment of Serial Port 1 Example /api/param?peripheral.serial(1).comment Example of response peripheral.serial(1).comment=serial1&200 OK Acquire comment of the serial port. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports. The Interpretation value returned will be a character string of 40 bytes or less.

  • Page 43: Network Basics

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics 5.8. Network Basics The APIs below are related to the basics of networks. These are equivalent to the features on the Basic page of the WEB setting page. Refer to the instruction manual for details on the Basic page.

  • Page 44: Setting Ip Address For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics Setting IP Address for VN-E4 Format /api/param?network.interface.ip=data Example /api/param?network.interface.ip=10.0.0.1 Example of Response network.interface.ip&202 Required(network.interface.status=restart) Change the IP address. Upon setting this API, execute the "network.interface.status=restart" API for enabling Interpretation network setting changes to enable the new settings.

  • Page 45: Setting Default Gateway For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics Setting Default Gateway for VN-E4 Format /api/param?network.gateway(ipv4)=data Example /api/param?network.gateway(ipv4)=10.0.0.254 Example of Response network.gateway&200 OK Change the default gateway of IPv4. Default gateway of IPv6 can not be changed. Upon setting this API, Interpretation execute the "network.interface.status=restart"...

  • Page 46: Setting Domain Name For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics Setting Domain Name for VN-E4 Format /api/param?network.domainname=data Example /api/param?network.domainname=somename Example of Response network.domainname&202 Required(network.interface.status=restart) Change the domain name. Characters that may be used for the domain name are alphanumerics, underscores Interpretation (_) and hyphens (-).

  • Page 47: Acquiring Dns Server Ip Address From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics Acquiring DNS Server IP Address from VN-E4 Format /api/param?network.dns.ip Example of Response network.dns.ip=10.0.0.150&200 OK Acquire the IP address of the DNS server. Interpretation admin, operator, user Allowed users Setting DNS Server IP Address for VN-E4 Format /api/param?network.dns.ip=data Example...

  • Page 48: Acquiring Link-local Ipv6 Address From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics Acquiring Link-local IPv6 Address from VN-E4 Format /api/param?network.interface.ipv6.link_local(Number) Acquire the first link-local address Example /api/param?network.interface.ipv6.link_local(1) Example of Response network.interface.ipv6.link_local(1)=fe80::280:88ff:fe41:400c&200 OK Acquire the link-local IPv6 address. A number between 1 to 8 may be specified, and the link-local IPv6 Interpretation addresses will be stored in sequence beginning from 1.

  • Page 49: Network Details

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.9. Network Details 5.9. Network Details The APIs below are related to network details. These are equivalent to the features on the Details page of the WEB setting page. Refer to the instruction manual for details on the Details page.

  • Page 50: Setting Mtu Value For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.9. Network Details Setting MTU Value for VN-E4 Format /api/param?network.interface.mtu=data Example /api/param?network.interface.mtu=1000 Example of Response network.interface.mtu&202 Required(network.interface.status=restart) Change the MTU value. The range of set value is between 512 to 1500 for IPv4 and between 1280 to 1500 for Interpretation IPv6.

  • Page 51: Setting Pppoe Status To On/off For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.9. Network Details Setting PPPoE Status to On/Off for VN-E4 Format /api/param?network.interface.pppoe.status=data Example /api/param?network.interface.pppoe.status=on Example of Response network.interface.pppoe.status&202 Required(network.interface.status=restart) Change the on/off status of PPPoE. Set to on or off. Upon changing PPPoE, VN-E4 will be rebooted using the Interpretation "network.interface.status=restart"...

  • Page 52: Manual Transmission

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.10. Manual Transmission 5.10. Manual Transmission Details on API for manual transmission will be described in Section 6. These are equivalent to the features on the Streaming page of the WEB setting page. Settings on the Streaming page will not change when APIs described in Section 6 are used. Refer to the instruction manual for details on the Streaming page.

  • Page 53: Access Restrictions

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.11. Access Restrictions 5.11. Access Restrictions The APIs below are related to access restrictions. These are equivalent to the features on the Access Restrictions page of the WEB setting page. Refer to the instruction manual for details on the Access Restrictions page. Acquiring Deny/Allow Setting of Client Restrictions from VN-E4 Format /api/param?network.access_control(api).logic...

  • Page 54: Acquiring Deny/allow Setting Of Audio Sender Restrictions From Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.11. Access Restrictions Example /api/param?network.access_control(api).host(1)=10.0.0.0/24 It is also possible to set using FQDN instead of IP address. Set as follows if the setting is to be left blank. Example /api/param?network.access_control(api).host(1)=%00 Details set by this API are the same as those set by the "Access Restriction" item of "Client Address" at the bottom of the Access Restrictions page.

  • Page 55

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.11. Access Restrictions Change the IP address setting of audio sender restrictions. Setting is possible up to 10 items. Specify a value Interpretation between 1 to 10 for the number. A range of IP address may be specified if the subnet mask is also specified. For example, set as follows to specify a range between 10.0.0.0 to 10.0.0.255.

  • Page 56: Time

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.12. Time 5.12. Time The APIs below are related to time. These are equivalent to the features on the Time page of the WEB setting page. Refer to the instruction manual for details on the Time page. Acquiring NTP Client Feature On/Off Status from VN-E4 Format /api/param?network.ntp.status...

  • Page 57: Setting Access Interval To Ntp Server For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.12. Time Setting Access Interval to NTP Server for VN-E4 Format /api/param?network.ntp.interval=data Example /api/param?network.ntp.interval=60 Example of Response network.ntp.interval&200 OK Change the interval for accessing the NTP server. Unit is in minutes. Upon setting this API, execute the Interpretation "network.interface.status=restart"...

  • Page 58: Setting Timezone For Vn-e4

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.12. Time GMT-6 Timezone that is 6 hour earlier than the Greenwich Mean Time. Central Same timezone as GMT-6 GMT-5 Timezone that is 5 hour earlier than the Greenwich Mean Time. East-Indiana Same timezone as GMT-5.

  • Page 59: Password

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.13. Password 5.13. Password The APIs below are related to passwords. These are equivalent to the features on the Password page of the WEB setting page. Refer to the instruction manual for details on the Password page. Setting Password for VN-E4 Format /api/param?system.password.data1=data2...

  • Page 60: Maintenance

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.14. Maintenance 5.14. Maintenance The APIs below are related to maintenance. These are equivalent to the features on the Maintenance page of the WEB setting page. Refer to the instruction manual for details on the Maintenance page. (Caution: There are 2 types of initialization features on the WEB setting page, but only 1 is available for API.) Initialization Format...

  • Page 61: Acquiring Status

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.15. Acquiring Status 5.15. Acquiring Status The APIs below are related to status acquisition. These are equivalent to the features on the Operation page of the WEB setting page. Refer to the instruction manual for details on the Operation page. Acquiring Sending Status Format /api/param?system.session...

  • Page 62: Acquiring Log

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.15. Acquiring Status Acquiring Log Format /api/param?system.log Return the following information. These information will be initialized upon turning off the power of VN-E4. Response Response examples on the number of seconds after startup, alarm log information, motion detect log, list of clients currently acquiring alarm, clients currently sending audio data, and clients currently using pass- through.

  • Page 63: Acquiring Settings

    5. API for Acquiring/Changing Parameters of VN-E4 _ 5.16. Acquiring Settings 5.16. Acquiring Settings The APIs below are related to the acquisition of settings. These are equivalent to the features on the Settings page of the WEB setting page. Refer to the instruction manual for details on the Settings page. Acquiring Model Name Format /api/param?system.model...

  • Page 64: Others

    6. API for Sending JPEG/Audio from VN-E4 via UDP 5. API for Acquiring/Changing Parameters of VN-E4 _ 5.17. Others 5.17. Others These are APIs of features not found on the WEB setting page. Restart VN-E4 Format /api/param?system.status=restart Example of Response system.status&200 OK Restarts VN-E4.

  • Page 65: Procedure

    6. API for Sending JPEG/Audio from VN-E4 via UDP _ 6.1. Procedure This section describes the API for sending JPEG or audio data via UDP. Make use of the APIs explained in this section in the way as mentioned in Section 4. VN-E4 allows sending of up to 10 streams of JPEG/audio data.

  • Page 66: List Of Apis

    6. API for Sending JPEG/Audio from VN-E4 via UDP _ 6.2. List of APIs 6.2. List of APIs (1) Sending JPEG from VN-E4 via RTP/UDP Format /api/send?from=video&from.input=data1&from.framesize=data2&from.framerate =data3&to=network&to.ip=data4&to.port=data5&to.session_id=data6 Example /api/send?from=video&from.input=1&from.framesize=qvga&from.framerate=15& to=network&to.ip=225.0.1.1&to.port=20000&to.session_id=12345678 Specify the video input channel.(1~4) from.input Specify the frame size. (qvga / vga) from.framesize Specify the JPEG frame rate.

  • Page 67: Stopping Jpeg/rtp/udp Sending From Vn-e4

    6. API for Sending JPEG/Audio from VN-E4 via UDP _ 6.2. List of APIs (2) Stopping JPEG/RTP/UDP Sending from VN-E4 Format /api/stop?to.session_id=data Example /api/stop?to.session_id=12345678 Specify session_id with the same value as when send is used. All JPEG sending will be terminated when session_id=* is specified.

  • Page 68: Stopping Audio (u-law) Sending From Vn-e4

    7. API for Audio Receiving by VN-E4 6. API for Sending JPEG/Audio from VN-E4 via UDP _ 6.2. List of APIs x-vne4_response: from=audio&to=network&to.ip=225.0.1.1&to.port=20002&to.session_id=1234567 9<CRLF><CRLF> 503 Service Unavailable<CRLF> (4) Stopping Audio (u-Law) Sending from VN-E4 Format /api/stop?to.session_id=data Example /api/stop?to.session_id=12345679 Specify session_id with the same value as when send is used. All audio sending will be terminated when session_id=* is specified.

  • Page 69: Audio Receiving Via Http

    7. API for Audio Receiving by VN-E4 _ 7.1. Audio Receiving via HTTP This section describes APIs for audio receiving by VN-E4. Make use of the APIs explained in this section in the way as mentioned in Section 4. 7.1. Audio Receiving via HTTP 1) The client establishes a TCP connection to port number 80 and sends out API.

  • Page 70: Audio Receiving Via Rtp

    8. API for Controlling External Devices Connected to VN-E4 7. API for Audio Receiving by VN-E4 _ 7.2. Audio Receiving via RTP 7.2. Audio Receiving via RTP 1) The client establishes a TCP connection to port number 80 and sends out API. Space API Character String Space...

  • Page 71: Control Of Pelco-d Camera

    8. API for Controlling External Devices Connected to VN-E4 _ 8.1. Control of Pelco-D Camera This section describes APIs for controlling external devices that are connected to the serial port of VN-E4. Make use of the APIs explained in this section in the way as mentioned in Section 4. 8.1.

  • Page 72: Iris Control

    8. API for Controlling External Devices Connected to VN-E4 _ 8.1. Control of Pelco-D Camera (3) Iris Control API Character String /api/param?peripheral.serial(Number).device(Address).camera.iris=Data1 Below is an example that opens the iris of a camera with an address of 123 that is connected to serial port Example number 2.

  • Page 73: Control Of External Devices Via Pass-through

    8. API for Controlling External Devices Connected to VN-E4 _ 8.2. Control of External Devices via Pass-through 8.2. Control of External Devices via Pass-through By using the pass-through feature, data sent to VN-E4 via the network will be output from the serial port of VN-E4. In addition, Ack received by the serial port of VN-E4 will be returned to the client via the network.

  • Page 74: Tcp Connection For Pass-through

    9. List of Protocols and Port Numbers Used with VN-E4 8. API for Controlling External Devices Connected to VN-E4 _ 8.2. Control of External Devices via Pass-through (2) TCP Connection for Pass-through The client will establish a TCP connection to TCP49152 when serial port 1 is used. In the case of serial port 2, the client will establish a TCP connection to 49153.

  • Page 75: Advanced Topics

    10. Advanced Topics 9. List of Protocols and Port Numbers Used with VN-E4 VN-E4 uses the following protocols and port numbers. Protocol / Port Number TCP 80 WEB setting page, API for acquiring status and changing settings TCP 8009 TCP acquisition of JPEG/audio from VN-E4 by client TCP 32040 Alarm acquisition from VN-E4 by client TCP 49152...

  • Page 76: Customizing Vn-e4's Built-in Viewer

    11. Customizing VN-E4's Built-in Viewer 10. Advanced Topics (1) When frame rate drops deteriorates due to long network delay time Causes of Frame Rate Deterioration During transmission via TCP, VN-E4 sends out the following data by receiving the Ack of TCP. When network delay is long, reception of Ack will be delayed and sending rate will drop.

  • Page 77: Html Sample

    11. Customizing VN-E4's Built-in Viewer The built-in viewer of VN-E4 consists of an ActiveX control, and customization is possible using HTML description. (1) HTML Sample <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML4.0 Transitional//EN"> <HTML><HEAD> <META http-equiv="Content-Type" content="text/html;charset=ISO-8859-1"> <TITLE></TITLE> </HEAD> <SCRIPT LANGUAGE=JAVASCRIPT> function stop_click() { Viewer.Stop();...

  • Page 78: Public Interface Of Activex Control

    11. Customizing VN-E4's Built-in Viewer (2) Public Interface of ActiveX Control Type / Name Details and HTML/SCRIPT Description Example Method For specifying JPEG frame size. SetJpegSize (ch , size) 1: ch1 2: ch2 3: ch3 4: ch4 size 0: VGA 1: QVGA Example: SetJpegSize(1,1);...

  • Page 79

    11. Customizing VN-E4's Built-in Viewer Method For starting ActiveX control. Start upon changing to new settings. Play( ) Example: Play( ); Start Method For ending ActiveX control. Close and reboot ActiveX control upon changing settings. Stop( ) Example: Stop( ); End Property For turning on/off audio sending from the viewer to the VN-E4 unit.

  • Page 80

    © 2005 Victor Company Of Japan, Limited LST0288-001A...

This manual also for:

Vn-e4

Comments to this Manuals

Symbols: 0
Latest comments: