JVC VN-E4U API Guide - Page 27

Alarm Setting, Acquiring Alarm On/Off Status from VN-E4, Setting Alarm to Off for VN-E4

Get JVC VN-E4U - 4 Channel Network Encoder PDF manuals and user guides
UPC - 046838021015
View all JVC VN-E4U manuals
Add to My Manuals
Save this manual to your list of manuals

Page 27 highlights

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 Example When acquiring the on/off status of Encoding No. 1 /api/param?application.event(1).status Example of response application.event(1).status=on&200 OK Interpretation Acquire 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. Setting Alarm to Off for VN-E4 Format /api/param?application.event(Number).status=off Example When setting Alarm No. 1 to off /api/param?application.event(1).status=off Example of response application.event(1).status&200 OK Interpretation Set 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. Object Input CH Frame Size object01 1 VGA object02 1 QVGA object03 2 VGA object04 2 QVGA object05 3 VGA object06 3 QVGA object07 4 VGA object08 4 QVGA 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

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
27
5. API for Acquiring/Changing Parameters of VN-E4 _
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
Example
When acquiring the on/off status of Encoding No. 1
/api/param?application.event(1).status
Example of response
application.event(1).status=on&200 OK
Interpretation
Acquire 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.
Setting Alarm to Off for VN-E4
Format
/api/param?application.event(Number).status=off
Example
When setting Alarm No. 1 to off
/api/param?application.event(1).status=off
Example of response
application.event(1).status&200 OK
Interpretation
Set 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.
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.
Format
5.4. Alarm Setting
Object
Input CH
Frame Size
object01
1
VGA
object02
1
QVGA
object03
2
VGA
object04
2
QVGA
object05
3
VGA
object06
3
QVGA
object07
4
VGA
object08
4
QVGA
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