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.
Responses
JPEG (No. 1)
JPEG (No. 2)
A 12-byte header will be added to the beginning of the JPEG file when header=1 is specified in the API
parameter.
Responses
header (12-byte)
JPEG (No. 1)
header (12-byte)
JPEG (No. 2)
Details on the header structure and JPEG file format will be explained later.
5) When the client wants to stop current JPEG transmission, the client disconnects TCP8009.
VN-E4 does not accept further API via current TCP that is used for JPEG transmission. To change parameters,
disconnect current TCP to stop the JPEG transmission, connect new TCP, and send API with new parameter.
5
1. Acquiring JPEG from VN-E4 via HTTP _ 1.2. API Format
1.2. API Format
Structure
GETSpaceAPI Character StringSpaceHTTP/1.10x0D 0x0A
Host:SpaceIP Address of VN-E40x0D 0x0A 0x0D 0x0A
Unlike parameter acquisition/setting, Accept line is not required. Basic authentication is also not necessary.
Parameter values are indicated using =. Do not insert space before and after =.
Example input=1
Parameters are segmented using &. Do not insert space before and after &.
Example input=1&framesize=vga
There is no need to specify all parameters. Default values will be used for parameters that are not specified.
Parameter Description
inputFor specifying the input video channel. For example, specify as input=4 when acquiring CH4. Specify as either
1, 2, 3 or 4.
framesizeFor specifying the frame size. Specify as framesize=vga when acquiring VGA and framesize=qvga when
acquiring QVGA.
framerateFor specifying the frame rate. For example, specify as framerate=5 when acquiring at 5 fps. Specify as
framerate=-5 to acquire at 1/5 fps, or in other words, 1 frame in 5 seconds. Selection range is as follows.
Only 1 frame of the JPEG data will be sent when the parameter is specified as framerate=0. In this case, VNE4 will disconnect TCP after 5 seconds if this is not disconnected by the client.
headerFor 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.
0x00000001
JPEG size in bytes
Time stamp (Unit: 8 kHz)
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 delay time. To acquire as many frames as possible in a network where delay fluctuates, it is
recommended that this be specified as assured=1. Default value is 0.
sendbufferUse this to increase the send buffer size. Default value is 16. Window scale will be enlarged upon increasing
the send buffer size, hence enhancing the transmission volume on networks with considerable delay. The send
buffer size may be increased up to 1024. When the send buffer size has already been increased to 1024 by other
clients, sendbuffer will remain as the default value even if a larger value is specified Refer to "10. Advanced
Topics" on countermeasures against network delays.
6
1. Acquiring JPEG from VN-E4 via HTTP _ 1.3. Response
1.3. Response
When API is successfully received
VN-E4 will return 200 OK. Content-length indicates file size of first JPEG in bytes. The x-vne4_response line indicates current values of all
parameters used for JPEG encoding.
When VN-E4 fails to realize the requested frame rate
Depending on the frame rate settings of VN-E4, transmission may not be possible at the frame rate requested by API. For example, when VNE4 is set to 15 fps, transmission will only be possible at 15 fps even if the client requests for 30 fps. When VN-E4 is set to 15 fps and 10 fps is
requested by the client, transmission will be carried out at 7.5 fps to enable transmission at equal time intervals.
The actual transmission frame rate is stated in the x-vne4_response line.
Frame rate encoded by VN-E4 can be changed using the web setting page or API for setting. Frame rate of data
that are currently being transmitted will remain unchanged even if the frame rate to encode is increased. When
the frame rate to encode is reduced, however, this value will become the upper limit of the transmission frame
rate.
When the specified input channel and frame size are not available
For example, when QVGA encoding of CH4 is set to off at VN-E4, transmission will fail if the client requests for QVGA of CH4. When this
occurs, VN-E4 will return an error response together with a PNG file. "Not Encoded" image is written in the PNG file.
ExampleHTTP/1.1 456 Header Field Not Valid for Resource<CRLF>
(This is followed by a PNG file which includes the "Not Encoded" message.)
7
1. Acquiring JPEG from VN-E4 via HTTP _ 1.4. Restrictions
1.4. Restrictions
䡵 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 8009.
䡵 Restriction 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 connection is made to TCP8009 by an 11th client, this
will be disconnected by VN-E4 immediately after the TCP connection is made.
8
1. Acquiring JPEG from VN-E4 via HTTP _
1.5. JPEG File Format Sent Out by VN-E4
1.5. JPEG File Format Sent Out by VN-E4
JPEG files sent out by VN-E4 are compliant with JFIF and consist of the following.
FFD8Start Code
FFE0Application Segment
FFFEComment Segment
FFC0SOF Frame Information
FFDBDQT Quantization Table
FFC4DHT Huffman Table
FFDAData Start Segment
FFD9End Code
The following information is stored in the comment segment. Each item has a fixed length.
ItemSizeExampleDescription
Version Information9JVC V1.0Indicates the version of information stored in the comment segment
File Size18size = 123456The number of bytes of the JPEG file.
Width13width = 640Width of JPEG.
Height14height = 480Height of JPEG.
Model Name18type = VN-E4Name of model that created the JPEG.
Invert Flag12Stores inversion
information set at VN-E4.
Time Stamp70timestamp =
20050214130509123JST
Alarm Information13alarm = 00000001Indicates the alarm input status when the JPEG is created in a 4-byte
Camera ID50camera = input01Stores camera information set at VN-E4. Character code is Shift-JIS
Motion Detect Setting11motion = 1Specified as 1 when the motion detect feature is ON.
Motion Detect Result7md = 1Specified as 1 if motion is detected at the time when JPEG is created.
Reserved17
Reserved32
Synchronization Time Stamp26sync_timestamp =
1FDC5A34
Video Signal Format20format = NTSCUIndicates the input video signal. Stated as NTSCJ for NTSC in Japan,
Input Channel7ch = 1Indicates the signal source among the 4 inputs of VN-E4.
Picture Quality9intp = 0Stated as 1 when this is set to field interpolation at VN-E4, and 0
Rate Control16size_cntl = VFSDescribes the mode of rate control for JPEG. VFS (VariableFileSize),
Target Size19size = 23456Target size of rate control.
Quantization Scale14q_scale = 45Indicates the quantization scale. Up to 3 digits.
Firmware Version Information 12ver = 01.00Indicates version of the firmware that is used to create JPEG.
Item names and values, excluding the version information that does not include =, are stored in the following format.
Item namesSpace=Spacevalues0x00
Specified as reverse=1 in the case of a vertical inversion.
Indicates the time at which JPEG is created. This is made up of the
year/month/day, hour/minute/second, millisecond and timezone code.
binary value. (Not ASCII code.) 4 alarm 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.
when information is stored in Japanese.
Indicates the 8 kHz counter value in a 4-byte binary value. (Not
ASCII code.) This can be used when synchronizing with audio.
and NTSCU for other NTSC formats. Stated as PAL for PAL format.
when this is set to frame processing.
AFS (AverageFileSize) or CFS (ConstantFileSize).
Defined fixed length by each item.
Example: When width=640, the 13-byte area will be written as follows.
width=6400x000x00
9
2. Acquiring Audio Data from VN-E4 via HTTP _ 2.1. Basic Procedures
q
2.1. Basic Procedures
1) The client establishes a TCP connection to port number 8009.
4) VN-E4 sends out audio data after returning the response.
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.
Responses
2. Ac
header (12-byte)
u-law (512-byte)
header (12-byte)
u-law (512-byte)
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.
0x00000080
No. of bytes of audio data (fixed as 512)
Time stamp (Unit: 8 kHz)
5) The client disconnects TCP8009 to end the audio transmission.
New APIs that are sent without disconnecting TCP will not be valid. To change the parameters, disconnect the
current TCP to stop data distribution, followed by sending API upon establishing a new TCP connection.
10
2. Acquiring Audio Data from VN-E4 via HTTP _ 2.2. API Format
2.2. API Format
Structure
GETSpaceAPI Character StringSpaceHTTP/1.10x0D 0x0A
Host:SpaceIP Address of VN-E40x0D 0x0A 0x0D 0x0A
Unlike parameter acquisition/setting, Accept line is not required. Basic authentication is also not necessary.
Parameter values are indicated using =. Do not insert space before and after =.
Example assured=1
Parameters are segmented using &. Do not insert space before and after &.
Example assured=1&lowdelay=0
There is no need to specify all parameters. Default values will be used for parameters that are not specified.
Parameter Description
assuredVN-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.
lowdelaySpecifying as lowdelay=1 disables the Nagle algorithm of TCP, and audio delay time will be shortened. When
lowdelay=0 is specified, the Nagle algorithm is enabled and audio delay time will be prolonged. However,
transmission overhead will be enhanced. Default value is 1.
11
2. Acquiring Audio Data from VN-E4 via HTTP _ 2.3. Response
2.3. Response
Unlike JPEG acquisition, there is no Content-length. The last line indicates the actual parameters set at VN-E4.
2. Acquiring Audio Data from VN-E4 via HTTP _ 2.4. Restrictions
2.4. Restrictions
䡵 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 8009.
䡵 Restriction 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 connection is made to TCP8009 by an 11th client, this
will be disconnected by VN-E4 immediately after the TCP connection is made.
13
3. Acquiring Alarm from VN-E4 _ 3.1 Procedure
q
3.1 Procedure
1) The client establishes a TCP connection to port number 32040.
2) When motion is detected from the video image of VN-E4, or when there are changes to the alarm input (make or break), VN-E4 will send
out alarm information in the following format. The first 4 lines indicate the current alarm input status (make or break). The following 4
lines indicate whether motion has been detected at each of the video input channel.
3) The client can disconnect TCP32040 to end the alarm acquisition.
3. Ac
14
3. Acquiring Alarm from VN-E4 _ 3.2. Restrictions
3.2. Restrictions
䡵 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 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 is not performed in 10 minutes.
15
4. Using API that Requires Basic Authentication _ 4.1. Procedure
Basic authentication is required for APIs which are explained in Section 5. This section provides basic explanation of the uses of APIs that
require basic authentication.
4.1. Procedure
1) The client establishes 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.
GETSpaceAPI Character StringSpaceHTTP/1.10x0D 0x0A
AcceptSpacetext/plain or text/html0x0D 0x0A
Host:SpaceIP Address of VN-E40x0D 0x0A
Authorization: BasicSpaceUser Name and Password0x0D 0x0A 0x0D 0x0A
The following is an example of API for acquiring the subnet mask of VN-E4.
Specify the response format by Accept line. A plain text response is returned when this is specified as text/
plain. An HTML response will be returned when text/html is specified. An HTML response will be returned
when Accept is not specified.
Restrictions are imposed on clients via basic authentication in the case of API for acquiring/setting parameters
of VN-E4. During basic authentication, user name and password shall be provided in the Authorization line.
There are 3 types of user names, namely admin, operator and user. The type of user for which use is allowed is
predetermined 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 the factory settings are as follows:
User NameDefault Password
adminvn-e4
operatorvn-e4
uservn-e4
4. Us
3) VN-E4 returns a response to the client. In the following example, current subnet mask is 255.0.0.0. In addition, 255.0.0.0 is followed by &
and 200 OK, indicating that acquisition is successful.
Note also that each of the content-type, date, server and keep-alive lines begin with a lower-case character.
4) The client can disconnect TCP80 to end the use of API.
16
4. Using API that Requires Basic Authentication _ 4.2. Restrictions
4.2. Restrictions
䡵 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.
17
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.1. Explanatory Notes
P
This section provides a description of API for acquiring/changing the parameters of VN-E4. Make use of the API explained in this section in
the way as mentioned in Section 4.
5.1. Explanatory Notes
(1) Acquiring parameters
● Specify API in GET line according to the format below when acquiring a parameter from VN-E4.
/api/param?ParamA.ParamB.ParamC
It is possible to acquire multiple parameters at a time. Parameters are segmented using &. Do not insert
space before and after &.
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.2. Signal Input
5.2. Signal Input
This API is related to signal input. This is equivalent to the feature on the Input page of the WEB setting page. Refer to the instruction manual
for details on the Input page.
Acquiring Comment in JPEG from VN-E4
Format/api/param?video.input(Number).comment
ExampleWhen acquiring comment of video input channel 1
/api/param?video.input(1).comment
Example of responsevideo.input(1).comment=input01&200 OK
Response example
when setting field is
left blank
InterpretationAcquire comment of the specified video input channel. This comment is stored in the JPEG header. Specify the
Allowed usersadmin, operator, user
video.input(1).comment=&200 OK
video input channel between the range of 1 to 4.
Setting Comment in JPEG from VN-E4
Format/api/param?video.input(Number).comment=data
ExampleWhen setting comment of video input channel 1
/api/param?video.input(1).comment=input01
Example when setting
as blank
Example of responsevideo.input(1).comment&200 OK
InterpretationChange the comment in JPEG of the specified video input channel. This comment is stored in the JPEG
/api/param?video.input(1).comment=%00
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, 0x30).
To use space, specify as %20(0x25, 0x32, 0x30). If you want to set "Comment In JPEG" for example, specify
as follows.
ExampleWhen setting Saturation of video input channel 1
/api/param?video.input(1).saturation=50
Example of responsevideo.input(1).saturation&200 OK
InterpretationChange the Saturation set value of the specified video input channel. Specify the video input channel between
the range of 1 to 4. Range of Saturation is between 0 to 100. The larger the value, the darker will be the color.
Allowed usersadmin, operator
Acquiring Phase from VN-E4
Format/api/param?video.input(Number).phase
ExampleWhen acquiring Phase of video input channel 1
/api/param?video.input(1).phase
Example of responsevideo.input(1).phase=50&200 OK
InterpretationAcquire the Phase set value of the specified video input channel. Specify the video input channel between the
range of 1 to 4. Range of Phase 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 usersadmin, operator, user
Setting Phase for VN-E4
Format/api/param?video.input(Number).phase=data
ExampleWhen setting Phase of video input channel 1
/api/param?video.input(1).phase=50
Example of responsevideo.input(1).phase&200 OK
InterpretationChange the Phase set value of the specified video input channel. Specify the video input channel between the
range of 1 to 4. Range of Phase 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 usersadmin, operator
Acquiring Turnover from VN-E4
Format/api/param?video.input(Number).turnover
ExampleWhen acquiring Turnover of video input channel 1
/api/param?video.input(1).turnover
Example of responsevideo.input(1).turnover=off&200 OK
InterpretationAcquire the Turnover set value of the specified video input channel. Turnover refers to flags that are stored in
the JPEG header. Specify the video input channel between the range of 1 to 4.
Allowed usersadmin, operator, user
21
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.2. Signal Input
ExampleWhen setting Turnover of video input channel 1
/api/param?video.input(1).turnover=on
Example of responsevideo.input(1).turnover&200 OK
InterpretationChange the Turnover set value of the specified video input channel. Turnover refers to flags that are stored in
the JPEG header. Specify the video input channel between the range of 1 to 4. Values that can be specified for
Turnover are on or off.
Allowed usersadmin, operator, user
(Note: This item can also be set by users.)
Acquiring Echo Suppressor from VN-E4
Format/api/param?audio.input.echo_suppress
Example of responseaudio.input.echo_suppress=off&200 OK
InterpretationAcquire the Echo Suppressor setting of the audio input. Specify as high, mid, low or off.
Allowed usersadmin, 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 responseaudio.input.echo_suppress&200 OK
InterpretationChange the Echo Suppressor setting of the audio input. Specify as high, mid, low or off.
Allowed usersadmin, operator
Acquiring Noise Suppressor from VN-E4
Format/api/param?audio.input.noise_suppress
Example of responseaudio.input.noise_suppress=off&200 OK
InterpretationAcquire the Noise Suppressor setting of the audio input. Specify as high, mid, low or off.
Allowed usersadmin, operator, user
Setting Noise Suppressor for VN-E4
Format/api/param?audio.input.noise_suppress=data
Example/api/param?audio.input.noise_suppress=low
Example of responseaudio.input.noise_suppress&200 OK
InterpretationChange the Noise Suppressor setting of the audio input. Specify as high, mid, low or off.
Allowed usersadmin, operator
22
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding
5.3. JPEG Encoding
This API is related to JPEG encoding. This is equivalent to the feature on the Encoding page of the WEB setting page. Refer to the instruction
manual for details on the Encoding page.
Up to 8 types of JPEG data may be encoded according to the combination of the input channel and frame size. Specify a type from the 8
encoding numbers below when acquiring/changing settings via API.
Encoding No.Input ChannelFrame Size
11VGA
21QVGA
32VGA
42QVGA
53VGA
63QVGA
74VGA
84QVGA
Acquiring JPEG Encoding On/Off from VN-E4
Format/api/param?encode(Number).status
ExampleWhen acquiring encoding on/off of Encoding No. 1
/api/param?encode(1).status
Example of responseencode(1).status=on&200 OK
InterpretationAcquire the encoding on/off of the specified encoding number. Note that encoding numbers are different from
video input channels.
Allowed usersadmin, operator, user
Setting JPEG Encoding On/Off for VN-E4
Format/api/param?encode(Number).status=data
ExampleWhen setting encoding on/off of Encoding No. 1
/api/param?encode(1).status=off
Example of responseencode(1).status&200 OK
InterpretationChange the encoding on/off of the specified encoding number. Specify as on to turn on and off to turn off. Note
that encoding numbers are different from video input channels.
Allowed usersadmin, operator
Acquiring Frame Rate from VN-E4
Format/api/param?encode(Number).framerate
ExampleWhen acquiring frame rate of Encoding No. 1
/api/param?encode(1).framerate
Example of responseencode(1).framerate=15&200 OK
InterpretationAcquire frame rate of the specified encoding number. Note that encoding numbers are different from video
input channels.
Allowed usersadmin, operator, user
23
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding
Setting JPEG Frame Rate for VN-E4
Format/api/param?encode(Number).framerate=data
ExampleWhen setting frame rate of Encoding No. 1
/api/param?encode(1).framerate=30
Example of responseencode(1).framerate&200 OK
InterpretationChange frame rate of the specified encoding number. Note that encoding numbers are different from video
input channels.
Frame rate can be set to 30, 15, 10, 7.5, 6, 5, 3, 2 or 1 in the case of VN-E4 and VN-E4U (NTSC).
Frame rate can be set to 25, 12.5, 8, 6, 5, 4, 3, 2 or 1 in the case of VN-E4E (PAL).
Allowed usersadmin, operator
Acquiring Rate Control Setting from VN-E4
Format/api/param?encode(Number).cbr_mode
ExampleWhen acquiring rate control setting of Encoding No. 1
/api/param?encode(1).cbr_mode
Example of responseencode(1).cbr_mode=afs&200 OK
InterpretationAcquire the rate control setting of the specified encoding number. Note that encoding numbers are different
from video input 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 that can be realized will drop.
Allowed usersadmin, operator, user
Setting Rate Control for VN-E4
Format /api/param?encode(Number).cbr_mode=data
ExampleWhen setting rate control of Encoding No. 1
/api/param?encode(1).cbr_mode=vfs
Example of response encode(1).cbr_mode&200 OK
InterpretationChange rate control of the specified encoding number. Note that encoding numbers are different from video
input channels.
Rate control can be set to vfs, afs, or cfs. In vfs (VariableFileSize), quantization table is fixed. In afs
(AverageFileSize), average file size of multiple JPEGs is controlled to be constant. In cfs (ConstanFileSize),
each file size is controlled to be constant. In cfs mode, maximum frame rate becomes a quater of the maximum
frame rate of vfs/afs.
Allowed usersadmin, operator
24
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding
Acquiring File Size Setting from VN-E4
Format/api/param?encode(Number).quality
ExampleWhen acquiring file size setting of Encoding No. 1
/api/param?encode(1).quality
Example of responseencode(1).quality=40k&200 OK
InterpretationAcquire the file size setting of the specified encoding number. Note that encoding numbers are different from
video input channels. If the response is 40k for example, the setting is 40KB.
Allowed usersadmin, operator, user
Setting File Size for VN-E4
Format/api/param?encode(Number).quality=Data
ExampleWhen setting the file size of Encoding No. 1
/api/param?encode(1).quality=60k
Example of responseencode(1).quality&200 OK
InterpretationChange the file size of the specified encoding number. Note that encoding numbers are different from video
input channels. The unit of set values is in KB. VN-E4 will perform rate control with this file size as the target.
The frame sizes for ch(1), ch(3), ch(5) and ch(7) are in VGA, and therefore setting between the range of 10 k to
100 k is possible. The frame sizes for ch(2), ch(4), ch(6) and ch(8) are in QVGA, and therefore setting between
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.
LevelFile Size Setting for VGAFile Size Setting for QVGA
180k27k
260k20k
340k13k
430k10k
525k8k
620k7k
715k5k
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 usersadmin, operator
Acquiring Interpolation Setting from VN-E4
Format/api/param?encode(Number).interpolate
ExampleWhen acquiring interpolation of Encoding No. 1
/api/param?encode(1).interpolate
Example of responseencode(1).interpolate=on&200 OK
InterpretationAcquire the interpolation setting of the specified encoding number. Note that encoding numbers are different
from video input channels. 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. This item is valid when the frame size is in VGA (Encoding Nos.: 1, 3, 5
and 7). When the frame size is in QVGA (Encoding Nos.: 2, 4, 6 and 8), this will be invalid as only the first
field will be used from the beginning.
Allowed usersadmin, operator, user
25
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.3. JPEG Encoding
Setting Interpolation for VN-E4
Format/api/param?encode(Number).interpolate=Data
ExampleWhen setting interpolation of Encoding No. 1
/api/param?encode(1).interpolate=on
Example of responseencode(1).interpolate&200 OK
InterpretationChange interpolation of the specified encoding number. Note that encoding numbers are different from video
input channels. 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 when the frame size
is in VGA (Encoding Nos.: 1, 3, 5 and 7). When the frame size is in QVGA (Encoding Nos.: 2, 4, 6 and 8), this
will be invalid as only the first field will be used from the beginning.
Allowed usersadmin, operator
26
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting
5.4. Alarm Setting
The APIs below are related to alarm setting. These are equivalent to the features on the Alarm page of the WEB setting page. Refer to the
instruction manual for details on the Alarm page.
Acquiring Alarm On/Off Status from VN-E4
Format/api/param?application.event(Number).status
ExampleWhen acquiring the on/off status of Encoding No. 1
/api/param?application.event(1).status
Example of responseapplication.event(1).status=on&200 OK
InterpretationAcquire the on/off status of the alarm action for the specified encoding number. 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.
Either on or off will be returned.
Example of responseapplication.event(1).status&200 OK
InterpretationSet the alarm action of the specified encoding number to off. When this is set to off, the action that is
associated with this event will 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 specific action using
the API for setting the alarm action.
Acquiring JPEG Parameters Added to FTP from VN-E4
As mentioned in the section on acquiring/setting alarm actions, specify between object01 to object08 for JPEG
to be added to FTP. Each object is a combination of the input CH and frame size as indicated below.
ObjectInput CHFrame Size
object011VGA
object021QVGA
object032VGA
object042QVGA
object053VGA
object063QVGA
object074VGA
object084QVGA
Format
Frame rate, BeforeTrigger and AfterTrigger for FTP are common among all objects. A same value will be
returned during acquisition by any of the objects.
Acquisition of input CH:/api/param?application.object(Number).source
Acquisition of frame size:/api/param?application.object(Number).framesize
Acquisition of frame rate:/api/param?application.object(Number).framerate
Acquisition of BeforeTrigger: /api/param?application.object(Number).prerec
Acquisition of AfterTrigger:/api/param?application.object(Number).postrec
27
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting
ExampleWhen acquiring setting of Object 1
Acquisition of input CH:/api/param?application.object(1).source
Acquisition 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
Example of Response
Acquisition of input CH:application.object(1).source=video.input(01)&200
OK
Acquisition of frame size:application.object(1).framesize=vga&200 OK
Acquisition of frame rate:application.object(1).framerate=10&200 OK
Acquisition of BeforeTrigger: application.object(1).prerec=2&200 OK
Acquisition of AfterTrigger:application.object(1).postrec=2&200 OK
InterpretationAcquire the parameter of the specified object. This object is used by the API for setting FTP. Specify the
number of object(number) between the range of 1 to 8.
Setting JPEG Parameters Added to FTP from VN-E4
Format
Setting of frame rate:
Setting of BeforeTrigger:/api/param?application.object(Number).prerec=data
Setting of AfterTrigger:/api/param?application.object(Number).postrec=data
Example
Set frame rate to 5 fps:/api/param?application.object(1).framerate=5
Set BeforeTrigger to 3
seconds:
Set AfterTrigger to 3
seconds:
Example of Response
Setting of frame rate:application.object(1).framerate&200 OK
Setting of BeforeTrigger:application.object(1).prerec&200 OK
Setting of AfterTrigger:application.object(1).postrec&200 OK
InterpretationPerform setting for the specified object. This object is used by the API for setting FTP. Specify the number of
object(number) between the range of 1 to 8. The maximum value for prerec/postrec is 60. In addition, input
CH and frame size for each object are fixed and cannot be changed.
Example of Responseapplication.event(1).action=mailto/somebody@somecompany.com/none/
Message&200 OK
28
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting
InterpretationAcquire 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).status) is
used to acquire the on/off status of the alarm action.
When sending via mail is specified, mailto, mail address, none and the character string to be sent will be
returned. When spaces are included in the character string, the character string with spaces will be returned.
Segments are indicated by /. none is an auxiliary item intended for future extensions.
Example of Responseapplication.event(1).action=mailto/somebody@somecompany.com/none/
Message&200 OK
When sending via FTP is specified, ftpto, FTP number, and the attached object number will be returned. The
FTP number is fixed as ftp01 at all times. An object number may be specified between object01 to object04.
Example of Responseapplication.event(1).action=ftpto/ftp01/object01&200 OK
When sending via TCP is specified, tcpto, IP address, port number and the character string to be sent will be
returned. Segments are indicated by /.
Example of Responseapplication.event(1).action=tcpto/10.0.0.100/20000/Message&200 OK
When sending via UDP is specified, udpto, IP address, port number and the character string to be sent will be
returned. Segments are indicated by /.
Example of Responseapplication.event(1).action=udpto/10.0.0.100/20000/Message&200 OK
When alarm output is specified, pinout, distinction between make/break (m1 or b1) and the time (millisecond)
will be returned. Segments are indicated by /.
Example of Responseapplication.event(1).action=pinout/m1/1500&200 OK
Example of Responseapplication.event(1).action&200 OK
InterpretationSet 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).status=off) is used
to set the alarm action to off.
The action will be activated by setting the alarm trigger. The API for setting the alarm trigger is /api/
param?application.event(Number).trigger.
Specify mailto, mail address, none and the character string to be sent when sending via mail. Segments are
indicated by /. The maximum number of characters for the mail address is 60. none is reserved for future
extensions. The upper limit of the character string to be sent is 40 bytes. Specify using the 3 characters %20
when inserting a space in the character string. For example, to send the character string "This is alarm.",
specify as "This%20is%20alarm.".
The character string "Alarm from VN-E4: No. 1" will be stored in the title field of the mail. The last number
denotes the event number.
Specify ftpto, FTP number and the object when sending via FTP. The FTP number is fixed as ftp01 at all times.
An object can be specified between object01 to object08, which denotes the type of JPEG to be sent. Details of
object are described in another page, AAcquiring JPEG Parameters Added to FTP from VN-E4B. Ensure to set
the FTP server (/api/param?application.ftp.host, etc.) before setting to FTP transmission. Only one alarm
action can be set to FTP. After one alarm aciotn is set to FTP, no other actions can be set to FTP.
Specify tcpto, IP address, port number and the character string to be sent when sending via TCP. Segments are
indicated by /. The upper limit of the character string to be sent is 40 bytes. Specify using the 3 characters %20
when inserting a space in the character string. For example, to send the character string "This is alarm.",
specify as "This%20is%20alarm.".
29
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.4. Alarm Setting
Specify udpto, IP address, port number and the character string to be sent when sending via UDP. Segments are
indicated by /. The upper limit of the character string to be sent is 40 bytes. Specify using the 3 characters %20
when inserting a space in the character string. For example, to send the character string "This is alarm.",
specify as "This%20is%20alarm.".
Specify pinout, distinction between make/break (m1 or b1) and the time (millisecond) when alarm output is
specified. Segments are indicated by /. Different values cannot be specified for the alarm output time of each
alarm action. When the alarm output time is changed for an alarm action, the alarm output time for other alarm
actions will also be altered.
Example of Responseapplication.event(1).trigger=0&200 OK
InterpretationAcquire Trigger of the alarm action for 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.
When only 1 Trigger is set, m1 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 Responseapplication.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 at alarm input 2 within 10 seconds after make is
invoked at alarm input 1.
Example of Responseapplication.event(1).trigger=m3(100)b4&200 OK
Example of Responseapplication.event(1).trigger&200 OK
InterpretationSet Trigger of the alarm action for 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.
When setting only 1 Trigger, specify as m1 in the case of make for alarm input 1, b2 in the case of break for
alarm input 2, and v3 for motion detection of video input 3.
When setting Trigger upon combining 2 alarm inputs, specify as m1(50)b2. The example above indicates that
trigger will be activated when break is invoked at alarm input 2 within 100 seconds after make is invoked at
alarm input 1. Additionally, combination is only allowed for alarm inputs and not motion detect. And same
alarm can not be combined. For example, m1(50)m1 is not available.
5. API for Acquiring/Changing P arameter s of VN-E4 _
5.5. Alarm Envir onment Setting
5.5. Alarm Environment Setting
The APIs below are related to alarm environment setting. These are equivalent to the features on the Alarm Environment page of the WEB
setting page. Refer to the instruction manual for details on the Alarm Environment page.
Acquiring SMTP Server Address Setting from VN-E4
Format/api/param?application.smtp.host
Example of Responseapplication.smtp.host=10.0.0.200&200 OK
Response example
when setting field is
left blank
InterpretationAcquire the address setting of the SMTP server.
Example of Responseapplication.pop.password&200 OK
InterpretationChange the password setting of the POP server. The maximum password size is 60 bytes. Set as follows when
this is to be left blank.
/api/param?application.pop.password=%00
Allowed usersadmin, operator
(Note: There is no API for reading passwords.)
33
5. API for Acquiring/Changing P arameter s of VN-E4 _
Acquiring FTP Server Address Setting from VN-E4
Format/api/param?application.ftp.host
Example of Responseapplication.ftp.host=10.0.0.200&200 OK
5.5. Alarm Envir onment Setting
Response example
when setting field is
left blank
InterpretationAcquire the FTP server address setting used for FTP transmission via alarm.
Allowed usersadmin, operator, user
application.ftp.host=&200 OK
Setting FTP Server Address for VN-E4
Format/api/param?application.ftp.host=data
Example/api/param?application.ftp.host=10.0.0.200
Example of Responseapplication.ftp.host&200 OK
InterpretationChange the FTP server address setting used for FTP transmission via alarm. Specify the IP address or FQDN.
The maximum FQDN size is 60 bytes. Specify as 0.0.0.0 when the FTP server is not set. It is also possible to
leave the setting field blank as follows.
/api/param?application.ftp.path=%00
Allowed usersadmin, operator
Acquiring FTP Server Directory Setting from VN-E4
Format/api/param?application.ftp.path
Example of Responseapplication.ftp.path=subdir1&200 OK
Response example
when setting field is
left blank
InterpretationAcquire the FTP server directory setting used for FTP transmission via alarm.
Allowed usersadmin, operator, user
application.ftp.path=&200 OK
Setting FTP Server Directory for VN-E4
Format/api/param?application.ftp.path=data
Example/api/param?application.ftp.path=subdir1
Example of Responseapplication.ftp.path&200 OK
InterpretationChange the FTP server directory setting used for FTP transmission via alarm. It is possible to set FTP
transmission to a directory under the FTP server home directory by specifying that directory name. Use / to
segment the directory. The maximum directory name size is 60 bytes.
Example of Responseperipheral.output_pin.pin.status&200 OK
InterpretationChange 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 usersadmin, operator
36
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.6. Motion Detect
5.6. Motion Detect
The APIs below are related to motion detection. These are equivalent to the features on the Motion Detection page of the WEB setting page.
Refer to the instruction manual for details on the Motion Detection page.
ExampleWhen acquiring the motion detect sensitivity of video input channel 1
/api/param?video.input(1).detection.level
Example of responsevideo.input(1).detection.level=20&200 OK
InterpretationAcquire the motion detect sensitivity. 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. A value between 0 to 100 will be returned. The larger
the value, the higher will be the sensitivity.
ExampleWhen acquiring motion parameters of motion detect for video input channel 1
/api/param?video.input(1).detection.velocity
Example of responsevideo.input(1).detection.velocity=10&200 OK
InterpretationAcquire the motion parameters of motion detect. 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. A value between 0 to 100 will be returned. 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 usersadmin, operator, user
Setting Motion Parameters of Motion Detect for VN-E4
ExampleWhen setting motion parameters of motion detect for video input channel 1
/api/param?video.input(1).detection.velocity=10
Example of responsevideo.input(1).detection.velocity&200 OK
InterpretationChange the motion parameters of motion detect. 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 a value between 0 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.
ExampleWhen acquiring the motion detect mask of video input channel 1
/api/param?video.input(1).detection.area
Example of responsevideo.input(1).detection.area=000102030405060708091011121314151617&200 OK
InterpretationAcquire the mask of motion detect. 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. 36 ASCII characters will be returned.
The screen of VN-E4 is made up of 12 x 12 = 144 blocks, and mask can be set to on/off for each block. This
information can be represented in 188 bits = 18-byte hexadecimal. (Response is returned in ASCII character
strings.Therefore, 36 characters will be returned.) The bit string will appear as follows when mask is set to off
for the top left block only.
10000000 00000000 00000000 ,,,
Storage in bytes will begin from the LSB and represented in a hexadecimal value as shown below.
01 00 00 ,,,
The hexadecimal value denotes the 18 ASCII characters acquired via this API that are expressed in ASCII
codes. For example, the following character string will be returned when only the top left and bottom right
blocks are masked.
video.input(1).detection.area=010000000000000000000000000000000080
Allowed usersadmin, operator, user
38
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.6. Motion Detect
InterpretationChange 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 blocks,
specify all zeros in the ASCII character string.
Allowed usersadmin, operator
39
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.7. Serial Port
5.7. Serial Port
The APIs below are related to the serial port. These are equivalent to the features on the Serial Port page of the WEB setting page. However,
specification of control device and camera address are not supported by API. Refer to the instruction manual for details on the Serial Port
page.
Acquiring Serial Port Baud Rate Setting from VN-E4
Format/api/param?peripheral.serial(Number).baud
ExampleWhen acquiring baud rate of Serial Port 1
/api/param?peripheral.serial(1).baud
Example of responseperipheral.serial(1).baud=9600&200 OK
InterpretationAcquire the serial port's baud rate. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports.
Value returned will be 1200, 1800, 2400, 4800, 9600, 19200 or 38400.
Example of responseperipheral.serial(1).comment&200 OK
InterpretationChange the serial port comment. Specify a value between 1 to 2 since VN-E4 comes with 2 serial ports.
Specify comment using a character string of 40 bytes or less. Specify as follows when the comment setting is
to be left blank.
Example when
comment is left blank
Allowed usersadmin, operator
/api/param?peripheral.serial(1).comment=%00
This comment setting is optional and does not affect the functions of the serial port.
42
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics
5.8. Network Basics
The APIs below are related to the basics of networks. These are equivalent to the features on the Basic page of the WEB setting page. Refer to
the instruction manual for details on the Basic page.
Enabling Network Setting Changes
Format/api/param?network.interface.status=restart
Example of Responsenetwork.interface.status&200 OK
InterpretationWhen network parameters are changed, this API can be used to enable the new settings. Changes will be not be
reflected in the actions until this API is used. VN-E4 will cut off the TCP connection when this API is used.
When this API is used upon changing IPv6, MTU, Negotiation, Timezone or SNMP, VN-E4 will reboot in
about 1 minute.
Allowed useradmin
Acquiring DHCP Setting from VN-E4
Format/api/param?network.interface.dhcp.status
Example of Responsenetwork.interface.dhcp.status=off&200 OK
Example of Responsenetwork.interface.dhcp.status&202
Required(network.interface.status=restart)
InterpretationChange the DHCP setting. Upon setting this API, execute the "network.interface.status=restart" API for
enabling network setting changes to enable the new settings. PPPoE will be turned off automatically when the
DHCP setting is set to on.
Allowed useradmin
Acquiring IP Address from VN-E4
Format/api/param?network.interface.ip
Example of Responsenetwork.interface.ip=10.0.0.1&200 OK
InterpretationAcquire the current IP address.
Allowed usersadmin, operator, user
43
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics
Setting IP Address for VN-E4
Format/api/param?network.interface.ip=data
Example/api/param?network.interface.ip=10.0.0.1
Example of Responsenetwork.interface.ip&202 Required(network.interface.status=restart)
InterpretationChange the IP address. Upon setting this API, execute the "network.interface.status=restart" API for enabling
network setting changes to enable the new settings. Ensure to execute "network.interface.status=restart" upon
setting the IP address, subnet mask and default gateway combination appropriately.
Allowed useradmin
Acquiring Subnet Mask from VN-E4
Format/api/param?network.interface.subnetmask
Example of Responsenetwork.interface.subnetmask=255.0.0.0&200 OK
Example of Responsenetwork.interface.subnetmask&202
Required(network.interface.status=restart)
InterpretationChange the subnet mask. Upon setting this API, execute the "network.interface.status=restart" API for
enabling network setting changes to enable the new settings. Ensure to execute
"network.interface.status=restart" upon setting the IP address, subnet mask and default gateway combination
appropriately.
Allowed useradmin
Acquiring Default Gateway fr om VN-E4
Format/api/param?network.gateway(version)
Example/api/param?network.gateway(ipv4)
Example of Responsenetwork.gateway(ipv4)=10.0.0.254&200 OK
InterpretationAcquire the current default gateway. Specify the version as ipv4 or ipv6.
Allowed usersadmin, operator, user
44
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics
InterpretationChange the default gateway of IPv4. Default gateway of IPv6 can not be changed. Upon setting this API,
execute the "network.interface.status=restart" API for enabling network setting changes to enable the new
settings.
Specify as 0.0.0.0 to cancel the default gateway setting. However, multicast transmission will be disabled if the
default gateway is not set.
Allowed useradmin
Acquiring Host Name from VN-E4
Format/api/param?network.hostname
Example of Responsenetwork.hostname=localhost&200 OK
InterpretationAcquire the current host name.
Allowed usersadmin, operator, user
Setting Host Name for VN-E4
Format/api/param?network.hostname=data
Example/api/param?network.hostname=somename
Example of Responsenetwork.hostname&202 Required(network.interface.status=restart)
InterpretationChange the host name. Characters that may be used for the host name are alphanumerics, underscores (_),
hyphens (-) and percents (%). Upon setting this API, execute the "network.interface.status=restart" API for
enabling network setting changes to enable the new settings.
Specify as %00 when the host name setting is to be left blank.
Example when leaving
field blank
Allowed useradmin
/api/param?network.hostname=%00
Acquiring Domain Name from VN-E4
Format/api/param?network.domainname
Example of Responsenetwork.domainname=somename&200 OK
InterpretationAcquire the current domain name.
Allowed usersadmin, operator, user
45
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics
Setting Domain Name for VN-E4
Format/api/param?network.domainname=data
Example/api/param?network.domainname=somename
Example of Responsenetwork.domainname&202 Required(network.interface.status=restart)
InterpretationChange the domain name. Characters that may be used for the domain name are alphanumerics, underscores
(_) and hyphens (-). Upon setting this API, execute the "network.interface.status=restart" API for enabling
network setting changes to enable the new settings.
Specify as %00 when the domain name setting is to be left blank.
Example when leaving
field blank
Allowed useradmin
/api/param?network.domainname=%00
Acquiring DNS Server On/Off Status from VN-E4
Format/api/param?network.dns.status
Example of Responsenetwork.dns.status=off&200 OK
InterpretationAcquire the on/off status of the DNS server. Either on or off will be returned.
Allowed usersadmin, 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 Responsenetwork.dns.status&202 Required(network.interface.status=restart)
InterpretationChange 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 setting changes to enable the new settings.
Allowed usersadmin, operator
Acquiring DNS Server Type from VN-E4
Format/api/param?network.dns.type
Example of Responsenetwork.dns.type=dns&200 OK
InterpretationAcquire the DNS server type. Either dns or ddns will be returned.
Allowed usersadmin, operator, user
Setting DNS Server Type for VN-E4
Format/api/param?network.dns.type=data
Example/api/param?network.dns.type=ddns
Example of Responsenetwork.dns.type&202 Required(network.interface.status=restart)
InterpretationChange the DNS server type. Specify as dns or ddns. Upon setting this API, execute the
"network.interface.status=restart" API for enabling network setting changes to enable the new settings.
Allowed usersadmin, operator
46
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics
Acquiring DNS Server IP Address from VN-E4
Format/api/param?network.dns.ip
Example of Responsenetwork.dns.ip=10.0.0.150&200 OK
InterpretationAcquire the IP address of the DNS server.
Allowed usersadmin, operator, user
Setting DNS Server IP Address for VN-E4
Format/api/param?network.dns.ip=data
Example/api/param?network.dns.ip=10.0.0.150
Example of Responsenetwork.dns.ip&202 Required(network.interface.status=restart)
InterpretationChange the IP address of the DNS server. Upon setting this API, execute the "network.interface.status=restart"
API for enabling network setting changes to enable the new settings.
Allowed usersadmin, operator
Acquiring MAC Address from VN-E4
Format/api/param?network.interface.mac
Example of Responsenetwork.interface.mac=008088001AEF&200 OK
InterpretationAcquire the MAC address. A 12-byte ASCII character string will be returned. There is no API for setting the
MAC address.
Allowed usersadmin, operator, user
Acquiring IPv6 On/Off Status from VN-E4
Format/api/param?network.interface.ipv6.status
Example of Responsenetwork.interface.ipv6.status=off&200 OK
InterpretationAcquire the on/off status of IPv6. Either on or off will be returned.
Allowed usersadmin, operator, user
Setting IPv6 Status to On/Off for VN-E4
Format/api/param?network.dns.ipv6.status=data
Example/api/param?network.dns.ipv6.status=on
Example of Responsenetwork.dns.ipv6.status&202 Required(network.interface.status=restart)
InterpretationChange the on/off status of IPv6. Specify as on or off. Upon setting this API, execute the
"network.interface.status=restart" API for enabling network setting changes to enable the new settings. Upon
changing the on/off status of IPv6, VN-E4 will be rebooted using the "network.interface.status=restart" API
for enabling settings. As such, access will not be possible for about 1 minute.
Allowed useradmin STATUS
47
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.8. Network Basics
Example of Responsenetwork.interface.ipv6.link_local(1)=fe80::280:88ff:fe41:400c&200 OK
InterpretationAcquire the link-local IPv6 address. A number between 1 to 8 may be specified, and the link-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 setting the IPv6 address.
Example of Responsenetwork.interface.ipv6.site_local(1)=fec0::1:280:88ff:fe41:114&200 OK
InterpretationAcquire 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 setting the IPv6 address.
Example of Response
(When a global
address is not set)
InterpretationAcquire the global IPv6 address. A number between 1 to 8 may be specified, and the global IPv6 addresses
Allowed usersadmin, operator, user
network.interface.ipv6.global=&200 OK
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 setting the IPv6 address.
48
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.9. Network Details
5.9. Network Details
The APIs below are related to network details. These are equivalent to the features on the Details page of the WEB setting page. Refer to the
instruction manual for details on the Details page.
Acquiring DSCP Value of Images from VN-E4
Format/api/param?network.interface.dscp.video
Example of Responsenetwork.interface.dscp.video=56&200 OK
InterpretationAcquire the DSCP value of the image.
Example of Responsenetwork.interface.dscp.video&202
Required(network.interface.status=restart)
Interpretation
Allowed useradmin
Change the DSCP value of the image. The range of set value is between 0 to 255. Upon setting this API, execute
the "network.interface.status=restart" API for enabling network setting changes to enable the new settings.
Acquiring DSCP V alue of Audio Data from VN-E4
Format/api/param?network.interface.dscp.audio
Example of Responsenetwork.interface.dscp.audio=56&200 OK
InterpretationAcquire the DSCP value of the audio data.
Example of Responsenetwork.interface.dscp.audio&202
Required(network.interface.status=restart)
Interpretation
Change the DSCP value of the audio data. The range of set value is between 0 to 255. Upon setting this API,
execute the "network.interface.status=restart" API for enabling network setting changes to enable the new settings.
Allowed useradmin
Acquiring MTU Value VN-E4
Format/api/param?network.interface.mtu
Example of Responsenetwork.interface.mtu=1420&200 OK
InterpretationAcquire the MTU value.
Allowed usersadmin, operator, user
49
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.9. Network Details
Setting MTU Value for VN-E4
Format/api/param?network.interface.mtu=data
Example/api/param?network.interface.mtu=1000
Example of Responsenetwork.interface.mtu&202 Required(network.interface.status=restart)
InterpretationChange the MTU value. The range of set value is between 512 to 1500 for IPv4 and between 1280 to 1500 for
IPv6. Upon setting this API, execute the "network.interface.status=restart" API for enabling network setting
changes to enable the new settings. Upon changing the MTU value, VN-E4 will be rebooted using the
"network.interface.status=restart" API for enabling settings. As such, access will not be possible for about 1
minute.
Allowed useradmin
Acquiring Network Negotiation Setting from VN-E4
Format/api/param?network.interface.negotiation
Example of Responsenetwork.interface.negotiation=auto&200 OK
InterpretationAcquire the network Negotiation setting. Either auto, 100full, 100half, 10full or 10half will be returned.
Example of Responsenetwork.interface.negotiation&202
Required(network.interface.status=restart)
InterpretationChange the network Negotiation setting. Set to auto, 100full, 100half, 10full or 10half. Upon setting this API,
execute the "network.interface.status=restart" API for enabling network setting changes to enable the new
settings. Upon changing the network Negotiation, VN-E4 will be rebooted using the
"network.interface.status=restart" API for enabling settings. As such, access will not be possible for about 1
minute.
Allowed useradmin
Acquiring PPPoE On/Off Status fr om VN-E4
Format/api/param?network.interface.pppoe.status
Example of Responsenetwork.interface.pppoe.status=off&200 OK
InterpretationAcquire the on/off status of PPPoE. Either on or off will be returned.
Allowed usersadmin, operator, user
50
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.9. Network Details
Example of Responsenetwork.interface.pppoe.status&202
Required(network.interface.status=restart)
InterpretationChange the on/off status of PPPoE. Set to on or off. Upon changing PPPoE, VN-E4 will be rebooted using the
"network.interface.status=restart" API for enabling settings. As such, access will not be possible for about 1
minute. Additionally, the DHCP client feature will be turned off automatically when PPPoE is set to on.
Allowed useradmin
Acquiring PPPoE User Name fr om VN-E4
Format/api/param?network.interface.pppoe.user
Example of Responsenetwork.interface.pppoe.user=somename&200 OK
Example of Responsenetwork.interface.pppoe.password&202
Required(network.interface.status=restart)
InterpretationChange the password of PPPoE. Set a password that is within 60 bytes. Upon changing PPPoE, VN-E4 will be
rebooted using the "network.interface.status=restart" API for enabling settings. As such, access will not be
possible for about 1 minute. There is no API for acquiring passwords.
Allowed useradmin
51
5. API for Acquiring/Changing P arameters of VN-E4 _
5.10. Manual Transmission
5.10. Manual Transmission
Details on API for manual 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.
52
5. API for Acquiring/Changing P arameters of VN-E4 _
5.11. Access Restrictions
5.11. Access Restrictions
The APIs below are related to access restrictions. These are equivalent to the features on the Access Restrictions page of the WEB setting
page. Refer to the instruction manual for details on the Access Restrictions page.
Acquiring Deny/Allow Setting of Client Restrictions from VN-E4
Example of Responsenetwork.access_control(api).logic=deny&200 OK
Interpretation
Allowed usersadmin, operator
Acquire the deny/allow setting of client restrictions. Either deny or allow will be returned. This API acquires the
same details as the "Access Restriction" item of "Client Address" at the top of the Access Restrictions page.
Setting Client Restriction to Deny/Allow for VN-E4
Example of Responsenetwork.access_control(api).logic&200 OK
Interpretation
Allowed useradmin
Change the deny/allow setting of client restrictions. Specify as deny or allow. Details set by this API are the same
as those set by the "Access Restriction" item of "Client Address" at the top of the Access Restrictions page.
Acquiring IP Address Setting of Restricted Client from VN-E4
Example of Responsenetwork.access_control(api).host(1)&200 OK
InterpretationChange the IP address setting of client restriction. Setting is possible up to 10 items. Specify a value between 1
to 10 for the number. A range of IP address may be 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.
53
5. API for Acquiring/Changing P arameters of VN-E4 _
Example of Responsenetwork.access_control(stream_in).host(1)=10.0.0.100&200 OK
InterpretationAcquire the IP address setting of the restricted audio sender. Setting is possible up to 10 items. Specify a value
between 1 to 10 for the number. The following will be returned if subnet mask is specified at the same time.
Example of Response 2
network.access_control(stream_in).host(1)=10.0.0.0/24&200 OK
The above example indicates that the range is set as between 10.0.0.0 to 10.0.0.255.
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 usersadmin, operator
Setting IP Address of Audio Sender Restrictions for VN-E4
Example of Responsenetwork.access_control(stream_in).host(1)&200 OK
54
5. API for Acquiring/Changing P arameters of VN-E4 _
InterpretationChange the IP address setting of audio sender restrictions. Setting is possible up to 10 items. Specify a value
between 1 to 10 for the number. A range of IP address may be 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.
This API acquires the same details as the "Access Restriction" item of "Source Address of Audio Sender" at
the top of the Access Restrictions page.
Allowed useradmin
5.11. Access Restrictions
55
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.12. Time
5.12. Time
The APIs below are related to time. These are equivalent to the features on the Time page of the WEB setting page. Refer to the instruction
manual for details on the Time page.
Acquiring NTP Client Feature On/Off Status from VN-E4
Format/api/param?network.ntp.status
Example of Responsenetwork.ntp.status=off&200 OK
InterpretationAcquire the on/off status of NTP client. Either on or off will be returned.
Allowed usersadmin, operator, user
Setting NTP Client Feature Status to On/Off for VN-E4
Format/api/param?network.ntp.status=data
Example/api/param?network.ntp.status=on
Example of Responsenetwork.ntp.status&200 OK
InterpretationChange the on/off status of NTP client. Specify as on or off. Upon setting this API, execute the
"network.interface.status=restart" API for enabling network setting changes to enable the new settings.
Allowed usersadmin, operator
Acquiring NTP Server Address from VN-E4
Format/api/param?network.ntp.host
Example of Responsenetwork.ntp.host=10.0.0.100&200 OK
InterpretationAcquire the address of the NTP server. Either the IP address or FQDN will be returned.
Allowed usersadmin, operator, user
Setting NTP Server Address for VN-E4
Format/api/param?network.ntp.host=data
Example/api/param?network.ntp.host=10.0.0.100
Example of Responsenetwork.ntp.host&200 OK
InterpretationChange the address of the NTP server. Specify the IP address or FQDN. Upon setting this API, execute the
"network.interface.status=restart" API for enabling network setting changes to enable the new settings.
Allowed usersadmin, operator
Acquiring Access Interval to NTP Server from VN-E4
Format/api/param?network.ntp.interval
Example of Responsenetwork.ntp.interval=100&200 OK
InterpretationAcquire the interval for accessing the NTP server. Unit is in minutes.
Allowed usersadmin, operator, user
56
5. API for Acquiring/Changing Parameters of VN-E4
_ 5.12. Time
Setting Access Interval to NTP Server for VN-E4
Format/api/param?network.ntp.interval=data
Example/api/param?network.ntp.interval=60
Example of Responsenetwork.ntp.interval&200 OK
InterpretationChange the interval for accessing the NTP server. Unit is in minutes. Upon setting this API, execute the
"network.interface.status=restart" API for enabling network setting changes to enable the new settings.
Allowed usersadmin, operator
Acquiring Time from VN-E4
Format/api/param?system.date
Example of Responsesystem.date=20050614171537&200 OK
InterpretationAcquire the time from the built-in clock of VN-E4. Time is arranged in the order of year, month, day, hour,
minute and second. Year is denoted in a 4-digit decimal number, and month, day, hour, minute and second are
denoted in 2-digit decimal numbers.
Allowed usersadmin, operator, user
Setting Time for VN-E4
Format/api/param?system.date=data
Example/api/param?system.date=20050614171537
Example of Responsesystem.date&200 OK
InterpretationChange 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 useradmin
Acquiring Timezone from VN-E4
Format/api/param?system.timezone
Example of Responsesystem.timezone=Pacific&200 OK
InterpretationAcquire the timezone from VN-E4. Character strings in the following table will be returned.
Timezone Character StringDescription
GMT-12Timezone that is 12 hours earlier than the Greenwich Mean Time.
GMT-11Timezone that is 11 hours earlier than the Greenwich Mean Time.
GMT-10Timezone that is 10 hours earlier than the Greenwich Mean Time.
HawaiiSame timezone as GMT-10
GMT-9Timezone that is 9 hours earlier than the Greenwich Mean Time.
AlaskaSame timezone as GMT-9
GMT-8Timezone that is 8 hours earlier than the Greenwich Mean Time.
Pacific(GMT-8:00) US/Pacific Time
GMT-7Timezone that is 7 hours earlier than the Greenwich Mean Time.
ArizonaSame timezone as GMT-7
MountainSame timezone as GMT-7
57
5. API for Acquiring/Changing Parameters of VN-E4
GMT-6Timezone that is 6 hour earlier than the Greenwich Mean Time.
CentralSame timezone as GMT-6
GMT-5Timezone that is 5 hour earlier than the Greenwich Mean Time.
East-IndianaSame timezone as GMT-5.
EasternSame timezone as GMT-5.
GMT+4Timezone that is 4 hour earlier than the Greenwich Mean Time.
AtlanticSame timezone as GMT-4.
GMT+3Timezone that is 3 hour earlier than the Greenwich Mean Time.
GMT+2Timezone that is 2 hour earlier than the Greenwich Mean Time.
GMT+1Timezone that is 1 hour earlier than the Greenwich Mean Time.
UTCGreenwich Mean Time
LondonSame timezone as UTC.
GMT+1Timezone that is 1 hour later than the Greenwich Mean Time.
BerlinSame timezone as GMT+1.
RomeSame timezone as GMT+1.
MadridSame timezone as GMT+1.
ParisSame timezone as GMT+1.
CETSame timezone as GMT+1.
GMT+2Timezone that is 2 hours later than the Greenwich Mean Time.
EETSame timezone as GMT+2
GMT+3Timezone that is 3 hours later than the Greenwich Mean Time.
GMT+4Timezone that is 4 hours later than the Greenwich Mean Time.
GMT+5Timezone that is 5 hours later than the Greenwich Mean Time.
GMT+6Timezone that is 6 hours later than the Greenwich Mean Time.
GMT+7Timezone that is 7 hours later than the Greenwich Mean Time.
GMT+8Timezone that is 8 hours later than the Greenwich Mean Time.
GMT+9Timezone that is 9 hours later than the Greenwich Mean Time.
JapanSame timezone as GMT+9.
GMT+10Timezone that is 10 hours later than the Greenwich Mean Time.
GMT+11Timezone that is 11 hours later than the Greenwich Mean Time.
GMT+12Timezone that is 12 hours later than the Greenwich Mean Time.
_ 5.12. Time
Allowed usersadmin, operator, user
Setting Timezone for VN-E4
Format/api/param?system.timezone=data
Example/api/param?system.timezone=Pacific
Example of Responsesystem.timezone&200 OK
InterpretationChange the timezone of VN-E4. Refer to "Acquiring Timezone from VN-E4" on the character string to
specify. Upon setting this API, execute the "system.status=restart" API for enabling setting changes to enable
the new settings. Upon changing the timezone, VN-E4 will be rebooted using the "system.status=restart" API
for enabling settings. As such, access will not be possible for about 1 minute.
Allowed useradmin
58
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.13. Password
5.13. Password
The APIs below are related to passwords. These are equivalent to the features on the Password page of the WEB setting page. Refer to the
instruction manual for details on the Password page.
Setting Password for VN-E4
Format/api/param?system.password.data1=data2
Example/api/param?system.password.admin=someword
Example of Responsesystem.password.admin&200 OK
InterpretationChange 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.
Example when setting admin password:/api/param?system.password.admin=word1
Example when setting operator password:/api/param?system.password.operator=word2
Example when setting user password: /api/param?system.password.user=word3
There is no API for acquiring passwords.
Allowed useradmin
59
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.14. Maintenance
5.14. Maintenance
The APIs below are related to maintenance. These are equivalent to the features on the Maintenance page of the WEB setting page. Refer to
the instruction manual for details on the Maintenance page.
(Caution: There are 2 types of initialization features on the WEB setting page, but only 1 is available for API.)
Initialization
Format/api/param?system.status=initialize
Example of Responsesystem.status&200 OK
InterpretationRestore all VN-E4 settings to factory defaults. Upon doing so, all transmission services that are in progress
will be terminated.
Allowed useradmin
Version Upgrade
Version upgrading is not possible using API. To do so, use the Version Upgrade feature on the Maintenance
page of the WEB setting page.
60
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
ResponseReturn 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
InterpretationAcquire the sending/receiving status of VN-E4.
Allowed usersadmin, operator, user
61
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.15. Acquiring Status
Acquiring Log
Format/api/param?system.log
ResponseReturn the following information. These information will be initialized upon turning off the power of VN-E4.
Response examples on the number of seconds after startup, alarm log information, motion detect log, list of
clients currently acquiring alarm, clients currently sending audio data, and clients currently using passthrough.
system.log=&200 OK
system alive time: 2142sec <----- No. of seconds after startup
Alarm Detect 1 ( total 2 times )<----- Alarm input 1ch
(Blank in the case of 0 times)
2005/07/01 11:26:30 ( make ) <----- Up to the latest 10 line
2005/07/01 11:26:29 ( break )<----- Up to the latest 10 line
Alarm Detect 2 ( total 2 times )
2005/07/01 11:26:30 ( make )
2005/07/01 11:26:29 ( break )
Alarm Detect 3 ( 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 ( total 2 times )
2005/07/01 11:26:30
2005/07/01 11:26:29
Motion Detect 4 ( total 2 times )
2005/07/01 11:26:30
2005/07/01 11:26:29
Alarm Monitor ( total 2 clients )<----- Clients currently acquiring alarm
(Blank in the case of 0 clients)
2005/07/01 11:26:30 ( 136.198.34.14 )<----- Up to 4
2005/07/01 11:26:29 ( 10.0.0.1 )
Serial Passthrough ( total 2 clients )<----- Clients currently using pass-through
2005/07/01 11:26:30 ( 1 136.198.34.14 ) <----- Serial port no. and client's IP address
2005/07/01 11:26:29 ( 2 10.0.0.1 )<----- Up to 2
Audio Client ( total 1 clients )<----- Clients currently sending audio data to E4
2005/07/01 11:26:30 ( 136.198.34.14 )<----- Up to 1
InterpretationAcquire the VN-E4 log.
Allowed useradmin
(Blank in the case of 0 clients)
(Blank in the case of 0 clients)
62
5. API for Acquiring/Changing Parameters of VN-E4 _
5.16. Acquiring Settings
5.16. Acquiring Settings
The APIs below are related to the acquisition of settings. These are equivalent to the features on the Settings page of the WEB setting page.
Refer to the instruction manual for details on the Settings page.
Acquiring Model Name
Format/api/param?system.model
Example of Responsesystem.model=VN-E4(U)&200 OK
InterpretationAcquire the model name.
Allowed usersadmin, operator, user
Acquiring Firmware Revisions
Format/api/param?system.software.revision
Example of Responsesystem.software.revision=1.0 U&200 OK
InterpretationAcquire revisions of the firmware.
Allowed usersadmin, operator, user
Acquiring DSP Firmware Revisions
Format/api/param?system.software.revision(DSP)
Example of Responsesystem.software.revision(DSP)=1.0&200 OK
InterpretationAcquire revisions of the DSP firmware.
Allowed usersadmin, operator, user
63
5. API for Acquiring/Changing Parameters of VN-E4 _ 5.17. Others
5.17. Others
These are APIs of features not found on the WEB setting page.
Restart VN-E4
Format/api/param?system.status=restart
Example of Responsesystem.status&200 OK
InterpretationRestarts VN-E4.
Allowed usersadmin
Acquiring SNMP Agent Feature On/Off Status from VN-E4
Format/api/param?network.snmp_client.status
Example of Responsenetwork.snmp_client.status=off&200 OK
InterpretationAcquire the on/off status of the SNMP agent feature. Either on or off will be returned.
Allowed usersadmin, operator, user
Setting SNMP Agent Feature Status to On/Off for VN-E4
Format/api/param?network.snmp_client.status=data
Example/api/param?network.snmp_client.status=on
Example of Responsenetwork.snmp_client.status&202 Required(network.interface.status=restart)
InterpretationChange 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 via the SNMP manager, a community name will be required when accessing
via SNMPv1 and SNMPv2c.
Community name: vn-e4
When access via SNMPv3, a user name, passphrase and private passphrase will be required.
User name: vn-e4
Passphrase: vn-e4-snmp
Private passphrase: vn-e4-snmp
Authentication method: MD5
Encryption system: DES
Memory may be consumed within the VN-E4 when the SNMP agent feature is turned on, and the maximum
sending bit rate may be constrained.
Allowed usersadmin, operator
64
6. API for Sending JPEG/Audio from VN-E4 via UDP _ 6.1. Procedure
P
This section describes the API for sending JPEG or audio data via UDP. Make use of the APIs explained in this section in the way as
mentioned in Section 4.
VN-E4 allows sending of up to 10 streams of JPEG/audio data. This includes HTTP sending based on client request, manual sending from the
WEB setting page as well as UDP sending via API. An error will be returned for the API if 10 streams of data are currently being sent.
6.1. Procedure
1) The client establishes 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.
GETSpaceAPI Character StringSpaceHTTP/1.10x0D 0x0A
AcceptSpacetext/plain or text/html0x0D 0x0A
Host:SpaceIP Address of VN-E40x0D 0x0A
Authorization: BasicSpaceUser Name and Password0x0D 0x0A 0x0D 0x0A
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.
6. A
4) Perform the action as instructed by VN-E4 (start or stop JPEG/audio sending).
5) The client can disconnect TCP80 to end the use of API.
65
6. API for Sending JPEG/Audio from VN-E4 via UDP _ 6.2. List of APIs
Specify the source IP address for ip=. Specify the client IP number for session_id=. VN-E4 will register this
number and accept the client with the same API (stop). VN-E4 will accept the API at all times when it is
specified as session_id=*.
When from.ip_translate is set to off, VN-E4 will standby to receive audio data from the IP address specified at
from.ip. When from.ip_translate is set to on, VN-E4 will ignore from.ip and standby to receive audio data from
the source IP address of this API.
The client may disconnect TCP80 at this point of time.
4) The client continues to send 512 bytes of u-Law data with a 12-byte header.
The data's header format is as follows. The 12-byte header is made up of 3 4-byte data.
0x00000080
No. of bytes of audio data (fixed as 512)
Time stamp (Unit: 8 kHz)
512 bytes of u-Law data
5) To end, disconnect TCP49298.
䡵 Restrictions on Number of Clients
Only 1 client is allowed to send audio data to VN-E4. VN-E4 will return an error for this API and TCP will be
disconnected when this function is currently in use by another client. In addition, VN-E4 will also return an error for this
API and disconnect TCP when there exists a client that makes use of the audio reception feature at VN-E4 via RTP/UDP.
䡵 Timing of Data Sending
512 bytes, or in other words, 64 msec of audio data may be sent during each transmission. Send audio data at intervals
as evenly as possible. A part of the data may be lost if audio data exceeding 2 seconds are sent to VN-E4 at one time.
69
7. API for Audio Receiving by VN-E4 _ 7.2. Audio Receiving via RTP
7.2. Audio Receiving via RTP
1) The client establishes a TCP connection to port number 80 and sends out API.
GETSpaceAPI Character StringSpaceHTTP/1.10x0D 0x0A
AcceptSpacetext/plain or text/html0x0D 0x0A
Host:SpaceIP Address of VN-E40x0D 0x0A
Authorization: BasicSpaceUser Name and Password0x0D 0x0A 0x0D 0x0A
Refer to Section 4 on details of the Accept and Authorization lines.
The API format when specifying using GET is as follows.
Specify the source IP address for ip=. Specify the client IP number for session_id=. VN-E4 will register this
number and accept the client with the same API (stop). VN-E4 will accept the API at all times when it is
specified as session_id=*.
When from.ip_translate is set to off, VN-E4 will standby to receive audio data from the IP address specified at
from.ip. When from.ip_translate is set to on, VN-E4 will ignore from.ip and standby to receive audio data from
the source IP address of this API.
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.
0x8000Sequence No.
Time stamp (Unit: 8 kHz)
SSRC
512 bytes of u-Law data
4) To end, send an API for stopping transmissions.
API Format/api/stop?from.session_id=data
Example/api/stop?from.session_id=*
Specify session_id= using the number that is specified via the send command. Ensure to stop audio reception
when session_id=* is specified.
䡵 Restrictions on Number of Clients
Only 1 client is allowed to send audio data to VN-E4. VN-E4 will return an error for this API and TCP will be
disconnected when this function is currently in use by another client. In addition, VN-E4 will also return an error for this
API and disconnect TCP when there exists a client that makes use of the audio reception feature at VN-E4 via RTP/UDP.
䡵 Timing of Data Sending
512 bytes, or in other words, 64 msec of audio data may be sent during each transmission. Send audio data at intervals
as evenly as possible. A part of the data may be lost if audio data exceeding 2 seconds are sent to VN-E4 at one time.
70
8. API for Controlling External Devices Connected to VN-E4 _
P
This section describes APIs for controlling external devices that are connected to the serial port of VN-E4. Make use of the APIs explained in
this section in the way as mentioned in Section 4.
8.1. Control of Pelco-D Camera
8.1. Control of Pelco-D Camera
This is an API for controlling cameras that support Pelco-D protocols.
(1) Pan Control
API Character String/api/param?peripheral.serial(Number).device(Address).camera.motion.pan.
The format above specifies the pan direction (mode), pan speed (speed) and start/stop (status) at one time. It is
also possible to set them separately over 3 times.
ExampleBelow is an example that indicates panning towards the left at speed 50 of a camera with an address of 123 that
Example of Responseperipheral.serial(2).device(123).camera.motion.pan.mode&200
OK&peripheral.serial(2).device(123).camera.motion.pan.speed&200
OK&peripheral.serial(2).device(123).camera.motion.pan.status&200 OK
8. A
InterpretationSend the pan command to the specified serial port and camera address. Specify the serial port as 1 or 2. Specify
the camera address between the range of 0 to 255. Specify the mode as left or right. 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.
The format above specifies the tilt direction (mode), tilt speed (speed) and start/stop (status) at one time. It is
also possible to set them separately over 3 times.
ExampleBelow is an example that indicates upward tilting at speed 50 of a camera with an address of 123 that is
Example of Responseperipheral.serial(2).device(123).camera.motion.tilt.mode&200
OK&peripheral.serial(2).device(123).camera.motion.tilt.speed&200
OK&peripheral.serial(2).device(123).camera.motion.tilt.status&200 OK
InterpretationSend the tilt command to the specified serial port and camera address. Specify the serial port as 1 or 2. Specify
the camera address between the range of 0 to 255. Specify the mode as up or down. 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.
Example of Responseperipheral.serial(2).device(123).camera.iris&200 OK
InterpretationSend the iris command to the specified serial port and camera address. Specify the serial port as 1 or 2. Specify
the camera address between the range of 0 to 255. Specify iris as + or -. Use + to open and - to close the iris.
Operation will be executed stepwise upon using the command once and there is no need to stop the operation.
Allowed usersadmin, operator, user
(4) Focus Control
API Character String/api/param?peripheral.serial(Number).device(Address).camera.focus=Data1
ExampleBelow is an example that sets the focus to a distant point for the camera with an address of 123 that is
Example of Responseperipheral.serial(2).device(123).camera.focus&200 OK
InterpretationSend the focus command to the specified serial port and camera 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 usersadmin, operator, user
(5) Zoom Control
API Character String/api/param?peripheral.serial(Number).device(Address).camera.motion.zoom.
Example of Responseperipheral.serial(2).device(123).camera.motion.zoom.mode&200
OK&peripheral.serial(2).device(123).camera.motion.zoom.status&200 OK
InterpretationSend the zoom command to the specified serial port and camera address. Specify the serial port as 1 or 2.
Specify the camera address between the range of 0 to 255. Specify the mode as in or out. Use in to set to the
tele end and out to the wide end. Specify status as start or stop. To specify stop only, make use of the API as
shown in the following example.
8. API for Controlling External Devices Connected to VN-E4 _ 8.2. Control
of External Devices via Pass-through
8.2. Control of External Devices via Pass-through
By using the pass-through feature, data sent to VN-E4 via the network will be output from the serial port of VN-E4. In addition, Ack received
by the serial port of VN-E4 will be returned to the client via the network.
Reserve the pass-through feature via API, connect the TCP for transmission of pass-through data (49152 for serial port 1 and 49153 for serial
port 2), followed by sending the data.
specified at from.ip. When from.ip_translate is set to on, VN-E4 will ignore from.ip and standby to receive the
pass-through data from the source IP address of this API.
Reservation of serial port 1 will be disabled when Service at the rear panel of VN-E4 is selected. When an API
is sent in this case, an error will be returned.
73
8. API for Controlling External Devices Connected to VN-E4 _ 8.2. Control
of External Devices via Pass-through
(2) TCP Connection for Pass-through
The client will establish a TCP connection to TCP49152 when serial port 1 is used. In the case of serial port 2, the client will establish a TCP
connection to 49153.
The client may also disconnect TCP80 used by the API.
(3) 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 following API.
API Character String/api/stop?to=serial(Number)
Example when ending
serial port 2
/api/stop?to=serial(2)
74
9. List of Protocols and Port Numbers Used with VN-E4
s
VN-E4 uses the following protocols and port numbers.
Protocol / Port NumberUse
TCP 80WEB setting page, API for acquiring status and changing settings
TCP 8009TCP acquisition of JPEG/audio from VN-E4 by client
TCP 32040Alarm acquisition from VN-E4 by client
TCP 49152Pass-through of serial port 1
TCP 49153Pass-through of serial port 2
TCP 49200UDP transmission of audio from client to VN-E4
TCP 49298TCP transmission of audio from client to VN-E4
9. Li
75
10. Advanced Topics
d
(1) When frame rate drops deteriorates due to long network delay time
䡵 Causes of Frame Rate Deterioration
During transmission via TCP, VN-E4 sends out the following data by receiving the Ack of TCP. When network delay is long, reception of
Ack will be delayed and sending rate will drop. This therefore leads to a drop in the frame rate.
䡵 Countermeasure 1
One of the countermeasures to improve this situation is to increase the TCP window size. Use sendbuffer (API argument for sending data to
VN-E4) to increase the outgoing buffer 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 increase the
buffer size will be rejected if the 1 MB size has already been used up by other clients.
䡵 Countermeasure 2
This problem can be avoided by receiving via multicast. Multicast uses UDP and Ack does not exist. As such, the sender will be able to
continue sending without being affected by network delays.
10. A
76
11. Customizing VN-E4's Built-in Viewer
The built-in viewer of VN-E4 consists of an ActiveX control, and customization is possible using HTML description.