JVC VN-E4U API Guide - Page 3

Content 1. Acquiring JPEG from VN-E4 via HTTP 5 1.1. Basic Procedures 5 1.2. API Format 6 Structure 6 Parameter Description 6 1.3. Response 7 When API is successfully received 7 When VN-E4 fails to realize the requested frame rate .....7 When the specified input channel and frame size are not available 7 1.4. Restrictions 8 1.5. JPEG File Format Sent Out by VN-E4 9 2. Acquiring Audio Data from VN-E4 via HTTP 10 2.1. Basic Procedures 10 2.2. API Format 11 Structure 11 Parameter Description 11 2.3. Response 12 2.4. Restrictions 13 3. Acquiring Alarm from VN-E4 14 3.1 Procedure 14 3.2. Restrictions 15 4. Using API that Requires Basic Authentication 16 4.1. Procedure 16 4.2. Restrictions 17 5. API for Acquiring/Changing Parameters of VN-E4 18 5.1. Explanatory Notes 18 5.2. Signal Input 19 Acquiring Comment in JPEG from VN-E4 19 Setting Comment in JPEG from VN-E4 19 Acquiring Brightness from VN-E4 19 Setting Brightness for VN-E4 20 Acquiring Contrast from VN-E4 20 Setting Contrast for VN-E4 20 Acquiring Saturation from VN-E4 20 Setting Saturation for VN-E4 21 Acquiring Phase from VN-E4 21 Setting Phase for VN-E4 21 Acquiring Turnover from VN-E4 21 Setting Turnover for VN-E4 22 Acquiring Echo Suppressor from VN-E4 22 Setting Echo Suppressor for VN-E4 22 Acquiring Noise Suppressor from VN-E4 22 Setting Noise Suppressor for VN-E4 22 5.3. JPEG Encoding 23 Acquiring JPEG Encoding On/Off from VN-E4 23 Setting JPEG Encoding On/Off for VN-E4 23 Acquiring Frame Rate from VN-E4 23 Setting JPEG Frame Rate for VN-E4 24 Acquiring Rate Control Setting from VN-E4 24 Setting Rate Control for VN-E4 24 Acquiring File Size Setting from VN-E4 25 Setting File Size for VN-E4 25 Acquiring Interpolation Setting from VN-E4 25 Setting Interpolation for VN-E4 26 5.4. Alarm Setting 27 Acquiring Alarm On/Off Status from VN-E4 27 Setting Alarm to Off for VN-E4 27 Acquiring JPEG Parameters Added to FTP from VN-E4 27 Setting JPEG Parameters Added to FTP from VN-E4 28 Acquiring Alarm Action from VN-E4 28 Setting Alarm Action for VN-E4 29 Acquiring Alarm Trigger from VN-E4 30 Setting Alarm Trigger for VN-E4 30 5.5. Alarm Environment Setting 31 Acquiring SMTP Server Address Setting from VN-E4 31 Setting SMTP Server Address for VN-E4 31 Acquiring SMTP Server Port Number Setting from VN-E4 31 Setting SMTP Server Port Number for VN-E4 31 Acquiring "POP before SMTP" Setting from VN-E4.....32 Setting "POP before SMTP" for VN-E4 32 Acquiring POP Server Address Setting from VN-E4 .....32 Setting POP Server Address for VN-E4 32 Acquiring POP Server Port Number Setting from VN-E4 32 Setting POP Server Port Number for VN-E4 33 Acquiring POP Server User Name Setting from VN-E4 33 Setting POP Server User Name for VN-E4 33 Setting POP Server Password for VN-E4 33 Acquiring FTP Server Address Setting from VN-E4......34 Setting FTP Server Address for VN-E4 34 Acquiring FTP Server Directory Setting from VN-E4 ...34 Setting FTP Server Directory for VN-E4 34 Acquiring FTP Server User Name Setting from VN-E4 35 Setting FTP Server User Name for VN-E4 35 Setting FTP Server Password for VN-E4 35 Acquiring Chattering Guard Time Setting of Alarm Input from VN-E4 35 Setting Chattering Guard Time of Alarm Input for VN-E4 36 Acquiring Alarm Output Time Setting from VN-E4 ......36 Setting Alarm Output Time for VN-E4 36 Acquiring Alarm Output Status from VN-E4 36 Changing Alarm Output of VN-E4 36 5.6. Motion Detect 37 Acquiring Motion Detect On/Off Status from VN-E4....37 Setting Motion Detect to On/Off for VN-E4 37 Acquiring Motion Detect Sensitivity from VN-E4 .........37 Setting Motion Detect Sensitivity for VN-E4 37 Acquiring Motion Parameters of Motion Detect from VN-E4 38 Setting Motion Parameters of Motion Detect for VN-E4 38 Acquiring Motion Detect Mask from VN-E4 38 Setting Motion Detect Mask for VN-E4 39 5.7. Serial Port 40 Acquiring Serial Port Baud Rate Setting from VN-E4 ...40 Setting Serial Port Baud Rate for VN-E4 40 Acquiring Serial Port Data Length Setting from VN-E4 40 Setting Serial Port Data Length for VN-E4 40 Acquiring Serial Port Parity Setting from VN-E4 ..........41 Setting Serial Port Parity for VN-E4 41 Acquiring Serial Port Stop Bit Setting from VN-E4.......41 Setting Serial Port Stop Bit for VN-E4 41 Acquiring Serial Port Comment from VN-E4 42 Setting Serial Port Comment for VN-E4 42 5.8. Network Basics 43 Enabling Network Setting Changes 43 Acquiring DHCP Setting from VN-E4 43 Setting DHCP for VN-E4 43 Acquiring IP Address from VN-E4 43 Setting IP Address for VN-E4 44 3