JVC 4ch Network Encoder VN-E4 Api Manual Download Page 36 | Manualshive

Page: 36 / 80

background image

36

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

Example

When setting the chattering guard time for alarm input 1

/api/param?peripheral.input_pin.pin(1).chatter=150

Example of response

peripheral.input_pin.pin(1).chatter&200 OK

Interpretation

Change the time setting to prevent chattering in the alarm input. Specify a number between 1 to 4 as VN-E4
has 4 alarm inputs. Unit of the response value is in msec.

Allowed users

admin, operator

Acquiring Alarm Output Time Setting from VN-E4

Format

/api/param?peripheral.output_pin.pin.duration

Example of Response

peripheral.output_pin.pin.duration=1000&200 OK

Interpretation

Acquire the current alarm output duration in millisecond. If alarm output is set in alarm action, this parameter
can be acqurired by following API.

/api/param?application.event(Number).action

Allowed users

admin, operator, user

Setting Alarm Output Time for VN-E4

Format

/api/param?peripheral.input_pin.pin.duration=data

Example

/api/param?peripheral.input_pin.pin.duration=50

Example of response

peripheral.input_pin.pin.duration&200 OK

Interpretation

Change the alarm output duration in millisecond. Specify 0, or 50 to 5000. Following API is also available to
set the parameter.

/api/param?application.event(Number).action

Allowed users

admin, operator

Acquiring Alarm Output Status from VN-E4

Format

/api/param?peripheral.output_pin.pin.status

Example of Response

peripheral.output_pin.pin.status=make&200 OK

Interpretation

Acquire the current alarm output status. Either make or break will be returned.

Allowed users

admin, operator, user

Changing Alarm Output of VN-E4

Format

/api/param?peripheral.output_pin.pin.status=data

Example

/api/param?peripheral.output_pin.pin.status=break

Example of Response

peripheral.output_pin.pin.status&200 OK

Interpretation

Change the alarm output. Specify as make or break.
When the alarm output time is zero, alarm output is changed as this API specifies. When the alarm output time is not
zero, alarm output is changed as this API specifies, then alarm output is changed again after the alarm output time.

Allowed users

admin, operator

«
...
34
35
36
37
38
...
»

Summary of Contents for 4ch Network Encoder VN-E4

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

Page 2: ...g operations are possible Acquisition of JPEG from VN E4 Acquisition of audio from VN E4 Acquisition of alarm from VN E4 Acquiring or changing VN E4 settings Multicast sending of JPEG audio from VN E4 Reception of audio at VN E4 Control of external devices that are connected to the serial port of VN E4 Customization of VN E4 s built in viewer Getting Started ...

Page 3: ...g 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...

Page 4: ...striction 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 Inter...

Page 5: ...0 sendbuffer 16 CRLF CRLF 4 VN E4 sends out JPEG data after returning the response JPEG files will be sent out continuously Responses and JPEG data sent out by VN E4 are as follows A 12 byte header will be added to the beginning of the JPEG file when header 1 is specified in the API parameter Details on the header structure and JPEG file format will be explained later 5 When the client wants to st...

Page 6: ...rame of the JPEG data will be sent when the parameter is specified as framerate 0 In this case VN E4 will disconnect TCP after 5 seconds if this is not disconnected by the client header For specifying whether to add a 12 byte header to the JPEG data Default value is 0 Header format is as follows The first 4 bytes 0x00000001 indicate that the payload is a JPEG data assured VN E4 temporarily saves u...

Page 7: ...HTTP 1 1 206 Partial Content CRLF Connection Keep Alive CRLF Content Length 27616 CRLF Content Type image jpeg CRLF Date Fri 13 MAY 2005 07 33 12 GMT CRLF Server VN E4 Jpeg Audio Server 1 0 0 CRLF Keep Alive timeout 5 max 5 CRLF x vne4_response input 1 framesize vga framerate 15 header 0 assured 0 sendbuffer 16 CRLF CRLF Frame rate encoded by VN E4 can be changed using the web setting page or API ...

Page 8: ... maximum bitrate of VN E4 The maximum distribution capacity of VN E4 is 40 Mbps VN E4 will return an error 503 Service Unavailable when the distribution capacity is exceeded due to the API s request In this case VN E4 will disconnect TCP after 5 seconds if this is not disconnected by the client 䡵 Number of clients The maximum number of clients for which TCP can connect to 8009 is 10 When a connect...

Page 9: ...larm inputs are assigned to 4 bits from the LSB For example value is alarm 00000001when changes occur with alarm input 1 alarm 00000008 when changes occur with alarm input 4 and alarm 00000009 when changes occur with alarm inputs 1 and 4 Camera ID 50 camera input01 Stores camera information set at VN E4 Character code is Shift JIS when information is stored in Japanese Motion Detect Setting 11 mot...

Page 10: ...esponse A 512 byte u Law data with a 12 byte header will be sent out repeatedly Responses and u Law data sent out by VN E4 are as follows Format of the 12 byte header is as follows The header is made up of 3 4 byte data The first 4 bytes 0x00000080 indicate that the payload is an audio data 5 The client disconnects TCP8009 to end the audio transmission New APIs that are sent without disconnecting ...

Page 11: ...iption assured VN E4 temporarily saves up to 2 5 seconds of the compressed data Specify as assured 0 to request for the latest data that is temporarily saved and assured 1 to request for the oldest data Specify as assured 0 to shorten the audio delay time To enable stable playback in a network where jitter occurs it is recommended that this be specified as assured 1 Default value is 1 lowdelay Spe...

Page 12: ...he 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 Audio Server 1 0 0 CRLF Keep Alive timeout 5 max 5 CRLF x vne4_response assured 0 lowdelay 0 CRLF CRLF 2 3 Response ...

Page 13: ... by maximum bitrate of VN E4 The maximum distribution capacity of VN E4 is 40 Mbps VN E4 will return an error 503 Service Unavailable when the distribution capacity is exceeded due to the API s request In this case VN E4 will disconnect TCP after 5 seconds if this is not disconnected by the client 䡵 Number of clients The maximum number of clients for which TCP can connect to 8009 is 10 When a conn...

Page 14: ...owing 4 lines indicate whether motion has been detected at each of the video input channel peripheral input_pin pin 1 status break CRLF peripheral input_pin pin 2 status break CRLF peripheral input_pin pin 3 status make CRLF peripheral input_pin pin 4 status break CRLF video input 1 detection motion status on CRLF video input 2 detection motion status off CRLF video input 3 detection motion status...

Page 15: ...tion 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 When a 5th client sends a SYN for TCP connection to port number 32040 VN E4 will return an RST Additionally VN E4 will also check whether the TCP connection is maintained at regular intervals VN E4 will disconnect the TCP connection if syn exchange...

Page 16: ... for each API Join the user name and the password using a colon Base64 encode this character string and enter this in the Authorization line For example when User name admin Password vn e4 then the character string upon joining the user name and the password with a colon will be admin vn e4 Base64 encoding this string yields YWRtaW46dm4tZTQ Enter this in the Authorization line Default passwords in...

Page 17: ...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 4 2 Restrictions ...

Page 18: ...dy of the response Example ParamA ParamB ParamC 401 Unauthorized When multiple acquirings are performed at one time a response will be returned for each setting ParamA ParamB ParamC 200 OK CRLF ParamA ParamB ParamD 200 OK CRLF 2 Setting parameters Specify API in GET according to the format below when setting a parameter for VN E4 api param ParamA ParamB ParamC Data Parameter values are indicated u...

Page 19: ...deo input 1 comment input01 Example when setting as blank api param video input 1 comment 00 Example of response video input 1 comment 200 OK Interpretation Change the comment in JPEG of the specified video input channel This comment is stored in the JPEG header Specify the video input channel between the range of 1 to 4 Maximum size of comments is 40 bytes To set as blank specify as 00 0x25 0x30 ...

Page 20: ...f 1 to 4 Range of Contrast is between 0 to 100 The larger the value the stronger will be the contrast Allowed users admin operator user Setting Contrast for VN E4 Format api param video input Number contrast data Example When setting Contrast of video input channel 1 api param video input 1 contrast 50 Example of response video input 1 contrast 200 OK Interpretation Change the Contrast set value o...

Page 21: ...se is between 0 to 100 180 degrees when 0 is specified 0 degree when 50 is specified and 180 degrees when 100 is specified Allowed users admin operator user Setting Phase for VN E4 Format api param video input Number phase data Example When setting Phase of video input channel 1 api param video input 1 phase 50 Example of response video input 1 phase 200 OK Interpretation Change the Phase set valu...

Page 22: ...or setting of the audio input Specify as high mid low or off Allowed users admin operator user Setting Echo Suppressor for VN E4 Format api param audio input echo_suppress data Example api param audio input echo_suppress low Example of response audio input echo_suppress 200 OK Interpretation Change the Echo Suppressor setting of the audio input Specify as high mid low or off Allowed users admin op...

Page 23: ...from video input channels Allowed users admin operator user Setting JPEG Encoding On Off for VN E4 Format api param encode Number status data Example When setting encoding on off of Encoding No 1 api param encode 1 status off Example of response encode 1 status 200 OK Interpretation Change the encoding on off of the specified encoding number Specify as on to turn on and off to turn off Note that e...

Page 24: ...t channels Quantization table is fixed in the case of vfs VariableFileSize In the case of afs AverageFileSize bit rates are controlled such that the average size of multiple files remains constant For cfs ConstantFileSize bit rates are controlled such that the size of each file remains constant Upon setting to afs or vfs the rate control processing load will increase and the maximum frame rate tha...

Page 25: ...n the range of 3 k to 33 k is possible When VFS VariableFileSize is specified for rate control at the WEB setting page 7 levels will be available for selection Each of these choices corresponds to the file sizes as follows When rate control is set to vfs and a file size that is not stated above is specified the closest choice will be displayed on the WEB setting page Allowed users admin operator A...

Page 26: ...annels When this is set to on JPEG compression will be performed upon creating VGA based on the first field out of the 2 fields that make up the video frame When this is set to off the video frame will be directly JPEG compressed Images with intense motion will not appear blurred when this is set to on For images with little motion set to off to obtain a high resolution image This setting is valid...

Page 27: ...ill be deleted When it is an FTP action the object file attribute that is sent via FTP will also be deleted Up to 10 alarm actions can be specified and therefore the number of event number can also be set between the range of 1 to 10 Note that alarm numbers are different from the alarm input pin numbers This API cannot be used to turn on the alarm action To turn on the alarm action specify a speci...

Page 28: ...uisition 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 Acquisition of input CH application object 1 source video input 01 200 OK Acquisition of frame size application object 1 framesize vga ...

Page 29: ...body somecompany com none Message Example of Response application event 1 action 200 OK Interpretation Set the alarm action of the specified alarm number Up to 10 alarm actions can be specified and therefore 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 A separate API api param application event Number...

Page 30: ... will be returned in the case of make for alarm input 1 b2 will be returned in the case of break for alarm input 2 and v3 will be returned for motion detection of video input 3 Example of Response application event 1 trigger v4 200 OK When a combination of 2 Triggers are set responses such as m1 10 b2 will be returned The example above indicates that trigger will be activated when break is invoked...

Page 31: ...pplication smtp host 10 0 0 200 Example of Response application smtp host 200 OK Interpretation Change the address setting of the SMTP server Specify the IP address or FQDN The maximum FQDN size is 60 bytes Specify as 0 0 0 0 when the SMTP server is not set It is also possible to leave the setting field blank as follows api param application smtp host 00 Allowed users admin operator Acquiring SMTP...

Page 32: ... application pop host Example of Response application pop host 10 0 0 200 200 OK Response example when setting field is left blank application pop host 200 OK Interpretation Acquire the address setting of the POP server Allowed users admin operator user Setting POP Server Address for VN E4 Format api param application pop host data Example api param application pop host 10 0 0 200 Example of Respo...

Page 33: ...s admin operator user Setting POP Server User Name for VN E4 Format api param application pop user data Example api param application pop user somename Example of Response application pop user 200 OK Interpretation Change the user name setting of the POP server The maximum user name size is 60 bytes Set as follows when this is to be left blank api param application pop user 00 Allowed users admin ...

Page 34: ...m application ftp path 00 Allowed users admin operator Acquiring FTP Server Directory Setting from VN E4 Format api param application ftp path Example of Response application ftp path subdir1 200 OK Response example when setting field is left blank application ftp path 200 OK Interpretation Acquire the FTP server directory setting used for FTP transmission via alarm Allowed users admin operator us...

Page 35: ...word for VN E4 Format api param application ftp password data Example api param application ftp password someword Example of Response application ftp password 200 OK Interpretation Change the FTP server password setting used for FTP transmission via alarm The maximum password size is 60 bytes Set as follows when this setting is to be left blank api param application ftp password 00 Allowed users a...

Page 36: ...t Time for VN E4 Format api param peripheral input_pin pin duration data Example api param peripheral input_pin pin duration 50 Example of response peripheral input_pin pin duration 200 OK Interpretation Change the alarm output duration in millisecond Specify 0 or 50 to 5000 Following API is also available to set the parameter api param application event Number action Allowed users admin operator ...

Page 37: ...ect VN E4 enables motion detect to be set to on or off for each of the 4 video inputs Specify a value between 1 to 4 for the number Specify as on or off Allowed users admin operator Acquiring Motion Detect Sensitivity from VN E4 Format api param video input Number detection level Example When acquiring the motion detect sensitivity of video input channel 1 api param video input 1 detection level E...

Page 38: ... to 100 The larger the value the easier it will be to detect objects moving at high speed The smaller the value the easier it will be to detect slow moving objects Allowed users admin operator Acquiring Motion Detect Mask from VN E4 Format api param video input Number detection area Example When acquiring the motion detect mask of video input channel 1 api param video input 1 detection area Exampl...

Page 39: ...2030405060708091011121314151617 Example of response 1 detection area 200 OK Interpretation Change the motion detect mask VN E4 enables motion detect to be adjusted for each of the 4 video inputs Specify a value between 1 to 4 for the number Specify using an 18 ASCII character string Refer to the item on Acquiring Motion Mask from VN E4 on the interpretation of this character string To mask all blo...

Page 40: ...api param peripheral serial 1 baud 19200 Example of response peripheral serial 1 baud 200 OK Interpretation Change the serial port s baud rate Specify a value between 1 to 2 since VN E4 comes with 2 serial ports Specify baud rate as 1200 1800 2400 4800 9600 19200 or 38400 Allowed users admin operator Acquiring Serial Port Data Length Setting from VN E4 Format api param peripheral serial Number bit...

Page 41: ... port Specify a value between 1 to 2 since VN E4 comes with 2 serial ports Specify parity as none odd or even Allowed users admin operator Acquiring Serial Port Stop Bit Setting from VN E4 Format api param peripheral serial Number stopbit Example When acquiring stop bit of Serial Port 1 api param peripheral serial 1 stopbit Example of response peripheral serial 1 stopbit 1 200 OK Interpretation Ac...

Page 42: ...affect the functions of the serial port Allowed users admin operator user Setting Serial Port Comment for VN E4 Format api param peripheral serial Number comment data Example When setting comment of Serial Port 1 api param peripheral serial 1 comment Memo1 Example of response peripheral serial 1 comment 200 OK Interpretation Change the serial port comment Specify a value between 1 to 2 since VN E4...

Page 43: ... user admin Acquiring DHCP Setting from VN E4 Format api param network interface dhcp status Example of Response network interface dhcp status off 200 OK Interpretation Acquire the current DHCP setting Allowed users admin operator user Setting DHCP for VN E4 Format api param network interface dhcp status data Example api param network interface dhcp status on Example of Response network interface ...

Page 44: ... 200 OK Interpretation Acquire the current subnet mask Allowed users admin operator user Setting Subnet Mask for VN E4 Format api param network interface subnetmask data Example api param network interface subnetmask 255 0 0 0 Example of Response network interface subnetmask 202 Required network interface status restart Interpretation Change the subnet mask Upon setting this API execute the networ...

Page 45: ...ork hostname localhost 200 OK Interpretation Acquire the current host name Allowed users admin operator user Setting Host Name for VN E4 Format api param network hostname data Example api param network hostname somename Example of Response network hostname 202 Required network interface status restart Interpretation Change the host name Characters that may be used for the host name are alphanumeri...

Page 46: ...min operator user Setting DNS Server Status to On Off for VN E4 Format api param network dns status data Example api param network dns status on Example of Response network dns status 202 Required network interface status restart Interpretation Change the on off status of the DNS server Specify as on or off Upon setting this API execute the network interface status restart API for enabling network...

Page 47: ...ion Acquire the MAC address A 12 byte ASCII character string will be returned There is no API for setting the MAC address Allowed users admin operator user Acquiring IPv6 On Off Status from VN E4 Format api param network interface ipv6 status Example of Response network interface ipv6 status off 200 OK Interpretation Acquire the on off status of IPv6 Either on or off will be returned Allowed users...

Page 48: ...etwork interface ipv6 site_local 1 Example of Response network interface ipv6 site_local 1 fec0 1 280 88ff fe41 114 200 OK Interpretation Acquire the site local IPv6 address A number between 1 to 8 may be specified and the site local IPv6 addresses will be stored in sequence beginning from 1 To acquire all addresses do so in sequence from 1 until an empty value is returned There is no API for sett...

Page 49: ...network interface status restart API for enabling network setting changes to enable the new settings Allowed user admin Acquiring DSCP Value of Audio Data from VN E4 Format api param network interface dscp audio Example of Response network interface dscp audio 56 200 OK Interpretation Acquire the DSCP value of the audio data Allowed users admin operator user Setting DSCP Value of Audio Data for VN...

Page 50: ...terpretation Acquire the network Negotiation setting Either auto 100full 100half 10full or 10half will be returned Allowed users admin operator user Setting Network Negotiation for VN E4 Format api param network interface negotiation data Example api param network interface negotiation auto Example of Response network interface negotiation 202 Required network interface status restart Interpretati...

Page 51: ...min operator Setting PPPoE User Name for VN E4 Format api param network interface pppoe user data Example api param network interface pppoe user somename Example of Response network interface pppoe user 202 Required network interface status restart Interpretation Change the PPPoE user name Set a user name that is within 60 bytes Upon changing PPPoE VN E4 will be rebooted using the network interfac...

Page 52: ...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 5 10 Manual Transmission ...

Page 53: ...param network access_control api host Number Example When acquiring the first IP address api param network access_control api host 1 Example of Response network access_control api host 1 10 0 0 100 200 OK Interpretation Acquire the IP address setting of the restricted client Setting is possible up to 10 items Specify a value between 1 to 10 for the number The following will be returned if subnet m...

Page 54: ...Change the deny allow setting of audio sender restrictions Specify as deny or allow This API acquires the same details as the Access Restriction item of Source Address of Audio Sender at the bottom of the Access Restrictions page Allowed user admin Acquiring IP Address Setting of Restricted Audio Sender from VN E4 Format api param network access_control stream_in host Number Example When acquiring...

Page 55: ...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 Example api param network access_control stream_in host 1 10 0 0 0 24 Set as follows if the setting is to be left blank Example api param network access_control stream_in host 1 00 This API acquires the same details as the Access Restriction item of Source Address of Audio Se...

Page 56: ...enabling network setting changes to enable the new settings Allowed users admin operator Acquiring NTP Server Address from VN E4 Format api param network ntp host Example of Response network ntp host 10 0 0 100 200 OK Interpretation Acquire the address of the NTP server Either the IP address or FQDN will be returned Allowed users admin operator user Setting NTP Server Address for VN E4 Format api ...

Page 57: ...le api param system date 20050614171537 Example of Response system date 200 OK Interpretation Change the time of the built in clock in VN E4 Specify in the order of year month day hour minute and second Specify year in a 4 digit decimal number and month day hour minute and second in 2 digit decimal numbers Allowed user admin Acquiring Timezone from VN E4 Format api param system timezone Example of...

Page 58: ...our earlier than the Greenwich Mean Time GMT 2 Timezone that is 2 hour earlier than the Greenwich Mean Time GMT 1 Timezone that is 1 hour earlier than the Greenwich Mean Time UTC Greenwich Mean Time London Same timezone as UTC GMT 1 Timezone that is 1 hour later than the Greenwich Mean Time Berlin Same timezone as GMT 1 Rome Same timezone as GMT 1 Madrid Same timezone as GMT 1 Paris Same timezone ...

Page 59: ...ystem password admin someword Example of Response system password admin 200 OK Interpretation Change the VN E4 password Different passwords may be set for the 3 user name types namely admin operator and user Set a password between 4 to 8 characters There is no API for acquiring passwords Allowed user admin 5 13 Password Example when setting admin password api param system password admin word1 Exam...

Page 60: ...ialization features on the WEB setting page but only 1 is available for API Initialization Format api param system status initialize Example of Response system status 200 OK Interpretation Restore all VN E4 settings to factory defaults Upon doing so all transmission services that are in progress will be terminated Allowed user admin Version Upgrade Version upgrading is not possible using API To do...

Page 61: ...on 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 se...

Page 62: ...total 2 times 2005 07 01 11 26 30 make 2005 07 01 11 26 29 break Alarm Detect 4 total 2 times 2005 07 01 11 26 30 make 2005 07 01 11 26 29 break Motion Detect 1 total 2 times Motion detect 1ch Blank in the case of 0 times 2005 07 01 11 26 30 Up to the latest 10 lines 2005 07 01 11 26 29 Up to the latest 10 lines Motion Detect 2 total 2 times 2005 07 01 11 26 30 2005 07 01 11 26 29 Motion Detect 3 ...

Page 63: ...tem model VN E4 U 200 OK Interpretation Acquire the model name Allowed users admin operator user Acquiring Firmware Revisions Format api param system software revision Example of Response system software revision 1 0 U 200 OK Interpretation Acquire revisions of the firmware Allowed users admin operator user Acquiring DSP Firmware Revisions Format api param system software revision DSP Example of R...

Page 64: ...etwork snmp_client status 202 Required network interface status restart Interpretation Change the on off status of the SNMP agent feature Set to on or off Upon setting this API execute the network interface status restart API for enabling network setting changes to enable the new settings When SNMP is changed and restarted VN E4 takes about 1 minute for restarting To acquire information of VN E4 v...

Page 65: ...blishes a TCP connection to port number 80 2 The client sends out API via TCP Character strings of the following structure will be sent out The API format when specifying using GET is as follows api cmd ParamA Data ParamB Data ParamC Data Refer to Section 4 on details of the Accept and Authorization lines 3 VN E4 returns a response to the client 4 Perform the action as instructed by VN E4 start or...

Page 66: ...supports will not be accepted Interpretation Send JPEG from VN E4 via RTP UDP JPEG data with a 12 byte RTP header will be sent out repeatedly Allowed users admin operator Example of Response HTTP 1 1 200 OK CRLF Date Fri 13 MAY 2005 07 33 12 GMT CRLF Server VN E4 API Server 1 0 0 CRLF Connection Keep Alive CRLF content type text plain CRLF Connection Keep Alive CRLF Keep Alive timeout 5 max 5 CRLF...

Page 67: ... number to session_id Specify the client IP number VN E4 will register this number and accept the client with the same API stop session_id that the stop command supports will not be accepted Interpretation Send u Law from VN E4 via RTP UDP u law data with a 12 byte RTP header will be sent out repeatedly Allowed users admin operator Example of Response HTTP 1 1 200 OK CRLF Date Fri 13 MAY 2005 07 3...

Page 68: ... session_id with the same value as when send is used All audio sending will be terminated when session_id is specified Interpretation Stop u Law RTP UDP sending from VN E4 Allowed users admin operator Example of Response HTTP 1 1 200 OK CRLF Date Fri 13 MAY 2005 07 33 12 GMT CRLF Server VN E4 API Server 1 0 0 CRLF Connection Keep Alive CRLF content type text plain CRLF Connection Keep Alive CRLF K...

Page 69: ...xt plain CRLF Connection Keep Alive CRLF Keep Alive timeout 5 max 5 CRLF x vne4_response from network from ip 10 0 0 100 from protocol tcp_passive frmo session_id 12345678 from ip_translate on to audio CRLF CRLF 200 OK CRLF The client may disconnect TCP80 at this point of time 3 The client establishes a TCP connection to port number 49298 4 The client continues to send 512 bytes of u Law data with...

Page 70: ...K CRLF The client may disconnect TCP80 at this point of time 3 The client continues to send 512 bytes of u Law data with a 12 byte header to port number 49200 The data s header format is as follows The 12 byte RTP header is made up of 3 4 byte data Refer to RFC1889 for details on the RTP header 4 To end send an API for stopping transmissions API Format api stop from session_id data Example api sto...

Page 71: ...ght Specify the speed between the range of 0 to 100 Specify status as start or stop To specify stop only make use of the API as shown in the following example api param peripheral serial 2 device 123 camera motion pan status stop Allowed users admin operator user 2 Tilt Control API Character String api param peripheral serial Number device Address camera motion tilt mode Data1 peripheral serial Nu...

Page 72: ...amera address Specify the serial port as 1 or 2 Specify the camera address between the range of 0 to 255 Specify focus as manual or auto Use to focus to a distant point to a near point manual to cancel auto focus and auto to turn on auto focus Operation will be executed stepwise upon using the command once and there is no need to stop the operation Allowed users admin operator user 5 Zoom Control ...

Page 73: ...VN E4 will ignore from ip and standby to receive the pass through data from the source IP address of this API Example of Response HTTP 1 1 200 OK CRLF Connection Keep Alive CRLF Content Length 104 CRLF content type text plain CRLF date Fri 13 MAY 2005 07 33 12 GMT CRLF server VN E4 API Server 1 0 0 CRLF keep alive timeout 5 max 5 CRLF x vne4_response from network from ip 10 0 0 100 from protocol t...

Page 74: ...Sending Pass through Data Send the data to output from the serial port of VN E4 via TCP 49152 for serial port 1 and 49153 for serial port 2 Ack received by the serial of VN E4 will be returned to the client by the same TCP port number 4 Ending Pass through End pass through by disconnecting TCP 49152 for serial port 1 and 49153 for serial port 2 It is also possible to end pass through using the fol...

Page 75: ...or 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 Pass through of serial port 1 TCP 49153 Pass through of serial port 2 TCP 49200 UDP transmission of audio from client to VN E4 TCP 49298 TCP transmission of audio from client to VN E4 10 Advanced Topics ...

Page 76: ... size of VN E4 In addition increase the window scale and incoming buffer size at the client s end as well If the OS used by the client is Windows window scale can be altered by changing the registry Refer to the Windows manual for details on operation of Windows registry Additionally the total size that can be increased by the sendbuffer argument of API is up to 1MB Subsequent client requests to i...

Page 77: ...5699 64A1 4024 BB79 27C00553ECD6 STYLE border style solid border 1px border color ffffff PARAM NAME ApiIP VALUE 192 168 0 2 PARAM NAME ApiPort VALUE 8009 PARAM NAME AudioSnd VALUE 1 PARAM NAME AudioRcv VALUE 1 PARAM NAME StartMode VALUE 2 PARAM NAME SelectCh VALUE 1 OBJECT form name myForm table tr td INPUT TYPE BUTTON NAME ch_btn VALUE CH1 onclick ch_click this 1 td td INPUT TYPE BUTTON NAME ch_b...

Page 78: ...ay 1 Display Example SetEnableCH 1 0 Do not display JPEG of 1ch Method SetFrameRate ch rate flag JPEG display frame rate Ch 1 ch1 2 ch2 3 ch3 4 ch4 rate NTSC 30 15 10 7 5 6 5 3 2 1 1 2 1 3 1 5 1 10 1 15 1 20 1 30 PAL 25 12 5 8 3 6 25 5 4 1 3 2 1 1 2 1 3 1 5 1 10 1 15 1 20 1 30 flag 0 1 fps or higher 1 Less than1 fps Example SetFrameRate 1 10 0 Set JPEG rate of 1 ch to 10 fps Method OpePassword pas...

Page 79: ...eX control upon setting 0 Off 1 On Example AudioRcv 1 When turning on audio receiving Property SelectCh For selecting Ch for JPEG display valid only during 1 screen display 1 ch1 2 ch2 3 ch3 4 ch4 Example SelectCh 1 When displaying 1ch Property ApiIP IP Address of VN E4 unit Example ApiIP 192 168 0 2 Specify IP address Property ApiPort Port number to access to JPEG Audio acquisition Example ApiPor...

Page 80: ... 2005 Victor Company Of Japan Limited LST0288 001A VN E4 API GUIDE ...

Reviews:

No comments

Related manuals for 4ch Network Encoder VN-E4

Brand: Danfoss Pages: 68

Brand: Datavideo Pages: 10

Brand: VAD Pages: 18

Brand: YMGI Pages: 64

Brand: Sungrow Pages: 14

Brand: Senergy Pages: 50

Brand: Briggs & Stratton Pages: 60

Brand: ZyXEL Communications Pages: 131

Brand: Canary Pages: 3

OSD2166M Series

Brand: Optical Systems Design Pages: 16

Brand: Dometic Pages: 288

Brand: ADF Web Pages: 27

david delight pro

Brand: mind alive Pages: 28

SITE INVERTER 300

Brand: ICT Pages: 8

B+B SmartWorx 485USB9F-2W

Brand: Advantech Pages: 2

Brand: DeLOCK Pages: 2

Brand: Icy Box Pages: 16

Nelson LINK DAC III

Brand: MSB Technology Pages: 12

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands