Document Outline

• Cover
• Custom Application Software Development Guide
• Content
• 1. Acquiring JPEG from VN-E4 via HTTP
  • 1.1. Basic Procedures
  • 1.2. API Format
    • Structure
    • Parameter Description
  • 1.3. Response
    • When API is successfully received
    • When VN-E4 fails to realize the requested frame rate
    • When the specified input channel and frame size are not available
  • 1.4. Restrictions
  • 1.5. JPEG File Format Sent Out by VN-E4
• 2. Acquiring Audio Data from VN-E4 via HTTP
  • 2.1. Basic Procedures
  • 2.2. API Format
    • Structure
    • Parameter Description
  • 2.3. Response
  • 2.4. Restrictions
• 3. Acquiring Alarm from VN-E4
  • 3.1 Procedure
  • 3.2. Restrictions
• 4. Using API that Requires Basic Authentication
  • 4.1. Procedure
  • 4.2. Restrictions
• 5. API for Acquiring/Changing Parameters of VN-E4
  • 5.1. Explanatory Notes
  • 5.2. Signal Input
    • Acquiring Comment in JPEG from VN-E4
    • Setting Comment in JPEG from VN-E4
    • Acquiring Brightness from VN-E4
    • Setting Brightness for VN-E4
    • Acquiring Contrast from VN-E4
    • Setting Contrast for VN-E4
    • Acquiring Saturation from VN-E4
    • Setting Saturation for VN-E4
    • Acquiring Phase from VN-E4
    • Setting Phase for VN-E4
    • Acquiring Turnover from VN-E4
    • Setting Turnover for VN-E4
    • Acquiring Echo Suppressor from VN-E4
    • Setting Echo Suppressor for VN-E4
    • Acquiring Noise Suppressor from VN-E4
    • Setting Noise Suppressor for VN-E4
  • 5.3. JPEG Encoding
    • Acquiring JPEG Encoding On/Off from VN-E4
    • Setting JPEG Encoding On/Off for VN-E4
    • Acquiring Frame Rate from VN-E4
    • Setting JPEG Frame Rate for VN-E4
    • Acquiring Rate Control Setting from VN-E4
    • Setting Rate Control for VN-E4
    • Acquiring File Size Setting from VN-E4
    • Setting File Size for VN-E4
    • Acquiring Interpolation Setting from VN-E4
    • Setting Interpolation for VN-E4
  • 5.4. Alarm Setting
    • Acquiring Alarm On/Off Status from VN-E4
    • Setting Alarm to Off for VN-E4
    • Acquiring JPEG Parameters Added to FTP from VN-E4
    • Setting JPEG Parameters Added to FTP from VN-E4
    • Acquiring Alarm Action from VN-E4
    • Setting Alarm Action for VN-E4
    • Acquiring Alarm Trigger from VN-E4
    • Setting Alarm Trigger for VN-E4
  • 5.5. Alarm Environment Setting
    • Acquiring SMTP Server Address Setting from VN-E4
    • Setting SMTP Server Address for VN-E4
    • Acquiring SMTP Server Port Number Setting from VN-E4
    • Setting SMTP Server Port Number for VN-E4
    • Acquiring "POP before SMTP" Setting from VN-E4
    • Setting "POP before SMTP" for VN-E4
    • Acquiring POP Server Address Setting from VN-E4
    • Setting POP Server Address for VN-E4
    • Acquiring POP Server Port Number Setting from VN-E4
    • Setting POP Server Port Number for VN-E4
    • Acquiring POP Server User Name Setting from VN-E4
    • Setting POP Server User Name for VN-E4
    • Setting POP Server Password for VN-E4
    • Acquiring FTP Server Address Setting from VN-E4
    • Setting FTP Server Address for VN-E4
    • Acquiring FTP Server Directory Setting from VN-E4
    • Setting FTP Server Directory for VN-E4
    • Acquiring FTP Server User Name Setting from VN-E4
    • Setting FTP Server User Name for VN-E4
    • Setting FTP Server Password for VN-E4
    • Acquiring Chattering Guard Time Setting of Alarm Input from VN-E4
    • Setting Chattering Guard Time of Alarm Input for VN-E4
    • Acquiring Alarm Output Time Setting from VN-E4
    • Setting Alarm Output Time for VN-E4
    • Acquiring Alarm Output Status from VN-E4
    • Changing Alarm Output of VN-E4
  • 5.6. Motion Detect
    • Acquiring Motion Detect On/Off Status from VN-E4
    • Setting Motion Detect to On/Off for VN-E4
    • Acquiring Motion Detect Sensitivity from VN-E4
    • Setting Motion Detect Sensitivity for VN-E4
    • Acquiring Motion Parameters of Motion Detect from VN-E4
    • Setting Motion Parameters of Motion Detect for VN-E4
    • Acquiring Motion Detect Mask from VN-E4
    • Setting Motion Detect Mask for VN-E4
  • 5.7. Serial Port
    • Acquiring Serial Port Baud Rate Setting from VN-E4
    • Setting Serial Port Baud Rate for VN-E4
    • Acquiring Serial Port Data Length Setting from VN-E4
    • Setting Serial Port Data Length for VN-E4
    • Acquiring Serial Port Parity Setting from VN-E4
    • Setting Serial Port Parity for VN-E4
    • Acquiring Serial Port Stop Bit Setting from VN-E4
    • Setting Serial Port Stop Bit for VN-E4
    • Acquiring Serial Port Comment from VN-E4
    • Setting Serial Port Comment for VN-E4
  • 5.8. Network Basics
    • Enabling Network Setting Changes
    • Acquiring DHCP Setting from VN-E4
    • Setting DHCP for VN-E4
    • Acquiring IP Address from VN-E4
    • Setting IP Address for VN-E4
    • Acquiring Subnet Mask from VN-E4
    • Setting Subnet Mask for VN-E4
    • Acquiring Default Gateway from VN-E4
    • Setting Default Gateway for VN-E4
    • Acquiring Host Name from VN-E4
    • Setting Host Name for VN-E4
    • Acquiring Domain Name from VN-E4
    • Setting Domain Name for VN-E4
    • Acquiring DNS Server On/Off Status from VN-E4
    • Setting DNS Server Status to On/Off for VN-E4
    • Acquiring DNS Server Type from VN-E4
    • Setting DNS Server Type for VN-E4
    • Acquiring DNS Server IP Address from VN-E4
    • Setting DNS Server IP Address for VN-E4
    • Acquiring MAC Address from VN-E4
    • Acquiring IPv6 On/Off Status from VN-E4
    • Setting IPv6 Status to On/Off for VN-E4
    • Acquiring Link-local IPv6 Address from VN-E4
    • Acquiring Site-local IPv6 Address from VN-E4
    • Acquiring Global IPv6 Address from VN-E4
  • 5.9. Network Details
    • Acquiring DSCP Value of Images from VN-E4
    • Setting DSCP Value of Images for VN-E4
    • Acquiring DSCP Value of Audio Data from VN-E4
    • Setting DSCP Value of Audio Data for VN-E4
    • Acquiring MTU Value VN-E4
    • Setting MTU Value for VN-E4
    • Acquiring Network Negotiation Setting from VN-E4
    • Setting Network Negotiation for VN-E4
    • Acquiring PPPoE On/Off Status from VN-E4
    • Setting PPPoE Status to On/Off for VN-E4
    • Acquiring PPPoE User Name from VN-E4
    • Setting PPPoE User Name for VN-E4
    • Setting PPPoE Password for VN-E4
  • 5.10. Manual Transmission
  • 5.11. Access Restrictions
    • Acquiring Deny/Allow Setting of Client Restrictions from VN-E4
    • Setting Client Restriction to Deny/Allow for VN-E4
    • Acquiring IP Address Setting of Restricted Client from VN-E4
    • Setting IP Address of Restricted Client for VN-E4
    • Acquiring Deny/Allow Setting of Audio Sender Restrictions from VN-E4
    • Setting Audio Sender Restriction to Deny/Allow for VN-E4
    • Acquiring IP Address Setting of Restricted Audio Sender from VN-E4
    • Setting IP Address of Audio Sender Restrictions for VN-E4
  • 5.12. Time
    • Acquiring NTP Client Feature On/Off Status from VN-E4
    • Setting NTP Client Feature Status to On/Off for VN-E4
    • Acquiring NTP Server Address from VN-E4
    • Setting NTP Server Address for VN-E4
    • Acquiring Access Interval to NTP Server from VN-E4
    • Setting Access Interval to NTP Server for VN-E4
    • Acquiring Time from VN-E4
    • Setting Time for VN-E4
    • Acquiring Timezone from VN-E4
    • Setting Timezone for VN-E4
  • 5.13. Password
    • Setting Password for VN-E4
  • 5.14. Maintenance
    • Initialization
    • Version Upgrade
  • 5.15. Acquiring Status
    • Acquiring Sending Status
    • Acquiring Log
  • 5.16. Acquiring Settings
    • Acquiring Model Name
    • Acquiring Firmware Revisions
    • Acquiring DSP Firmware Revisions
  • 5.17. Others
    • Restart VN-E4
    • Acquiring SNMP Agent Feature On/Off Status from VN-E4
    • Setting SNMP Agent Feature Status to On/Off for VN-E4
• 6. API for Sending JPEG/Audio from VN-E4 via UDP
  • 6.1. Procedure
  • 6.2. List of APIs
    • (1) Sending JPEG from VN-E4 via RTP/UDP
    • (2) Stopping JPEG/RTP/UDP Sending from VN-E4
    • (3) Sending Audio (u-Law) from VN-E4 via RTP/UDP
    • (4) Stopping Audio (u-Law) Sending from VN-E4
• 7. API for Audio Receiving by VN-E4
  • 7.1. Audio Receiving via HTTP
  • 7.2. Audio Receiving via RTP
• 8. API for Controlling External Devices Connected to VN-E4
  • 8.1. Control of Pelco-D Camera
    • (1) Pan Control
    • (2) Tilt Control
    • (3) Iris Control
    • (4) Focus Control
    • (5) Zoom Control
  • 8.2. Control of External Devices via Pass-through
    • (1) Reservation of Pass-through Feature via API
    • (2) TCP Connection for Pass-through
    • (3) Sending Pass-through Data
    • (4) Ending Pass-through
• 9. List of Protocols and Port Numbers Used with VN-E4
• 10. Advanced Topics
• 11. Customizing VN-E4's Built-in Viewer
  • (1) HTML Sample
  • (2) Public Interface of ActiveX Control