Home » JVC Manuals » Security Cameras » JVC VN-E4U » Manual Viewer

JVC VN-E4U API Guide - Page 61

Acquiring Status, Acquiring Sending Status

UPC - 046838021015

Add to My Manuals
Save this manual to your list of manuals

Page 61 highlights

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 Response Return the total transmission bit rate, status of each sending operation, and receiving status. Transmission is not carried out in the following examples. system.session=&200 OK system.session.total_bitrate=0k&200 OK system.session.sending_count=0&200 OK system.session.sending_max=20&200 OK system.session.receiving_count=0&200 OK system.session.receiving_max=1&200 OK In the examples below, 2 streams of TCP are being sent and 1 stream of TCP is being received. system.session=&200 OK system.session.total_bitrate=388k&200 OK system.session.sending_count=2&200 OK system.session.sending_max=20&200 OK system.session.sending(01).bitrate=326k&200 OK system.session.sending(01).to.ip=10.0.0.100&200 OK system.session.sending(01).to.port=1536&200 OK system.session.sending(01).to.protocol=tcp_passive&200 OK system.session.sending(01).to.session=http&200 OK system.session.sending(01).from.input=1&200 OK system.session.sending(01).from.encode=jpeg&200 OK system.session.sending(01).from.framerate=1&200 OK system.session.sending(01).from.framesize=vga&200 OK system.session.sending(02).bitrate=64k&200 OK system.session.sending(02).to.ip=10.0.0.100&200 OK system.session.sending(02).to.port=1538&200 OK system.session.sending(02).to.protocol=tcp_passive&200 OK system.session.sending(02).to.session=http&200 OK system.session.sending(02).from.input=1&200 OK system.session.sending(02).from.encode=ulaw&200 OK system.session.receiving_count=1&200 OK system.session.receiving_max=1&200 OK system.session.receiving(01).bitrate=64k&200 OK system.session.receiving(01).from.ip=10.0.0.100&200 OK system.session.receiving(01).from.port=49298&200 OK system.session.receiving(01).from.protocol=tcp_passive&200 OK system.session.receiving(01).from.session=proprietary&200 OK system.session.receiving(01).to.output=1&200 OK system.session.receiving(01).to.decode=ulaw&200 OK Interpretation Acquire the sending/receiving status of VN-E4. Allowed users admin, operator, user 61

Section	Page
Cover	1
Custom Application Software Development Guide	2
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 \	32
Setting \	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
Acquiring Subnet Mask from VN-E4	44
Setting Subnet Mask for VN-E4	44
Acquiring Default Gateway from VN-E4	44
Setting Default Gateway for VN-E4	45
Acquiring Host Name from VN-E4	45
Setting Host Name for VN-E4	45
Acquiring Domain Name from VN-E4	45
Setting Domain Name for VN-E4	46
Acquiring DNS Server On/Off Status from VN-E4	46
Setting DNS Server Status to On/Off for VN-E4	46
Acquiring DNS Server Type from VN-E4	46
Setting DNS Server Type for VN-E4	46
Acquiring DNS Server IP Address from VN-E4	47
Setting DNS Server IP Address for VN-E4	47
Acquiring MAC Address from VN-E4	47
Acquiring IPv6 On/Off Status from VN-E4	47
Setting IPv6 Status to On/Off for VN-E4	47
Acquiring Link-local IPv6 Address from VN-E4	48
Acquiring Site-local IPv6 Address from VN-E4	48
Acquiring Global IPv6 Address from VN-E4	48
5.9. Network Details	49
Acquiring DSCP Value of Images from VN-E4	49
Setting DSCP Value of Images for VN-E4	49
Acquiring DSCP Value of Audio Data from VN-E4	49
Setting DSCP Value of Audio Data for VN-E4	49
Acquiring MTU Value VN-E4	49
Setting MTU Value for VN-E4	50
Acquiring Network Negotiation Setting from VN-E4	50
Setting Network Negotiation for VN-E4	50
Acquiring PPPoE On/Off Status from VN-E4	50
Setting PPPoE Status to On/Off for VN-E4	51
Acquiring PPPoE User Name from VN-E4	51
Setting PPPoE User Name for VN-E4	51
Setting PPPoE Password for VN-E4	51
5.10. Manual Transmission	52
5.11. Access Restrictions	53
Acquiring Deny/Allow Setting of Client Restrictions from VN-E4	53
Setting Client Restriction to Deny/Allow for VN-E4	53
Acquiring IP Address Setting of Restricted Client from VN-E4	53
Setting IP Address of Restricted Client for VN-E4	53
Acquiring Deny/Allow Setting of Audio Sender Restrictions from VN-E4	54
Setting Audio Sender Restriction to Deny/Allow for VN-E4	54
Acquiring IP Address Setting of Restricted Audio Sender from VN-E4	54
Setting IP Address of Audio Sender Restrictions for VN-E4	54
5.12. Time	56
Acquiring NTP Client Feature On/Off Status from VN-E4	56
Setting NTP Client Feature Status to On/Off for VN-E4	56
Acquiring NTP Server Address from VN-E4	56
Setting NTP Server Address for VN-E4	56
Acquiring Access Interval to NTP Server from VN-E4	56
Setting Access Interval to NTP Server for VN-E4	57
Acquiring Time from VN-E4	57
Setting Time for VN-E4	57
Acquiring Timezone from VN-E4	57
Setting Timezone for VN-E4	58
5.13. Password	59
Setting Password for VN-E4	59
5.14. Maintenance	60
Initialization	60
Version Upgrade	60
5.15. Acquiring Status	61
Acquiring Sending Status	61
Acquiring Log	62
5.16. Acquiring Settings	63
Acquiring Model Name	63
Acquiring Firmware Revisions	63
Acquiring DSP Firmware Revisions	63
5.17. Others	64
Restart VN-E4	64
Acquiring SNMP Agent Feature On/Off Status from VN-E4	64
Setting SNMP Agent Feature Status to On/Off for VN-E4	64
6. API for Sending JPEG/Audio from VN-E4 via UDP	64
6.1. Procedure	65
6.2. List of APIs	66
(1) Sending JPEG from VN-E4 via RTP/UDP	66
(2) Stopping JPEG/RTP/UDP Sending from VN-E4	67
(3) Sending Audio (u-Law) from VN-E4 via RTP/UDP	67
(4) Stopping Audio (u-Law) Sending from VN-E4	68
7. API for Audio Receiving by VN-E4	68
7.1. Audio Receiving via HTTP	69
7.2. Audio Receiving via RTP	70
8. API for Controlling External Devices Connected to VN-E4	70
8.1. Control of Pelco-D Camera	71
(1) Pan Control	71
(2) Tilt Control	71
(3) Iris Control	72
(4) Focus Control	72
(5) Zoom Control	72
8.2. Control of External Devices via Pass-through	73
(1) Reservation of Pass-through Feature via API	73
(2) TCP Connection for Pass-through	74
(3) Sending Pass-through Data	74
(4) Ending Pass-through	74
(1) HTML Sample	77
(2) Public Interface of ActiveX Control	78

Match case Limit results 1 per page

5. API for Acquiring/Changing Parameters of VN-E4 _

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

Response

Return the total transmission bit rate, status of each sending operation, and receiving status. Transmission is

not carried out in the following examples.

system.session=&200 OK

system.session.total_bitrate=0k&200 OK

system.session.sending_count=0&200 OK

system.session.sending_max=20&200 OK

system.session.receiving_count=0&200 OK

system.session.receiving_max=1&200 OK

In the examples below, 2 streams of TCP are being sent and 1 stream of TCP is being received.

system.session=&200 OK

system.session.total_bitrate=388k&200 OK

system.session.sending_count=2&200 OK

system.session.sending_max=20&200 OK

system.session.sending(01).bitrate=326k&200 OK

system.session.sending(01).to.ip=10.0.0.100&200 OK

system.session.sending(01).to.port=1536&200 OK

system.session.sending(01).to.protocol=tcp_passive&200 OK

system.session.sending(01).to.session=http&200 OK

system.session.sending(01).from.input=1&200 OK

system.session.sending(01).from.encode=jpeg&200 OK

system.session.sending(01).from.framerate=1&200 OK

system.session.sending(01).from.framesize=vga&200 OK

system.session.sending(02).bitrate=64k&200 OK

system.session.sending(02).to.ip=10.0.0.100&200 OK

system.session.sending(02).to.port=1538&200 OK

system.session.sending(02).to.protocol=tcp_passive&200 OK

system.session.sending(02).to.session=http&200 OK

system.session.sending(02).from.input=1&200 OK

system.session.sending(02).from.encode=ulaw&200 OK

system.session.receiving_count=1&200 OK

system.session.receiving_max=1&200 OK

system.session.receiving(01).bitrate=64k&200 OK

system.session.receiving(01).from.ip=10.0.0.100&200 OK

system.session.receiving(01).from.port=49298&200 OK

system.session.receiving(01).from.protocol=tcp_passive&200 OK

system.session.receiving(01).from.session=proprietary&200 OK

system.session.receiving(01).to.output=1&200 OK

system.session.receiving(01).to.decode=ulaw&200 OK

Interpretation

Acquire the sending/receiving status of VN-E4.

Allowed users

admin, operator, user

5.15. Acquiring Status