61
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