RCP Doc 8.90.37
RCP Doc 8.90.37
RCP Doc 8.90.37
Reference
RCP Version 3
Specification
Copyright
This manual is the intellectual property of Bosch Security Systems and is protected by copyright.
All rights are reserved. No part of this document may be reproduced or transmitted for any
purpose, by whatever means, be they electronic or mechanical, without the express written
permission of Bosch Security Systems. Bosch Security Systems 2001 2021
Note
This manual was compiled with the greatest of care and all information double checked. At the
time of printing the description was complete and correct. Because of the further development of
products, the content of the manual might change without prior notice. Bosch Security Systems
will not be liable for damage which is directly or indirectly due to errors, incompleteness, or
discrepancies between the manual and the product described.
Trade marks
All names used in this manual for hardware and software are very probably registered trade
marks and must be treated as such.
Bosch RCP Plus Reference, Firmware 8.90
Functional Description
1 Functional Description
Transport Protocol........................................................................................................................ 4
Packetizing in the TCP Stream.................................................................................................... 7
RCP Protocol Procedure.............................................................................................................. 8
RCP over a HTTP tunnel........................................................................................................... 10
Autodetecting Devices................................................................................................................ 12
Setting an IP Address using Broadcast Mechanism.................................................................. 25
RCP over CGI.............................................................................................................................28
Request or setting of system or network parameters using Broadcast Mechanism................... 33
Extension for RCP+ commands containing IPv6 addresses or host names.............................. 34
RCP Command Notification........................................................................................................37
16 32
Tag Data Type Version R/W
2 Bytes 1 Byte 4 Bits 4 Bits
C T
Action Reserved Client ID
1 1
6 Bits 1 Byte 2 Bytes
Bit Bit
Session ID
4 Bytes
Numeric Descriptor ID Payload Length
2 Bytes 2 Bytes
8 24
Tag
Each tag is represented by two octets. It identifies the command which should be processed by the VideoJet.
Data Type
Specifies the data type of the payload section. These are the currently available data types.
Values:
F_FLAG 0x00
T_OCTET 0x01
T_WORD 0x02
T_INT 0x04
T_DWORD 0x08
P_OCTET 0x0C
P_STRING 0x10
P_UNICODE 0x14
Version
The current RCP version is 3. Backward compatibility to version 2 or version 0 is NOT provided.
R/W
Specifies whether the command should read or write. The Read/Write field is coded in the lower nibble
of byte 4.
Values:
Read 0x00
Write 0x01
C
Continuation. This bit signals, when set, that this RCP+ packet is not terminated in the payload; additional
packets with the full RCP+ header will follow immediately in the stream as long as this bit is cleared. The
reassembly of the complete payload is up to the application and is beyond the scope of this document.
T
StringTable available. This bit signals, when set, that there is a string table appended to this RCP+ packet
which contains IPv6 addresses or host names.
Action
Specifies the kind of the packet.
Values:
Request 0x00
Reply 0x01
Message 0x02
Error 0x03
Reserved
This byte is returned by the VideoJet unchanged. It is up to the user to setup a request ID here to assign
the replies to multiple pending requests.
Client ID
Each RCP client register results in a Client ID; this ID has to be provided in all following RCP commands.
Session ID
This ID is used for implementations which need to identify a once registered user in other applications or
RCP sessions.
Numeric Descriptor ID
The Numeric Descriptor specifies an attribute for components which are installed more than one time inside
the VideoJet, e.g. inputs or relays. The first component is always counted as 1. If this field is not applicable
to the command in this packet, a value of zero should be inserted.
Payload Length
The number of data bytes inside the payload section. The length field itself is not counted.
16 32
Version Reserved Length
1 Byte 1 Byte 2 Bytes
RCPPacket
N Bytes
8 24
Version
TPKT version 3.
Reserved
Should be set to zero.
Length
Byte count of the complete packet; RCP packet length + TPKT length (4 Bytes).
RCP is capable of sending messages on certain events. Before an RCP client can receive these messages,
a registration at the VideoJet is necessary.
RCP Errors
The packet will have the standard layout with the method field set to ‘Error’. The first bytes of the payload
section contains error cause. If the error code is RCP_ERROR_COMMAND_SPECIFIC, then the command
specific error (see RCP command for details) is included in the second byte. The following generic error
codes are defined:
RCP_ERROR_INTERNAL 0x01
RCP_ERROR_INVALID_VERSION 0x10
RCP_ERROR_NOT_REGISTERED 0x20
RCP_ERROR_INVALID_CLIENT_ID 0x21
RCP_ERROR_INVALID_METHOD 0x30
RCP_ERROR_INVALID_CMD 0x40
RCP_ERROR_INVALID_ACCESS_TYPE 0x50
RCP_ERROR_INVALID_DATA_TYPE 0x60
RCP_ERROR_WRITE_ERROR 0x70
RCP_ERROR_PACKET_SIZE 0x80
RCP_ERROR_READ_NOT_SUPPORTED 0x90
RCP_ERROR_INVALID_AUTH_LEVEL 0xa0
RCP_ERROR_INVAILD_SESSION_ID 0xb0
RCP_ERROR_TRY_LATER 0xc0
RCP_ERROR_TIMEOUT 0xd0
RCP_ERROR_NO_LICENCE 0xe0 Used by NVR only
RCP_ERROR_COMMAND_SPECIFIC 0xf0
RCP_ERROR_ADDRESS_FORMAT 0xf1
RCP_ERROR_NOT_SUPPORTED_ON_THAT_PLATFORM
0xf2
RCP_ERROR_UNKNOWN 0xff
Note the error code 0xc0 RCP_ERROR_TRY_LATER indicates, that the VideoJet recognizes the
command, but it cannot be processed immediately. The client should repeat this command later.
A list of all defined command specific error codes can be found in the Appendix.
advices the webserver to pass this socket to the RCP server. From that point on, the client is connected to
the RCP server and can immediately cointinue with RCP registration.
Note: The delimiters '\r' and '\n' are written here in C notation; in the TCP packet to the server these delimiters
corresponds with the ASCII codes 0x0d and 0x0a.
Example:
• Establish a TCP connection to port 80 at your Videjet
• Send the string "GET /rcp_tunnel HTTP/1.0\r\n\r\n" (as HEX string: 0x47 0x45 0x54 0x20
0x2f 0x72 0x63 0x70 0x5f 0x74 0x75 0x6e 0x6e 0x65 0x6c 0x20 0x48 0x54 0x54 0x50
0x31 0x2e 0x30 0x0d 0x0a 0x0d 0x0a)
• Proceed in the same manner as a normal RCP connection
Receiving media data
The VideoJet is capable for tunneling media data through HTTP. In some network environments this might
be helpful.
When using this mechanism, the connect primitive must set the "RTP over TCP" for the media encapsulation
protocol. The response for Media host and port can be ignored. After that, a TCP connection to the HTTP
port must be established. By sending the string
SSSSSSS The session ID returned from the connect primitive (padded with leading zeros
to 8)
CC The media type (see connect primitive; 01=video, 02=audio)
DD Direction of media (01=receive media, 00=transmit media)
LL The line input number
CO The relative coder number
When the HTTP server inside the VideoJet received this string, it passes this socket to the RCP. From that
point on, media data will be transferred over this socket using TPKT encapsulation (see chapter Packetizing
in the TCP Stream).
The coder numbers that have to be used to establish the media tunnels is a relative one that isn't unique when
using video as media type. The video and meta data can have the same relative coder number and have the
same media type. In that case the optional index parameter might be used to distinguish the media channels:
where n is the number of the initial connect primitive channel position starting at 1.
E.g the ConnectPrimitive request contains a Get Video, a Get Audio and a Get Meta section, then the index
for video would be 1, the index for audio 2 and the index for meta would be 3.
When all sockets of a session are in data sending mode, a RCP message MEDIA_SOCKETS_COMPLETE
with the associated session ID will be sent out to the initiator of the session. This is useful
when a session is used for replay; the replay PLAY command can securely be applied when the
MEDIA_SOCKETS_COMPLETE message has been arrived.
Sequence Number
This sequence number must be a randomized number.
Reply Port
Specifies the reply UDP port e.g. RP1 0x06; RP2 0xDE -> reply port: 1758
ID
Values:
NCID_NVR 0x01
NCID_VJ8000 0x02
NCID_VIP10 0x03
NCID_VIP1000 0x04
NCID_VJ400 0x06
NCID_VIP100 0x07
NCID_VJEX 0x08
NCID_VJ1000 0x09
NCID_VJ100 0x0A
NCID_VJ10 0x0B
NCID_VJ8008 0x0C
NCID_VJ8004 0x0D Latest unit carrying the old numbering
scheme
EscapeCode 0x0F Used to switch over to new detection
R
Reserved
FL
Flavour - Values:
HARDWARE_TYPE_VIN 0x00
HARDWARE_TYPE_VOUT 0x01
HARDWARE_TYPE_VIN_OUT 0x02
Net
Values:
Mask Name
Bit 2 0x4 HARDWARE_SYSTEM_ETHERNET
Bit 0 0x1 HARDWARE_SYSTEM_OPT_ISDN
Opt
Values:
Mask Name
Bit 1 0x2 HARDWARE_OPT_HDD
Bit 0 0x1 HARDWARE_OPT_AUDIO
Esc
Must be set to 0xF
R
Reserved
M
Values:
Master 0x00
Slave 0x01
FL
Flavour - Values:
HARDWARE_TYPE_VIN 0x00
HARDWARE_TYPE_VOUT 0x01
HARDWARE_TYPE_VIN_OUT 0x02
ID
Note: this Hardware ID will not be further maintained
for future products. To distinguish different device
variants please use the Product- and Variant ID, see
command CONF_DEVICE_TYPE_IDS
HARDWARE_ID_VIPX1 0x01
HARDWARE_ID_VIPX2 0x02
HARDWARE_ID_VIPXDEC 0x03
HARDWARE_ID_VJ_X10 0x05
HARDWARE_ID_VJ_X20 0x06
HARDWARE_ID_VJ_X40 0x07
HARDWARE_ID_VJ_X40_ECO 0x08
HARDWARE_ID_VJ_X10_ECO 0x09
HARDWARE_ID_VJ_X20_ECO 0x0A
HARDWARE_ID_IP_PANEL 0x0d
HARDWARE_ID_GEN4 0x0e
HARDWARE_ID_M1600 0x0f
HARDWARE_ID_FLEXIDOME 0x11
HARDWARE_ID_M1600_DEC 0x13
HARDWARE_ID_M1600_XFM 0x15
HARDWARE_ID_AUTODOME 0x16
HARDWARE_ID_NBC_225P 0x1a
HARDWARE_ID_VIPX1_XF 0x1e
HARDWARE_ID_CPP13 0x1f
HARDWARE_ID_NBC_255P 0x20
HARDWARE_ID_NBC_255W 0x21
HARDWARE_ID_AUTODOME_EASY_II 0x23
HARDWARE_ID_AUTODOME_EASY_II_E 0x24
HARDWARE_ID_VIPX1_XF_E 0x25
HARDWARE_ID_VJT_X20XF_E_2CH 0x26
HARDWARE_ID_VJT_X20XF_E_4CH 0x27
HARDWARE_ID_VIPX1_XF_W 0x28
HARDWARE_ID_VG5_AUTODOME_700 0x29
HARDWARE_ID_NDC_455_P 0x2a
HARDWARE_ID_NDC_455_P_IVA 0x2b
HARDWARE_ID_NBC_455_P 0x2c
HARDWARE_ID_NBC_455_P_IVA 0x2d
HARDWARE_ID_VG4_AUTODOME 0x2e
HARDWARE_ID_NDC_225_P 0x2f
HARDWARE_ID_NDC_255_P 0x30
HARDWARE_ID_VOT 0x32
HARDWARE_ID_NDC_274_P 0x35
HARDWARE_ID_NDC_284_P 0x36
HARDWARE_ID_NTC_265_PI 0x37
HARDWARE_ID_NDC_265_PIO 0x38
HARDWARE_ID_DINION_720P 0x39
HARDWARE_ID_NDN_822 0x3a
HARDWARE_ID_FLEXIDOME_720P 0x3b
HARDWARE_ID_NDC_265_W 0x3c
HARDWARE_ID_NDC_265_P 0x3d
HARDWARE_ID_NBC_265_P 0x3e
HARDWARE_ID_NDC_225_PI 0x3f
HARDWARE_ID_NTC_255_PI 0x40
HARDWARE_ID_JR_DOME_HD 0x41
HARDWARE_ID_JR_DOME_HD_FIXED 0x42
HARDWARE_ID_EX30_IR 0x43
HARDWARE_ID_GEN5_HD_PC 0x45
HARDWARE_ID_EX65 0x46
HARDWARE_ID_DINION_1080P 0x47
HARDWARE_ID_FLEXIDOME_1080P 0x48
HARDWARE_ID_HD_DECODER 0x49
HARDWARE_ID_GEN5_HD 0x4a
HARDWARE_ID_NER_L2 0x4b
HARDWARE_ID_VIP_MIC 0x4c
HARDWARE_ID_GEN5_A5_800 0x4d
HARDWARE_ID_NEVADA_TRANSCODER 0x4e
HARDWARE_ID_TESLA_BOXED 0x4f
HARDWARE_ID_TESLA_DOME 0x50
HARDWARE_ID_GEN5_A5_700 0x52
HARDWARE_ID_VJ_GENERIC_TRANSCODER 0x53
HARDWARE_ID_HD_DECODER_M 0x54
HARDWARE_ID_OASIS 0x55
HARDWARE_ID_GALILEO_BOXED 0x56
HARDWARE_ID_GALILEO_DOME 0x57
HARDWARE_ID_HUYGENS_KEPPLER 0x58
HARDWARE_ID_TESLA_KEPPLER 0x59
HARDWARE_ID_GALILEO_KEPPLER 0x5a
HARDWARE_ID_NUC_20002 0x5b
HARDWARE_ID_NUC_20012 0x5c
HARDWARE_ID_NUC_50022 0x5d
HARDWARE_ID_NUC_50051 0x5e
HARDWARE_ID_NPC_20002 0x5f
HARDWARE_ID_NPC_20012 0x60
HARDWARE_ID_NPC_20012_W 0x61
HARDWARE_ID_NIN_50022 0x62
HARDWARE_ID_NII_50022 0x63
HARDWARE_ID_NDN_50022 0x64
HARDWARE_ID_NDI_50022 0x65
HARDWARE_ID_NTI_50022 0x66
HARDWARE_ID_NIN_50051 0x67
HARDWARE_ID_NDN_50051 0x68
HARDWARE_ID_NAI_90022 0x69
HARDWARE_ID_NCN_90022 0x6a
HARDWARE_ID_NEVADA_DECODER 0x6c
HARDWARE_ID_NBN_50022_C 0x6d
HARDWARE_ID_NBN_40012_C 0x6e
HARDWARE_ID_NBN_80052 0x71
HARDWARE_ID_MIC_7000 0x72
HARDWARE_ID_EX65_HD 0x73
HARDWARE_ID_NBN_80122 0x74
HARDWARE_ID_NPC_20012_L 0x75
HARDWARE_ID_MIC_NPS 0x76
HARDWARE_ID_NBN_50051_C 0x78
HARDWARE_ID_NIN_40012 0x79
HARDWARE_ID_NII_40012 0x7a
HARDWARE_ID_NDN_40012 0x7b
HARDWARE_ID_NDI_40012 0x7c
HARDWARE_ID_NTI_40012 0x7d
HARDWARE_ID_NII_50051 0x7e
HARDWARE_ID_NDI_50051 0x7f
HARDWARE_ID_NEZ_4000 0x80
HARDWARE_ID_VEGA_3000_HD 0x81
HARDWARE_ID_VEGA_4000_HD 0x82
HARDWARE_ID_VEGA_5000_HD 0x83
HARDWARE_ID_VEGA_5000_MP 0x84
HARDWARE_ID_NIN_70122_180 0x85
HARDWARE_ID_NIN_70122_360 0x86
HARDWARE_ID_NEZ_5000 0x88
HARDWARE_ID_NEZ_5000_IR 0x89
HARDWARE_ID_ROLA 0x8b
HARDWARE_ID_NBN_80122_CA 0x8c
HARDWARE_ID_ROLA_VANDAL 0x8d
HARDWARE_ID_ROLA_MSI 0x8e
HARDWARE_ID_SVO_1601 0x8f
HARDWARE_ID_VJD_8000 0x90
HARDWARE_ID_PIXIE_BOXED 0x91
HARDWARE_ID_SVI_1609 0x92
HARDWARE_ID_PIXIE_DOME 0x94
HARDWARE_ID_NBN_80052_FIRE 0x95
HARDWARE_ID_ALTAIR3 0x96
HARDWARE_ID_PLANCK 0x97
HARDWARE_ID_NDP_4000 0x99
HARDWARE_ID_NDP_5000 0x9a
HARDWARE_ID_NDP_5000_IR 0x9b
HARDWARE_ID_NDE_8502 0x9e
HARDWARE_ID_NDE_8503_4 0x9f
HARDWARE_ID_NBE_4000 0xa0
HARDWARE_ID_NBE_5000 0xa1
HARDWARE_ID_NBE_6000 0xa2
HARDWARE_ID_MIC_9000 0xa3
HARDWARE_ID_MIC_7000_7_3 0xa9
HARDWARE_ID_GEN5_7_3 0xaa
HARDWARE_ID_NTI_51022 0xad
HARDWARE_ID_NDP_5523 0xae
HARDWARE_ID_NDP_5523_IR 0xaf
HARDWARE_ID_CHOPPER 0xb0
HARDWARE_ID_NDE_8502_RX_8503_RX 0xb4
HARDWARE_ID_ISCSI_TARGET 0xf6
HARDWARE_ID_VRM_PROXY_16 0xf7
HARDWARE_ID_VRM_UL_APP 0xf8
HARDWARE_ID_VRM_LE_APP 0xf9
HARDWARE_ID_CAMNETWORK 0xfa
HARDWARE_ID_VRM_PROXY 0xfb
HARDWARE_ID_VRM 0xfc
HARDWARE_ID_VIDOS_SERVER 0xfd
HARDWARE_ID_VIDOS_MONITOR 0xfe
Net
Values:
Mask Name
Bit 2 0x4 HARDWARE_SYSTEM_ETHERNET
Bit 0 0x1 HARDWARE_SYSTEM_OPT_ISDN
Opt
Values:
Mask Name
Bit 1 0x2 HARDWARE_OPT_HDD
Bit 0 0x1 HARDWARE_OPT_AUDIO
Sequence Number
Returns the sequence number from the request packet.
Hardware Address
MAC address of the device.
ID
Unit Hardware ID returned from request (will be 0xff when the new version layout is used).
Device IP
Current IP address of the device.
Subnet Mask
Current Subnet mask of the device.
Gatway IP
Current Gateway of the device.
Flavor
Flavor of this device.
Connections
Number of active connections.
ID new
The ID filed of the new version layout.
<RCPPort>XXXX</RCPPort>
<HTTPPort>XXXX</HTTPPort>
<HTTPSPort>XXXX</HTTPSPort>
<dhcp>X</dhcp>
<cameraFrontendID>XXXX</cameraFrontendID>
<Flags>X</Flags>
<Lines>X</Lines>
<BcJpeg>X</BcJpeg>
<ClusterMember>XXX.XXX.XXX.XXX</ClusterMember>
<ClusterMemberMAC>XX-XX-XX-XX-XX-XX</ClusterMemberMAC>
<ClusterID>X</ClusterID>
<deviceCapabilities>XXXXXXXXXX...XX</deviceCapabilities>
</device>
</root>
<root xmlns="OEMExtXX:device-1-0">
XX is the OEM Extension; 0x00 for Bosch Security Systems; OEM
specific
<deviceType>OEMExtXX:device:deviceIDYY</deviceType>
XX is the OEM Extension; 0x00 for Bosch Security Systems; OEM
specific
YY is the VideoJet ID from the request packet
<friendlyName>VideoJet</friendlyName>
The name and type of the VideoJet; type and OEM specific
<unitName>UnitName</unitName>
The name of the unit coded in UTF-8
<serialNumber>XXXXXXXX:YYYYYYYY</serialNumber>
XXXXXXX is the Hardware version of the VideoJet
YYYYYYY is the Softwareware version of the VideoJet
<sessionKey>XXXXXXXXXXXXXXXX</sessionKey>
No common use
<unitSubnetMask>XXX.XXX.XXX.XXX</unitSubnetMask>
XXX.XXX.XXX.XXX is the subnet mask of the VideoJet
<unitGatewayIp>XXX.XXX.XXX.XXX</unitGatewayIp>
XXX.XXX.XXX.XXX is the current gateway IP address of the VideoJet
<unitIPv6Address>XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX</
unitIPv6Address>
XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX:XXXX is the current IPv6 address of
the VideoJet e.g. FD00::1234:5678
<activeConnections>XX</activeConnections>
XX is the number of active media connections of the VideoJet
<RCPPort>XXXX</RCPPort>
XXXX is the current RCP port number the VideoJet is listening to
<HTTPPort>XXXX</HTTPPort>
XXXX is the current HTTP port number the VideoJet is listening to
<HTTPSPort>XXXX</HTTPSPort>
XXXX is the current HTTPS port number the VideoJet is listening to
<dhcp>X</dhcp>
X indicates if dhcp is switched on (1) or off (0)
<cameraFrontendID>XXXX</cameraFrontendID>
XXXX is the ID of the (internal) camera frontend (see also Bicom
documentation)
<Flags>X</Flags>
X is the flag value returned by RCP command CONF_CM_DEFAULT_CONFIG
<Lines>X</Lines>
X is the number of video lines the device has
<BcJpeg>X</BcJpeg>
X indicates the ability to deliver JPEGs via the broadcast JPEG
retrieval mechanism
<ClusterMember>XXX.XXX.XXX.XXX</ClusterMember>
XXX.XXX.XXX.XXX is the ip address of one of the cluster members; there
might be multiple entries including this device
<ClusterMemberMAC>XX-XX-XX-XX-XX-XX</ClusterMemberMAC>
XX-XX-XX-XX-XX-XX is the MAC address of one of the cluster members;
there might be multiple entries including this device
<ClusterID>XX</ClusterID>
XX is index number of the above ClusterMember list of this device
<deviceCapabilities>XXXXXXXXXX...XX</deviceCapabilities>
16 32
Scan Extension Identifier
4 Bytes
Size
4 Bytes
8 24
Size
The Size field of the extension informs about the number of bytes used in the extension. The number includes
the 4 bytes of the Scan Extension Identifier field, the 4 bytes of the Size field itself and the length of the
following payload in bytes.
In case of the MAC address extension, the Size field is followed by one or more MAC addresses of 6 bytes
length each. A scan extension limiting the autodetect scan to 2 devices, the size field of the scan extension
should contain a value of 20. (4 bytes Scan Extension Identifier + 4 bytes Length + 6 bytes first MAC
address + 6 bytes second MAC address)
Retrieving thumbnail JPEGs using the Autodetecting Broadcast
Mechanism
The Bosch Security Systems products support a mechanism that allows to retrieve thumbnail JPEGs via a
broadcast autodetect mechanism. The mechanism requires to send a UDP packet similar to the autodetect
scan packet to the configurable autodetect port of the device, whose default port number is 1800. The device
replies with a packet containing the thumbnail JPEG. The JPEG retrieval can not be accomplished via the
static autodetect port 1757.
Format of the request packet of an autodetect based JPEG request
The request packet triggering the autodetect based JPEG retrieval consists of an RCP plus protocol header
and an autodetect based JPEG request header, followed by a MAC list scan extension.
RCP plus protocol header
The RCP plus protocol header's command id field is set to 0x099e (CONF_JPEG). The data type field is set
to 0x0c (P_OCTET). The numeric descriptor field identifies the line of the targeted device, from which the
JPEG is to be retrieved. The length field of the request indicates the number of payload bytes and therefore
is to be set to the length of the autodetect based JPEG request header plus the length of the scan extension
(e.g. 12 bytes for autodetect based JPEG request header, 8 bytes for scan extension header and 6 bytes for
MAC address = 26 bytes).
Autodetect based JPEG Request Header
The first four bytes of the autodetect based JPEG request header consist of a static magic number, that is
always set to the values given in the table below. The sequence number given in the request is returned in
the reply, so that replies can be matched to the respective request.
16 32
0x4B 0xA5 0xC3 0x55
1 Byte 1 Byte 1 Byte 1 Byte
Sequence Number
4 Bytes
0x00 0x00 Reply Port
1 Byte 1 Byte 2 Bytes
8 24
Sequence Number
This sequence number must be a randomized number.
Reply Port
Specifies the reply UDP port e.g. RP1 0x06; RP2 0xDE -> reply port: 1758
The reply packet to the request for an autodetect based broadcast JPEG consists of an RCP plus protocol
header and an autodetect based JPEG request header, followed by the JPEG data.
RCP plus protocol header
The RCP plus protocol header's command id field is set to 0x099e (CONF_JPEG). The data type field is
set to 0x0c (P_OCTET). The numeric descriptor field identifies the line of the targeted device, from which
the JPEG was retrieved. The length field of the reply indicates the number of payload bytes and therefore is
to be set to the length of the autodetect based JPEG request header plus the length of the JPEG thumbnail.
Autodetect based JPEG Request Header
The autodetect based JPEG request header in the reply is byte for byte a copy of the same header in the
respective request.
JPEG thumbnail
The JPEG thumbnail data follows the autodetect based JPEG request header.
Hardware Address
MAC address of the device.
Reserved
Should be zero
IP Address
IP address to set.
Subnet Mask
Subnet mask to set.
Gateway Address
Gateway IP address to set.
Note: As all VideoJets will receive this message, only the unit matching the hardware address (HW1-HW6)
will update its IP parameters.
Note: There will be no reply to this command.
Note: This command will only work if NO service password is set.
Payload Structure (Extended Version IPv4 and IPv6 settings)
16 32
Hardware Address...
6 Bytes
Hardware Address Version Ipv6 PrefixLen
... 1 Byte 1 Byte
IPv4 Address
4 Bytes
IPv4 Subnet Mask
4 Bytes
Gateway IPv4 Address
4 Bytes
Reserved
4 Bytes
IPv6AddrString
64 Bytes
IPv6GatewayAddrString
64 Bytes
8 24
Hardware Address
MAC address of the device.
Version
Version of this command (must be 2)
Ipv6 PrefixLen
IPv6 Prefix length used for the IPv6 Device Address
IPv4 Address
IP address to set.
IPv6AddrString
Zero terminated string containig the IPv6 address to set. Format: e.g. FD00::1234:5678
IPv6GatewayAddrString
Zero terminated string containig the IPv6 gateway address to set. Format: e.g. FD00::1234:5678
Note: As all VideoJets will receive this message, only the unit matching the hardware address (HW1-HW6)
will update its IP parameters.
Note: There will be no reply to this command.
Note: This command will only work if NO service password is set.
Command
The RCP+ command tag number
Data Type
Values:
See 'Data Types'
Direction
Values:
READ 0
WRITE 1
Num
The numeric parameter.
Payload
Values:
• The payload as readable string for payload type P_STRING
• The payload as octet array with no spaces preceeded with 0x for payload type P_OCTET
and P_UNICODE
• The payload value in hex or decimal notion for all other payload types
Optional CGI parameters:
idstring
User defined parameter which will not be processed by the unit; will return unchanged in the reply
sessionid
Context specific session ID for this command
Multiple parameters are passed in CGI manner with '&' in between two parameter-value pairs.
Example:
A sample request to readout the units hardware version will look
http://ip.ip.ip.ip/rcp.xml?command=0x002e&type=P_STRING&direction=READ
<rcp>
<command>
<hex>0x002e</hex>
<dec>46</dec>
</command>
<type>T_DWORD</type>
<direction>READ</direction>
<num>0</num>
<idstring />
<payload />
<result>
<hex>0xf0000f43</hex>
<dec>4026535747</dec>
</result>
</rcp>
The upper part contains the request, the <result> contains the reply. Numerical values are presented in <hex>
and <dec>, strings, unicodes and p_octet in <str> sections. <
Message handling
RCP+ messages will be processed and received by the CGI client using a poll mechanism. A CGI command
set with the requested messages command tag numbers need to be issued. After issuing a request, the reply
returns immediately after a message has been sent or the default timeout of 1000 ms has been expired.
When the timeout expires, a message count of 0 is returned. Otherwise the number of received messages
is signaled. The default timeout can be altered by setting the 'collectms' CGI value to the appropriate
number of milliseconds. In order to ensure correct assignment of messages in case several clients are polling
for messages or if a polling client uses different socket connections, a unique message domain ID (CGI
parameter 'msgdomainID') should be provided. Messages are then collected separately for each ID and can
be uniquely assigned to the polling client even if requesting via different socket connections.
Valid CGI commands to control messages:
Message
One or a list of requested message RCP+ command tag numbers separated by '$'
CollectMS
Time in milliseconds to collect messages before returning with 'No messages'; default is 1000 ms
MsgDomainID
Unique ID (maximum 4 Bytes) to identify a certain polling client and to e.g. ensure correct message
assignment to clients sending requests via different socket connections
The <msgcnt> section contains the number of veiled <msg> sections inside the reply.
A buffer mechanism (depth 64) ensures that no messages will be lost during two consecutive poll cycles.
The <over> sections counts the number of lost messages. <clip> signals too small internal buffers; this
should never occur.
The <poll> section counts the number of issued poll requests
A sample request to receive all connection related messages (CONF_CONNECT_TO) will look like
http://ip.ip.ip.ip/rcp.xml?message=0xffcc&collectms=5000
<message_list>
<msg>
<no>1</no>
<command>0xffcc</command>
<num>0</num>
<sessionID>0x7063001f</sessionID>
<hex>0xa00a0034000000000101000001010001</hex>
</msg>
<msg>
<no>2</no>
<command>0xffcc</command>
<num>0</num>
<sessionID>0x70630020</sessionID>
<hex>0xa00a0034000000000101000001010001</hex>
</msg>
</message_list>
Authentication
The RCP+ server needs proper authentication to process protected commands. The CGI interface provides
two basic authentication schemes to be used.
In this case, HTTP header authentication (basic or digest) must be present in the request. The internal HTTP
server will pass the granted authorization level to the RCP+ server.
For each successful HTTP authentication (for all available resources like html pages, images...) a session
cookie will be returned by the HTTP server. When this cookie is present in any further HTTP connections,
the same authorization level will be granted as for the originating connection. The session cookie will remain
active as long as at least one HTTP connection remains open. In this case the internal HTTP server will
pass the granted authorization level to the RCP+ server.
IPv6
For RCP commands which are defined as T_DWORD or P_OCTET and contain DWORD IP-Addresses
there is a extention to read or write also IPv6 adresses or Hostnames, e.g. URL:
http://ip.ip.ip.ip/rcp.xml?
command=0x0a1f&type=T_DWORD&direction=WRITE&payload=0x00000000&ip-
item0=fd00::55:77
or
http://ip.ip.ip.ip/rcp.xml?
command=0x0a1f&type=T_DWORD&direction=WRITE&payload=0x00000000&ip-
item0=MyHostname.de
where payload must contain a 4 byte index to the trailing list of ip-item0..ip-itemn
The reply XML structure will then have this format:
<rcp>
<command>
<hex>0x0a1f</hex>
<dec>2591</dec>
</command>
<type>T_DWORD</type>
<direction>READ</direction>
<num>0</num>
<idstring />
<payload />
<result>
<hex>0x00000000</hex>
<dec>0</dec>
<ip-table>
<item>
<idx>0</idx>
<type>IPV6</type>
<str>fd00::55:77</str>
</item>
</ip-table>
</result>
</rcp>
where payload contains a 4 byte index to the ip-table list for each address contained in the command.
If the command datatype is P_OCTET and the command does contain more IP-Adresses then the result will
contain multipe item blocks.
Alternative formats for the item blocks are also possible:
<item>
<idx>1</idx>
<type>IPV4</type>
<str>192.168.1.2</str>
</item>
<item>
<idx>2</idx>
<type>NAME</type>
<str>MyHostname.de</str>
</item>
If a list is supplied the ALL addresses MUST be in the list also in the case that they are IPv4 type
16 32
Hardware Address...
6 Bytes
Hardware Address Reserved
... 2 Bytes
Command ID Payload Length
2 Bytes 2 Bytes
Payload
Payload Length Bytes
8 24
Hardware Address
MAC address of the unit to configure.
Command ID
ID of broadcast setting command
Payload Length
ID of broadcast setting command"
LED_BLINK 0x0000
SWITCH_DHCP 0x0001
Payload
Payload; depending on Command ID
Payload length 4 bytes. Requests the unit blink the power led; payload containin the number of seconds for
blinking. NOTE duration is limited to 60 sec.
Payload length 4 bytes. Switches DHCP on (payload = 1) or off (payload=0).
Note: There will be no reply to this command.
RCP Header
RCP Data
...
TableLenBytes
Length of hole string table including this header.
Version
Must be 1.
Reserved
Must be 0.
Num Entries
Number of entries in the table
Length
Length of this entry including this header in bytes.
Datatype
Type of content:
IPv4 0 IPv4 binary encoded value (always 4 bytes)
IPv6 1 IPv6 binary encoded value (always 16 bytes)
HostName 2 HostName or IPv4/IPv6 Address String (encoded as zero terminated string)
Reserved
Must be 0.
Data
N bytes of entry data.
Command Tag
Tag code of the RCP command.
Datatype
Datatype of the RCP command (e.g. P_OCTET).
Direction
Direction of the RCP command (currently only WRITE).
Action
Action of the RCP command (currently only REPLY).
Client ID
Client Id of the RCP client that sent the RCP command.
NumDes
Numeric Descriptor (NumDes) parameter value of the RCP command.
Count
Number of times that this RCP command has been processed.
account
CONF_ACCOUNT_SETTINGS.................................................................................................. 64
CONF_ACCOUNT_SETTINGS_V2............................................................................................ 65
CONF_NBR_OF_ACCOUNTS................................................................................................. 749
CONF_DROPBOX_AUTH_ADDR............................................................................................ 360
CONF_DROPBOX_AUTH_STATUS........................................................................................ 361
CONF_DROPBOX_TOKEN_V2............................................................................................... 363
CONF_DROPBOX_AUTH_V2.................................................................................................. 362
CONF_ACCOUNT_STATUS...................................................................................................... 73
CONF_FTP_SERVER_PORT...................................................................................................446
CONF_FTP_PWD..................................................................................................................... 445
CONF_ACCOUNT_LIST............................................................................................................. 62
CONF_ACCOUNTS_CREATE_FOLDER................................................................................... 74
CONF_ACCOUNTS_DELETE_FOLDER................................................................................... 75
CONF_FTP_CWD..................................................................................................................... 443
CONF_FTP_CDUP................................................................................................................... 442
CONF_START_CLIENT............................................................................................................992
CONF_STOP_CLIENT............................................................................................................1011
CONF_FTP_FILE_NAME......................................................................................................... 444
CONF_ACCOUNT_LOGIN_TEST.............................................................................................. 63
alarm
CONF_VIDEO_ALARM_STATE............................................................................................. 1138
CONF_MOTION_ALARM_STATE............................................................................................ 704
CONF_NBR_OF_ALARM_OUT................................................................................................751
CONF_NBR_OF_MOTION_DETECTORS............................................................................... 763
CONF_HD_MGR_SIGNAL_ALARM......................................................................................... 478
CONF_VIRTUAL_ALARM_STATE......................................................................................... 1233
CONF_SET_VIRTUAL_ALARM_ID.......................................................................................... 921
CONF_NBR_OF_VIRTUAL_ALARMS......................................................................................770
CONF_MANIPULATION_ALARM_STATE............................................................................... 691
CONF_NBR_OF_MANIPULATION_ALARMS.......................................................................... 762
CONF_VIRTUAL_ALARM_PARAMETER.............................................................................. 1230
CONF_NBR_OF_ALARM_IN....................................................................................................750
CONF_INPUT_PIN_NAME....................................................................................................... 582
CONF_INPUT_PIN_STATE...................................................................................................... 583
CONF_ALARM_INPUT_LH_VAL................................................................................................96
CONF_ALARM_INPUT_SUPERVISED...................................................................................... 97
CONF_ALARM_INPUT_CAPABILITIES..................................................................................... 95
CONF_EVENT_SCRIPT........................................................................................................... 417
CONF_MESSAGE_BROKER_MSG......................................................................................... 699
alarm connections
CONF_ALARM_CONNECT_TO_IP_STR.................................................................................. 91
CONF_ALARM_CONNECT_TO_IP............................................................................................90
CONF_NBR_OF_ALTERNATIVE_ALARM_IPS....................................................................... 752
CONF_AUTO_DISCONNECT_TIME........................................................................................ 138
CONF_DEFAULT_CONNECTION_MODE............................................................................... 319
CONF_STD_MEDIA_CONNECTION_DIRECTION................................................................1008
CONF_STD_MEDIA_ENCAPSULATION_PROTOKOL......................................................... 1009
CONF_DEFAULT_CAM............................................................................................................ 318
CONF_ALARM_CONNECTION_DESTINATION_PORT............................................................92
CONF_ALARM_CONNECTION_USE_SSL............................................................................... 93
CONF_CONNECT_URL........................................................................................................... 280
CONF_REMOTE_PASSWORD................................................................................................ 878
app management
CONF_LIST_APPS................................................................................................................... 665
CONF_MANAGE_APPS........................................................................................................... 688
CONF_APP_MGMT_GET_DEVICE_IDS................................................................................. 106
CONF_APP_MGMT_INSTALL_LICENSE................................................................................ 107
CONF_SAST_CLOUD_CONNECTION.................................................................................... 889
CONF_SAST_CLAIM_DEVICE_URI........................................................................................ 888
CONF_ENABLE_DEVELOPER_MODE................................................................................... 389
audio
CONF_AUDIO_INPUT_LEVEL................................................................................................. 117
CONF_AUDIO_OUTPUT_LEVEL............................................................................................. 127
CONF_AUDIO_ON_OFF.......................................................................................................... 124
CONF_AUDIO_STARTUP_SOUND......................................................................................... 131
CONF_AUDIO_NOTIFICATION_SOUND................................................................................ 123
CONF_AUDIO_INPUT.............................................................................................................. 116
CONF_AUDIO_OUTPUT.......................................................................................................... 126
CONF_AUDIO_INPUT_MAX.................................................................................................... 118
CONF_AUDIO_OUTPUT_MAX................................................................................................ 128
CONF_AUDIO_MIC_LEVEL..................................................................................................... 121
CONF_AUDIO_MIC_MAX........................................................................................................ 122
CONF_AUDIO_LOUDSPEAKER_ON_OFF............................................................................. 120
CONF_AUDIO_OPTIONS.........................................................................................................125
CONF_AUDIO_INPUT_PEEK.................................................................................................. 119
CONF_AUDIO_OUTPUT_PEEK.............................................................................................. 129
CONF_NBR_OF_AUDIO_OUT.................................................................................................754
CONF_NBR_OF_AUDIO_IN.....................................................................................................753
CONF_AUDIO_AAC_BITRATE................................................................................................ 114
CONF_VIRTUAL_AUDIO_LINES........................................................................................... 1234
CONF_MPEG_AUDIO_SAMPLING_FREQ..............................................................................705
CONF_AUPROC_CONFIG....................................................................................................... 134
CONF_AUPROC_MELPEGEL................................................................................................. 136
CONF_AUPROC_NAME.......................................................................................................... 137
CONF_AUPROC_ALARM........................................................................................................ 133
CONF_LIVE_AUDIO_CONNECTION_ACTIVE........................................................................ 671
autotracker
CONF_AUTO_TRACKER_TRACK_OBJECT...........................................................................139
CONF_AUTO_TRACKER_TRACK_OBJECT_POS................................................................. 140
CONF_MODE_AUTO_TRACKER............................................................................................ 702
CONF_STATUS_AUTO_TRACKER....................................................................................... 1007
backup
CONF_BACKUP....................................................................................................................... 143
CONF_BACKUP_MAX_KBPS.................................................................................................. 146
CONF_BACKUP_STATUS....................................................................................................... 151
CONF_BACKUP_STOP............................................................................................................157
bicom
CONF_BICOM_COMMAND..................................................................................................... 161
browser
CONF_STARTPAGE_BACKGROUND_URL........................................................................... 997
CONF_STARTPAGE_LOGO_URL........................................................................................... 998
CONF_STARTPAGE_PRESENTATION_SWITCHES..............................................................999
CONF_DYNAMIC_HTML_COUNT........................................................................................... 364
CONF_DYNAMIC_HTML_NAME............................................................................................. 366
CONF_DYNAMIC_HTML_DATA.............................................................................................. 365
CONF_BROWSER_LANGUAGE_VAL..................................................................................... 173
CONF_HTTP_SESSION_COOKIE_NAME.............................................................................. 575
CONF_LOGIN_PAGE_TEXT.................................................................................................... 683
calibration
CONF_CAMERA_POSITION....................................................................................................191
CONF_CAMERA_POSITION_ALL........................................................................................... 195
CONF_CAMERA_ORIENTATION............................................................................................ 187
CONF_CAMERA_POSITION_OPTIONS................................................................................. 196
CONF_CAMERA_SURROUNDING..........................................................................................197
CONF_CAMERA_SURROUNDING_OPTIONS........................................................................200
CONF_CAMERA_LOCATION_METADATA............................................................................. 184
CONF_CAMERA_CALIBRATION............................................................................................. 180
CONF_COMPLETE_CALIBRATION_ELEMENT..................................................................... 261
CONF_SHIFT_CALIBRATION_ELEMENT............................................................................... 922
CONF_SENSOR_ORIENTATION............................................................................................ 907
CONF_PREDEFINED_MOUNTING_LIST................................................................................ 806
CONF_LENS_ROTATION........................................................................................................ 663
Cbs
CONF_CBS_COMMISSION..................................................................................................... 210
CONF_CBS_STATUS...............................................................................................................213
CONF_CBS_DESTINATION.....................................................................................................211
CONF_REMOTE_PORTAL_INFO............................................................................................ 879
cert store
CONF_CERTIFICATE...............................................................................................................215
CONF_CERTIFICATE_OPTIONS............................................................................................ 223
CONF_CERTIFICATE_LIST..................................................................................................... 219
CONF_CERTIFICATE_REQUEST........................................................................................... 224
CONF_CERTIFICATE_REQUEST_OPTIONS......................................................................... 231
CONF_CERTIFICATE_REQUEST_PROGRESS..................................................................... 233
CONF_CERTIFICATE_USAGE................................................................................................ 236
CONF_CERTIFICATE_USAGE_OPTIONS.............................................................................. 238
CONF_MIN_TLS_VERSION..................................................................................................... 701
CONF_GET_LAST_CMP_ERROR_MESSAGES.....................................................................455
CloudWatch
CONF_CLOUD_WATCH_SETTINGS...................................................................................... 245
commissioning
CONF_COMMISSION_SETUP.................................................................................................259
debug
CONF_LED_BLINKING............................................................................................................ 661
CONF_TELNET_PORT.......................................................................................................... 1077
decoder/videoout
CONF_VIDEO_OUT_STANDARD..........................................................................................1172
CONF_VIDEO_OUT_STANDARD_OPTIONS....................................................................... 1174
CONF_VIDEO_OUT_STANDARD_VIDEO_INPUT_SRC...................................................... 1176
CONF_VIDEO_OUT_STANDARD_FORCE........................................................................... 1173
CONF_VIDEO_OUT_CROPPING.......................................................................................... 1168
CONF_MONITOR_NAME......................................................................................................... 703
CONF_LOGO............................................................................................................................ 684
CONF_DEC_SHOW_FREEZE................................................................................................. 310
CONF_DECODER_MODE....................................................................................................... 316
CONF_DECODER_LAYOUT_LIST.......................................................................................... 315
CONF_DECODER_LAYOUT.................................................................................................... 312
CONF_VIDEO_OUT_MONITOR_SPEC.................................................................................1169
CONF_NBR_OF_VIDEO_OUT................................................................................................. 769
CONF_DECODER_DELAY...................................................................................................... 311
CONF_DECODING_ERROR.................................................................................................... 317
dyndns
CONF_DYNDNS_HOST_NAME...............................................................................................369
CONF_DYNDNS_USER_NAME...............................................................................................381
CONF_DYNDNS_PASSWORD................................................................................................ 377
CONF_DYNDNS_ENABLE....................................................................................................... 367
CONF_DYNDNS_STATE......................................................................................................... 379
CONF_DYNDNS_LAST_REGISTER........................................................................................370
CONF_DYNDNS_FORCE_REGISTER_NOW......................................................................... 368
CONF_DYNDNS_PROVIDER.................................................................................................. 378
CONF_DYNDNS_STATUS_MAIL_ONOFF.............................................................................. 380
CONF_DYNDNS_MAIL_SMTP_SRV_IP_STR.........................................................................375
CONF_DYNDNS_MAIL_SMTP_LOGIN................................................................................... 373
CONF_DYNDNS_MAIL_SMTP_PASS..................................................................................... 374
CONF_DYNDNS_MAIL_DEST_EMAIL_ADDR........................................................................ 371
CONF_DYNDNS_MAIL_SENDER_NAME............................................................................... 372
CONF_DYNDNS_MAIL_TEST_SEND..................................................................................... 376
eap
CONF_EAP_IDENTITY.............................................................................................................387
CONF_EAP_GET_IDENTITY_LIST..........................................................................................384
CONF_EAP_ENABLE............................................................................................................... 383
CONF_EAP_PASSWORD........................................................................................................ 388
CONF_EAP_AUTO_ADJUST_INVALID_SYSTEMTIME..........................................................382
encoder
CONF_MPEG4_CURRENT_PARAMS..................................................................................... 723
CONF_MPEG4_CURRENT_PARAMS_TRANSCODER..........................................................726
CONF_MPEG4_CURRENT_PARAMS_REL_CODER............................................................. 724
CONF_MPEG4_NAME............................................................................................................. 731
CONF_MPEG4_BANDWIDTH_KBPS...................................................................................... 721
CONF_MPEG4_BANDWIDTH_KBPS_SOFT_LIMIT............................................................... 722
CONF_MPEG4_INTRA_FRAME_DISTANCE.......................................................................... 729
CONF_MPEG4_FRAME_SKIP_RATIO.................................................................................... 728
CONF_MPEG4_RESOLUTION................................................................................................ 733
CONF_MPEG4_DEFAULTS..................................................................................................... 727
CONF_MPEG4_PARAMS_MAX_NUM.................................................................................... 732
CONF_MPEG4_AVC_I_FRAME_QUANT................................................................................ 716
CONF_MPEG4_AVC_P_FRAME_QUANT...............................................................................717
CONF_MPEG4_AVC_P_FRAME_QUANT_MIN...................................................................... 718
CONF_MPEG4_AVC_DELTA_IPQUANT.................................................................................714
CONF_MPEG4_AVC_QUANT_ADJ_REGION_1.....................................................................719
CONF_MPEG4_AVC_QUANT_ADJ_REGION_2.....................................................................720
CONF_MPEG4_AVC_DEBLOCKING_ENABLE...................................................................... 713
CONF_MPEG4_AVC_DEBLOCKING_ALPHA......................................................................... 711
CONF_MPEG4_AVC_DEBLOCKING_BETA........................................................................... 712
CONF_MPEG4_AVC_CHROMA_QUANT_OFF...................................................................... 709
CONF_MPEG4_AVC_CODING_MODE................................................................................... 710
CONF_MPEG4_AVC_GOP_STRUCTURE.............................................................................. 715
CONF_GOP_STRUCTURE_OPTIONS.................................................................................... 460
CONF_VIDEO_ENC_P_REF_LIST_SIZE.............................................................................. 1141
CONF_GET_VIDEO_ENC_P_REF_LIST_SIZE_LIMIT............................................................457
CONF_MPEG4_AVC_CABAC.................................................................................................. 708
CONF_MPEG4_AVC_BITRATE_OPTIMIZATION_OPTIONS................................................. 707
CONF_ENC_DYN_SCENE_CTRL........................................................................................... 397
CONF_ENC_DYN_SCENE_CTRL_OPTIONS......................................................................... 399
CONF_GET_ENC_DYN_SCENE_CTRL_INFO....................................................................... 453
CONF_MPEG4_AVC_BITRATE_OPTIMIZATION................................................................... 706
CONF_CODER_SPECIFIC_ENC_PROFILES......................................................................... 255
CONF_VIDEO_BITRATE_AVERAGING_PERIOD.................................................................1139
CONF_VIDEO_QUALITY........................................................................................................1178
CONF_JPEG_BANDWIDTH_KBPS......................................................................................... 645
CONF_VIDEO_ENCODER_STATUS..................................................................................... 1147
CONF_VIDEO_ENCODER_STATUS_EXT............................................................................ 1148
CONF_EXT_ENCODER_BITRATE_STATISTICS................................................................... 424
CONF_VIDEO_ENCODER_ENCODED_BYTES................................................................... 1146
CONF_ENC_CURRENT_RESOLUTION..................................................................................396
CONF_ENC_PROFILE_BASIC_PARAMS............................................................................... 400
CONF_ENC_PROFILE_PARAMS............................................................................................ 401
CONF_ADAPT_ENC_PROFILE_BITRATES..............................................................................79
CONF_VIDEO_ENC_PRIO.....................................................................................................1142
CONF_JPEG............................................................................................................................. 643
CONF_VIDEO_ENC_TEMP_QUANT_ADJ............................................................................ 1144
CONF_VIDEO_CURRENT_PARAMS_CODNBR...................................................................1140
CONF_MAX_NBR_OF_ENC_STREAMS................................................................................. 696
CONF_CODER_VIDEO_OPERATION_MODE........................................................................ 256
CONF_CODER_VIDEO_OPERATION_MODE_OPTIONS...................................................... 257
CONF_VIDEO_H264_ENC_CONFIG..................................................................................... 1152
CONF_VIDEO_H264_ENC_CONFIG_DEFAULTS................................................................ 1155
CONF_VIDEO_H264_ENC_CONFIG_BULK......................................................................... 1153
CONF_ENC_BASE_OPERATION_MODE_TYPE....................................................................395
CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE..................................................... 1149
CONF_VID_H264_ENC_BASE_OPERATION_MODE_CAPS...............................................1133
CONF_VIDEO_H264_ENC_CURRENT_PROFILE................................................................ 1156
CONF_JPEG_STREAM_SETUP.............................................................................................. 648
CONF_JPEG_STREAM_SETUP_OPTIONS_VERBOSE........................................................ 649
CONF_JPEG_STREAM_FRAME_RATES............................................................................... 646
CONF_ENC_PROFILE_RESOLUTION_OPTIONS..................................................................406
CONF_RECOMMENDED_JPEG_POSTING_RESOLUTIONS................................................ 864
CONF_TCP_RATE_CONTROL.............................................................................................. 1076
CONF_STREAM_PRIORITY.................................................................................................. 1040
CONF_NBR_OF_ENC_STREAMS...........................................................................................756
CONF_H264_ENC_BASE_OP_MODE_CAPS_VERBOSE..................................................... 461
CONF_H26x_ENC_BASE_OP_MODE_CAPS_VERBOSE_EX...............................................465
CONF_VIDEO_STATIC_SCENE_REGIONS......................................................................... 1182
CONF_VCA_SHAPES............................................................................................................ 1128
CONF_VCA_SHAPES_LEVEL............................................................................................... 1129
ethernet
CONF_MAC_ADDRESS........................................................................................................... 687
CONF_IP...................................................................................................................................587
CONF_IP_STR..........................................................................................................................588
CONF_SUBNET......................................................................................................................1050
CONF_SUBNET_STR............................................................................................................ 1051
CONF_GATEWAY_IP_STR......................................................................................................448
CONF_GATEWAY_IP_V6_STRING......................................................................................... 449
CONF_IP_V6_PREFIX_LEN.................................................................................................... 589
CONF_IP_V6_STR................................................................................................................... 590
CONF_STATELESS_IP_V6_PREFIX_LEN............................................................................1000
CONF_STATELESS_IP_V6_STR.......................................................................................... 1001
CONF_STATELESS_IP_V6_STRINGS..................................................................................1002
CONF_DNS_SERVER_IP........................................................................................................ 355
CONF_DNS_SERVER_IP_STRING......................................................................................... 356
CONF_APPLY_NETWORK_SETTINGS.................................................................................. 113
CONF_ETH_LINK..................................................................................................................... 413
CONF_ETH_LINK_STATUS..................................................................................................... 414
CONF_ETH_LINK_TROUGHPUT............................................................................................ 415
CONF_ETH_TX_PKT_BURST................................................................................................. 416
CONF_NBR_OF_EXT_ETH_PORTS....................................................................................... 759
CONF_NBR_OF_EXT_ETH_COPPER_PORTS...................................................................... 757
CONF_NBR_OF_EXT_ETH_FIBER_PORTS.......................................................................... 758
CONF_NBR_OF_DNS_SERVERS........................................................................................... 755
CONF_SND_MSS..................................................................................................................... 924
CONF_PORT_FC_MODE.........................................................................................................801
CONF_DIFF_SERV_VAL..........................................................................................................351
CONF_DIFF_SERV_POST_ALARM_TIME..............................................................................350
CONF_IPV4_ENABLE.............................................................................................................. 591
CONF_IPV6_ENABLE.............................................................................................................. 593
CONF_IPV4_FILTER................................................................................................................ 592
CONF_MTU_SIZE.................................................................................................................... 737
CONF_UPLINK_KBPS............................................................................................................1100
CONF_OBEY_ICMP_REDICRECTS........................................................................................ 779
CONF_DHCP_VAL................................................................................................................... 349
CONF_DHCP_ON.....................................................................................................................347
CONF_DHCP_OFF................................................................................................................... 346
CONF_DHCP_STABLE............................................................................................................ 348
CONF_DHCP_COMPLIANCY.................................................................................................. 345
extension
CONF_EXTERNAL_CLIENTS_LIST........................................................................................ 431
CONF_EXTERNAL_CLIENT.................................................................................................... 428
GB28181
CONF_GB28181....................................................................................................................... 450
http settings
CONF_LOCAL_HTTP_PORT................................................................................................... 678
CONF_LOCAL_HTTPS_PORT.................................................................................................679
CONF_HSTS_ENABLED.......................................................................................................... 572
CONF_ALLOW_BASIC_HTTP_AUTH_ON_NON_SSL_SOCK............................................... 103
CONF_PROTECT_HTTP_COOKIE..........................................................................................826
CONF_CSRF_PROTECTION_ENABLED................................................................................ 296
I/Os
CONF_RELAIS_NAME............................................................................................................. 874
CONF_RELAIS_SWITCH......................................................................................................... 875
CONF_RELAY_OUTPUT_STATE............................................................................................ 877
CONF_RELAY_OUTPUT_MODE............................................................................................. 876
CONF_PIR_SENSITIVITY........................................................................................................ 796
CONF_PIR_STATUS................................................................................................................ 797
CONF_NBR_OF_PIR................................................................................................................764
CONF_PIR_ALARM_STATE.................................................................................................... 795
CONF_ILLUMINATOR_OPTIONS............................................................................................ 579
CONF_ILLUMINATOR_STATE................................................................................................ 580
CONF_ILLUMINATION_INTENSITY........................................................................................ 578
iscsi
CONF_ISCSI_IP....................................................................................................................... 612
CONF_ISCSI_PORT................................................................................................................. 633
CONF_ISCSI_LUN....................................................................................................................616
CONF_ISCSI_TARGET_IDX.................................................................................................... 638
CONF_ISCSI_TARGET............................................................................................................ 637
CONF_ISCSI_TCP_CONNECTIONS....................................................................................... 640
CONF_ISCSI_DISCOVERY......................................................................................................598
CONF_ISCSI_TARGET_PWD.................................................................................................. 639
CONF_ISCSI_LOCK_OVERRIDE............................................................................................ 613
CONF_ISCSI_LOCK_RELEASE_ON_LEAVE......................................................................... 614
CONF_ISCSI_INITIATOR_NAME.............................................................................................610
CONF_ISCSI_INITIATOR_NAME_EXTENTION...................................................................... 611
CONF_ISCSI_SERVER_STATE.............................................................................................. 636
CONF_ISCSI_MNI.................................................................................................................... 617
CONF_ISCSI_AUTH................................................................................................................. 594
CONF_ISCSI_SEG_SIZE......................................................................................................... 635
CONF_ISCSI_DATARATE........................................................................................................597
CONF_ISCSI_LOWERDATARATE.......................................................................................... 615
CONF_ISCSI_READDATARATE..............................................................................................634
CONF_ISCSI_MULTIPATH...................................................................................................... 626
CONF_ISCSI_MULTIPATH_STATE......................................................................................... 627
CONF_ISCSI_FLUSH_DISVCACHE........................................................................................ 607
CONF_ISCSI_DISV_CACHE.................................................................................................... 599
CONF_ISCSI_MP_DISCOVER.................................................................................................622
Keyboard
CONF_KBD_CONFIG_CAMERA............................................................................................. 651
CONF_KBD_CONFIG_CAMERA_STR.................................................................................... 652
CONF_KBD_CONFIG_MONITOR............................................................................................ 653
CONF_KBD_CONFIG_MONITOR_STR...................................................................................654
CONF_KBD_CONNECT_PARAMS.......................................................................................... 656
CONF_KBD_PASSWORD_CAMERA...................................................................................... 659
CONF_KBD_PASSWORD........................................................................................................ 658
CONF_KBD_CONFIG_SALVO................................................................................................. 655
CONF_KBD_KEY_LABEL........................................................................................................ 657
CONF_KBD_SET_ALARM....................................................................................................... 660
lldp
CONF_LLDP_REQUESTED_POWER_TOTAL........................................................................676
CONF_LLDP_REQUESTED_POWER_CAM........................................................................... 675
CONF_LLDP_ALLOCATED_POWER_TOTAL.........................................................................673
CONF_LLDP_POWER_ADDER............................................................................................... 674
CONF_BASE_POE_CLASS..................................................................................................... 158
CONF_SIGNALLED_POE_CLASS...........................................................................................923
CONF_POE_GRANTED_POWER........................................................................................... 800
multicast
CONF_MULTICAST_VIDEO_GROUP_IP_STR....................................................................... 744
CONF_MULTICAST_VIDEO_GROUP_IP................................................................................ 743
CONF_MULTICAST_AUDIO_GROUP_IP_STR.......................................................................739
CONF_MULTICAST_AUDIO_GROUP_IP................................................................................ 738
CONF_MULTICAST_VIDEO_PORT_STR............................................................................... 746
CONF_MULTICAST_VIDEO_PORT.........................................................................................745
CONF_MULTICAST_AUDIO_PORT_STR............................................................................... 741
CONF_MULTICAST_AUDIO_PORT........................................................................................ 740
CONF_MULTICAST_TTL......................................................................................................... 742
CONF_IGMP_VERSION........................................................................................................... 577
CONF_STREAMING_VAL...................................................................................................... 1049
CONF_VIDEO_ENC_STREAMING........................................................................................ 1143
CONF_AUDIO_ENC_STREAMING.......................................................................................... 115
CONF_START_MULTICAST_STREAMING.............................................................................993
CONF_AUDIO_STREAMING_ENCODING.............................................................................. 132
network services
CONF_NETWORK_SERVICES................................................................................................771
onvif
CONF_ONVIF_STREAM_MODE............................................................................................. 786
CONF_ONVIF_STREAM_URI_EX........................................................................................... 787
CONF_ENABLE_ONVIF........................................................................................................... 391
CONF_ONVIF_PROFILE_INFO............................................................................................... 783
CONF_CHECK_WS_USERNAMETOKEN_AUTH_TIMESTAMP............................................ 243
rcp.connection
CONF_CONNECT_PRIMITIVE................................................................................................ 265
CONF_DISCONNECT_PRIMITIVE.......................................................................................... 352
CONF_CONNECT_TO............................................................................................................. 276
CONF_ACTIVE_CONNECTION_LIST....................................................................................... 76
CONF_MEDIA_SOCKETS_COMPLETE.................................................................................. 698
CONF_RCP_CONNECTIONS_ALIVE...................................................................................... 849
CONF_CAPABILITY_LIST........................................................................................................ 204
CONF_RCP_CODER_LIST...................................................................................................... 841
CONF_RCP_CONNECT_SALVO............................................................................................. 847
CONF_MUTE_MEDIA_CHANNEL........................................................................................... 747
CONF_SEI_ENABLE................................................................................................................ 905
CONF_PIC_INFO......................................................................................................................794
CONF_TRANSCODER_INFORMATION................................................................................ 1092
CONF_REQ_FAST_UPDATE...................................................................................................882
CONF_MPEG4_INTRA_FRAME_REQUEST........................................................................... 730
rcp.control
CONF_RCP_CLIENT_REGISTRATION................................................................................... 832
CONF_RCP_CLIENT_REGISTRATION_V2............................................................................ 835
CONF_RCP_CLIENT_UNREGISTER...................................................................................... 840
CONF_RCP_CLIENT_TIMEOUT_WARNING.......................................................................... 839
CONF_RCP_REG_MD5_RANDOM......................................................................................... 853
CONF_RCP_TRANSFER_TRANSPARENT_DATA................................................................. 855
CONF_RCP_MSG_V2_HISTORY............................................................................................ 850
CONF_RCP_SERVER_PORT.................................................................................................. 854
rcp.discovery
CONF_AUTODETECT_REPLY_GROUP................................................................................. 141
CONF_UNSOLICITED_AUTODETECT_REPLY_TIME......................................................... 1099
CONF_DISCOVER_PORT....................................................................................................... 354
recording settings
CONF_HD_PARTITIONS_RECORDING................................................................................. 489
CONF_HD_PARTITION_RECORDING.................................................................................... 487
CONF_HD_PARTITION_RECORDING_SECONDARY........................................................... 488
CONF_HD_SIZE_MB................................................................................................................563
CONF_HD_RECORD_SCHEDULE.......................................................................................... 510
CONF_HD_RECORD_SCHEDULE_SECONDARY................................................................. 512
CONF_HD_RECORD_HOLIDAYS........................................................................................... 494
CONF_HD_RECORD_PROFILES............................................................................................497
CONF_HD_RECORD_PROFILES_SECONDARY................................................................... 501
CONF_HD_RECORD_PROFILES_V2..................................................................................... 502
CONF_HD_RECORD_PROFILES_V2_SECONDARY.............................................................506
CONF_HD_MGR_START......................................................................................................... 479
CONF_HD_MGR_START_SECONDARY................................................................................ 480
CONF_HD_MGR_STOP........................................................................................................... 481
CONF_HD_MGR_STOP_SECONDARY.................................................................................. 482
CONF_HD_RECORDING_REPORT........................................................................................ 515
CONF_HD_RECORDING_REPORT_SECONDARY............................................................... 520
CONF_RECORDING_STATUS................................................................................................ 869
CONF_RECORDING_RETENTION_TIME............................................................................... 867
CONF_RECORDING_RETENTION_TIME_SECONDARY...................................................... 868
CONF_MAX_RECORDING_RETENTION_TIME..................................................................... 697
CONF_REMOTE_REC_DEVICE.............................................................................................. 881
CONF_REC_MGNT.................................................................................................................. 857
CONF_HD_MGR_REC_STATUS............................................................................................. 475
CONF_HD_MGR_REC_STATUS_SECONDARY.................................................................... 477
CONF_HD_FILE_INFO............................................................................................................. 470
CONF_HD_FILE_INFO_SECONDARY.................................................................................... 472
CONF_HD_RELOAD_PARTITION_FILE_INFO....................................................................... 521
CONF_HD_RECORDING_ACTIVE.......................................................................................... 514
CONF_HD_REPLAY_ENCRYPTED_DATA............................................................................. 530
CONF_HD_REPLAY_AUTHENTICITY_OUT........................................................................... 522
CONF_START_RECORD......................................................................................................... 994
CONF_SET_REC_BUFFER_SIZE........................................................................................... 920
CONF_AUDIO_REC_FORMAT................................................................................................ 130
CONF_MANAGING_VRM.........................................................................................................689
CONF_REC_STORAGE_REQ_CFG........................................................................................863
CONF_RECORDING_BUFFER_LEVEL...................................................................................866
CONF_HD_REC_BUFFER....................................................................................................... 490
CONF_MAX_GOP_LENGTH_VALUE...................................................................................... 695
CONF_ALARM_BACKUP_REC_SPEED_LIMIT........................................................................ 89
CONF_BACKUP_RECORDING_STATUS............................................................................... 147
CONF_BACKUP_RECORDING_STATUS_MSG_THRESHOLD............................................. 150
CONF_BUFFERED_RECORDING_MODE.............................................................................. 174
CONF_EXT_RECORDER_BITRATE_STATISTICS.................................................................427
CONF_FORMAT_FS_SPAN.....................................................................................................436
CONF_FORMAT_FS_SPANS_STATUS.................................................................................. 438
CONF_SPAN_ADDRESS_LIST............................................................................................... 947
CONF_SPAN_ADDRESS_LIST_NEW..................................................................................... 949
CONF_SPAN_HDR_ACCESS.................................................................................................. 957
CONF_START_SPAN_RECORD............................................................................................. 995
CONF_SPAN_PARTITION_PROP........................................................................................... 966
CONF_SPAN_PARTITION_PROP_SECONDARY.................................................................. 967
CONF_SPAN_USE_STATUS................................................................................................... 971
CONF_SPAN_USE_STATUS_SECONDARY.......................................................................... 976
CONF_SPAN_PARTITION_FILE_INFO................................................................................... 964
CONF_EXPORT_SPAN............................................................................................................418
CONF_CAM_REC_SPANS...................................................................................................... 175
CONF_REC_SPAN_MGR........................................................................................................ 861
CONF_SPAN_SWITCH............................................................................................................ 968
CONF_HD_SET_VRM_LOCK.................................................................................................. 562
CONF_SPAN_FILES_DIR........................................................................................................ 954
CONF_SPAN_HISTORY.......................................................................................................... 962
CONF_ACCESS_LUN_MGMT_FILE..........................................................................................59
CONF_FLUSH_LUN_INFO_CACHE........................................................................................ 434
CONF_DELETE_CAM_REC_SPANS...................................................................................... 321
CONF_HDD_VCD_CACHE_SIZE............................................................................................ 566
CONF_SPAN_CERTIFICATES_LIST....................................................................................... 950
CONF_SCHEDULED_PTZ_PROFILES................................................................................... 893
CONF_SCHEDULED_PTZ_PROFILE...................................................................................... 891
CONF_REC_MONITOR_STATUS........................................................................................... 858
CONF_VIDEO_RECOVERY................................................................................................... 1179
replay control
CONF_HD_REPLAY_START................................................................................................... 556
CONF_HD_REPLAY_START_EX............................................................................................ 557
CONF_HD_REPLAY_STOP..................................................................................................... 558
CONF_HD_REPLAY_STOP_TIME.......................................................................................... 559
CONF_HD_REPLAY_SEEK_TIME...........................................................................................550
CONF_HD_REPLAY_SEEK_IFRAME......................................................................................549
CONF_HD_REPLAY_EVENT_INFO........................................................................................ 531
CONF_HD_REPLAY_MOTION_SAMPLES............................................................................. 547
CONF_HD_REPLAY_FAST_INTRA_DELAY........................................................................... 535
CONF_HD_REPLAY_FAST_INTRA_FPS................................................................................ 536
CONF_HD_REPLAY_LIVE....................................................................................................... 546
CONF_HD_REPLAY_SIZE_INFO............................................................................................ 554
CONF_HD_REPLAY_VCD_LAYER......................................................................................... 561
CONF_HD_REPLAY_VCD_CONFIG_ID..................................................................................560
CONF_HD_REPLAY_FORENSIC_SEARCH_SETUP............................................................. 541
CONF_HD_REPLAY_FORENSIC_SEARCH_CANCEL...........................................................537
CONF_HD_REPLAY_FORENSIC_SEARCH_RESULT........................................................... 538
CONF_HD_REPLAY_PREFETCH_JPEGS..............................................................................548
CONF_HD_REPLAY_CUSTOM_SETTINGS........................................................................... 528
CONF_HD_REPLAY_CERTIFICATES_LIST........................................................................... 525
CONF_HD_REPLAY_SEQUENCE_VERIFY............................................................................553
CONF_HD_PARTITION_FILE_INFO........................................................................................483
roi
CONF_STREAM_EXCLUSIVE_CHECK................................................................................ 1039
CONF_ROI................................................................................................................................ 883
CONF_ROI_OPTIONS..............................................................................................................884
CONF_DPTZ_DYNAMIC_CAPS.............................................................................................. 357
CONF_DPTZ_STATIC_CAPS.................................................................................................. 358
rtsp settings
CONF_RTSP_PORT.................................................................................................................885
CONF_RTSPS_PORT.............................................................................................................. 886
CONF_GET_RTSP_SESSION_ID............................................................................................456
CONF_VRM_RTSP_AUTHENTICATE................................................................................... 1238
security
CONF_PUBLISH_MEDIA_KEYS.............................................................................................. 829
CONF_CRYPT_KEYAUDIO_ENC............................................................................................ 290
CONF_CRYPT_KEYVIDEO_ENC............................................................................................ 294
CONF_CRYPT_KEYAUDIO_DEC............................................................................................ 288
CONF_CRYPT_KEYVIDEO_DEC............................................................................................ 292
CONF_CRYPT_KEY_GENERATE_ALL...................................................................................287
CONF_WATERMARK............................................................................................................. 1239
CONF_STREAM_SECURITY_V2...........................................................................................1042
CONF_STREAM_SECURITY_OPTIONS............................................................................... 1041
CONF_VIDEO_OVER_SSL.................................................................................................... 1177
CONF_WIFI_CONFIG_TOKEN.............................................................................................. 1240
CONF_LOGIN_LIMITER_MESSAGE....................................................................................... 680
CONF_DEVELOPER_MODE_ALLOWED................................................................................ 324
serial port
CONF_SERIAL_PORT_APP_VAL........................................................................................... 913
CONF_SERIAL_PORT_RATE.................................................................................................. 918
CONF_SERIAL_PORT_BITS................................................................................................... 914
CONF_SERIAL_PORT_STBITS............................................................................................... 919
CONF_SERIAL_PORT_PAR.................................................................................................... 917
CONF_SERIAL_PORT_MODE_VAL........................................................................................ 916
CONF_SERIAL_PORT_HD_MODE_VAL.................................................................................915
CONF_SERIAL_ACTS_ACCESS_RIGHTS............................................................................. 911
CONF_TPPP_PORT............................................................................................................... 1089
snmp
CONF_SNMP_SRV_PORT...................................................................................................... 927
CONF_SNMP_TRAPS_HOST.................................................................................................. 930
CONF_SNMP_TRAPS_HOST_STR.........................................................................................931
CONF_NBR_OF_TRAPS_HOSTS........................................................................................... 767
CONF_SNMP_TRAP_LIST.......................................................................................................929
CONF_PMPP_PORT................................................................................................................ 799
CONF_PMPP_ADDRESS.........................................................................................................798
CONF_SYSCONTACT............................................................................................................1053
CONF_SYSLOCATION...........................................................................................................1054
CONF_SNMP_READ_COMMUNITY........................................................................................925
CONF_SNMP_WRITE_COMMUNITY...................................................................................... 936
CONF_SNMP_TRAP_COMMUNITY........................................................................................ 928
CONF_SNMP_SERVER_MODE.............................................................................................. 926
CONF_SNMP_USER_PROFILE.............................................................................................. 932
CONF_SNMP_V3_ENGINEID.................................................................................................. 935
Socket Knocker
CONF_SOCKET_KNOCKER_MODE....................................................................................... 940
CONF_SOCKET_KNOCKER_DESTINATION......................................................................... 937
CONF_SOCKET_KNOCKER_DESTINATION_NAME............................................................. 939
CONF_SOCKET_KNOCKER_STATUS................................................................................... 941
stamping
CONF_STAMP_ATTR_DEC_FREEZE.....................................................................................984
CONF_STAMP_DEC_FREEZE_STRING................................................................................ 991
CONF_OSD_ACCESS..............................................................................................................789
CONF_OSD_POS..................................................................................................................... 791
CONF_STAMP.......................................................................................................................... 977
CONF_ENC_STAMPING_PROPERTIES.................................................................................410
CONF_NAME_STAMP_VAL.....................................................................................................748
CONF_TIME_STAMP_VAL.................................................................................................... 1087
CONF_TIME_STAMP_RESOLUTION.................................................................................... 1086
CONF_ALARM_DISP_VAL.........................................................................................................94
CONF_ALARM_STRING.......................................................................................................... 102
CONF_INFO_STAMP_VAL...................................................................................................... 581
CONF_LOGO_STAMP_VAL.....................................................................................................685
CONF_STAMP_ATTR_NAME.................................................................................................. 988
CONF_STAMP_ATTR_TIME.................................................................................................... 990
CONF_STAMP_ATTR_ALARM................................................................................................ 983
CONF_STAMP_ATTR_INFO.................................................................................................... 986
CONF_STAMP_ATTR_LOGO.................................................................................................. 987
storage
CONF_FORMAT_FS_STATUS................................................................................................ 440
CONF_PREPARE_FOR_RECORDING................................................................................... 807
CONF_SD_CARD_LIFE_SPAN_STATUS............................................................................... 898
CONF_SD_CARD_LIFE_SPAN_ALARM_THRESHOLD......................................................... 895
CONF_SD_CARD_LIFE_SPAN_MANF................................................................................... 897
CONF_SD_CARD_LIFE_SPAN_ENABLE............................................................................... 896
CONF_NBR_OF_SD_CARD_SLOTS.......................................................................................765
CONF_STORAGE_REPORT..................................................................................................1031
CONF_STORAGE_REPORT_SECONDARY......................................................................... 1034
CONF_STORAGE_MEDIUM_TYPE.......................................................................................1030
CONF_STORAGE_MEDIUM_AVAIL...................................................................................... 1028
CONF_STORAGE_LIST......................................................................................................... 1022
CONF_STORAGE_IO............................................................................................................. 1013
CONF_DATA_COPY_JOB_START..........................................................................................297
CONF_DATA_COPY_JOB_STOP............................................................................................303
CONF_DATA_COPY_JOB_STATUS....................................................................................... 301
CONF_STORAGE_TARGET_ID............................................................................................ 1035
CONF_TARGET_ID_RESOLVE_RULES............................................................................... 1069
CONF_INTERNAL_STORAGE_ENCRYPTION....................................................................... 586
CONF_HDD_RECORD_ENCRYPTION................................................................................... 565
CONF_HDD_RECORD_ALARM_RING_INIT_SIZE.................................................................564
CONF_HD_FORMAT_STORAGE_ERROR_LOG_CNT.......................................................... 474
stratocast
CONF_STRATOCAST_ONOFF............................................................................................. 1036
CONF_STRATOCAST_REGISTER........................................................................................1037
CONF_STRATOCAST_STATE.............................................................................................. 1038
streaming gateway
CONF_STREAMING_GATEWAY_CONFIG........................................................................... 1044
CONF_STREAMING_GATEWAY_ACTIVE_LINES............................................................... 1043
CONF_STREAMING_GATEWAY_MAX_LINES.....................................................................1048
syslog
CONF_SYSLOG_LOG_LEVEL...............................................................................................1056
CONF_SYSLOG_PROTOCOL............................................................................................... 1059
CONF_SYSLOG_HOST_STR................................................................................................ 1055
CONF_SYSLOG_PORT......................................................................................................... 1058
CONF_SYSLOG_MESSAGE..................................................................................................1057
system.settings
CONF_UNIT_NAME............................................................................................................... 1098
CONF_UNIT_ID...................................................................................................................... 1097
CONF_CAMNAME.................................................................................................................... 201
CONF_CAMNAME2.................................................................................................................. 203
CONF_CAMNAME_LINES....................................................................................................... 202
CONF_HARDWARE_VERSION............................................................................................... 469
CONF_SOFTWARE_VERSION................................................................................................945
CONF_SOFTWARE_VERSION_FORMATTED....................................................................... 946
CONF_BOOTLOADER_VERSION........................................................................................... 171
CONF_FW_MIN_VERSION...................................................................................................... 447
CONF_SERIAL_NUMBER........................................................................................................ 912
CONF_PRODUCT_NAME........................................................................................................ 825
CONF_COMMERCIAL_TYPE_NUMBER................................................................................. 258
CONF_DEVICE_TYPE_IDS..................................................................................................... 344
CONF_SUPPORTED_UPLOAD_TARGETS.......................................................................... 1052
CONF_DEVICE_GUID.............................................................................................................. 341
CONF_DEVICE_CAPABILITIES...............................................................................................325
CONF_DEVICE_OPERATION_MODE_VERSIONS................................................................ 342
CONF_SOFT_VARIANT_ID..................................................................................................... 942
CONF_SOFT_VARIANT_ID_OPTIONS................................................................................... 943
CONF_APPLICATION_TYPE................................................................................................... 112
CONF_SECURITY_COPROC_VERSION................................................................................ 904
CONF_SECURITY_COPROC_CERTIFICATE.........................................................................903
CONF_SECURITY_COPROC_AUTHENTICATE.....................................................................902
CONF_TRANSCODER_CAPABILITIES................................................................................. 1090
CONF_HOST_NAME................................................................................................................ 571
CONF_OEM_DEVICE_NAME.................................................................................................. 781
CONF_OEM_EXT_ID............................................................................................................... 782
CONF_OEM_DEVICE_DOMAIN.............................................................................................. 780
CONF_DEFAULTS................................................................................................................... 320
CONF_FACTORY_DEFAULTS................................................................................................ 432
CONF_BOARD_RESET........................................................................................................... 168
CONF_BOOT_DEFAULT_APP................................................................................................ 169
CONF_CLUSTER_GROUP_SETTING.....................................................................................253
CONF_CLUSTER_ID................................................................................................................ 254
CONF_APP_OPTION............................................................................................................... 108
CONF_APP_OPTION_EXT...................................................................................................... 109
CONF_APP_OPTION_UNIT_ID............................................................................................... 111
CONF_APP_OPTION_SET...................................................................................................... 110
CONF_BOOT_STATE.............................................................................................................. 170
CONF_CPU_COUNT................................................................................................................ 282
CONF_NIGHT_MODE_STATE.................................................................................................774
CONF_INSTALLER_SEQUENCE............................................................................................ 585
CONF_STATIC_SERVER_URL............................................................................................. 1006
CONF_PRIVACY_MODE..........................................................................................................823
CONF_PTZ_AUTO_ROTATE_MODE...................................................................................... 827
CONF_POWER_MONITOR_VALUES..................................................................................... 803
CONF_POWER_MONITOR_NAMES....................................................................................... 802
CONF_AUXILIARY_POWER.................................................................................................... 142
CONF_NBR_OF_IMU............................................................................................................... 761
CONF_LED_CAPS................................................................................................................... 662
CONF_ENABLE_TRAFFIC_LED.............................................................................................. 392
CONF_SCAN_ID.......................................................................................................................890
CONF_HEATER_MODE........................................................................................................... 568
CONF_SYSTEM_OS_VERSION............................................................................................ 1067
CONF_HOME_EVENT............................................................................................................. 569
CONF_MQTT_SETTINGS........................................................................................................ 734
CONF_MANUFACTURER_NAME............................................................................................692
CONF_LICENSE_LOCK_CODE...............................................................................................664
CONF_THALES_LIC_INSTALL.............................................................................................. 1080
CONF_SYSTEM_INFO_FILE................................................................................................. 1061
CONF_THALES_LIC_UNINSTALL......................................................................................... 1081
CONF_THALES_FEATURE_LIST.......................................................................................... 1079
system.status
CONF_NBR_OF_TEMP_SENS................................................................................................ 766
CONF_TEMP_SENS.............................................................................................................. 1078
CONF_UPLOAD_PROGRESS............................................................................................... 1110
CONF_CHECK_DEFAULT_BUTTON_STATE......................................................................... 241
CONF_CHECK_POS_FB_STATE............................................................................................ 242
CONF_CLOUD_COMMISSIONING_STATUS......................................................................... 244
CONF_AMBIENT_LIGHT_LEVEL............................................................................................ 105
CONF_LOW_AMBIENT_LIGHT_THRESHOLD....................................................................... 686
CONF_NBR_OF_HUMIDITY_SENSORS.................................................................................760
CONF_HUMIDITY_VALUE....................................................................................................... 576
CONF_CONFIG_SEALING_ENABLED.................................................................................... 262
CONF_CONFIG_SEALING_STATUS...................................................................................... 263
CONF_USB_PORT_PLUG_STATUS..................................................................................... 1114
CONF_SYSUPTIME............................................................................................................... 1068
CONF_SD_CARD_STATUS..................................................................................................... 901
CONF_CPU_LOAD_IDLE......................................................................................................... 285
CONF_CPU_LOAD_CODER.................................................................................................... 284
CONF_CPU_LOAD_VCA......................................................................................................... 286
CONF_STORAGE_LOAD....................................................................................................... 1027
CONF_CPU_LOAD................................................................................................................... 283
CONF_SYSTEM_LOAD..........................................................................................................1062
CONF_UPLOAD_HISTORY................................................................................................... 1101
transcoder
CONF_TCP_BANDWIDTH_CHECK.......................................................................................1073
CONF_TCP_BANDWIDTH_CHECK_RESULT.......................................................................1074
CONF_ADD_REMOTE_DEVICE................................................................................................ 80
CONF_TCP_FWD................................................................................................................... 1075
upnp
CONF_ENABLE_UPNP............................................................................................................ 393
CONF_UPNP_SEARCH_IP_CONN_SERVICE..................................................................... 1112
CONF_UPNP_TCP_FWD....................................................................................................... 1113
user management
CONF_PASSWORD_SETTINGS............................................................................................. 793
CONF_ADV_USER_SETTINGS................................................................................................. 84
CONF_ADV_USER_SETTINGS_LIST....................................................................................... 88
CONF_ADV_USER_OPTIONS...................................................................................................83
CONF_USER_AUTH_MODE..................................................................................................1115
CONF_ENABLE_MASTERPWD...............................................................................................390
CONF_ACCESS_OPTION..........................................................................................................61
CONF_MASTERPWD_CHALLENGE....................................................................................... 693
CONF_MASTERPWD_CHALLENGE_STATE......................................................................... 694
CONF_STEALTH_MODE....................................................................................................... 1010
video input
CONF_CAMERA_LENS_CURVE............................................................................................. 181
CONF_VID_IN_CONTRAST................................................................................................... 1136
CONF_VID_IN_SATURATION............................................................................................... 1137
CONF_VID_IN_BRIGHTNESS............................................................................................... 1135
CONF_VIDEO_TERMINATION_RESISTOR_ON.................................................................. 1186
CONF_VIDEO_TERMINATION_RESISTOR_OFF.................................................................1185
CONF_VIDEO_INPUT_FORMAT........................................................................................... 1158
CONF_VIDEO_INPUT_FORMAT_EX.................................................................................... 1159
CONF_VIDEO_INPUT_FORMAT_EX_OPTIONS.................................................................. 1161
CONF_VIDEO_INPUT_FORMAT_EX_VERBOSE................................................................. 1162
CONF_VIDEO_INPUT_DESCRIPTION..................................................................................1157
CONF_INPUT_SOURCE_VAL................................................................................................. 584
CONF_NBR_OF_VIDEO_IN..................................................................................................... 768
CONF_PRIV_MSK.................................................................................................................... 811
CONF_PRIV_MSK_POLY........................................................................................................ 815
CONF_PRIV_MASK_DOME_PTZ_POS.................................................................................. 809
CONF_PRIV_MSK_OPTIONS.................................................................................................. 812
CONF_VCA_MSK_POLY....................................................................................................... 1123
CONF_VCA_MSK_OPTIONS................................................................................................. 1121
CONF_VCA_MASK_DOME_PTZ_POS................................................................................. 1119
CONF_STATIC_PRIV_MSK_OVERLAY................................................................................ 1003
CONF_STATIC_PRIV_MSK_OVERLAY_OPTIONS.............................................................. 1005
CONF_VIN_BASE_FRAMERATE.......................................................................................... 1187
CONF_VIRTUAL_LINES.........................................................................................................1236
CONF_VIDEO_LINE_DEWARPING_MODE.......................................................................... 1165
CONF_VIDEO_LINE_DEWARPING_MODE_CAPS.............................................................. 1166
CONF_VIDEO_LINE_DUO..................................................................................................... 1167
CONF_RAW_IMAGE................................................................................................................ 830
CONF_BLUR_ENABLED.......................................................................................................... 167
CONF_BLUR_COLOR.............................................................................................................. 166
CONF_LIVE_VIDEO_CONNECTION_ACTIVE........................................................................ 672
viproc
CONF_VIPROC_ID................................................................................................................. 1208
CONF_VIPROC_ONOFF........................................................................................................ 1212
CONF_VIPROC_CUSTOM_PARAMETERS.......................................................................... 1195
CONF_VIPROC_FIRE_PARAMETERS................................................................................. 1202
CONF_VIPROC_CUSTOM_PARAMETERS_TAGS.............................................................. 1196
CONF_VIPROC_GLOBAL_PARAMETERS........................................................................... 1203
CONF_VIPROC_GLOBAL_PARAMETERS_TAGS............................................................... 1204
CONF_VIPROC_DLL_NAME................................................................................................. 1200
CONF_VIPROC_DLL_NAME_LIST........................................................................................ 1201
CONF_VIPROC_SAVE_REFERENCE_IMAGE..................................................................... 1217
CONF_VIPROC_REFERENCE_IMAGE_FILENAME.............................................................1216
CONF_START_VIPROC_CONFIG_EDITING.......................................................................... 996
CONF_STOP_VIPROC_CONFIG_EDITING.......................................................................... 1012
CONF_CONT_VIPROC_CONFIG_EDITING............................................................................281
CONF_VIPROC_SCENE........................................................................................................ 1218
CONF_NUMBER_OF_VIPROC_CONFIGS............................................................................. 778
CONF_VIPROC_DEFAULT_LIST.......................................................................................... 1198
CONF_VIPROC_DEFAULT.................................................................................................... 1197
CONF_ACTIVE_VIPROC_CONFIG........................................................................................... 78
CONF_LOADED_VIPROC_CONFIG........................................................................................677
CONF_VIPROC_CONFIG_NAME.......................................................................................... 1194
CONF_LIST_OF_VIPROC_SCENES....................................................................................... 670
CONF_VIPROC_TAGGED_CONFIG..................................................................................... 1223
CONF_VIPROC_TAGGED_CONFIG_INTERNAL................................................................. 1227
CONF_VIPROC_ALARM........................................................................................................ 1188
CONF_VIPROC_ALARM_MASK............................................................................................ 1192
CONF_VIPROC_MODE..........................................................................................................1209
CONF_VIPROC_WEEKLY_SCHEDULE................................................................................ 1228
CONF_VIPROC_HOLIDAYS_SCHEDULE.............................................................................1205
CONF_PTZ_CONTROLLER_AVAILABLE............................................................................... 828
CONF_ENABLE_VCA...............................................................................................................394
CONF_VIPROC_ALARM_AGGREGATION_TIME.................................................................1190
CONF_VIPROC_ALARM_EXT_AGGREGATION_TIME........................................................1191
CONF_VIPROC_MOTION_DEBOUNCE_TIME..................................................................... 1210
CONF_VCA_TASK_RUNNING_STATE................................................................................. 1131
CONF_TRANSPARENT_DATA_OVER_IP............................................................................ 1096
CONF_SENSITIVITY_OBJECT_BASED_VCA........................................................................ 906
CONF_VIPROC_SENSITIVE_AREA...................................................................................... 1219
CONF_REFERENCE_IMAGE_CHECK_INFO_MESSAGE......................................................873
CONF_BEST_FACE................................................................................................................. 159
CONF_WRITE_XML_TO_VCD...............................................................................................1254
CONF_VCA_BRIGHTNESS_INFO......................................................................................... 1118
CONF_VCA_ORIENTATION_INFO........................................................................................1126
CONF_VCA_SUGGESTED_FIREMASK................................................................................ 1130
CONF_GETPROFILE_ALGO_PRESET_NAME_LIST............................................................. 458
CONF_VIPROC_CONFIG_CHANGE_IN_RECORDING........................................................1193
CONF_VIPROC_OLD_AGGREGATION_TIME_USED..........................................................1211
CONF_VIPROC_STATUS...................................................................................................... 1222
CONF_ALARM_OVERVIEW...................................................................................................... 98
CONF_RULE_ENGINE_ID....................................................................................................... 887
CONF_IVA_COUNTER_VALUES............................................................................................ 641
CONF_FIRE_ALARM................................................................................................................433
CONF_VIPROC_SET_REF_ORIENTATION..........................................................................1221
CONF_VIPROC_REF_ORIENTATION...................................................................................1215
CONF_VCD_OPERATOR_PARAMS..................................................................................... 1132
CONF_VIPROC_RE_TASK_NAMES..................................................................................... 1213
CONF_VIPROC_DETECTOR_PARAMS............................................................................... 1199
CONF_VCA_OUTPUT_FORMAT........................................................................................... 1127
wlan
CONF_WLAN_SSID............................................................................................................... 1249
CONF_WLAN_WPA_PSK...................................................................................................... 1250
CONF_WLAN_IOCTRL...........................................................................................................1242
CONF_WLAN_SCAN.............................................................................................................. 1247
CONF_WLAN_LINK_TEST.....................................................................................................1244
CONF_WLAN_OPERATING_MODE...................................................................................... 1245
CONF_WLAN_REGION_CODE............................................................................................. 1246
CONF_WLAN_LINK_QUALITY.............................................................................................. 1243
CONF_WLAN_WPS_SETUP..................................................................................................1251
CONF_WLAN_WPS_STATUS............................................................................................... 1252
CONF_WLAN_DEFAULT_CHANNEL.................................................................................... 1241
CONF_WPS_BUTTON_ENABLED........................................................................................ 1253
2.1 CONF_ACCESS_LUN_MGMT_FILE
[API: recording settings]
Description
This command can be used to acces the lun managment file. This exists only on span formatted luns, which
were formatted by firmware /generic dll versions, that are able to create this file. Older versions cannot do
this. The file name is "lunmgmt.bin". the max size which can be stored is 504 bytes. The in payload for
reading or writing this command has to be at least a size of 12 bytes and includes the lun address for read/
write from/to lun mgmt file. The response on the read direction includes the user data from the lun mgmt
file. The data length will be the remayning bytes from the respons payload size minus the lun address and
the reserved bytes (12 bytes together). Same in write direction. The payload size determines the number of
bytes to write to the lun mgmt file(max 504 bytes).
Payload Structure
16 32
target id
4 Bytes
target idx lun reserved...
1 Byte 1 Byte 6 Bytes
reserved
...
data
n Bytes (max 504 bytes)
8 24
target id
Target id of the lun (may be the ipv4 address for older versions or with default target resolve configuration,
see CONF_TARGET_ID_RESOLVE_RULES)
target idx
Target index of the lun
lun
Lun
reserved
data
User data to read/write from/to the lun mgmt file
2.2 CONF_ACCESS_OPTION
[API: user management]
Values:
Mask Name
Bit 1 0x000 Force Initial Password
Bit 0 0x000 0=Normal Access
2.3 CONF_ACCOUNT_LIST
[API: account]
2.4 CONF_ACCOUNT_LOGIN_TEST
[API: account]
Values:
ok 0
Connect failed 1
invalid user or password 2
set directory failed 3
general error 4
List failed 5
2.5 CONF_ACCOUNT_SETTINGS
[API: account]
2.6 CONF_ACCOUNT_SETTINGS_V2
[API: account]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: ACCOUNT_TAG_TYPE
16 32
Tag = 0x0001 Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_TYPE (t_dword)
4 Bytes
8 24
Values:
not configured 0
ftp 1
dropbox 2
amazon s3 5
kinesis 6
Tag 2: ACCOUNT_TAG_NAME
account name
16 32
Tag = 0x0002 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_NAME (p_string)
Length Bytes
8 24
Tag 3: ACCOUNT_TAG_URL
url, e.g url to the ftp server
16 32
Tag = 0x0003 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_URL (p_string)
Length Bytes
8 24
Tag 4: ACCOUNT_TAG_LOGIN
username
16 32
Tag = 0x0004 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_LOGIN (p_string)
Length Bytes
8 24
Tag 5: ACCOUNT_TAG_PASSWORD
password
16 32
Tag = 0x0005 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_PASSWORD (p_string)
Length Bytes
8 24
Tag 6: ACCOUNT_TAG_PATH
path
16 32
Tag = 0x0006 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_PATH (p_string)
Length Bytes
8 24
Tag 7: ACCOUNT_TAG_FLAGS
optional flags
16 32
Tag = 0x0007 Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_FLAGS (t_dword)
4 Bytes
8 24
Values:
FTP Encryption mode off 0
FTP Encryption mode TLS 1
Tag 8: ACCOUNT_TAG_ACCESS_KEY
aws access key (max 128 bytes)
16 32
Tag = 0x0008 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_ACCESS_KEY (p_string)
Length Bytes
8 24
Tag 9: ACCOUNT_TAG_SECRET_KEY
aws secret access key (max 128 bytes)
16 32
Tag = 0x0009 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_SECRET_KEY (p_string)
Length Bytes
8 24
16 32
Tag = 0x000a Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_BUCKET_NAME (p_string)
Length Bytes
8 24
16 32
Tag = 0x000b Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_REGION (p_string)
Length Bytes
8 24
16 32
Tag = 0x000c Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_CAMERA_ID (p_string)
Length Bytes
8 24
16 32
Tag = 0x000d Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_FILE_DURATION (t_dword)
4 Bytes
8 24
16 32
Tag = 0x000e Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_STREAM_NAME (p_string)
Length Bytes
8 24
16 32
Tag = 0x000f Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_KBPS (t_dword)
4 Bytes
8 24
16 32
Tag = 0x0010 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_GROUP (p_string)
Length Bytes
8 24
16 32
Tag = 0x0011 Length = 0x0001
2 Bytes 2 Bytes
ACCOUNT_TAG_CLOUD_WATCH_ENABLED (t_octet)
1 Byte
8 24
16 32
Tag = 0x0012 Length = 0x0001
2 Bytes 2 Bytes
ACCOUNT_TAG_KMS_ENABLED (t_octet)
1 Byte
8 24
16 32
Tag = 0x0013 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_KMS_KEY_ID (p_string)
Length Bytes
8 24
2.7 CONF_ACCOUNT_STATUS
[API: account]
Values:
ftp 1
dropbox 2
2.8 CONF_ACCOUNTS_CREATE_FOLDER
[API: account]
2.9 CONF_ACCOUNTS_DELETE_FOLDER
[API: account]
2.10 CONF_ACTIVE_CONNECTION_LIST
[API: rcp.connection]
Payload Structure
ConnectionEntry [0]
(see description)
...
ConnectionEntry [N]
(see description)
ConnectionEntry
16 32
Destination IP Address
4 Bytes
Local Coder Local Line Flags
1 Byte 1 Byte 2 Bytes
Session ID
4 Bytes
Remote Coder Remote Line Reserved
1 Byte 1 Byte 2 Bytes
TX Channels
4 Bytes
RX Channels
4 Bytes
8 24
Destination IP Address
IP address to which the unit is connected.
Local Coder
The local connected coder (relative to line).
Local Line
The remote connected line
Flags
Mask Name Description
Bit 11 0x0800 H.265 Is set when connection is H.265
Bit 10 0x0400 Transcoder Is set when connection is using transcoder
Bit 9 0x0200 Jpeg Is set when connection is Jpeg
Bit 8 0x0100 H.264 Is set when connection is H.264
Bit 7 0x0080 Encrypted Is set when datastream is encrypted
Bit 6 0x0040 TCP Transportation Is set when connection is using TCP for
transportation
Bit 5 0x0020 Multicast Is set when connection is using multicast
Bit 4 0x0010 Streaming Is set when connection is started as streaming
Bit 3 0x0008 HDD Replay Is set when connection is to HDD replay
Bit 2 0x0004 MPEG4 Is set when connection is MPEG4
Bit 1 0x0002 MPEG2 PRG Is set when connection is MPEG2 PRG
Bit 0 0x0001 MPEG2 VES Is set when connection is MPEG2 VES
Session ID
Session identifier.
Remote Coder
The remote connected coder (relative to line), (absolute) transcoder if connection is using transcoder
Remote Line
The remote connected line.
Reserved
TX Channels
See CONNECT_TO command for bit mask.
RX Channels
See CONNECT_TO command for bit mask.
Note: If a session ID is provided in the rcp header, then only the connection list of this specific session
ID is supplied.
2.11 CONF_ACTIVE_VIPROC_CONFIG
[API: viproc]
2.12 CONF_ADAPT_ENC_PROFILE_BITRATES
[API: encoder]
2.13 CONF_ADD_REMOTE_DEVICE
[API: transcoder]
Description
Adds a device with forwarder ports, all data to/from the forwarder ports will be forwarded to/from the
configured device port. It is allowed to store complete zeroed forwarder/remote port entries. For entries
which are referenced by CONF_RCP_CONNECT_SALVO command num param, it it nessessary, that the
first forward port entry contains the http port and the second one the https port. If one of these ports shall
not be used, at least a zeroed entry (remote/forwarder port to zero) has to be placed. The max lines and
coder per lines are just information, which will be stored together in the config. To delete an entry, send
an empty or zeroed payload.
Payload Structure
16 32
mac...
6 Bytes
mac reserved
... 2 Bytes
line cnt max coder per line
2 Bytes 2 Bytes
nbr of forwarder entries
4 Bytes
forwarder entry [0]
(see description)
...
forwarder entry [
nbr of forwarder entries
- 1]
(see description)
mac
Mac of the device (will be stored only as information in config)
reserved
line cnt
Max lines of the device (will be stored only as information in config)
forwarder entry
16 32
remote port forwarder port
2 Bytes 2 Bytes
8 24
remote port
Port of the remote device
forwarder port
Local port which forwards all data to the remote port
url len
Length of the following url (actual limit is 64)
url
Url for the connection to the remote device, ascii string including zero termination
pwd len
Length of the following password (actual limit is 64)
pwd
Password for the connection, ascii string including zero termination
device name
Device name of the remote device, ascii string including zero termination
2.14 CONF_ADV_USER_OPTIONS
[API: user management]
Payload Structure
16 32
Max number of users
4 Bytes
Max user name length
4 Bytes
Max password length
4 Bytes
Password user support Certificate user support
1 Byte 1 Byte
8 24
2.15 CONF_ADV_USER_SETTINGS
[API: user management]
Description
Command CONF_ADV_USER_SETTINGS allows to query or configure user entries for camera access
control. User entries are indentified by the user name, the user name of each entry must be unique. Supported
lengths, types and restrictions can be queried using CONF_ADV_USER_SETTINGS_OPTIONS.
In read direction only the user name is used to find the user entry to query the user configuration.
In write direction an already existing user with the same name is modified or a new user with the given
configuration is created.
Payload Structure
User Entry
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x0000
2 Bytes 2 Bytes
8 24
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
User Name (p_string)
Length - 4 Bytes
8 24
The payload of tag user type contains the user type, possible values are:
Deleted 0
Password 1
Certificate 2
Temporary with 3
password
Cloud 4 (read only)
Tag 4: Password
The payload of tag user password contains the user password.
This field is only mandatory when configuring a user of type Password and will be empty when read if there
is no password or just '********' when a password is set.
16 32
Length Tag = 0x0004
2 Bytes 2 Bytes
Password (p_string)
Length - 4 Bytes
8 24
On read, this field will indicate the remaining time in seconds until the user will expire.
16 32
Length = 0x0024 Tag = 0x0005
2 Bytes 2 Bytes
Expires In Seconds (t_dword)
4 Bytes
8 24
2.16 CONF_ADV_USER_SETTINGS_LIST
[API: user management]
Payload Structure
...
The payload of this command consists of a list of 'User Entry' items of the command
CONF_ADV_USER_SETTINGS.
2.17 CONF_ALARM_BACKUP_REC_SPEED_LIMIT
[API: recording settings]
Description
This command can be used to limit the data traffic caused by backuped recording per line (num parameter
1 to n). This can be done by limiting the data rate and/or the speed in percent(100 percent means backup
speed like replay in normal speed), based on the time information of the video data. The backup can be
stopped completly, by sending a speed limit by 0 and continued again by sending a non zero speed later. It
cannot be stopped by the data rate, a value of 0 for the data rate means to disable the limit for the data rate.
The data rate parameter isn't applied immediately, but when the next backup starts.
Payload Structure
16 32
speed limit
4 Bytes
data rate limit
4 Bytes
8 24
speed limit
Speed limit in percent (0 to 9999, default 200)
2.18 CONF_ALARM_CONNECT_TO_IP
[API: alarm connections]
2.19 CONF_ALARM_CONNECT_TO_IP_STR
[API: alarm connections]
2.20
CONF_ALARM_CONNECTION_DESTINATION_PORT
[API: alarm connections]
2.21 CONF_ALARM_CONNECTION_USE_SSL
[API: alarm connections]
2.22 CONF_ALARM_DISP_VAL
[API: stamping]
Values:
disable alarm display 1
enable alarm display 2
alarm stamping with custom attributes 3 can be set with the CONF_STAMP_ATTR_ALARM
2.23 CONF_ALARM_INPUT_CAPABILITIES
[API: alarm]
Description
Read capabilities of the available alarm inputs.
Payload Structure
16 32
Count
4 Bytes
Capabilities [0]
4 Bytes
...
Capabilities [
Count
- 1]
4 Bytes
8 24
Count
Number of available alarm inputs
Capabilities
Capabilities of the alarm input
Mask Name
Bit 0 0x00000001 Supervised mode possible
2.24 CONF_ALARM_INPUT_LH_VAL
[API: alarm]
2.25 CONF_ALARM_INPUT_SUPERVISED
[API: alarm]
2.26 CONF_ALARM_OVERVIEW
[API: viproc]
Description
Messages are sent if a change has happened (event, state change, alarm added, alarm deleted). The readout
command contains all registered alarm entries.
Payload Structure
16 32
Flags Reserved Number of alarm entries
1 Byte 1 Byte 2 Bytes
Alarm Entry [0]
(see description)
...
Alarm Entry [
Number of alarm entries
- 1]
(see description)
8 24
Flags
Mask Name Description
Bit 7 0x80 All entries included (read out)
Alarm Entry
16 32
Entry ID Entry Length
2 Bytes 2 Bytes
Flags Reserved Alarm Source Alarm Type
1 Byte 1 Byte 1 Byte 1 Byte
Alarm Name (p_unicode)
Entry Length - 8 Bytes
8 24
Entry ID
Unique ID for each entry. May be reassigned to entry if entry is deleted.
Entry Length
Length of the entry payload, inclusive header.
Flags
Mask Name Description
Bit 7 0x80 Add Flag Alarm Entry has been registered
Bit 6 0x40 Delete Flag Alarm Entry has been unregistered
Bit 5 0x20 State Flag Alarm Entry is a state
Bit 4 0x10 State Set Flag Alarm Entry State is set (states only)
Alarm Source
Values:
Unknown 0
Relais 2
Digital Input 3
Audio 4
Virtual Input 5
Tamper 6
Motion 7
Flow 8
Intelligent Video Analytics 9
Fire 10
Man Over Board 11
storage 13
recorder 14
Alarm Type
Values:
Unknown 0
VCA 1
Relais 2
Digital Input 3
Audio 4
Virtual Input 5
storage medium failure 6
storage recording state 7
disk mounted 8
disk unmounted 9
Default Task 16
Global Change 17
Signal too bright 18
Signal too dark 19
Signal too noisy 20
Signal too blurry 21
Signal loss 22
Reference Image Check Failed 23
Invalid Configuration 24
Flame Detected 25
Smoke Detected 26
Object in field 32
Crossing line 33
Loitering 34
Condition change 35
Following route 36
Tampering 37
Removed object 38
Idle object 39
Entering field 40
Leaving field 41
Similarity search 42
Crowd detection 43
Flow in field 44
Counter flow in field 45
Motion in field 46
Man over board 47
Counter 48
BEV People Counter 49
Occupacy 50
Alarm Name
String encoded in unicode.
2.27 CONF_ALARM_STRING
[API: stamping]
2.28
CONF_ALLOW_BASIC_HTTP_AUTH_ON_NON_SSL_SOCK
[API: http settings]
Values:
not allowed 0 default
allowed 1
2.29
CONF_ALLOW_OVERWRITE_TIMESRVIP_BY_DHCP
[API: local time and time server settings and configuration]
Values:
deny 0
allow 1
2.30 CONF_AMBIENT_LIGHT_LEVEL
[API: system.status]
2.31 CONF_APP_MGMT_GET_DEVICE_IDS
[API: app management]
2.32 CONF_APP_MGMT_INSTALL_LICENSE
[API: app management]
2.33 CONF_APP_OPTION
[API: system.settings]
2.34 CONF_APP_OPTION_EXT
[API: system.settings]
2.35 CONF_APP_OPTION_SET
[API: system.settings]
2.36 CONF_APP_OPTION_UNIT_ID
[API: system.settings]
2.37 CONF_APPLICATION_TYPE
[API: system.settings]
Values:
default application 0
standard application 1
2.38 CONF_APPLY_NETWORK_SETTINGS
[API: ethernet]
2.39 CONF_AUDIO_AAC_BITRATE
[API: audio]
2.40 CONF_AUDIO_ENC_STREAMING
[API: multicast]
2.41 CONF_AUDIO_INPUT
[API: audio]
Values:
Line 0
Mic 1
Mute 2 only supported by arm based products
2.42 CONF_AUDIO_INPUT_LEVEL
[API: audio]
2.43 CONF_AUDIO_INPUT_MAX
[API: audio]
2.44 CONF_AUDIO_INPUT_PEEK
[API: audio]
2.45 CONF_AUDIO_LOUDSPEAKER_ON_OFF
[API: audio]
Values:
Off 0
On 1
2.46 CONF_AUDIO_MIC_LEVEL
[API: audio]
2.47 CONF_AUDIO_MIC_MAX
[API: audio]
2.48 CONF_AUDIO_NOTIFICATION_SOUND
[API: audio]
Values:
do not play sound 0
play sound 1
2.49 CONF_AUDIO_ON_OFF
[API: audio]
Values:
Off 0
On 1
2.50 CONF_AUDIO_OPTIONS
[API: audio]
Values:
Mask Name
Bit 3 0x08 Loudspeaker
Bit 2 0x04 Mic
Bit 1 0x02 Line Out
Bit 0 0x01 Line In
2.51 CONF_AUDIO_OUTPUT
[API: audio]
Values:
Decoder 0
Sine 1
Loop 2
Mute 3
Sample 4
2.52 CONF_AUDIO_OUTPUT_LEVEL
[API: audio]
2.53 CONF_AUDIO_OUTPUT_MAX
[API: audio]
2.54 CONF_AUDIO_OUTPUT_PEEK
[API: audio]
2.55 CONF_AUDIO_REC_FORMAT
[API: recording settings]
Values:
None 0
G711 1
L16 2
AAC 3
2.56 CONF_AUDIO_STARTUP_SOUND
[API: audio]
2.57 CONF_AUDIO_STREAMING_ENCODING
[API: multicast]
Values:
g711 1
aac 2
2.58 CONF_AUPROC_ALARM
[API: audio]
Payload Structure
16 32
Alarm Flags
4 Bytes
8 24
Alarm Flags
The message is sent whenever any of the bit values changes. Additionally it is sent once per second when
any of the bits is set.
Values:
Mask Name Description
Bit 13 0x00002000 Entire Entire frequency band
Bit 12 0x00001000 Hz2865_4000 Frequency band 2875-4000 Hz
Bit 11 0x00000800 Hz2420_3400 Frequency band 2420-3400 Hz
Bit 10 0x00000400 Hz2030_2875 Frequency band 2030-2875 Hz
Bit 9 0x00000200 Hz1690_2420 Frequency band 1690-2420 Hz
Bit 8 0x00000100 Hz1375_2030 Frequency band 1375-2030 Hz
Bit 7 0x00000080 Hz1110_1690 Frequency band 1110-1690 Hz
Bit 6 0x00000040 Hz890_1375 Frequency band 890-1375 Hz
Bit 5 0x00000020 Hz690_1110 Frequency band 690-1110 Hz
Bit 4 0x00000010 Hz500_890 Frequency band 500-890 Hz
Bit 3 0x00000008 Hz360_690 Frequency band 360-690 Hz
Bit 2 0x00000004 Hz220_500 Frequency band 220-500 Hz
Bit 1 0x00000002 Hz110_360 Frequency band 110-360 Hz
Bit 0 0x00000001 Hz0_220 Frequency band 0-220 Hz
2.59 CONF_AUPROC_CONFIG
[API: audio]
Description
This command configures the audio alarm analysis. The analysis is based on a 8kHz signal (if the device
supports higher sampling rates the signal is downsampled). The analysed frequency bands (there are 13
frequency bands) have the following center frequencies:
100 Hz, 220 Hz, 350 Hz, 500 Hz, 680 Hz, 880 Hz, 1.1 kHz, 1.4 kHz, 1.7 kHz, 2.0 kHz, 2.4 kHz, 2.9 kHz,
3.4 kHz
The freuqnecy bands are overlapping triangles.
Payload Structure
16 32
Version
4 Bytes
Trigger Level Trigger Level Trigger Level Trigger Level
Hz0_220 Band Hz110_360 Band Hz220_500 Band Hz360_690 Band
1 Byte 1 Byte 1 Byte 1 Byte
Trigger Level Trigger Level Trigger Level Trigger Level
Hz500_890 Band Hz690_1110 Band Hz890_1375 Band Hz1110_1690 Band
1 Byte 1 Byte 1 Byte 1 Byte
Trigger Level Trigger Level Trigger Level Trigger Level
Hz1375_2030 Band Hz1690_2420 Band Hz2030_2875 Band Hz2420_3400 Band
1 Byte 1 Byte 1 Byte 1 Byte
Trigger Level Trigger Level
Trigger Level1 Unused Trigger Level2 Unused
Hz2865_4000 Band Entire Signal
1 Byte 1 Byte
1 Byte 1 Byte
Sensitivity Sensitivity Sensitivity Sensitivity
Hz0_220 Signal Hz110_360 Band Hz220_500 Band Hz360_690 Band
1 Byte 1 Byte 1 Byte 1 Byte
Sensitivity Sensitivity Sensitivity Sensitivity
Hz500_890 Band Hz690_1110 Band Hz890_1375 Band Hz1110_1690 Band
1 Byte 1 Byte 1 Byte 1 Byte
Sensitivity Sensitivity Sensitivity Sensitivity
Hz1375_2030 Band Hz1690_2420 Band Hz2030_2875 Band Hz2420_3400 Band
Version
Unused (should be zero).
Flags
1 byte reserved for flags
Values:
Mask Name Description
Bit 7 0x80 OnOff Indicates if audio alarm is on or off
Reserved
2.60 CONF_AUPROC_MELPEGEL
[API: audio]
Description
Each of the 14 bytes corresponds to the frequency bands described within the command AUPROC_ALARM
and AUPROC_MELPEGEL.
Payload Structure
16 32
Recent melpegel Recent melpegel Recent melpegel Recent melpegel
Hz0_220 Band Hz110_360 Band Hz220_500 Band Hz360_690 Band
1 Byte 1 Byte 1 Byte 1 Byte
Recent melpegel Recent melpegel Recent melpegel Recent melpegel
Hz500_890 Band Hz690_1110 Band Hz890_1375 Band Hz1110_1690 Band
1 Byte 1 Byte 1 Byte 1 Byte
Recent melpegel Recent melpegel Recent melpegel Recent melpegel
Hz1375_2030 Band Hz1690_2420 Band Hz2030_2875 Band Hz2420_3400 Band
1 Byte 1 Byte 1 Byte 1 Byte
Recent melpegel Recent melpegel Adaptive Threshold Adaptive Threshold
Hz2865_4000 Band Entire Signal Level Hz0_220 Signal Level Hz110_360 Band
1 Byte 1 Byte 1 Byte 1 Byte
Adaptive Threshold Adaptive Threshold Adaptive Threshold Adaptive Threshold
Level Hz220_500 Band Level Hz360_690 Band Level Hz500_890 Band Level Hz690_1110 Band
1 Byte 1 Byte 1 Byte 1 Byte
Adaptive Adaptive Adaptive
Adaptive Threshold
Threshold Level Threshold Level Threshold Level
Level Hz890_1375 Band
Hz1110_1690 Band Hz1375_2030 Band Hz1690_2420 Band
1 Byte
1 Byte 1 Byte 1 Byte
Adaptive Adaptive Adaptive
Adaptive Threshold
Threshold Level Threshold Level Threshold Level
Level Entire Signal
Hz2030_2875 Band Hz2420_3400 Band Hz2865_4000 Band
1 Byte
1 Byte 1 Byte 1 Byte
8 24
2.61 CONF_AUPROC_NAME
[API: audio]
2.62 CONF_AUTO_DISCONNECT_TIME
[API: alarm connections]
2.63 CONF_AUTO_TRACKER_TRACK_OBJECT
[API: autotracker]
2.64 CONF_AUTO_TRACKER_TRACK_OBJECT_POS
[API: autotracker]
2.65 CONF_AUTODETECT_REPLY_GROUP
[API: rcp.discovery]
2.66 CONF_AUXILIARY_POWER
[API: system.settings]
Payload Structure
16 32
Flags ovl_cnt Reserved
1 Byte 1 Byte 2 Bytes
8 24
Flags
Mask Name Description
Bit 3 0x08 ovl Indicates if auxiliary power is overloaded (read only,
write will be ignored)
Bit 2 0x04 has ovl Indicates if the unit has overload detection (read
only, write will be ignored)
Bit 1 0x02 ena power Indicates if auxiliary power is switched on
Bit 0 0x01 aux power Indicates if the unit has auxiliary power (read only,
write will be ignored)
ovl_cnt
Counts up if an overload occurs
Values:
no overload 0
nr of overload events 1 - 254
more than 254 overload events 255
2.67 CONF_BACKUP
[API: backup]
Description
Starts an mp4 backup file of the specified replay range and store it on a account. The
CONF_BACKUP_STATUS message is sent periodicallay to inform about the backup progress. The
command returns an 1 byte backup id that can be used to identify the backup in the message. The backup
may include signature generation and video authenticity checks. The check results can be return by an
optional addon in CONF_BACKUP_STATUS message. The backup destination can be a dummy backup,
the data won't be stored anywhere in that case. The dummy backup is used on the special account number
0xff (255). This is usefull, if the backup is just just for authenticity check of records.
Payload Structure
16 32
From2000
4 Bytes
To2000
4 Bytes
Account
4 Bytes
RecordingIndex
4 Bytes
RemoteCamera Transcode TranscoderPreset Reserved
1 Byte 1 Byte 1 Byte 1 Byte
ReplaySpeed
4 Bytes
ObjectID
4 Bytes
Reserved
4 Bytes
Backup filename...
16 Bytes
Backup filename
...
Backup filename
...
Backup filename
...
Flags Signature hash type Reserved
1 Byte 1 Byte 2 Bytes
8 24
From2000
Start time of the backup in seconds since 2000
To2000
Stop time of the backup in seconds since 2000
Account
Index of the account that should be used for backup (see CONF_ACCOUNT_SETTINGS), special account
dummy backup 0xff.
RecordingIndex
Index of the recording to be backuped (0 or 1)
RemoteCamera
0 - local Camera, 1 to 4 refering to entries of CONF_ADD_REMOTE_DEVICE
Transcode
Optional field that defines if the video should be transcoded before backup (used by Transcoder Devices
only)
TranscoderPreset
Optional field that defines the preset used by transcoding (used by Transcoder Devices only)
ReplaySpeed
Optional field that defines the replay speed (used by Transcoder Devices only). Use the same values as for
CONF_HD_REPLAY_START
ObjectID
Optional field: if that Id is given a autotracker instance will be started that follows the object (used by
Transcoder Devices only)
Backup filename
Backup filename: filename in arbitrary order of: %b begin date/time, %e end date/time, %c camera name,
%i export job id, %f file nbr, %a alarm description, %dSubDirectory sub directory to write; optionally
seperated by "_" or "-". Exampe: %b_%c would result e.g in a filename 20111017_14-29-26_camera1.mp4
Flags
Flags:
Mask Name Description
Bit 1 0x02 AUTH_MSG_ADDON Status message CONF_BACKUP_STATUS will
contain a message addon containing authenticity
check result information
Bit 0 0x01 CHECK_SIGNATURE Checks the signature of the source records, the
generation of a signature of the backup will fail, if
the check fails
Types:
NO_SIGNATURE 0 Signature generation disabled
SHA1 1 Generates a signature file over the backup file using SHA1
SHA256 2 Generates a signature file over the backup file using SHA256
2.68 CONF_BACKUP_MAX_KBPS
[API: backup]
2.69 CONF_BACKUP_RECORDING_STATUS
[API: recording settings]
Description
This command returns the backup recording status on a line, specified by the num parameter (1 ... n).
First it looks for a valid configuration of backup recording. Valid means, there exists a running recording
configured to record the life data and a second recording for backup, which copies the data from the life
data recording storage to it's recording storage on alarm or continuously. If both "rec idx life" and "rec idx
backup" are none zero, there is a valid configuration. Then the following fields inform about the status and
progress of the backuped recording. The utilization of the life data recording storage can be calculated in
percent with the equation: utilization = ("unbackuped MB" * 100)/("unbackuped MB" + "backuped MB" +
"free MB"). The status will be send as message, if the utilization will cross some thresholds. There are two
thresholds, the "All Clear" threshold and the "Warning" threshold. These thresholds can be configured with
the command CONF_BACKUP_RECORDING_STATUS_MSG_THRESHOLD (see rcp documentation).
Another reason for sending this message will be on deleting or overwriting of records, which had to be
backuped but weren't backuped before deletion, or were deleted while still within the maximum retention
time range. Every time this event happens, the lost counter will be incremented. This counter will count
since device boot.
Payload Structure
16 32
rec idx life rec idx backup
2 Bytes 2 Bytes
free MB
4 Bytes
backuped MB
4 Bytes
unbackuped MB
4 Bytes
lost counter
4 Bytes
msg trigger reserved
1 Byte 3 Bytes
8 24
Values:
None 0
Primary 1
Secondary 2
Values:
None 0
Primary 1
Secondary 2
free MB
Free Storage space in MB for the life data recording
backuped MB
Storage space in MB with records of the life data recording for this line, which are already backuped or
which are not required to be backuped
unbackuped MB
Storage space in MB with records of the life data recording for this line, which have to be backuped or
potentially required to be backuped, because they are in range of the max pre alarm time
lost counter
Counter for events of records, which had to be backuped and that couldn't be backuped, on deleting or
overwriting by newer records
msg trigger
Reason for sending this status
Values:
REQUESTED 0 Response on request
ALL_CLEAR 1 All clear threshold passed
WARNING 2 Warning threshold passed
DATA_LOSS 3 New data loss
2.70
CONF_BACKUP_RECORDING_STATUS_MSG_THRESHOLD
[API: recording settings]
Description
This command configures the thresholds for the CONF_BACKUP_RECORDING_STATUS message. The
message will be send, when the storage space utilization will cross the "all clear" threshold by changed
utilization from higher to lower utilization or when crossing the "warning" threshold by changed utilization
from lower to higher utilization.
Payload Structure
16 32
all clear threshold warning threshold reserved
1 Byte 1 Byte 2 Bytes
8 24
warning threshold
Threshold for warning in percent
2.71 CONF_BACKUP_STATUS
[API: backup]
Description
This command returns a list of the current backups or the status of one single backup if a specific valid
backup id was provided. The list contains the following sequence:
Payload Structure
16 32
Backup Session ID
4 Bytes
RCP Session ID
4 Bytes
Start Time
4 Bytes
End Time
4 Bytes
Transfered Bytes
8 Bytes
Transfered Bytes
...
File Count File Nbr
2 Bytes 2 Bytes
File part Reserved
2 Bytes 2 Bytes
Current time
4 Bytes
Ppm Current File
4 Bytes
Backup Errrors
4 Bytes
RTP packet loss
4 Bytes
MP4 box errors
4 Bytes
Account errors
4 Bytes
Cam RecIdx
2 Bytes 2 Bytes
Timezone
Account Backup ID Reserved
quarter hours
1 Byte 1 Byte 1 Byte
1 Byte
Link...
128 Bytes
Link
[...]
Link
...
Reserved...
8 Bytes
Reserved
...
8 24
Backup Session ID
Backup Session ID
RCP Session ID
Corresponding RCP Session ID
Start Time
Start Time of the Backup in Seconds since 2000
End Time
End Time of the Backup in Seconds since 2000
Transfered Bytes
Transfered Bytes
File Count
Number of files to backup
File Nbr
Current file to backup
File part
If a larger Backup file is split into multiple parts this value tells the current part
Current time
The current time of the backup
Backup Errrors
The last account error.
Errors:
ERROR 2 Error during backup
CANCELLED 4 Backup canceled
START_FAILED 5 Start of backup failed
Account errors
The last account error.
Errors:
NO_ERROR 0
NO_IP 1
CONNECT_FAILED 2
SETDIR_FAILED 3
WRITE_FAILED 4
Cam
Camera
RecIdx
Recording Index
Account
The index of the account used for backup (see CONF_ACCOUNT_SETTINGS and CONF_BACKUP).
For backup via http the account is set to 0.
Backup ID
The backup id that is returned by the CONF_BACKUP command. This id can be used to link the backup
started by CONF_BACKUP with this status message
Link
A direct link to the backup mp file. The message contains the link if it is available
16 32
Backup Status...
200 Bytes
Backup Status
[...]
Backup Status
...
Backup Status Addon (optional)
(see description)
8 24
TZ QH
Time time zone offset in quarter hours (7 lowest bits), and sign (highest bit)
hash status
Hash status for authenticity check
Values:
missing 0
not checked 1
invalid 2
valid 3
sign status
Signature status
Values:
missing 0
not checked 1
missing certificate 2
invalid 3
valid 4
cert status
Signing certificate status
Values:
not checked 0
unknown 1
invalid 2
trusted 3
owned 4
hash issues
Count of hash issues occured since start of authenticity check
sign issues
Count of sign issues occured since start of authenticity check
cert issues
Count of cert issues occured since start of authenticity check
2.72 CONF_BACKUP_STOP
[API: backup]
2.73 CONF_BASE_POE_CLASS
[API: lldp]
Values:
class0 1
class1 2
class2 3
no PoE 255
2.74 CONF_BEST_FACE
[API: viproc]
Description
Allows the upload of detected faces to an ftp server or drop box account.
Payload Structure
16 32
enable reserved accountId pictureFormat
1 Byte 1 Byte 1 Byte 1 Byte
targetObjectWidth
4 Bytes
time out reserved...
1 Byte 11 Bytes
reserved
...
reserved
...
8 24
enable
best face is disabled 0
best face is enabled 1
accountId
Select account which is used as target for the detected faces for detailed information’s see
CONF_ACCOUNT_SETTINGS
pictureFormat
Select file format:
Jpeg 0
YUV420 1
Uncompressed tiff 2
targetObjectWidth
Configure maximum face width in pixel 0 means auto no scaling is necessary delivers best performance
time out
Time out in seconds. If the time out is set to 0 the best face of the tracking process will be posted when
the face has left the scene.
Defines a timeout for the maximum delay which is introduced till a face is posted. After a face is posted
the tracking is restarted.
Example:
Face is in scene for 50 sec t = [0s,50s]
timeout is configured to 10 s
best face of [0s,10s] is posted
best face of [10s,20s] is posted
best face of [20s,30s] is posted
best face of [30s,40s] is posted
best face of [40s,50s] is posted
2.75 CONF_BICOM_COMMAND
[API: bicom]
Payload Structure
16 32
Error:
NaN
is
not
a
multiple
of
32
which
is
required
for
table.
Variant
is
-1
Flags Lease Time Info (conditional)...
1 Byte (see description)
Error:
NaN
is
not
a
multiple
of
32
which
is
required
for
table.
Variant
is
-1
Lease Time Info (conditional)
...
Error:
NaN
is
not
a
multiple
of
32
which
is
required
for
table.
Variant
is
-1
Error:
NaN
is
not
a
multiple
of
32
which
is
required
for
table.
Variant
is
-1
Error:
NaN
is
not
a
multiple
of
32
which
is
required
for
table.
Variant
is
-1
Error:
NaN
is
not
a
multiple
of
32
which
is
required
for
table.
Variant
is
-1
8 24
Flags
Transmission-Flags
Mask Name Description
Bit 7 0x80 Flags Available Must be always set to 1
Bit 6 0x40 unsued3 unused set to 0
Bit 5 0x20 unused2 unused set to 0
Bit 4 0x10 unused1 unused set to 0
Bit 3 0x08 Lease Time Available Set to 1 if a lease time is included in the request
Bit 2 0x04 Native Errors Set to 1 to receive the native BICOM errors
Bit 1 0x02 obsolete2 obsolete, don't care
Bit 0 0x01 obsolete1 obsolete, don't care
24 48
Lease time Lease time ID
2 Bytes 4 Bytes
12 36
Lease time
Time period in seconds the access should be blocked for other clients.
Note: This field has to be signaled in little endian mode.
Lease time ID
Random number generated by the client. If a lease time > 0 is provided with the first access, further accesses
during the lease time are only possible if the same lease time id is provided.
Bicom Server ID
Server ID, e.g. 0x0002 for "Device Server" (See BICOM application documentation)
Object ID
Object ID, e.g. 0x0100 for "Type" (See BICOM application documentation)
Operation
See BICOM application documentation for details.
Values
GET 0x01
SET 0x02
SET_GET 0x03
INC 0x04
INC_GET 0x05
DEC 0x06
DEC_GET 0x07
SET_DFLT 0x08
SET_GET_DFLT 0x09
Bicom Server ID
Server ID, e.g. 0x0004 for "Camera Server" (See BICOM application documentation)
Object ID
Object ID, e.g. 0x0190 for "Colour" (See BICOM application documentation)
Operation
See BICOM application documentation
Values:
EVENT 0x70 -
0x7F
2.76 CONF_BLUR_COLOR
[API: video input]
2.77 CONF_BLUR_ENABLED
[API: video input]
2.78 CONF_BOARD_RESET
[API: system.settings]
2.79 CONF_BOOT_DEFAULT_APP
[API: system.settings]
2.80 CONF_BOOT_STATE
[API: system.settings]
Values:
booted 100
waiting for camera frontend 50
waiting for DHCP 25
Percent 0 - 100
2.81 CONF_BOOTLOADER_VERSION
[API: system.settings]
2.82 CONF_BROWSER_DATETIME_FORMAT_VAL
[API: local time and time server settings and configuration]
2.83 CONF_BROWSER_LANGUAGE_VAL
[API: browser]
2.84 CONF_BUFFERED_RECORDING_MODE
[API: recording settings]
Description
This command can be used to configure the buffered recording configuration mode. The default is the
manual mode, which is used for standard (single/dual) recording or manually configured buffered recording,
which means the primary and secondary recording will be setup to do buffered recording. In case of
buffered recording configuration mode, the device recording configuration will be changed internally to
an buffered recording setup. The recording will then be configured like a single primary recording via
recording profiles but internally the configuration is mapped to a coresponding buffered recording setup.
When set to this mode, the secondary recording isn't accessable anymore via recording profile configuration
(affected comands: CONF_HD_RECORD_PROFILE, CONF_HD_RECORD_PROFILE_V2,
CONF_HD_RECORD_PROFILE_SECONDARY, CONF_HD_PROFILE_V2_SECONDARY) and start/
stop configuration(affected commands: CONF_START_RECORD, CONF_START_SPAN_RECORD,
CONF_HD_MGR_START, CONF_HD_MGR_START_SECONDARY, CONF_HD_MGR_STOP,
CONF_HD_MGR_STOP_SECONDARY). When the mode is changed, the actual recording is stopped.
Payload Structure
4 8
Buffered Rec Mode
1 Byte
2 6
2.85 CONF_CAM_REC_SPANS
[API: recording settings]
Payload Structure
16 32
IP
4 Bytes
MAC...
6 Bytes
MAC Recording Index Camera
... 1 Byte 1 Byte
LUN Target ID
4 Bytes
LUN Target IDX LUN Reserved
1 Byte 1 Byte 2 Bytes
8 24
IP
The ip address of the recording device.
MAC
The hardware address of the recording device. This field may be zero if you search for recordings without
considering the mac.
Recording Index
Primary Recording 1
Secondary Recording 2
Camera
The camera index.
LUN Target ID
Target id of the lun (may be the ipv4 address for older versions or with default target resolve configuration,
see CONF_TARGET_ID_RESOLVE_RULES).
LUN
The logical unit number.
...
Span Index
The span index in the current lun.
S
The timezone sign.
Timezone
Timezone in quarter hours.
Flags
Values:
Mask Name
Bit 7 0x80 extended span rec info
Bit 6 0x40 virtual alarm
Bit 5 0x20 video loss
Bit 4 0x10 motion alarm
Bit 3 0x08 input alarm
Bit 2 0x04 reserved (former migrated
recording)
Bit 1 0x02 Recording Running
Bit 0 0x01 Continous Recording
Start Time
Seconds since 2000.
Stop Time
Seconds since 2000.
Reserved
File Count
The number of files that are stored in this span.
16 32
Extended Record Info
(see description)
8 24
ext bytes
Size of extension bytes (actual always 8 bytes)
flags
Values:
Mask Name
Bit 5 0x20 meta in file
Bit 4 0x10 audio in file
Bit 3 0x08 last file time record
Bit 2 0x04 last file alarm record
Bit 1 0x02 first file time record
Bit 0 0x01 first file alarm record
rec density
Always 0
recorder version
FW version of the recorder.
reserved
Reserved.
2.86 CONF_CAMERA_CALIBRATION
[API: calibration]
2.87 CONF_CAMERA_LENS_CURVE
[API: video input]
Description
The command allows to query the lens transfer function of the camera. This command is not supported for
all cameras. In the case of CONF_DEVICE_CAPABILITIES -> PTZ_ON_CLIENT_TAG = TRUE A lens
curve must be present.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length Tag = 0x0000
2 Bytes 2 Bytes
Optical Center (p_string)
Length - 4 Bytes
8 24
Example
x;y = "16384;16384"
-> x = 16384, y = 16384 -> lens is centered
For a radius bigger than the last point the behavoiur of the lens is undefined (should be masked out in black
on the client)
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Lens transfer function (p_string)
Length - 4 Bytes
8 24
Example
lens transfer function =
"7189;20.469667;13815;40.049053;17223;50.729707;20151;60.518720;21646;65.859
-> p[0] = (radius = 7189, angle of incidence = 20.469667°)
-> p[1] = (radius = 13815, angle of incidence = 40.049053°)
-> p[2] = (radius = 17223, angle of incidence = 50.729707°)
-> p[3] = (radius = 20151, angle of incidence = 60.518720°)
-> p[4] = (radius = 21646, angle of incidence = 65.859047°)
2.88 CONF_CAMERA_LOCATION_METADATA
[API: calibration]
Description
Command CONF_CAMERA_LOCATION_METADATA allows to configure/retrieve several descriptive
location metadata fields, e.g. City, Country Code. The command has an internal tagged structure.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 0: City
Contains the city name as string, no zero termination.
16 32
Length Tag = 0x0000
2 Bytes 2 Bytes
City (p_string)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Zip Code (p_string)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
Country Code (p_string)
Length - 4 Bytes
8 24
Tag 3: Region
Specifies the region.
16 32
Length = 0x0021 Tag = 0x0003
2 Bytes 2 Bytes
Region (t_octet)
1 Byte
8 24
2.89 CONF_CAMERA_ORIENTATION
[API: calibration]
Description
The format has an internal tagged structure, the allowed tags can be queried via
CONF_CAMERA_POSITION_OPTIONS. (Support orientation calibration [0 no support, 1 pan only, 2
full support])
1: pan only: Tag 1 and 3 are supported
2: full support: Tag 1,2,3 and 4 are supported
All commands can be send in binary or string format. Only one configuration is valid.
Tag 1 (binary) and 3 (string) configure only pan angle for configuration tag 1 or 3 can used.
Tag 2 (binary) and 4 (string) configure can be used to configure the full camera orientation.
Read will always return both variant of one configuration (string + binary representation)
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x0000
2 Bytes 2 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0001
2 Bytes 2 Bytes
Pan Angle (t_dword)
4 Bytes
8 24
16 32
Length = 0x0010 Tag = 0x0002
2 Bytes 2 Bytes
pan (t_dword)
4 Bytes
tilt (t_dword)
4 Bytes
roll (t_dword)
4 Bytes
8 24
pan
Specifies the pan angle in units of (2*pi/(2^32))
tilt
Specifies the tilt angle in units of (2*pi/(2^32))
roll
Specifies the roll angle in units of (2*pi/(2^32))
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
Pan Angle String (p_string)
Length - 4 Bytes
8 24
Example
pan="3.455"
-> pan = 3.455°
16 32
Length Tag = 0x0004
2 Bytes 2 Bytes
Full Orientation String (p_string)
Length - 4 Bytes
8 24
2.90 CONF_CAMERA_POSITION
[API: calibration]
Description
The format has an internal tagged structure, the allowed tags can be queried via
CONF_CAMERA_POSITION_OPTIONS
(Byte[0] support local cartesian coordinate system [0 no, 1 yes];) 1 -> tag 1 and 2 are supported
(Byte[1] support wgs 1984 coordinate system [0 no, 1 yes]) 1 -> tag 3 and 4 are supported
Only a single set of coordinates can be used e.g. local coordinates or global WGS coordinates it is possible
to define the coordinates via a string or a binary command
Tag 1 (binary) and 3 (string) configure a local cartesian coordinate system.
Tag 2 (binary) and 4 (string) configure a wgs 1984 coordinate system.
Read will always return both variant of one configuration (string + binary representation)
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x0000
2 Bytes 2 Bytes
8 24
16 32
Length = 0x0010 Tag = 0x0001
2 Bytes 2 Bytes
X (t_dword)
4 Bytes
Y (t_dword)
4 Bytes
Z (t_dword)
4 Bytes
8 24
X
Specifies the x coordinate in units of 1/(2^16)
Y
Specifies the y coordinate in units of 1/(2^16)
Z
Specifies the z coordinate in units of 1/(2^16)
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
Cartesian Position String (p_string)
Length - 4 Bytes
8 24
Example
XYZ = "1000.124;145.3434;123.2355"
-> x= 1000.124 m, y = 145.3434 m, z = 123.2355
16 32
Length = 0x0018 Tag = 0x0002
2 Bytes 2 Bytes
Longitude (t_dword)
8 Bytes
Longitude (t_dword)
...
Latitude (t_dword)
8 Bytes
Latitude (t_dword)
...
Height (t_dword)
4 Bytes
8 24
Longitude
Specifies the longitude in units of (2*pi/(2^64))
Latitude
Specifies the latitude in units of (2*pi/(2^64))
Height
Signed value height above sea level in units of 1/(2^16) m
16 32
Length Tag = 0x0004
2 Bytes 2 Bytes
WGS 1984 Camera Position String (p_string)
Length - 4 Bytes
8 24
Example
longitude;latitude;height="12.45674964;45.456464;125.1234"
-> longitude = 12.45674964°, latitude = 45.456464°, 125.1234 m
2.91 CONF_CAMERA_POSITION_ALL
[API: calibration]
2.92 CONF_CAMERA_POSITION_OPTIONS
[API: calibration]
Payload Structure
16 32
LocalPosSupport WGS1984Support OrientationSupport Reserved
1 Byte 1 Byte 1 Byte 1 Byte
Reserved
4 Bytes
8 24
LocalPosSupport
Support local cartesian coordinate system
Values:
No 0
Yes 1
WGS1984Support
Support wgs 1984 coordinate system
Values:
No 0
Yes 1
OrientationSupport
Support pan, tilt, and/or roll orientation
Values:
No 0
Yes 1
2.93 CONF_CAMERA_SURROUNDING
[API: calibration]
Description
The format has an internal tagged structure, the allowed tags can be queried via
CONF_CAMERA_SURROUNDING_OPTIONS ([0: no, 1: flat plane only elevation can be configured
(plane is assumed to be parallel to the (world, local) coordinate system])
1 -> Tag 1 (binary) and 3 (string) configure a offset to the ground plane (orientation is derived from
(CONF_CAMERA_ORIENTATION))
Only a single surrounding configuration it is possible to define the coordinates via a string or a binary
command
Tag 1 (binary) and 3 (string) configure a elevation to the ground plane under the assumption that
the ground plane is parallel to the camera surrounding defined by (CONF_CAMERA_POSITION and
CONF_CAMERA_ORIENTATION) surrounding is defined by CONF_CAMERA_ORIENTATION [tilt,
roll] + CONF_CAMERA_SURROUNDING [elevation]
Read will always return both variant of one configuration (string + binary representation)
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x0000
2 Bytes 2 Bytes
8 24
Tag 1: Elevation
Specify the elevation relativ to the ground plane in units of 1/(2^16) m. Camera ground
model plane is parallel to coordinate system defined by (CONF_CAMERA_POSITION and
CONF_CAMERA_ORIENTATION).
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Elevation (t_int)
4 Bytes
8 24
Tag 3: Elevation
Specify the elevation relativ to the ground plane. Camera ground model plane is parallel to coordinate
system defined by (CONF_CAMERA_POSITION and CONF_CAMERA_ORIENTATION).
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
Elevation (p_string)
Length - 4 Bytes
8 24
Example
elevation = "1000.124"
-> elevation= 1000.124 m
2.94 CONF_CAMERA_SURROUNDING_OPTIONS
[API: calibration]
Payload Structure
16 32
Surrounding model Reserved
1 Byte 3 Bytes
Reserved
4 Bytes
8 24
Surrounding model
Values:
No 0
Flat plane 1 flat plane only elevation can be configured (plane is assumed to be parallel
to the (world, local) coordinate system
2.95 CONF_CAMNAME
[API: system.settings]
2.96 CONF_CAMNAME_LINES
[API: system.settings]
2.97 CONF_CAMNAME2
[API: system.settings]
2.98 CONF_CAPABILITY_LIST
[API: rcp.connection]
Payload Structure
16 32
0xBABA Version
2 Bytes 2 Bytes
Num Sections Section [0]
2 Bytes (see description)
...
8 24
Version
Current version of the capabilities
Num Sections
Number of following sections
Section
16 32
Type Size
2 Bytes 2 Bytes
Num Elements Element [0]
2 Bytes (see description)
...
8 24
Type
Type of Element
Values:
Video 0x0001
Audio 0x0002
Serial 0x0003
IO 0x0004
Camera Data 0x0005
Size
Size of the section including SectionType, Size and NbElement. If the section is unknown, you can skip
to the next using the size.
Num Elements
Determines how many Elements are following. The definition of each Element depends on the type of the
section.
Element
'Element' payload for 'Type' = 'Video Element' (0x0001)
8 16
Type
2 Bytes
Identifier
2 Bytes
Compression
2 Bytes
Input Number
2 Bytes
Resolution
2 Bytes
4 12
Type
Values:
VIDEO_ENCODER 0x0001
VIDEO_DECODER 0x0002
VIDEO_TRANSCODER 0x0003
Identifier
Identifier is the RCP numeric descriptor to use to address the entity. It should be unique when associated
with the type and the compression. In case of transcoders this numeric descriptor is informative only. It is
not necessary to address the entity directly (use the relevant rcp commands instead).
Compression
One or multiple of the following
Values:
VIDEO_COMP_MPEG2 0x0001
VIDEO_COMP_MPEG4 0x0002
VIDEO_COMP_H264 0x0004
VIDEO_COMP_JPEG 0x0008
VIDEO_COMP_H265 0x0010
Input Number
Input Number is the number of the physical input from which the entity gets or puts its video. In case of
transcoder this value is unused and set to 0.
Resolution
One or multiple of the following
Values:
VIDEO_RESO_QCIF 0x0001
VIDEO_RESO_CIF 0x0002
VIDEO_RESO_2CIF 0x0004
VIDEO_RESO_4CIF 0x0008
VIDEO_RESO_CUSTOM 0x0010
VIDEO_RESO_QVGA 0x0020
VIDEO_RESO_VGA 0x0040
VIDEO_RESO_HD720 0x0080
VIDEO_RESO_HD1080 0x0100
VIDEO_RESO_WD144 0x0200
VIDEO_RESO_WD288 0x0400
VIDEO_RESO_WD432 0x0800
VIDEO_RESO_HD2592x1944 0x1000
Note: This list is not further maintained/extended. If additional resolutions are supported, the
VIDEO_RESO_CUSTOM value is set and the available resolutions can be obtained via the command
CONF_VID_H264_ENC_BASE_OPERATION_MODE_CAPS. For JPEG encoders the available
resolutions can be obtained via the command CONF_JPEG_STREAM_SETUP_OPTIONS_VERBOSE.
Type
Values:
AUDIO_ENCODER 0x0001
AUDIO_DECODER 0x0002
Identifier
Identifier is the RCP numeric descriptor to use to address the entity. It should be unique when associated
with the type and the compression.
Compression
One or multiple of the following
Values:
AUDIO_COMP_MPEG2 0x0001
AUDIO_COMP_G711 0x0002
AUDIO_COMP_AAC 0x0004
Type
Values:
SERIAL_RS232 0x0001
SERIAL_RS485 0x0002
SERIAL_RS422 0x0004
Identifier
RCP numeric descriptor to use to address the entity.
Type
Values:
IO_INPUT 0x0001
IO_OUTPUT 0x0002
IO_VIRTUAL_IN 0x0004
Identifier
RCP numeric descriptor to use to address the entity.
Type
Values:
CAMDATA_BILINX 0x0001
Identifier
RCP numeric descriptor to use to address the entity.
2.99 CONF_CBS_COMMISSION
[API: Cbs]
Payload Structure
16 32
Action User
1 Byte N Bytes
Password
N Bytes
8 24
Action
Cancel Commission 0
Start Commission 1
User
User name (0-terminated, max-len 128)
Password
User password (0-terminated, max-len 128)
2.100 CONF_CBS_DESTINATION
[API: Cbs]
Payload Structure
16 32
Port SSL reserved...
2 Bytes 1 Byte 5 Bytes
reserved
...
URL
N Bytes
8 24
Port
Destination port
SSL
SSL Socket not provided 0
SSL Socket provided 1
reserved
Reserved for future use. Set to zero.
URL
Destination URL (0-terminated, max-len 128)
Example
Payload for port 443, ssl 1, url "api.remote.boschsecurity.com"
0x01bb0100000000006170692e72656d6f74652e626f73636873656375726974792e636f6d00
0x01bb0100000000006170692e72656d6f746573742e6362732e626f736368736563757269747
2.101 CONF_CBS_STATUS
[API: Cbs]
Payload Structure
8 16
cbs status cbs action status
1 Byte 1 Byte
4 12
cbs status
Is a status byte for the Remote Portal connection
Registered 0
OnGoing 1
UnRegistered 2
Unknown 255
Ok 0
OnGoing 1
UnRegistered 2
Canceled 3
Reconfiguration Forbidden 0xe0
Reconfiguration Conflict 0xe1
Reconfiguration UnprocessibleEntity 0xe2
Reconfiguration Locked 0xe3
Reconfiguration ServiceUnavailable 0xe4
Reconfiguration AuthError 0xe5
CloudConnector not running 0xf5
CloudDestinationError 0xf6
2.102 CONF_CERTIFICATE
[API: cert store]
Description
The command CONF_CERTIFICATE supports the following operations:
• Upload a certificate optionally including its private key.
• Download a certificate or signing request from the device.
• Delete a certificate or signing request. A delete implicitly deletes an associated private key.
Each certificate/signing request/key is identified by a unique label. If a certificate has a matching private key
both have the same label. When the command fails it returns a command specific error code in the payload.
On upload the command supports the following file formats:
• PEM: PEM file format. With this format you can upload a certificate and a key at once. For
this you must set Certificate and Private Key bits in type tag.
• DER: Binary DER file format. For this file format you can only upload one type of content
and the type must be exactly specified in type tag.
• PKCS#12 or PFX: PKCS#12 (sometimes also called PFX) file format. This file format
carried information what is included, so you can upload certificate and key in one file. The
type tag does not matter when using this file format and can be set to certificate and key
or even be not provided.
On download the command currently only supports the PEM file format
You can also use this command to upload encrypted private keys as PEM, DER or PKCS12 file. To do this
you upload the file containing the encrypted key. The device stores the encrypted key internally and waits,
that the password is provided later with help of the CONF_CERTIFICATE_REQUEST command.
To delete a certificate/CSR or key you have to provide the following tags: Tag 0 with the label, tag 1 with
0, tag 2 with length 4 and no data and tag 3 with entry type 0xFF (delete).
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 0: Label
Contains the label string, no zero termination. For the maximum supported length see
CONF_CERTIFICATE_OPTIONS.
16 32
Length Tag = 0x0000
2 Bytes 2 Bytes
Label (p_string)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0001
2 Bytes 2 Bytes
Data Format (t_dword)
4 Bytes
8 24
Values:
PEM 0
DER 1
PKCS#2 / PFX 2
Tag 2: Data
Contains the certificate/signing request/key data in the specified format. If this tag contains no data (zero
payload length) the corresponding entry is deleted from the device.
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
Data (p_octet)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0003
2 Bytes 2 Bytes
Entry Type (t_dword)
4 Bytes
8 24
Values:
Certificate 1
Signing Request (read or delete) 2
Private key (write only) 4
Pem 5
Encryption key (write only) 8
CombinedEncryptedKey 13
Any type (delete only) 255
16 32
Length = 0x0024 Tag = 0x0004
2 Bytes 2 Bytes
Tag Protection (t_dword)
4 Bytes
8 24
Values:
Mask Name Description
Bit 0 0x00000001 Factory Reset Protect at factory reset. (Note: on CPP13 this
only works for trusted certficates without key.
Any corresponding keys would be deleted)
Example
Delete cert with label 'test':
2.103 CONF_CERTIFICATE_LIST
[API: cert store]
Description
Command CONF_CERTIFICATE_LIST allows to query the labels of all certificates, signing requests and
keys installed on a device. The command CONF_CERTIFICATE can then be used to retrieve a certificate
or signing request using the label. The format has an internal tagged structure. Some tags are optional and
might be absent if the data is not available. The tags are always in the sequence as listed below.
Payload Structure
...
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x0000
2 Bytes 2 Bytes
8 24
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Entry Label (p_string)
Length - 4 Bytes
8 24
Tag 2: Type
Contains the entry type bitmask. All types with the same label are listed together as one entry.
16 32
Length = 0x0024 Tag = 0x0002
2 Bytes 2 Bytes
Type (t_dword)
4 Bytes
8 24
Mask Name
Bit 7 0x00000080 Encrypted PKCS#12
Bit 6 0x00000040 Key decryption in progress
Bit 5 0x00000020 Signing request generation in
progress
Bit 4 0x00000010 Certificate generation in
progress
Bit 3 0x00000008 Encrypted private key
Bit 2 0x00000004 Private key
Bit 1 0x00000002 Signing request
Bit 0 0x00000001 Certificate
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
Subject common name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0004
2 Bytes 2 Bytes
Protection BitmapType (t_dword)
4 Bytes
8 24
Mask Name
Bit 1 0x00000002 Protect from manual deletion
Bit 0 0x00000001 Protect at factory reset
16 32
Length Tag = 0x0005
2 Bytes 2 Bytes
Issuer common name (p_unicode)
Length - 4 Bytes
8 24
GT) is present you should always use the date from there as UTC is limited to 1950-01-01 up to 2049-12-31.
For compatibility reason both tags will be present when the date can be presented in both formats.
16 32
Length Tag = 0x0006
2 Bytes 2 Bytes
Not after timestamp in UTC (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0007
2 Bytes 2 Bytes
Not after timestamp in GT (p_unicode)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0008
2 Bytes 2 Bytes
Key Type (t_dword)
4 Bytes
8 24
2.104 CONF_CERTIFICATE_OPTIONS
[API: cert store]
Payload Structure
16 32
Max label length
4 Bytes
Certificate
reserved
store support
3 Bytes
1 Byte
8 24
2.105 CONF_CERTIFICATE_REQUEST
[API: cert store]
Description
The command CONF_CERTIFICATE_REQUEST allows to start a certificate signing request or a key
decryption operation. Since both operations may take some time to complete, this command may return
before the actual completion of the operation. The progress of the operation can be tracked by registering
for the CONF_CERTIFICATE_REQUEST_PROGRESS message.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 0: Label
Contains the label string, no zero termination. Access the generated private key and the signed certificate
using the provided label after the process has finished successfully. For key decryption this label is used
to identify the key to be decrypted.
16 32
Length Tag = 0x0000
2 Bytes 2 Bytes
Label (p_string)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0001
2 Bytes 2 Bytes
Key Type (t_dword)
4 Bytes
8 24
Tag 2: Type
Below enumeration lists example values for the key type association:
16 32
Length = 0x0024 Tag = 0x0002
2 Bytes 2 Bytes
Type (t_dword)
4 Bytes
8 24
Values:
PKCS10 0 Create PKCS#10 CSR
SelfSigned 3 Create self-signed certificate
Decrypt 4 Decrypt private key
SCEP 5 SCEP certificate enrollment
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
CA Server FQHN (p_string)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0004
2 Bytes 2 Bytes
CA Server Port (t_dword)
4 Bytes
8 24
16 32
Length Tag = 0x0005
2 Bytes 2 Bytes
Common Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0006
2 Bytes 2 Bytes
Organization Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0007
2 Bytes 2 Bytes
Unit Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0008
2 Bytes 2 Bytes
Locality Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0009
2 Bytes 2 Bytes
Country Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x000a
2 Bytes 2 Bytes
State or Province Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x000b
2 Bytes 2 Bytes
Password (p_string)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x000c
2 Bytes 2 Bytes
Certificate Extension (p_octet)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x000d
2 Bytes 2 Bytes
Service Path (p_string)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x000e
2 Bytes 2 Bytes
Challenge Password (p_string)
Length - 4 Bytes
8 24
2.106 CONF_CERTIFICATE_REQUEST_OPTIONS
[API: cert store]
Payload Structure
16 32
Max label length
4 Bytes
Max IP string length
4 Bytes
Number of supported key types
4 Bytes
Number of supported cmd types
4 Bytes
Key Type Description [0]
(see description)
...
...
2.107 CONF_CERTIFICATE_REQUEST_PROGRESS
[API: cert store]
Description
This message informs about the current status of certificate/signing request/key operations started by a
CONF_CERTIFICATE_REQUEST. The format has an internal tagged structure.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x000c Tag = 0x0000
2 Bytes 2 Bytes
Type (t_dword)
4 Bytes
Status (t_dword)
4 Bytes
8 24
Type
PKCS10 0 Create PKCS#10 CSR
SelfSigned 3 Create self-signed certificate
Descrypt 4 Decrypt private key
Status
Values in the range of 0 to 100 represent the current status, other values need to be handled as error.
Status values:
Generating request 25
Sending request 50
Request completed successfully 100
Error values:
General error 129
File already exists error 130
No free key entry error 131
No storage space error 132
Server error 133
Decrypt error 134
Entry not found error 135
No certificate found for key error 136
Tag 1: Label
Contains the certificate/signing request/key label, no zero termination.
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Label (p_string)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
New Label (p_string)
Length - 4 Bytes
8 24
2.108 CONF_CERTIFICATE_USAGE
[API: cert store]
Description
Command CONF_CERTIFICATE_USAGE allows to configure for which purpose the certificates and keys
on the device are used. The format has an internal tagged structure, the allowed tags and values can be
queried via CONF_CERTIFICATE_USAGE_OPTIONS.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 0: CertUsageID
Contains the certificate usage ID. This tag is mandatory for the read and write commands and
should appear only once. The available usages and their corresponding IDs can be queried via
CONF_CERTIFICATE_USAGE_OPTIONS
16 32
Length = 0x0024 Tag = 0x0000
2 Bytes 2 Bytes
CertUsageID (t_dword)
4 Bytes
8 24
There are two types of certificate usages that can be distinguished by the highest bit (bit 31) of the
CertUsageID:
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Certificate/Key label (p_string)
Length - 4 Bytes
8 24
2.109 CONF_CERTIFICATE_USAGE_OPTIONS
[API: cert store]
Description
This command returns the list of certificate usages available in the camera. Each usage has a unique ID
and a label which can be presented to the end user. In the CONF_CERTIFICATE_USAGE command the
usageID is referenced.
Payload Structure
16 32
Write support
4 Bytes
Max Label Length
4 Bytes
Max Number Of Labels
4 Bytes
Number Of Usages
4 Bytes
Usage Entry [0]
(see description)
...
Usage Entry [
Number Of Usages
- 1]
(see description)
8 24
Write support
Write Not Supported 0
Write Supported 1
Number Of Usages
Amount of usage entries following after this entry.
Usage Entry
16 32
Usage ID
4 Bytes
Label (p_string)
Max Label Length + 1 Bytes
8 24
Usage ID
This bit mask contains a unique numerical ID for this usage. Bits 31 and 30 are not part of this numerical
ID and have a special meaning. They indicate properties of this usage regarding the certificates which can
be associated with this usage.
2.110 CONF_CHECK_DEFAULT_BUTTON_STATE
[API: system.status]
2.111 CONF_CHECK_POS_FB_STATE
[API: system.status]
Values:
Mask Name
Bit 1 0x02 hall sensor
Bit 0 0x01 end position fb switch
2.112
CONF_CHECK_WS_USERNAMETOKEN_AUTH_TIMESTAMP
[API: onvif]
2.113 CONF_CLOUD_COMMISSIONING_STATUS
[API: system.status]
2.114 CONF_CLOUD_WATCH_SETTINGS
[API: CloudWatch]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: ACCOUNT_TAG_TYPE
16 32
Tag = 0x0001 Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_TYPE (t_dword)
4 Bytes
8 24
Values:
not configured 0
ftp 1
dropbox 2
amazon s3 5
kinesis 6
Tag 2: ACCOUNT_TAG_NAME
account name
16 32
Tag = 0x0002 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_NAME (p_string)
Length Bytes
8 24
Tag 3: ACCOUNT_TAG_URL
url, e.g url to the ftp server
16 32
Tag = 0x0003 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_URL (p_string)
Length Bytes
8 24
Tag 4: ACCOUNT_TAG_LOGIN
username
16 32
Tag = 0x0004 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_LOGIN (p_string)
Length Bytes
8 24
Tag 5: ACCOUNT_TAG_PASSWORD
password
16 32
Tag = 0x0005 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_PASSWORD (p_string)
Length Bytes
8 24
Tag 6: ACCOUNT_TAG_PATH
path
16 32
Tag = 0x0006 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_PATH (p_string)
Length Bytes
8 24
Tag 7: ACCOUNT_TAG_FLAGS
optional flags
16 32
Tag = 0x0007 Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_FLAGS (t_dword)
4 Bytes
8 24
Values:
FTP Encryption mode off 0
FTP Encryption mode TLS 1
Tag 8: ACCOUNT_TAG_ACCESS_KEY
aws access key (max 128 bytes)
16 32
Tag = 0x0008 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_ACCESS_KEY (p_string)
Length Bytes
8 24
Tag 9: ACCOUNT_TAG_SECRET_KEY
aws secret access key (max 128 bytes)
16 32
Tag = 0x0009 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_SECRET_KEY (p_string)
Length Bytes
8 24
16 32
Tag = 0x000a Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_BUCKET_NAME (p_string)
Length Bytes
8 24
16 32
Tag = 0x000b Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_REGION (p_string)
Length Bytes
8 24
16 32
Tag = 0x000c Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_CAMERA_ID (p_string)
Length Bytes
8 24
16 32
Tag = 0x000d Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_FILE_DURATION (t_dword)
4 Bytes
8 24
16 32
Tag = 0x000e Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_STREAM_NAME (p_string)
Length Bytes
8 24
16 32
Tag = 0x000f Length = 0x0004
2 Bytes 2 Bytes
ACCOUNT_TAG_KBPS (t_dword)
4 Bytes
8 24
16 32
Tag = 0x0010 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_GROUP (p_string)
Length Bytes
8 24
16 32
Tag = 0x0011 Length = 0x0001
2 Bytes 2 Bytes
ACCOUNT_TAG_CLOUD_WATCH_ENABLED (t_octet)
1 Byte
8 24
16 32
Tag = 0x0012 Length = 0x0001
2 Bytes 2 Bytes
ACCOUNT_TAG_KMS_ENABLED (t_octet)
1 Byte
8 24
16 32
Tag = 0x0013 Length = 0x000
2 Bytes 2 Bytes
ACCOUNT_TAG_KMS_KEY_ID (p_string)
Length Bytes
8 24
2.115 CONF_CLUSTER_GROUP_SETTING
[API: system.settings]
2.116 CONF_CLUSTER_ID
[API: system.settings]
2.117 CONF_CODER_SPECIFIC_ENC_PROFILES
[API: encoder]
2.118 CONF_CODER_VIDEO_OPERATION_MODE
[API: encoder]
Description
There are two different modes signaled via INDIVIDUAL_ENCODER_OPERATION_MODE_CONFIG
@CONF_DEVICE_CAPABILITIES
1: invidual encoder configuration mode:
CONF_CODER_VIDEO_OPERATION_MODE, num parameter for a specific absolute coder has to be
provided; global configration (numDesc = 0) is not supported
0: global encoder configuration mode :
CONF_CODER_VIDEO_OPERATION_MODE, num parameter supports only 0 as global option for all
possible encoders
1: invidual encoder configuration mode:
use CONF_CODER_VIDEO_OPERATION_MODE_OPTIONS with NumDesc = absolute coder number
to get the supported options at CONF_CODER_VIDEO_OPERATION_MODE
0: global encoder configuration mode :
use CONF_CODER_VIDEO_OPERATION_MODE_OPTIONS with NumDesc = 0 to get the supported
global options at CONF_CODER_VIDEO_OPERATION_MODE
Set one video coder (absolute coder number given by NumDesc) or all video coders, which can handle the
option, depending on the supported configuration mode, to a video operation mode.
Allowed options can be queried by CONF_CODER_VIDEO_OPERATION_MODE_OPTIONS: 0 = jpeg,
1 = h263, 2 = h264, 3 = h265, 0x103 = h_265 without B-Frames.
Live connections will be dropped; Only applicable if recording isn't active and configured to off.
2.119
CONF_CODER_VIDEO_OPERATION_MODE_OPTIONS
[API: encoder]
Payload Structure
Option [0]
4 Bytes
...
Option [N]
4 Bytes
Option
Values:
jpeg 0
h263 1
h264 2
h265 3
h_265 without B- 0x0103 h_265 without B-Frames delivers higher framerates
Frames
2.120 CONF_COMMERCIAL_TYPE_NUMBER
[API: system.settings]
2.121 CONF_COMMISSION_SETUP
[API: commissioning]
Flags
Mask Name Description
Bit 3 0x8 Commissioning Available This camera has commisioning
Bit 2 0x4 Is Initialized Commissioning is ready to use
Bit 1 0x2 Last Command Failed set to 1 on fail, will be set to 0 with each write
command.
Bit 0 0x1 Running Last write command is still processing
Coordinates are relative in 1/0x8000. Corner top left is (0,0), bottom right is (0x8000,0x8000). If new view
top left coordinate is same as new view bottom right coordinate, zoom will not be changed, just view is
repositioned.
2.122 CONF_COMPLETE_CALIBRATION_ELEMENT
[API: calibration]
2.123 CONF_CONFIG_SEALING_ENABLED
[API: system.status]
2.124 CONF_CONFIG_SEALING_STATUS
[API: system.status]
Description
The system can be set up in a way that unexpected configuration changes on the device cause a alert message,
even when the user uses a valid login and password for this action.
After the whole system configuration is completed CONFIG_SEALING_ENABLED needs to be set
to 1 (= Seal enabled). In this state each critical configuration change causes the device to send a
CONFIG_SEALING_STATUS message.
If a client wants to activly verify if a seal is valid then it should read CONFIG_SEALING_STATUS.
Payload Structure
16 32
Status Reserved
1 Byte 3 Bytes
SealSetTimestamp
4 Bytes
SealRandom
4 Bytes
SystemTimestamp
4 Bytes
8 24
Status
Sealing off 0
Sealing on and seal valid 1
Sealing on and seal broken 2
SealSetTimestamp
Timestamp when seal was activated in seconds since year 2000.
SealRandom
Random number generated once when seal was activated.
SystemTimestamp
Current system time in seconds since year 2000. Can be used to protect against time manipulation on
SealSetTimestamp
2.125 CONF_CONNECT_PRIMITIVE
[API: rcp.connection]
Description
Each RCP client may have different media sources and media receivers. To connect these media channels, a
low level connect/disconnect primitive is implemented. These low level primitives can be grouped together
to more complex commands, which can connect more than one media channel at the same time. The
primitives are designed to be asserted by media sources or receivers itself. Manager software should use
the high level commands (see next chapter).
By sending a CONNECT GET to the remote endpoint, this endpoint will start sending media to the requested
address. For example, a VideoJet receiver is registered at a VideoJet transmitter. On sending a ‘CONNECT
GET video to port 1234’ to the transmitter, the transmitter starts to send video to the appropriate port at
the receiver. The endpoint requesting the media stream (the VideoJet receiver) must be prepared to receive
the stream from the network. The coding bits for video must be set according to the receivers capability to
decode the data stream. E.g. a Decoder capable of decoding MPEG2 and MPEG4 should set all these bits.
By sending a CONNECT PUT to the remote endpoint, the endpoint will prepare itself for receiving data
from the one initiating the request. For example, a VideoJet transmitter is registered at a VideoJet receiver.
On sending a ‘CONNECT PUT video to port 2222’ to the receiver, the receiver will prepare its network stack
to receive data from the appropriate port. The endpoint initiating the media stream (the VideoJet transmitter)
must start sending the media stream to the network. The coding bits for video must be set to a value suitable
to the current encoding parameters inside the VideoJet. E.g. if a video encoder is set to encode MPEG4,
only a PUT request having these bits set is accepted. The coder parameter is used to address a specific
encoder/decoder inside the VideoJet. As the VideoJet may have a Dual-stream feature, one physical line
input might be connected to more than one encoder. By setting a coder to another value than 0, the VideoJet
only tries this specific coder to establish a connection. When the coder value is set to 0, all coders inside the
system will be checked. Each connect primitive will result in a Session ID for maintaining and controlling
the media stream with other RCP commands. The Session ID can be treated as unique on the entire system.
By sending a DISCONNECT supplied with a valid Session ID, the receiver of the command will stop
sending/receiving to/from the media stream. The endpoint initiating the DISCONNECT command must
stop receiving/sending from/to the media stream.
Payload Structure
Item [0]
(see description)
...
Item [N]
(see description)
Item
16 32
Method Media Reserved Header Flags
1 Byte 1 Byte 1 Byte 1 Byte
Reserved
4 Bytes
Media Descriptor [0]
(see description)
...
Method
Values:
Get 0x00
Put 0x01
Key Transport 0xE0
Media
Values:
Video 1
Audio 2
Data 3
Header Flags
Mask Name Description
Bit 7 0x80 Multi ROI capable This Bit signals that a client is able to provide
a session ID to steer multiple ROIs (region of
interrest) with E-PTZ.
Bit 6 0x40 Media over ssl This Bit is set in the response to signal that the
device supports 'media over ssl'.
Bit 5 0x20 Transcoder Set this bit to instanciate and establish a connection
to the transcoder.
Bit 4 0x10 Dry Connect If this bit is set a replay connection is established
(and a session id to control the replay
connection is returned). The replay source
is not connected. This can be done using the
CONF_RCP_CONNECT_SALVO command.
Bit 3 0x08 Media Key Media key request (when using GET) / Media key
is appended at the end of this section (when using
PUT)
Bit 2 0x04 Signalling Optional signalling for streaming (for correct
connection list display)
Bit 1 0x02 Free Running Connection When this bit is set, the connection does
not need to be re-triggered by the command
CONF_RCP_CONNECTIONS_ALIVE.
Bit 0 0x01 Do reverse Login This will control whether the called server will
perform a reverse RCP Login.
Media Descriptor
'Media Descriptor' payload for 'Media' = 'Video' (1)
16 32
MEP Flags MTA Port
1 Byte 1 Byte 2 Bytes
MTA IP Address
4 Bytes
Coder Line MCTA Port
1 Byte 1 Byte 2 Bytes
MCTA IP Address
4 Bytes
Coding Resolution
2 Bytes 2 Bytes
Linked Coder Linked Line Flags2
1 Byte 1 Byte 2 Bytes
Key (conditional)
(see description)
8 24
MEP
Media Encapsulation Protocol.
Values:
RTP over UDP 0x01
RTP over TCP 0x04
Note: When using RTP over TCP, media channels must be established as described in 'RCP Protocol
Procedure / Receiving media data'.
Flags
Mask Name Description
Bit 6 0x40 ExclusiveROI Request an exclusive (ROI) stream. (Only applicaple
if device is in multi ROI mode and an exclusive
coder is still available).
Bit 2 0x04 UseFlags2 Flags2 are used
Bit 1 0x02 RelativeNumber Use relative to line coder addressing.
Bit 0 0x01 Substitute Substitute connection (if an RX connection to the
requested interface is already established, the old
connection will be disconnected and substituted by a
new connection coming with this request).
MTA Port
Media Transport Address - Network port.
MTA IP Address
Media Transport Address IP Address
Values:
0.0.0.0 VideoJet will take address from the incoming TCP header
224.0.0.0 VideoJet will take its configured multicast group IP
Coder
Specifies the internal coder number; when set to 0, the appropriate coder corresponding to the given line
number and/or coding parameter is chosen by the VideoJet itself.
Line
Identifies the Line Input/Output channel for the specified coding engine.
MCTA Port
Media Control Transport Address Network Port. Currently unused.
MCTA IP Address
Media Control Transport Address IP Address. Currently unused.
Coding
Mask Name Description
Bit 15 0x8000 Mpeg2Prog MPEG-2 (program stream)
Bit 14 0x4000 RecordedMedia Recorded Media
Bit 9 0x0200 H265 H265
Bit 7 0x0080 Jpeg JPEG
Bit 6 0x0040 H264 H264
Bit 4 0x0010
Bit 3 0x0008 Mpeg2 MPEG-2 (only video)
Bit 2 0x0004 Mpeg4 MPEG-4 (elementary stream)
Resolution [Obsolete]
Mask Name
Bit 11 0x0800 WD432
Bit 10 0x0400 WD288
Bit 9 0x0200 WD144
Bit 8 0x0100 HD1080
Bit 7 0x0080 HD720
Bit 6 0x0040 VGA
Bit 5 0x0020 QVGA
Bit 3 0x0008 4CIF
Bit 2 0x0004 2CIF
Bit 1 0x0002 CIF
Bit 0 0x0001 QCIF
Linked Coder
Use this field for signalling the callers local coder in the connection list of the called device.
Linked Line
Use this field for signalling the callers local line in the connection list of the called device.
Flags2
Only evaluated if Bit3 of Flags is set. For internal usage
Key (conditional)
See description of 'Key transport'
MEP
Media Encapsulation Protocol.
Values:
RTP over UDP 0x01
RTP over TCP 0x04
Flags
Mask Name Description
Bit 1 0x02 RelativeNumber Use relative to line coder addressing.
Bit 0 0x01 Substitute Substitute connection (if an RX connection to the
requested interface is already established, the old
connection will be disconnected and substituted by a
new connection coming with this request).
MTA Port
Media Transport Address - Network port.
MTA IP Address
Media Transport Address IP Address
Values:
0.0.0.0 VideoJet will take address from the incoming TCP header
224.0.0.0 VideoJet will take its configured multicast group IP
Coder
Specifies the internal coder number; when set to 0, the appropriate coder corresponding to the given line
number and/or coding parameter is chosen by the VideoJet itself.
Line
Identifies the Line Input/Output channel for the specified coding engine.
MCTA Port
Media Control Transport Address Network Port. Currently unused.
MCTA IP Address
Media Control Transport Address IP Address. Currently unused.
Coding
Mask Name Description
Bit 15 0x8000 Mpeg2Prog MPEG-2 (program stream)
Bit 14 0x4000 RecordedMedia Recorded Media
Bit 4 0x0010 L16 L16 (sampling rate: 16 kHz, rtp clock rate: 90
kHz)
Bit 3 0x0008 L16 16kHz L16_16kHz (sampling rate: 16 kHz, rtp clock
rate: 16 kHz)
Bit 2 0x0004 G711 8kHz G.711_8kHz (sampling rate: 8 kHz, rtp clock
rate: 8 kHz)
Bit 1 0x0002 AAC
Bit 0 0x0001 G711 G.711 (sampling rate: 8 kHz, rtp clock rate: 90
kHz)
Linked Coder
Use this field for signalling the callers local coder in the connection list of the called device.
Linked Line
Use this field for signalling the callers local line in the connection list of the called device.
Key (conditional)
See description of 'Key transport'
MEP
Media Encapsulation Protocol.
Values:
RCP Intrinsic 0x02
MTA IP Address
Media Transport Address IP Address
Values:
0.0.0.0 VideoJet will take address from the incoming TCP header
Coder
Informational
Line
Identifies the Line Input/Output channel for the specified coding engine.
Coding
Mask Name Description
Bit 14 0x4000 RecordedMedia Recorded Media
Bit 0 0x0001 RCP
Linked Coder
Use this field for signalling the callers local coder in the connection list of the called device.
Linked Line
Use this field for signalling the callers local line in the connection list of the called device.
Key (conditional)
See description of 'Key transport'
...
Key [N]
(see description)
Key
16 32
Method Bytes valid Status tag Reserved
1 Byte 1 Byte 1 Byte 1 Byte
Key data
4 Bytes
8 24
Method
Must be set to 'Key transport' 0xE0
Bytes valid
The number of valid key bytes in this header
Status tag
Must be set to 'Key transport tag' 0xE0
Key data
The key payload
The media key is transferred using a sequence of key headers all with the method field set to 0xE0. The end
of the key section is marked by a header with less than 4 bytes (or zero) indicated in the bytes valid field.
The typical key length is 16 bytes (128 bit AES). In this case, four full key headers followed by one empty
header must be transferred (4 x 4 bytes valid + 1 x 0 bytes valid = 16 bytes). For backward compatibility,
the header method 0xE0 will be skipped by units with former firmwares versions. The key is located and
stored on each media source (using the CONF_CRYPT_KEY* commands); When the system is configured
to publish its keys (see CONF_PUBLISH_MEDIA_KEYS), then the media sources must fill in the secret
by sending (PUT method) or replying to (GET method) the connect primitive. For example, when sending
a GET connect primitive to a device and the key transport is selected, then the device will fill in its key in
the reply to the connect primitive.
Note: Be sure to use a secure RCP connection, the keys in the connect primitive are tranferred in plain
Response Payload Structure
Item [0]
(see description)
...
Item [N]
(see description)
Item
16 32
Method Media Status Flags
1 Byte 1 Byte 1 Byte 1 Byte
Reserved
4 Bytes
Media Descriptor [0]
4 Bytes
...
Method
Values:
Get 0
Put 1
Media
Values:
Video 1
Audio 2
Data 3
Status
Values:
InterfaceUnavailable 0 Interface not available (Remark: former version may return this
error in case of unknown method/media type)
AccessGranted 1 Access to this interface granted
AccessDenied 2 Access to this interface rejected
InvalidIdOrConnectionLoss 3 Session ID invalid or connection no longer active
CodingIncompatible 4 Coding parameters incompatible
ExternalData 5 Interface data will be supplied by another media descriptor
UnknownMethod 8 The method field in the header does not carry a known method
UnknownMedia 9 The media field in the header does not carry a known media type
Note: Any wildcards used in the transport addresses will be replaced by the real used network
addresses. This command is NOT readable; to gain information on active connection refer to the
ACTIVE_CONNECTION_LIST command. The Media Control sockets have currently no function
2.126 CONF_CONNECT_TO
[API: rcp.connection]
Description
A message will be generated if all requested channels are established or respectivly failed; if a channel fails,
the appropriate bit will be cleared in the channel section.
Payload Structure
16 32
Destination IP Address
4 Bytes
Reserved Line Flags
1 Byte 1 Byte 2 Bytes
Local Coder Local Line Put Channel
1 Byte 1 Byte 2 Bytes
Remote Coder Remote Line Get Channels
1 Byte 1 Byte 2 Bytes
Appendix (optional)
(see description)
8 24
Destination IP Address
The reception of this command will force the host to connect to the mentioned destination IP address.
Line [Obsolete]
This parameter carries the number of the remote input (for get channels) or the local input (for put channels);
For connection to the HDD, the Line byte must carry the partition number of the HD. This parameter is
updated by the local line/coder and remote line/coder settings.
Flags
Mask Name Description
Bit 13 0x2000 H265 Request video mode H.265
Bit 12 0x1000 AllowAAC Allow audio mode AAC
Bit 11 0x0800 AllowL16 Allow audio mode L16 (setting this bit to
0 uses G711 (default, previous behaviour),
setting to 1 allows G.711 and L16 - both with
90kHz timestamp clock)
Bit 10 0x0400 Jpeg Request video mode JPEG
Bit 9 0x0200 H264 Request video mode H.264
Bit 8 0x0100 UseSSL Use SSL for the RCP control connection; if
no destination port is specified, the remote
port defaults to 443 (HTTPS) in case of SSL is
requested otherwise 80(HTTP)
Bit 7 0x0080 NoKeyExchange Supress automatic media key exchange
Bit 6 0x0040 ConnectVCA Connect a VCA meta data stream
Bit 4 0x0010 ConnectHDD Connect to the HDD to receive a recorded
media stream
Bit 3 0x0008 ForceTCP Force the use of TCP as transportation protocol
Bit 2 0x0004 Mpeg2 Request video mode MPEG-4
Bit 1 0x0002 Mpeg4 Request video mode MPEG-2
Bit 0 0x0001 Substitute Substitute an existing connection
Note: Only one video standard (MPEG2/4) can be used; setting all bits will result in best currently available
mode.
Local Coder
This parameter carries the number of the local coder number. A wildcard of ‘0’ will result in first match.
Local Line
This parameter carries the number of the local video line number. A wildcard of ‘0’ will result in first match.
Put Channel
Mask Name
Bit 2 0x0004 Data
Bit 1 0x0002 Audio
Bit 0 0x0001 Video
Remote Coder
This parameter carries the number of the remote coder number (at the destination IP). A wildcard of ‘0’
will result in first match.
Remote Line
This parameter carries the number of the remote video line number (at the destination IP). A wildcard of
‘0’ will result in first match.
Get Channels
Mask Name
Bit 2 0x0004 Data
Bit 1 0x0002 Audio
Bit 0 0x0001 Video
Note: For audio connections, the local and remote line parameter are taken from the video settings.
Appendix (optional)
If this command is extended with the optional appendix, the remote port number for RCP login must be
specified. This can be either 1756 for the normal RCP port or any available HTTP port at the remote host.
When a port number different to 1756 is used, the login will use a HTTP tunnelling.
16 32
Dest. Port Flags
2 Bytes 2 Bytes
Reserved Remote password level Password (optional)
2 Bytes 1 Byte (see description)
8 24
Dest. Port
This parameter carries the number of the remote TCP port number used for RCP login.
Flags
Mask Name Description
Bit 0 0x0001 IsURL Remote password field is url (supports urls like
rtsp://user:[email protected]:5540/rtsp_tunnel)
Password (optional)
16 32
Password length Password
1 Byte Password length Bytes
8 24
2.127 CONF_CONNECT_URL
[API: alarm connections]
2.128 CONF_CONT_VIPROC_CONFIG_EDITING
[API: viproc]
2.129 CONF_CPU_COUNT
[API: system.settings]
2.130 CONF_CPU_LOAD
[API: system.status]
Description
Read the CPU load information from a device.
Num Descriptor Values
Host 1
CoProc 2
Payload Structure
16 32
Idle Coder VCA LocalRecording
1 Byte 1 Byte 1 Byte 1 Byte
8 24
Idle
Idle time of CPU in percent.
Coder
Coder time of CPU in percent. Only supported on CPP6/CPP7/CPP7.3, '0' otherwise
VCA
VCA time of CPU in percent. Only supported on CPP6/CPP7/CPP7.3, '0' otherwise
LocalRecording
Local recording time of CPU in percent. Only supported on CPP6/CPP7/CPP7.3, '0' otherwise
2.131 CONF_CPU_LOAD_CODER
[API: system.status]
2.132 CONF_CPU_LOAD_IDLE
[API: system.status]
2.133 CONF_CPU_LOAD_VCA
[API: system.status]
2.134 CONF_CRYPT_KEY_GENERATE_ALL
[API: security]
2.135 CONF_CRYPT_KEYAUDIO_DEC
[API: security]
Description
This description is valid for the the commands:
• CONF_CRYPT_KEYVIDEO_ENC
• CONF_CRYPT_KEYVIDEO_DEC
• CONF_CRYPT_KEYAUDIO_ENC
• CONF_CRYPT_KEYAUDIO_DEC
Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
Num Descriptor Values
coder Any The number of the coder instance (absolute)
Payload Structure
16 32
Key...
16 Bytes
Key
...
Key
...
Key
...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
2.136 CONF_CRYPT_KEYAUDIO_ENC
[API: security]
Description
This description is valid for the the commands:
• CONF_CRYPT_KEYVIDEO_ENC
• CONF_CRYPT_KEYVIDEO_DEC
• CONF_CRYPT_KEYAUDIO_ENC
• CONF_CRYPT_KEYAUDIO_DEC
Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
Num Descriptor Values
coder Any The number of the coder instance (absolute)
Payload Structure
16 32
Key...
16 Bytes
Key
...
Key
...
Key
...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
2.137 CONF_CRYPT_KEYVIDEO_DEC
[API: security]
Description
This description is valid for the the commands:
• CONF_CRYPT_KEYVIDEO_ENC
• CONF_CRYPT_KEYVIDEO_DEC
• CONF_CRYPT_KEYAUDIO_ENC
• CONF_CRYPT_KEYAUDIO_DEC
Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
Num Descriptor Values
coder Any The number of the coder instance (absolute)
Payload Structure
16 32
Key...
16 Bytes
Key
...
Key
...
Key
...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
2.138 CONF_CRYPT_KEYVIDEO_ENC
[API: security]
Description
This description is valid for the the commands:
• CONF_CRYPT_KEYVIDEO_ENC
• CONF_CRYPT_KEYVIDEO_DEC
• CONF_CRYPT_KEYAUDIO_ENC
• CONF_CRYPT_KEYAUDIO_DEC
Set all Key- and all Salt- Bytes to zero, if no encryption/decryption is wished.
Num Descriptor Values
coder Any The number of the coder instance (absolute)
Payload Structure
16 32
Key...
16 Bytes
Key
...
Key
...
Key
...
8 24
Key
The 16 Byte Masterkey for AES encryption/decryption of data
2.139 CONF_CSRF_PROTECTION_ENABLED
[API: http settings]
Values:
protection active 1 default
protection disabled 0
2.140 CONF_DATA_COPY_JOB_START
[API: storage]
Description
This command starts a copy job, given by first the source descriptor and second the destination
descriptor. If starting the job was ok, the status will be reported by CONF_DATA_COPY_JOB_STATUS
messages or can be querried by the same comand. The return payload structure is the same as the
CONF_DATA_COPY_JOB_STATUS payload and contains the job id on success. This id can be used for
stopping the job, query the state or to identify it in the status messages payload.
Payload Structure
16 32
Source Descriptor
(see description)
Destination Descriptor
(see description)
8 24
Source Descriptor
See description of 'Source/Destination Descriptor'
Destination Descriptor
See description of 'Source/Destination Descriptor'
Offset
The offset in lba sized units ( = 512 bytes)
Length
Amount of data to copy in lba sized units ( = 512 bytes), not relevant for destination descriptor
Full Copy 0
Length 1-n
Type
Interface Test 0
Span on ISCSI 1
File 2
Raw ISCSI lun 3
Access to a span on an iscsi lun. This type can be used for example to copy a span. The parts of a span (unit,
lock, mgr header, data) has to be copied in seperate copy jobs.
Target Id
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES)
File type
Lock Header 1
Unit Header 2
Manager Header 3
Recording Data 4
Timeout
Default 0 Default, using default iscsi timeouts
Timeout 1 - 65534 Timeout in seconds
Never 65535 Never timeout
Access to a file. Can be used for example to copy a span to a file. If the file is the source, it has to exist. If
the file is destination it will be created if it doesn't exist. Parameter length is the path length including zero
termination and stuffing bytes in order to be 4 byte aligned. Size is at least 4 bytes.
File Path
Zero terminated ascii string specifing the path and file name of a source/destination
'Type spec. parameter' payload for 'Type' = 'Raw ISCSI lun' (3)
16 32
Target Id
4 Bytes
Target index Lun index Timeout
1 Byte 1 Byte 2 Bytes
8 24
Access to a complete iscsi lun. This type can be used for example to make a one to one copy of a complete
lun.
Target Id
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES)
Timeout
Default 0 Default, using default iscsi timeouts
Timeout 1 - 65534 Timeout in seconds
Never 65535 Never timeout
2.141 CONF_DATA_COPY_JOB_STATUS
[API: storage]
Description
This message reports the status of the copy job and will be send on each status change or several times while
in state "running". The status can also be queried by sending this command in read direction.
Payload Structure
16 32
Job Id
4 Bytes
State Reserved
1 Byte 3 Bytes
Progress
4 Bytes
Full data amount
4 Bytes
8 24
Job Id
Id of a data copy job
State
State of the copy Job
Initializing 0
Running 1
Finished 2
Failed 3
Stopped 4
Progress
Progress in lba units (= 512 bytes)
2.142 CONF_DATA_COPY_JOB_STOP
[API: storage]
2.143 CONF_DATE_DAY
[API: local time and time server settings and configuration]
2.144 CONF_DATE_MONTH
[API: local time and time server settings and configuration]
2.145 CONF_DATE_WDAY
[API: local time and time server settings and configuration]
2.146 CONF_DATE_YEAR
[API: local time and time server settings and configuration]
2.147 CONF_DAY_LIGHT_SAVE_TIME
[API: local time and time server settings and configuration]
2.148 CONF_DAY_LIGHT_SAVE_TIME_TABLE
[API: local time and time server settings and configuration]
2.149 CONF_DEC_SHOW_FREEZE
[API: decoder/videoout]
2.150 CONF_DECODER_DELAY
[API: decoder/videoout]
2.151 CONF_DECODER_LAYOUT
[API: decoder/videoout]
Payload Structure
Layout Reserved
2 Bytes 2 Bytes
Flags YUV
1 Byte 3 Bytes
Entry [0]
(see description)
...
Entry [N]
(see description)
Layout
Single 1
Quad 2
Nine 3
Sixteen 4
Multiview M
Flags
Mask Name Description
Bit 0 0x01 useRGB Signals RGB instead of YUV
YUV
Background YUV
Entry
16 32
len flags xPosition yPosition
1 Byte 1 Byte 1 Byte 1 Byte
width height inst reserved
1 Byte 1 Byte 1 Byte 1 Byte
hPos vPos
2 Bytes 2 Bytes
size reserved
2 Bytes 2 Bytes
8 24
len
Entry len
flags
Bit 0= flip, bit 1=mirror, bit 2=allFrames
xPosition
X position in grid
yPosition
Y position in grid
width
Width in grid
height
Height in grid
inst
Instance
hPos
Optional ptz hpos (see CONF_ROI)
vPos
Optional ptz vpos (see CONF_ROI)
size
Optional ptz size(see CONF_ROI)
2.152 CONF_DECODER_LAYOUT_LIST
[API: decoder/videoout]
2.153 CONF_DECODER_MODE
[API: decoder/videoout]
Values:
low delay 0
A/V sync 1
2.154 CONF_DECODING_ERROR
[API: decoder/videoout]
Payload Structure
16 32
ID
4 Bytes
Error Data
(see description)
8 24
Error Data
'Error Data' payload for 'ID' = '1'
H.264 video resolution exceeded decoder limit.
16 32
Current Width
4 Bytes
Current Height
4 Bytes
Max Width
4 Bytes
Max Height
4 Bytes
8 24
2.155 CONF_DEFAULT_CAM
[API: alarm connections]
2.156 CONF_DEFAULT_CONNECTION_MODE
[API: alarm connections]
2.157 CONF_DEFAULTS
[API: system.settings]
2.158 CONF_DELETE_CAM_REC_SPANS
[API: recording settings]
Description
This command is used for deleting spans of a specific recording line and index containing recordings
between a given time interval. The flag "delete enclodes spans only" chooses wether a span shall be deletet
if it is completetly enclosed by the time interval or if it only overlaps the interval. The flag "force delete" will
delete all spans of the cam independend of the state of the span. That means even if the cam is still recording
on a span, the span will be deleted. So use this option very carefully, as it could lead to inconsitencies. If the
command return successfully, it doesn't mean, that the deletion is completetd, it just tells the caller, that a
asychonous job for deletion was invoked. The command has to be send to the storage lun managing device.
Payload Structure
16 32
Recording Camera
(see description)
Lun Address
(see description)
From
4 Bytes
To
4 Bytes
Flags
4 Bytes
8 24
Recording Camera
16 32
IP
4 Bytes
MAC...
6 Bytes
MAC Recording Index Camera Index
... 1 Byte 1 Byte
8 24
IP
The IP address of the recording device.
MAC
The hardware address of the recording device. This field may be zero if you search for recordings without
considering the mac.
Recording Index
Primary Recording 1
Secondary 2
Recording
Camera Index
The camera index
Lun Address
16 32
Target ID
4 Bytes
Target Idx Lun Reserved
1 Byte 1 Byte 2 Bytes
8 24
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES).
Target Idx
The index of the target.
Lun
The logical unit number.
From
Start time of the interval in Seconds since 2000 local time for deleting.
To
End time of the interval in Seconds since 2000 local time for deleting.
Flags
Mask Name Description
Bit 1 0x00000002 Force ForceDeletion
Bit 0 0x00000001 EnclosedOnly Delete enclosed spans only
2.159 CONF_DEVELOPER_MODE_ALLOWED
[API: security]
2.160 CONF_DEVICE_CAPABILITIES
[API: system.settings]
Payload Structure
Number of tagged elements
4 Bytes
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
16 32
Tag = Tag ID Length
2 Bytes 2 Bytes
Tag Payload
8 24
Tag 1: DEVICE_TYPE_TAG
Values:
encoder 1
camera 2
transcoder 3
vrm 4
decoder 5
streaming gateway 6
storage 8
other 0
Tag 2: PTZ_CAMERA_TAG
Values:
no ptz 0
full ptz 1
zoom only 2 no pan/tilt
Tag 3: ROI_CAMERA_TAG
Values:
no 0
yes 1
Tag 4: AUTOTRACKER_TAG
Values:
no 0
yes 1
Tag 9: AUDIO_OPTIONS_TAG
Values:
Mask Name
Bit 3 0x08 loudspeaker (see
CONF_AUDIO_OPTIONS)
Bit 2 0x04 mic
Bit 1 0x02 line out
Bit 0 0x01 line in
2.161 CONF_DEVICE_GUID
[API: system.settings]
2.162 CONF_DEVICE_OPERATION_MODE_VERSIONS
[API: system.settings]
Description
This command can be used to get a hint for changes between firmware versions or differences between
device types concerning handling or way of configuration of the devices for several aspects. In order to
parse the response payload, first check the first byte of a operation mode version info structure, which is the
type and depending on the type read the remaining payload of the structure. Do this again for all following
operation mode version info structures until the end of the response payload.
Payload Structure
Operation Mode Version Info [0]
(see description)
...
Type
Type of the operation mode version info structure.
Specific Information
Specific information depending on the type.
Variant
Variant of the recording configuration.
Values:
Profile 0 Configuration has to be done by command
Configuration Mode CONF_HD_RECORD_PROFILES
Stream 1 Configuration has to be done by command
Configuration Mode CONF_HD_RECORD_PROFILES_V2
Version
Version of the recording configuration. Current version is 1.
2.163 CONF_DEVICE_TYPE_IDS
[API: system.settings]
Payload Structure
16 32
Product ID
4 Bytes
OEM ID Variant ID (t_dword)
1 Byte 3 Bytes
Frontend Family ID
4 Bytes
8 24
OEM ID
BOSCH = 0
Frontend Family ID
Bicom
2.164 CONF_DHCP_COMPLIANCY
[API: ethernet]
Values:
allow last-assigned 0
strict rfc 1
2.165 CONF_DHCP_OFF
[API: ethernet]
2.166 CONF_DHCP_ON
[API: ethernet]
2.167 CONF_DHCP_STABLE
[API: ethernet]
2.168 CONF_DHCP_VAL
[API: ethernet]
Values:
OFF 0
ON 1 On write: Enables DHCP and kicks lease acquisition
mechanism
ON No Kick 2 Write only: enables DHCP mode in config, but does
not kick lease acquisition mechanism
ON+APIPA-Fallback 3
2.169 CONF_DIFF_SERV_POST_ALARM_TIME
[API: ethernet]
2.170 CONF_DIFF_SERV_VAL
[API: ethernet]
2.171 CONF_DISCONNECT_PRIMITIVE
[API: rcp.connection]
Disconnect
Values:
Disconnected 1
Keep Connection 0
Status
Values:
Disconnected 1 Connection disconnected
Not Found 2 Connection identified by the given Session ID not found on this host
Cause
Values:
Not closed 0x00
Normal termination 0x01
Abnormal termination 0x02
No response 0x03
Remote host terminated 0x04
Timed out 0x05
Remote login rejected 0x06
No common media channels 0x07
Connection substituted 0x08
Automatic disconnect 0x09
Stop streaming 0x0a
Remote Host IP
IP address of the remote connected host.
2.172 CONF_DISCOVER_PORT
[API: rcp.discovery]
2.173 CONF_DNS_SERVER_IP
[API: ethernet]
2.174 CONF_DNS_SERVER_IP_STRING
[API: ethernet]
2.175 CONF_DPTZ_DYNAMIC_CAPS
[API: roi]
2.176 CONF_DPTZ_STATIC_CAPS
[API: roi]
Description
Read current DPTZ capabilities. They may are changed if
CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE or
CONF_VIDEO_LINE_DEWARPING_MODE is changed. The command consists of n entries with a fixed
length of 8 Bytes and the following data.
Payload Structure
16 32
Line Stream Bicom PTZ Steering Auto Tracker Type
1 Byte 1 Byte 1 Byte 1 Byte
Steering Type Reserved
1 Byte 3 Bytes
8 24
Line
Line id (1 based)
Stream
Stream id (1 based)
Steering Type
ptzSteeringTypeNoOptionPresent 0
ptzSteeringTypePhysicalDome 1
ptzSteeringTypeCutOutRegion 2
ptzSteeringTypeVirtualPtz 3
2.177 CONF_DROPBOX_AUTH_ADDR
[API: account]
2.178 CONF_DROPBOX_AUTH_STATUS
[API: account]
Values:
not authenticated 0
authenticated 1
authentication session timed out 2
failed 3
2.179 CONF_DROPBOX_AUTH_V2
[API: account]
2.180 CONF_DROPBOX_TOKEN_V2
[API: account]
2.181 CONF_DYNAMIC_HTML_COUNT
[API: browser]
2.182 CONF_DYNAMIC_HTML_DATA
[API: browser]
2.183 CONF_DYNAMIC_HTML_NAME
[API: browser]
2.184 CONF_DYNDNS_ENABLE
[API: dyndns]
Values:
enable 1
disable 0
2.185 CONF_DYNDNS_FORCE_REGISTER_NOW
[API: dyndns]
2.186 CONF_DYNDNS_HOST_NAME
[API: dyndns]
2.187 CONF_DYNDNS_LAST_REGISTER
[API: dyndns]
2.188 CONF_DYNDNS_MAIL_DEST_EMAIL_ADDR
[API: dyndns]
2.189 CONF_DYNDNS_MAIL_SENDER_NAME
[API: dyndns]
2.190 CONF_DYNDNS_MAIL_SMTP_LOGIN
[API: dyndns]
2.191 CONF_DYNDNS_MAIL_SMTP_PASS
[API: dyndns]
2.192 CONF_DYNDNS_MAIL_SMTP_SRV_IP_STR
[API: dyndns]
2.193 CONF_DYNDNS_MAIL_TEST_SEND
[API: dyndns]
2.194 CONF_DYNDNS_PASSWORD
[API: dyndns]
2.195 CONF_DYNDNS_PROVIDER
[API: dyndns]
Values:
dyndns.org 0
no-ip.com 1
selfhost.de 2
2.196 CONF_DYNDNS_STATE
[API: dyndns]
Payload Structure
State
The current state of the process of registering the device at dyndns.com
Values:
Success 0 successfully updated
ConfigUnchanged 1 updated with unchanged cfg
InvalidCreentials 2 dyndns username or password wrong
UnqualifiedDomain 3 not fully qualified domain name (e.g. not in form host.dyndns.org)
InvalidHostname 4 wrong host name for this dyndns user account
TooManyHosts 5 too many hosts in last update
HostnameBlocked 6 host name is blocked by dyndns for update abuse
NoAgent 7 no user agent submitted or http method not permitted
ErrorDns 8 dyndns server error dns related
ErrorMaintenance 9 dyndns server error maintenance related
ErrorMisconfigured 252 update not done due to misconfiguration
ErrorFatal 253 fatal error during update process
UpdateInProgress 254 update in process
SwitchedOff 255 switched off
2.197 CONF_DYNDNS_STATUS_MAIL_ONOFF
[API: dyndns]
Values:
off 0 default
on 1
2.198 CONF_DYNDNS_USER_NAME
[API: dyndns]
2.199
CONF_EAP_AUTO_ADJUST_INVALID_SYSTEMTIME
[API: eap]
Values:
off 0 Do not auto-adjust system time for EAP/802.1x
on 1 auto-adjust a potentially invalid system time for
EAP/802.1x certifciate based authentication
2.200 CONF_EAP_ENABLE
[API: eap]
Values:
off 0 Don't do EAP/802.1x
on 1 Use EAP/802.1x
2.201 CONF_EAP_GET_IDENTITY_LIST
[API: eap]
Description
This command returns the identities used for EAP authentication. If a EAP client certificate is assigned, the
command returns up to 3 identity strings. All strings are UTF-16 coded. The order of the list is the order
the EAP client uses the identies. If one identity fails to authenticate the next one from the list is used.
• The alternative subject name from the certificate (tag 0x0001)
• The common name from the certificate subject (tag 0x0002)
• The EAP identity from config (tag 0x0003)
Each of these entries is optional and can be missing. The complete identity list is surrounded by the tag
0x0000. If no identity is configured or found, the tag 0x0004 is returned to indicate the empty list.
Payload Structure
...
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x8000
2 Bytes 2 Bytes
8 24
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Subject Alt Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
Common Name (p_unicode)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
Configured identity (p_unicode)
Length - 4 Bytes
8 24
16 32
Length = 0x0020 Tag = 0x0004
2 Bytes 2 Bytes
8 24
2.202 CONF_EAP_IDENTITY
[API: eap]
2.203 CONF_EAP_PASSWORD
[API: eap]
2.204 CONF_ENABLE_DEVELOPER_MODE
[API: app management]
2.205 CONF_ENABLE_MASTERPWD
[API: user management]
Values:
disable 0
enable 1
2.206 CONF_ENABLE_ONVIF
[API: onvif]
2.207 CONF_ENABLE_TRAFFIC_LED
[API: system.settings]
2.208 CONF_ENABLE_UPNP
[API: upnp]
2.209 CONF_ENABLE_VCA
[API: viproc]
2.210 CONF_ENC_BASE_OPERATION_MODE_TYPE
[API: encoder]
Values:
no support 0
specific fixed resolution 1
upper limit 2
2.211 CONF_ENC_CURRENT_RESOLUTION
[API: encoder]
2.212 CONF_ENC_DYN_SCENE_CTRL
[API: encoder]
Status
disable 0
enable 1
leading stream
smart stream 255
16 32
Status leading stream reserved...
1 Byte 1 Byte 15 Bytes
reserved
...
reserved
...
reserved
...
reserved
...
8 24
Status
disable 0
enable 1
leading stream
smart stream 255
2.213 CONF_ENC_DYN_SCENE_CTRL_OPTIONS
[API: encoder]
Payload Structure
12 24
CONF_ENC_DYN_SCENE_CTRL
Imagepipe
Is Supported
2 Bytes
1 Byte
6 18
CONF_ENC_DYN_SCENE_CTRL Is Supported
Yes 1
No 0
Imagepipe
One Imagepipe Per 0
Line
Separated Imagepipe 1
Per Stream
2.214 CONF_ENC_PROFILE_BASIC_PARAMS
[API: encoder]
2.215 CONF_ENC_PROFILE_PARAMS
[API: encoder]
Description
The format has a tagged structure. Each tagged entry consists of a length field, a tag ID and a payload.
Allows to read/write all relevant parameters of an encoder profile preset like resolution, skip, bandwidth,
etc... within one single command. In read direction all available tags are returned. In write direction just the
parameters/tags which should be changed need to be sent. So either one tag, several tags or all available
tags can be provided.
Each tag ID in this command represents the according RCP command which already exists to read/write
one of the encoder profile parameters individually. I.e. this command combines several individual RCP
commands within one command and provides the parameters as separate tags. The payload of the tag entries
corresponds to the related RCP command. For detailed information please check the documentation of the
according RCP command.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
2.216 CONF_ENC_PROFILE_RESOLUTION_OPTIONS
[API: encoder]
Description
Obtain all allowed CONF_MPEG4_RESOLUTION IDs together with their according width and height.
The format has a tagged structure. Each tagged command consits of a length field a tag id + payload. Only
read is supported. Allows to query information about the resolution IDs which can be used in an encoder
profile, set via CONF_MPEG4_RESOLUTION.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Profile resolution options - for non-encoder-specific profiles (p_octet)
Length - 4 Bytes
8 24
id
Id supported by the CONF_MPEG4_RESOLUTION command
width
According width, 0 -> device automaticaly decides which resolution delivers the best performance in
conjuction with the current encoder configuration
height
According height, 0 -> device automaticaly decides which resolution delivers the best performance in
conjuction with the current encoder configuration
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
Profile resolution options - for encoder-specific profiles (p_octet)
Length - 4 Bytes
8 24
stream
Relative stream number for which the resolution is supported; starting with '1'
abs coder
The according absolute coder number for 'stream'
id
Id supported by the CONF_MPEG4_RESOLUTION command
width
According width, 0 -> device automaticaly decides which resolution delivers the best performance in
conjuction with the current encoder configuration
height
According height, 0 -> device automaticaly decides which resolution delivers the best performance in
conjuction with the current encoder configuration
2.217 CONF_ENC_STAMPING_PROPERTIES
[API: stamping]
Payload Structure
16 32
UTF16CharsPerLine CamNameLines
2 Bytes 2 Bytes
AlarmStampingLines TimeStampSupport TimeStampRes TranspStampSupport
1 Byte 1 Byte 1 Byte 1 Byte
BannerModeSupport ExtendedSysconAreas SpinnerStampSupport BigFontSupport
1 Byte 1 Byte 1 Byte 1 Byte
SeperateLogoAreaSupport InfoStampSupport maxLogoSize CustomStampingLines
1 Byte 1 Byte 1 Byte 1 Byte
ColorSupport customFontSupport reserved
1 Byte 1 Byte 2 Bytes
8 24
UTF16CharsPerLine
Number of UTF16 chars per line
CamNameLines
Number of stamping lines available at CONF_CAMNAME_LINES
AlarmStampingLines
Number of alarm stamping lines
TimeStampSupport
TimestampingUnsupported 0 Time stamping is not supported
TimestampingSupported 1 Time stamping is supported
TimeStampRes
Time stamp resolution, 1 also ms stamping is supported
TranspStampSupport
TransparentUnsupported 0 Transparent stamping is not supported
TransparentSupported 1 Transparent stamping is supported
BannerModeSupport
BannerModeUnsupported 0x00 Transparent stamping is not supported
BannerModeNameSupported 0x01 Name stamping supports banner mode
BannerModeAllSupported 0xFF All stamping areas supports banner mode
ExtendedSysconAreas
Number of extended syscon areas. In CPP7.3 this is usually 3, in earlier platforms 0.
SpinnerStampSupport
SpinnerUnsupported 0 Spinner stamping is not supported
SpinnerSupported 1 Spinner stamping is supported
BigFontSupport
BigFontUnsupported 0 Big font is not supported
BigFontSupported 1 Big font is supported
SeperateLogoAreaSupport
TransparentUnsupported 0 Seperate logo area is not supported
TransparentSupported 1 Seperate logo area is supported
maxLogoSize
Maximum logo size
CustomStampingLines
Number of custom stamping lines
ColorSupport
ColorUnsupported 0 Changing the stamping color is not supported
ColorSupported 1 Changing the stamping color is supported
customFontSupport
customFontUnsupported 0 custom font is not supported
customFontSupported 1 custom font is supported
2.218 CONF_ETH_LINK
[API: ethernet]
2.219 CONF_ETH_LINK_STATUS
[API: ethernet]
2.220 CONF_ETH_LINK_TROUGHPUT
[API: ethernet]
2.221 CONF_ETH_TX_PKT_BURST
[API: ethernet]
2.222 CONF_EVENT_SCRIPT
[API: alarm]
2.223 CONF_EXPORT_SPAN
[API: recording settings]
Recording Camera
The address of the device the span is assigned to.
16 32
IPv4
4 Bytes
MAC...
6 Bytes
MAC Recording Index Camera
... 1 Byte 1 Byte
8 24
IPv4
The ipv4 address of the recording device. If the device hasn't an ipv4 Adress, this field should be set to
invalid (zero ip 0.0.0.0). In that case a valid url has to be provided.
MAC
The hardware address of the recording device.
Recording Index
Primary Recording 1
Secondary 2
Recording
Camera
The camera index starting from 1.
Lun Addr
The address of the lun a span is desired from.
16 32
Target ID
4 Bytes
Target IDX LUN Reserved
1 Byte 1 Byte 2 Bytes
8 24
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES).
Target IDX
The index of the target.
LUN
The logical unit number.
Url
Url of the the device which requests the span as zero terminated ascii string. Max length is 128 bytes
including zero termination. This parameter is optional but is requiered if the device doesn't has an ipv4
address or if the IPv4 adress of the Cam id is not used.
Last Recording
...
State Reserved
1 Byte 3 Bytes
8 24
16 32
IPv4
4 Bytes
MAC...
6 Bytes
MAC Recording Index Camera
... 1 Byte 1 Byte
8 24
IPv4
The ipv4 address of the recording device. If the device hasn't an ipv4 Adress, this field should be set to
invalid (zero ip 0.0.0.0). In that case a valid url has to be provided.
MAC
The hardware address of the recording device.
Recording Index
Primary Recording 1
Secondary 2
Recording
Camera
The camera index starting from 1.
Span Address
The address of the span the device exports. If this field is zero, no span is exported.
16 32
Target ID
4 Bytes
Target IDX LUN Span IDX
1 Byte 1 Byte 2 Bytes
8 24
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES).
Target IDX
The index of the target.
LUN
The logical unit number.
Span IDX
The index of the span on the lun.
Last Recording
The address of the span the device exports.
16 32
Recording Camera...
12 Bytes
Recording Camera
...
Recording Camera
...
Retention Time
4 Bytes
8 24
Recording Camera
The id of the camera of the recording that is overwritten. Field is zero, if there was no recording on this span.
16 32
IPv4
4 Bytes
MAC...
6 Bytes
MAC Recording Index Camera
... 1 Byte 1 Byte
8 24
IPv4
The ipv4 address of the recording device. If the device hasn't an ipv4 Adress, this field should be set to
invalid (zero ip 0.0.0.0). In that case a valid url has to be provided.
MAC
The hardware address of the recording device.
Recording Index
Primary Recording 1
Secondary 2
Recording
Camera
The camera index starting from 1.
State
Values:
SUCCESS 0x00
NO SPAN AVAILABLE 0x01
STORAGE OFFLINE 0x02
INVALID SPAN MANAGER 0x03
ADDRESS
ACCESS DENIED 0x04
Note: A list of span manager the recording is using can be obtained by the command
CONF_REC_SPAN_MGR.
2.224 CONF_EXT_ENCODER_BITRATE_STATISTICS
[API: encoder]
Description
The command provides enhanced encoder bitrate statistics every record describes a table of bitrates. The
table has a time base in sec typically sec, min, hour, days and weeks is provided. The first entry of the list
can also only be active since a part of the cell e.g. cell time base is one day may this is only active since
300 sec. This time is signaled via lastCellIsActiveSinceSec
Definition of the global parameters, these parameters are vaild for all record entrys:
• GlobalParameters.localTimeSecoundsSince2000 local camera time which corresponds to
the delivered entrys
• GlobalParameters.UTCSecoundsSince2000 utc time which corresponds to the delivered
entrys
Payload Structure
16 32
GlobalParameters.localTimeSecoundsSince2000
4 Bytes
GlobalParameters.UTCSecoundsSince2000
4 Bytes
GlobalParameters.Reserved...
24 Bytes
GlobalParameters.Reserved
[...]
GlobalParameters.Reserved
...
Record [0]
(see description)
...
Record [N]
(see description)
8 24
GlobalParameters.localTimeSecoundsSince2000
Local camera time which corresponds to the delivered entrys
GlobalParameters.UTCSecoundsSince2000
Utc time which corresponds to the delivered entrys
Record
16 32
TimeBaseInSec
4 Bytes
LastCellIsActiveSinceSec
4 Bytes
ElementCount
4 Bytes
Reserved...
20 Bytes
Reserved
[...]
Reserved
...
Bitrate [0]
4 Bytes
...
Bitrate [
ElementCount
- 1]
4 Bytes
8 24
TimeBaseInSec
Base time for bitrate[1-n] base time of bitrate[0] is signaled via lastCellIsActiveSinceSec
LastCellIsActiveSinceSec
Bitrate[0] is active since lastCellIsActiveSinceSec
ElementCount
Number of elements
Bitrate
Example:
timeBaseInSec = 60, lastCellIsActiveSinceSec = 20 sec, elementCount = 256
• bitrate[1] : average bitrate{0 s ,...- 20 s}
• bitrate[2] : average bitrate{-20 s,...- 80 s}
• bitrate[3] : average bitrate{-80 s,...- 140 s}
• [...]
• bitrate[elementCount]
2.225 CONF_EXT_RECORDER_BITRATE_STATISTICS
[API: recording settings]
cam
Camera index starting with 1
rec idx
Recording index
Values:
Primary Recording 1
Secondary Recording 2
data type
Values:
Video Data 0
Other Data 1
2.226 CONF_EXTERNAL_CLIENT
[API: extension]
Description
This command lists information about all running external clients or about a specific external client.
Num Descriptor Values
To get the information of a specific external client the
num parameter is set to:
Video App 1
User App 2
All Running Clients 0xFFFF
...
Client Info
16 32
Line Instance Length Client Name...
1 Byte 1 Byte 1 Byte Length Bytes
Client Name
...
8 24
Line
Video line (1...n), in case of user app this is 0
Instance
Client instance. In case of Video app this may be 0 or 1, in case of client app this may be 1 to 16.
Length
Length of client name
Client Name
Client name
...
Client Info
16 32
Line Instance Length Client Name...
1 Byte 1 Byte 1 Byte Length Bytes
Client Name
...
8 24
Line
Video line (1...n), in case of user app this is 0
Instance
Client instance. In case of Video app this may be 0 or 1, in case of client app this may be 1 to 16.
Length
Length of client name
Client Name
Client name
2.227 CONF_EXTERNAL_CLIENTS_LIST
[API: extension]
2.228 CONF_FACTORY_DEFAULTS
[API: system.settings]
2.229 CONF_FIRE_ALARM
[API: viproc]
Description
Read the current state of each single fire alarm.
Payload Structure
16 32
Alarm Flags Reserved
1 Byte 3 Bytes
8 24
Alarm Flags
These bits can be combined by using the bitwise or-operator.
Values:
Mask Name Description
Bit 3 0x08 General Fire trouble: General issue
Bit 2 0x04 Illumination Fire trouble: Ilumination out of range
Bit 1 0x02 Smoke Alarm Smoke detected
Bit 0 0x01 Flame Alarm Flame detected
Reserved
Reserved bits, must be zero.
2.230 CONF_FLUSH_LUN_INFO_CACHE
[API: recording settings]
2.231 CONF_FORCE_TIME_SET
[API: local time and time server settings and configuration]
Payload Structure
16 32
year month day
2 Bytes 1 Byte 1 Byte
hours minutes sec reserved
1 Byte 1 Byte 1 Byte 1 Byte
8 24
2.232 CONF_FORMAT_FS_SPAN
[API: recording settings]
Payload Structure
16 32
Target ID
4 Bytes
Target IDX Lun IDX Span Cnt Span Size
1 Byte 1 Byte 1 Byte 1 Byte
Flags reserved
1 Byte 3 Bytes
8 24
Target ID
Target ID of ISCSI Server(server ipv4 address if std TargetID resolve rule is applied)
Values:
Local USB ff.ff.ff.ff Local connected USB disk.
iSCSIServer Any IP address Valid ip address
Target IDX
Index of the iSCSI server target. The index of the desired target can be obtained from the reply to an iSCSI
discover.
Lun IDX
Index of the lun of the specified target.
Span Cnt
Number of spans the lun shall be formated with
Span Size
Size of each span in megabyte. (1 MB = 1024 x 1024 Bytes)
Flags
These flags define the operations to be executed. If no flags are set (default), nothing will be done.
Format options:
REPAIR_FS 0x01 Repair file system without clearing spans
CLEAR_SPANS_ONLY 0x02 Only clear the spans
Note: The reply packet will contain the values of the actually formated spans and size. If the product of
the span count and the span size in the request packet exceeds the size of the current lun, only as many
as possible spans are formatted. If the product is less than the available lun space, the back part of the lun
will be unused. Size of the write payload is at least 12 bytes, if the optional flags are uses the payload has
to be at least 16 bytes.
Note: Note: A list of all defined error types can be found in the Appendix.
2.233 CONF_FORMAT_FS_SPANS_STATUS
[API: recording settings]
Description
This message reports the status and progress of a running format. The formatting includes the
creation of the FAT32 file system (step: HD_STEP_FORMAT_FS) and clearing of the span
header files(step: HD_STEP_CLEAR_SPAN_HEADER). The progress is reported about the whole
formatting. A successful format should always end with a message with 100 percent progress at
step HD_STEP_CLEAR_SPAN_HEADER and status should be HD_FORMAT_STATUS_FINISHED.
A failed format should finish with a status HD_FORMAT_STATUS_FAILED at any progress
and any step. After these final messages no futher messages will follow. The whole
formatting takes two steps HD_STEP_FORMAT_FS and HD_STEP_CLEAR_SPAN_HEADER. First
step HD_STEP_FORMAT_FS will run up to 90 percent and will end with a 90 percent
progress message and status HD_FORMAT_STATUS_FINISHED if successful. Then the last step
HD_STEP_CLEAR_SPAN_HEADER will follow from 90 to 100 percent and will also end with a
HD_FORMAT_STATUS_FINISHED status if successfull, which is also as mentioned earlier the final
success message. If the formatting runs with the option of disk erasing, The first step will be the
HD_STEP_ERASE_DISK step and will run upto 70 percent if successful.
Payload Structure
16 32
Step Status Progress
1 Byte 1 Byte 2 Bytes
Ip
4 Bytes
Target_idx Lun Reserved
1 Byte 1 Byte 2 Bytes
8 24
Step
Which step of the formating (FAT32 Formatting including creating spans and clearing span headers)
Values:
HD_STEP_FORMAT_FS 0x00
HD_STEP_CLEAR_SPAN_HEADER 0x02
Status
Reports the state of formatting. The format can be in state of running, failed or successfully finished. success
means the creation of the fat32 file system and the empty spans or clearing the span headers was successfully.
Values:
HD_FORMAT_STATUS_FAILED 0xff
HD_FORMAT_STATUS_RUNNING 0x00
HD_FORMAT_STATUS_FINISHED 0x02
HD_FORMAT_ERASE_DISK 0x03
Progress
Value from 0 to 100 represent the progress of the format including the creation of the empty recording spans
and clearing the header files.
Values:
Progress in percent 0 - 100
Ip
Ip of the storage device or lun, that is formatting
Target_idx
Target Index of the storage device from 0 to 255.
Lun
Lun of the storage device from 0 to max. 255.
Reserved
2 Bytes reserved
2.234 CONF_FORMAT_FS_STATUS
[API: storage]
Description
the message reports the status and progress of a running format. The formatting takes two steps that
is first formating FAT32 including creating the recording files and second copy the replay tools. The
progress is reported about the whole formatting. The status reports the state of each formatting step. A
successful format should always end with a message with 100 percent progress, step should be copy toolkit
and status should be HD_FORMAT_STATUS_FINISHED or HD_FORMAT_STATUS_SKIPPED if the
storage device is too small for recording (e.g. RAMDISK). A failed format should finish with a status
HD_FORMAT_STATUS_FAILED at any progress and step. After this final messages no futher message
will follow.
Payload Structure
16 32
Step Status Progress
1 Byte 1 Byte 2 Bytes
8 24
Step
Which step of the formating (FAT32 Formatting including creating recording files or copy replay tools)
Values:
HD_STEP_FORMAT_FS 0x00
HD_STEP_COPY_TOOLKIT 0x01
Status
Reports the state of formatting. The format can be in state of running, failed or successfully finished. The last
one is devided in the two states of HD_FORMAT_STATUS_FINISHED which means FAT32 including
recording files and replay tools were created and HD_FORMAT_STATUS_SKIPPED which means that
only the FAT32 was created because the storage device was not the needed size for recording.
Values:
HD_FORMAT_STATUS_FAILED 0xff
HD_FORMAT_STATUS_RUNNING 0x00
HD_FORMAT_STATUS_SKIPPED 0x01
HD_FORMAT_STATUS_FINISHED 0x02
Progress
Value from 0 to 100 represent the progress of the format including copy replay tools in percent.
Values:
Progress in percent 0 - 100
2.235 CONF_FTP_CDUP
[API: account]
2.236 CONF_FTP_CWD
[API: account]
2.237 CONF_FTP_FILE_NAME
[API: account]
2.238 CONF_FTP_PWD
[API: account]
2.239 CONF_FTP_SERVER_PORT
[API: account]
2.240 CONF_FW_MIN_VERSION
[API: system.settings]
2.241 CONF_GATEWAY_IP_STR
[API: ethernet]
2.242 CONF_GATEWAY_IP_V6_STRING
[API: ethernet]
2.243 CONF_GB28181
[API: GB28181]
Payload Structure
16 32
Enable H264 Stream Cfg Reserved
1 Byte 1 Byte 2 Bytes
Heart beat time out
4 Bytes
Registration time out
4 Bytes
Server port Device Port
2 Bytes 2 Bytes
Server URL...
64 Bytes
Server URL
[...]
Server URL
...
Server ID...
21 Bytes
Server ID
[...]
Server ID
...
Server ID Device ID...
... 21 Bytes
Device ID
[...]
Device ID
...
Device ID Alarm Device ID...
... 21 Bytes
Alarm Device ID
[...]
Alarm Device ID
...
Alarm Device ID Password...
... 128 Bytes
Password
[...]
Password
...
Password Reserved...
... 753 Bytes
Reserved
[...]
Reserved
...
Reserved
...
8 24
Enable
1: Enable GB28181 client 0: Disable
Server port
Currently 5060 or 5511 can be used (server and device port must be equivalent server port is also used
for device port)
Device Port
Currently 5060 or 5511 can be used (server and device port must be equivalent server port is also used
for device port)
Server URL
URL of GB28181 server
2.244 CONF_GET_ENC_DYN_SCENE_CTRL_INFO
[API: encoder]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Stream Id
1...n associated stream
2.245 CONF_GET_LAST_CMP_ERROR_MESSAGES
[API: cert store]
2.246 CONF_GET_RTSP_SESSION_ID
[API: rtsp settings]
2.247
CONF_GET_VIDEO_ENC_P_REF_LIST_SIZE_LIMIT
[API: encoder]
2.248
CONF_GETPROFILE_ALGO_PRESET_NAME_LIST
[API: viproc]
Description
This command returns a list of VCA profile specific information. These information contains the VCA
algorithm type, the associated dome preset (if existent otherwise zero) and the profile name.
Payload Structure
16 32
Num Profiles Reserved Profile [0]
1 Byte 1 Byte (see description)
...
8 24
Num Profiles
Reserved
Profile
16 32
Algorithm Type Preset
2 Bytes 2 Bytes
Profile Name (p_unicode)...
32 Bytes
Profile Name
[...]
Profile Name
...
8 24
Algorithm Type
Mask Name Description
Bit 2 0x0004 Block Based Block Based VCA (Motion)
Bit 1 0x0002 Flow Based
Bit 0 0x0001 Object Based Object Based VCA (IVA, EVA)
2.249 CONF_GOP_STRUCTURE_OPTIONS
[API: encoder]
Payload Structure
16 32
Gop Structure
Gop Structure Options [
Num Options
Options [0] ... Num Options
1 Byte
(see description) - 1]
(see description)
8 24
Num Options
Number of following options
Gop Structure
Gop Structure option
Values:
IP 0
IBP 1
IBBP 2
IBBRBP 3
2.250
CONF_H264_ENC_BASE_OP_MODE_CAPS_VERBOSE
[API: encoder]
Description
encBaseModeId: id used in CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE height: video
format height of base mode with encBaseModeId 0 -> height is not fixed width: video format width of base
mode with encBaseModeId 0 -> width is not fixed copy: base mode is copy of an other stream sd: base mode
is sd, base mode resolution is determined by encoder profile sdFramerateDependent: base mode resolution
depends on frame rate crop: base mode is a croped view skip: base mode is frame rate reduced (applys a
skip on the full frame rate) roi: base mode is a region of interest stream typically ptz is supported ptz: base
mode allows ptz dualStream: base mode supports "dual stream" two encoders are used for the stream (e.g. 2
different ptz views are possible) exclusive: only used in combination with 'dualStream' property. Indicates
if the additional stream of the 'dual stream' is for exclusive access (only one client at a time) or not.
Payload Structure
16 32
stream count
4 Bytes
Descriptor 0 description
(see description)
...
Descriptor N description
(see description)
8 24
stream count
Array index in text
Descriptor description
...
encBaseModeId
Id used in CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE
height
Video format height of base mode with encBaseModeId 0 -> height is not fixed
width
video format width of base mode with encBaseModeId 0 -> width is not fixed
copy
Base mode is copy of another stream
No 0
Yes 1
sd
Base mode is sd, base mode resolution is determined by encoder profile
No 0
Yes 1
sdFramerateDependent
Base mode resolution depends on frame rate
No 0
Yes 1
crop
Base mode is a croped view
No 0
Yes 1
skip
Base mode is frame rate reduced (applys a skip on the full frame rate)
No 0
Yes 1
roi
Base mode is a region of interest stream typically ptz is supported
No 0
Yes 1
ptz
Base mode allows ptz
No 0
Yes 1
dualStream
Base mode supports 'dual stream' two encoders are used for the stream (e.g. 2 different ptz views are
possible)
No 0
Yes 1
exclusive
only used in combination with 'dualStream' property. Indicates if the additional stream of the 'dual stream'
is for exclusive access (only one client at a time) or not.
No 0
Yes 1
2.251
CONF_H26x_ENC_BASE_OP_MODE_CAPS_VERBOSE_EX
[API: encoder]
Description
encBaseModeId: id used in CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE height: video
format height of base mode with encBaseModeId 0 -> height is not fixed width: video format width of base
mode with encBaseModeId 0 -> width is not fixed copy: base mode is copy of an other stream sd: base mode
is sd, base mode resolution is determined by encoder profile sdFramerateDependent: base mode resolution
depends on frame rate crop: base mode is a croped view skip: base mode is frame rate reduced (applys a
skip on the full frame rate) roi: base mode is a region of interest stream typically ptz is supported ptz: base
mode allows ptz dualStream: base mode supports "dual stream" two encoders are used for the stream (e.g. 2
different ptz views are possible) exclusive: only used in combination with 'dualStream' property. Indicates
if the additional stream of the 'dual stream' is for exclusive access (only one client at a time) or not.
Payload Structure
16 32
stream count
4 Bytes
Descriptor 0 description
(see description)
...
Descriptor N description
(see description)
8 24
stream count
Array index in text
Descriptor description
16 32
Description for stream [0]
(see description)
...
reserved
...
reserved
...
8 24
encBaseModeId
Id used in CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE
height
Video format height of base mode with encBaseModeId 0 -> height is not fixed
width
video format width of base mode with encBaseModeId 0 -> width is not fixed
copy
Base mode is copy of another stream
No 0
Yes 1
sd
Base mode is sd, base mode resolution is determined by encoder profile
No 0
Yes 1
sdFramerateDependent
Base mode resolution depends on frame rate
No 0
Yes 1
crop
Base mode is a croped view
No 0
Yes 1
skip
Base mode is frame rate reduced (applys a skip on the full frame rate)
No 0
Yes 1
roi
Base mode is a region of interest stream typically ptz is supported
No 0
Yes 1
ptz
Base mode allows ptz
No 0
Yes 1
dualStream
Base mode supports 'dual stream' two encoders are used for the stream (e.g. 2 different ptz views are
possible)
No 0
Yes 1
exclusive
only used in combination with 'dualStream' property. Indicates if the additional stream of the 'dual stream'
is for exclusive access (only one client at a time) or not.
No 0
Yes 1
2.252 CONF_HARDWARE_VERSION
[API: system.settings]
2.253 CONF_HD_FILE_INFO
[API: recording settings]
Description
This message is used for updating actual recording files, it will be send periodically about every second by
the recording device, that is running the recording on that file. The message informs about the start and end
time changes of an file. For uniqe idetification, the message includes the span address and a file id. it also
has the information about the recording cam (attention: in older firmware the file info msg only has the first
4 payload fields(from start time to file id))
Payload Structure
16 32
start time
4 Bytes
end time
4 Bytes
flags
4 Bytes
file id
4 Bytes
target id
4 Bytes
target idx lun span idx
1 Byte 1 Byte 2 Bytes
cam recording idx reserverd
1 Byte 1 Byte 2 Bytes
8 24
start time
Start time in seconds since 2000 of the recording file
end time
End time in seconds since 2000 of the recording file
flags
File info flags, see CONF_HD_PARTITION_FILE_INFO
file id
File ID on the file unique per span
target id
Target id of the lun (may be the ipv4 address for older versions or with default target resolve configuration,
see CONF_TARGET_ID_RESOLVE_RULES)
target idx
Target index of the span
lun
Lun of the span
span idx
Span index
cam
Camera from 1 to ...
recording idx
Recording index (primary or secondary)
Values:
primary 1
secondary 2
reserverd
2.254 CONF_HD_FILE_INFO_SECONDARY
[API: recording settings]
Description
This message is used for updating actual recording files, it will be send periodically about every second by
the recording device, that is running the recording on that file. The message informs about the start and end
time changes of an file. For uniqe idetification, the message includes the span address and a file id. it also
has the information about the recording cam (attention: in older firmware the file info msg only has the first
4 payload fields(from start time to file id))
Payload Structure
16 32
start time
4 Bytes
end time
4 Bytes
flags
4 Bytes
file id
4 Bytes
target id
4 Bytes
target idx lun span idx
1 Byte 1 Byte 2 Bytes
cam recording idx reserverd
1 Byte 1 Byte 2 Bytes
8 24
start time
Start time in seconds since 2000 of the recording file
end time
End time in seconds since 2000 of the recording file
flags
File info flags, see CONF_HD_PARTITION_FILE_INFO
file id
File ID on the file unique per span
target id
Target id of the lun (may be the ipv4 address for older versions or with default target resolve configuration,
see CONF_TARGET_ID_RESOLVE_RULES)
target idx
Target index of the span
lun
Lun of the span
span idx
Span index
cam
Camera from 1 to ...
recording idx
Recording index (primary or secondary)
Values:
primary 1
secondary 2
reserverd
2.255
CONF_HD_FORMAT_STORAGE_ERROR_LOG_CNT
[API: storage]
2.256 CONF_HD_MGR_REC_STATUS
[API: recording settings]
Description
This command shows the state for a recording. It can be read and it will be send at state changes. State
changes are the change of rec state or rec preset only. Within the Msg there is no distiction between the state
OFF and NO RECORDING. That means no msg will be send on the state change between this two states.
The msg will never contain the state OFF but the read response maybe. OFF state means the recording
is configured to off by set it to stop. NO RECORDING can be caused by many things e.g. no recording
on the schedule, no storage present and so on. STAND BY means there is recording on the schedule but
not at the moment. The recording scheduler waits for the time to start the recording. All the other states
indicating a running recording. In case of alarm recording in prealarm state, the message state will be PRE
ALARM RECORDING even if the pre alarm recording takes place in the ram only, if at least the storage
is connected. If there is no storahge connected and recording is configured for running, the state will alway
be NO RECORDING.
Payload Structure
16 32
rec state rec preset enc preset flags
1 Byte 1 Byte 1 Byte 1 Byte
8 24
rec state
State of the recording, state OFF not in payload of msg
Values:
OFF 0
NO RECORDING 1
STAND BY 2
PRE ALARM RECORDING 3
ALARM RECORDING 4
POST ALARM RECORDING 5
rec preset
Actual used recording preset from 1 to 10 or 0 if no preset is used
enc preset
Actual used encoder preset from 1 to 8 or 0 if no preset is used
flags
These flags show the alarm states and the recording mode
Mask Name
Bit 7 0x80 reserved for extension
Bit 4 0x10 virtual alarm
Bit 3 0x08 video loss
Bit 2 0x04 motion alarm
Bit 1 0x02 input alarm
Bit 0 0x01 alarm recording mode
2.257 CONF_HD_MGR_REC_STATUS_SECONDARY
[API: recording settings]
Payload Structure
This payload equals the payload of the command 'CONF_HD_MGR_REC_STATUS'
2.258 CONF_HD_MGR_SIGNAL_ALARM
[API: alarm]
2.259 CONF_HD_MGR_START
[API: recording settings]
2.260 CONF_HD_MGR_START_SECONDARY
[API: recording settings]
2.261 CONF_HD_MGR_STOP
[API: recording settings]
2.262 CONF_HD_MGR_STOP_SECONDARY
[API: recording settings]
2.263 CONF_HD_PARTITION_FILE_INFO
[API: replay control]
Description
This command initiates a search to get the times where data is available within a recording.
The Session ID paramter must be set (a connect primitive must have been preceded).
Recording mode can be time recording (1) or alarm recording (2 and 3), only for command
CONF_SPAN_PARTITION_FILE_INFO there are seperagte files for pre (2) and post (3) alarm recording.
Search is performed from a start point on the timeline towards an end point. If the end point is prior to the
start point search is performed backwards. To get all available results of an recording a search from 0 to
0xFFFFFFFF needs to be done.
The number of results is limited to 256 per response. The result are always in ascending order independent
if the search is performed forward or backward. The File ID always increases on span recording regions if
new files will be created. To get all results the command has to be called multiple times.
In that case the start or stop times needs to be updated with every call: If a forward search is executed
the start time of the next request must be the stop time of the last retrieved result. If a bachward search is
executed the start time of the next request must be the start time of the first retrieved result.
A search is completed if the number of returned results is smaller than 256 or if the endpoint of the search
is greater or equal than than the endpoint of the last result. In case of forward search a virtual start point
(equal to the start point of the search) will be inserted if the search start point is range with recording.
Request Payload Structure
16 32
Search Start Time
4 Bytes
Search Stop Time
4 Bytes
Max Entries
4 Bytes
Flags
4 Bytes
8 24
Max Entries
Max Number of entries, limited to 256
Entries 1 - 256
Flags
Mask Name Description
Bit 1 0x00000002 UTC_FLAG Start and stop time are utc times (request)
Bit 0 0x00000001 YOUNGER_OR_EQUAL_FLAG
Must be set in case of forward search
RecordingEntry
16 32
Start Time
4 Bytes
Stop Time
4 Bytes
Flags
4 Bytes
File ID
4 Bytes
8 24
Start Time
Seconds since 2000
Stop Time
Seconds since 2000
Flags
Mask Name Description
Bit 29 0x20000000 Time Zone Sign
Bit 28 0x10000000 Time Zone
Bit 27 0x08000000 Time Zone
Bit 26 0x04000000 Time Zone
Bit 25 0x02000000 Time Zone
Bit 24 0x01000000 Time Zone
Bit 23 0x00800000 Time Zone
Bit 22 0x00400000 Protected (VRM only)
Bit 21 0x00200000 Offline (VRM only)
Bit 18 0x00040000 reserved
Bit 17 0x00020000 reserved
Bit 16 0x00010000 Alarm Remote (there are virtual/remote alarms in this file, see
CONF_HD_MGR_SIGNAL_ALARM)
Bit 15 0x00008000 Track Fill Level
Bit 14 0x00004000 Track Fill Level
Bit 13 0x00002000 Track Fill Level
Bit 12 0x00001000 Track Fill Level
Bit 11 0x00000800 Track Fill Level
Bit 10 0x00000400 Track Fill Level
Bit 9 0x00000200 Track Fill Level
Bit 8 0x00000100 Track Fill Level
Bit 7 0x00000080 Recording mode
Bit 6 0x00000040 Recording mode
Bit 5 0x00000020 Video Loss (there are video loss in this file)
Bit 4 0x00000010 New Alarm (obsolete)
Bit 3 0x00000008 Alarm Motion (there are motion alarms in this file)
Bit 2 0x00000004 Alarm Input (there are input alarms in this file)
Bit 1 0x00000002 Recording Overwriting (recording takes place in a ring and old
recording data will be overwritten)
Bit 0 0x00000001 Recording Running (actual recording is running on this file or
recording not closed regulary)
Combined Values
Mask Name Description
0x1F800000 Time Zone Quarter hours
0x0000FF00 Track Fill Level Fill level in percent, always 100 % on filled
ring recording
0x0000C000 Recording Mode
Time Recording 1
Alarm recording 2
(pre alarm)
Alarm recording 3
(post alarm)
Example
Forward search (data is available from time A to time B):
• A search is executed from time 0 to time B. In that case the reponse is: secStart=A,
secStop=B
• A search is executed from time 0 to time 0xFFFFFFFF. In that case the reponse is:
secStart=A, secStop=B
• A search is executed from time C (C > A and C < B) to time B. In that case the reponse
is: secStart=C, secStop=B
• A search is executed from time A to time C (C > A and C < B). In that case the reponse
is: secStart=A, secStop=C
Backward search (data is available from time A to time B):
• A search is executed from time 0xFFFFFFFF to time A. In that case the reponse is:
secStart=A, secStop=B
• A search is executed from time 0xFFFFFFFF to time 0. In that case the reponse is:
secStart=A, secStop=B
• A search is executed from time C (C < B and C > A) to time A. In that case the reponse
is: secStart=A, secStop=C
• A search is executed from time B to time C (C < B and C > A). In that case the reponse
is: secStart=C, secStop=B
2.264 CONF_HD_PARTITION_RECORDING
[API: recording settings]
Values:
running 1
not running 0
2.265
CONF_HD_PARTITION_RECORDING_SECONDARY
[API: recording settings]
Values:
running 1
not running 0
2.266 CONF_HD_PARTITIONS_RECORDING
[API: recording settings]
2.267 CONF_HD_REC_BUFFER
[API: recording settings]
Description
This command gets information about the recording buffer size, it includes the full amount of buffer for all
recordings, the allocated, and the minimum amount of buffer of the recording specified by the in payload.
The "full buffer bytes" is usually preallocated memory at startup and won't change it's size as long as the
device is running and is the same for all recordings (except streaming gateway). The "min buffer bytes" is
the amount of buffer the device will at least allocate if running. The "allocated buffer bytes" is the amount
of buffer the recording has actually allocated. This value can be higher than "min buffer bytes", if nt all
possible recrdings are running. The unused buffer of non running recordings will be used by the running
ones. If the recording is deaktivated, the value will be 0. When running, the value wil be usually at least "min
buffer bytes", but it can be temporary less than that value, if e.g. the recording was started shortly before and
another already running recording has allocated the whole buffer. In that case it could take some time free
the buffer by the running recording, so the allocated buffer will increase over the time. The "filled buffer
bytes" is the amount of buffer memory of the the "allocated buffer bytes", which contains data for recording
or in case of alarm recording, the amout to be recorded, if an alarm would occur in this moment. The
"filled_buffer bytes" can therefor be used to calculate the fill level of the recording buffer. The information
also includes the incomming data rate, which is the data rate of data from the video, audio, ... encoders to
the record buffer. Also th time range of available data in buffer are presented along with the progress of the
recording, all in seconds since 2000 utc. This is usefull to observe backlog of recording. Internally there are
replay sessions running directly on the record buffer, therefor information about the buffer replay are also
present, including the utc timestamp of the last replay data from buffer and byte counter and replay data rate.
Request Payload Structure
16 32
Cam Rec idx
2 Bytes 2 Bytes
8 24
Cam
Camera starting with 1 (in payload)
Rec idx
Recording index (in payload)
Primary Recording 1
Secondary Recording 2 (active low)
Cam
Camera starting with 1 (in payload)
Rec idx
Recording index (in payload)
Primary Recording 1
Secondary Recording 2 (active low)
reserved
Reserved
2.268 CONF_HD_RECORD_HOLIDAYS
[API: recording settings]
Description
This command reads/writes the Holiday table for the primary recording. On holidays the recording uses the
special schedule instead of the standard schedule. The table contains N entries (max. 25) each entry specifies
one or more holidays in a row followd by a recording schedule. the payload sends only valid holiday entries,
so the size of N depends on the number of valid entries in the table.
Payload Structure
holiday schedule entry [0]
(see description)
...
16 32
day month year number of days
1 Byte 1 Byte 1 Byte 1 Byte
reco [0] reco [95]
...
4 Bits 4 Bits
8 24
day
Day of the month, which is a holiday
Values:
invalid 0
day of the month 1 - 31
month
Month of the year
Values:
invalid 0
january 1
february 2
march 3
april 4
may 5
june 6
july 7
august 8
september 9
october 10
november 11
december 12
year
Year since 2000
Values:
year 2000 to 2255 0 - 255
number of days
Number of days that follow the specified holiday, which are also scheduled as holidays. If only the specified
date is the holiday, this field should be set to 1.
Values:
invalid 0
number of days 1 - 255
reco
This is the recocording schedule containing 96 entries of recording profile numbers for the holiday, each
represents the recording profile for a 15 min time period. First entry is from 00:00 to 00:15. The following
entries are for the following 15 min time periods until 24:00.
Values:
recording off 0
recording profile numbers 1 - 10
2.269 CONF_HD_RECORD_PROFILES
[API: recording settings]
Description
Read/Write up to ten recording profiles (at least one) for a camera, payload upto 560 bytes total. The profiles
will be written to the device config. These profiles are used as default profiles for each span that is mounted
by this cam for span recording. If less than 10 profiles will be written, the remaining profiles stay unchanged.
Payload Structure
Recording Profile [0]
(see description)
...
Recording Profile
16 32
post alarm
Flags video preset nr encoder index
video preset nr
1 Byte 1 Byte 1 Byte
1 Byte
See See
See
reserved *0 *2 profile name (p_string)...
*1
12 Bits 1 1 32 Bytes
2 Bits
Bit Bit
profile name
[...]
profile name
...
Flags
Mask Name
Bit 6 0x40 MANAGED_BY_ONVIF
Bit 5 0x20 IMMEDIATE_ALARM_BACKUP
Bit 4 0x10 ALARM_RECORDING_PRE_ALARM_BUFFER
Bit 3 0x08 ALARM_FILE_BACKUP
Bit 2 0x04 META_RECORDING_DISABLE
Bit 1 0x02 AUDIO_RECORDING_DISABLE
Bit 0 0x01 ALARM_RECORDING_PRE_ALARM_RING
Combined Values
Mask Name
0x11 ALARM_RECORDING_PRE_ALARM_AUTO
video preset nr
Video preset number used for recording
Values:
no recording on this 0
profile
video preset nr 1-8
Values:
Not set 0 uses video preset nr if set
video preset nr for 1-8
post alarm
encoder index
Index of the encoder stream starting with 0, index 255 is for the backup output
Back Up Account
Backup account Number from 0 (first account) to 3(fourth account), for choosing the back up account in
case activated ALARM_FILE_BACKUP flag
profile name
Profile name is a zero terminated string
motion alarm
The bits represent the activation
Mask Name
Bit 31 0x80000000 Alarm Nbr. 32
...
Bit 1 0x00000002 Alarm Nbr. 2
Bit 0 0x00000001 Alarm Nbr. 1
Mask Name
Bit 31 0x80000000 Virtual Nbr. 0
...
Mask Name
Bit 31 0x80000000 Alarm Nbr. 32
...
Bit 1 0x00000002 Alarm Nbr. 2
Bit 0 0x00000001 Alarm Nbr. 1
2.270 CONF_HD_RECORD_PROFILES_SECONDARY
[API: recording settings]
Payload Structure
This payload equals the payload of the command 'CONF_HD_RECORD_PROFILES'
2.271 CONF_HD_RECORD_PROFILES_V2
[API: recording settings]
Description
Read/Write the ten recording profiles for a camera, payload upto 560 bytes total. The profiles will be written
to the device configuration. These profiles are used as default profiles for each span that is mounted by this
cam for span recording. If less than 10 profiles will be written, the remaining profiles stay unchanged.
Payload Structure
Recording Profile [0]
(see description)
...
Recording Profile
16 32
post alarm
Flags stream config nr encoder index
stream config nr
1 Byte 1 Byte 1 Byte
1 Byte
See See
See
post alarm profile reserved *0 *2 profile name...
*1
1 Byte 4 Bits 1 1 32 Bytes
2 Bits
Bit Bit
profile name
[...]
profile name
...
profile name max pre alarm time
... 2 Bytes
Flags
Mask Name
Bit 6 0x40 MANAGED_BY_ONVIF
Bit 5 0x20 IMMEDIATE_ALARM_BACKUP
Bit 4 0x10 ALARM_RECORDING_PRE_ALARM_BUFFER
Bit 3 0x08 ALARM_FILE_BACKUP
Bit 2 0x04 META_RECORDING_DISABLE
Bit 1 0x02 AUDIO_RECORDING_DISABLE
Bit 0 0x01 ALARM_RECORDING_PRE_ALARM_RING
Combined Values
Mask Name
0x11 ALARM_RECORDING_PRE_ALARM_AUTO
stream config nr
Video preset number used for recording
Values:
no recording on this 0
profile
stream configuration 1 - 2
nr for pre alarm
I-frames only from 3
stream 1 for pre
alarm
Values:
not set 0 uses stream config nr if set
stream configuraton 1 - 2
nr for post alarm
encoder index
Index of the encoder stream starting with 0, index 255 is for the backup output
Back Up Account
Backup account Number from 0 (first account) to 3(fourth account), for choosing the back up account in
case activated ALARM_FILE_BACKUP flag
profile name
Profile name is a zero terminated string
motion alarm
The bits represent the activation
Mask Name
Bit 31 0x80000000 Alarm Nbr. 32
...
Bit 1 0x00000002 Alarm Nbr. 2
Bit 0 0x00000001 Alarm Nbr. 1
Mask Name
Bit 31 0x80000000 Alarm Nbr. 0
...
Bit 17 0x00020000 Alarm Nbr. 14
Bit 16 0x00010000 Alarm Nbr. 15
Bit 15 0x8000 Virtual Nbr. 16
...
Bit 1 0x0002 Virtual Nbr. 2
Bit 0 0x0001 Virtual Nbr. 1
Mask Name
Bit 31 0x80000000 Alarm Nbr. 32
...
Bit 1 0x00000002 Alarm Nbr. 2
Bit 0 0x00000001 Alarm Nbr. 1
2.272
CONF_HD_RECORD_PROFILES_V2_SECONDARY
[API: recording settings]
Description
Read/Write the ten recording profiles for the secondary recording, payload upto 560 bytes total. The profiles
will be written to the device configuration. These profiles are used as default profiles for each span that
is mounted by this cam for span recording. If less than 10 profiles will be written, the remaining profiles
stay unchanged.
Payload Structure
Recording Profile [0]
(see description)
...
Recording Profile
16 32
post alarm
Flags stream config nr encoder index
stream config nr
1 Byte 1 Byte 1 Byte
1 Byte
See See
See
post alarm profile reserved *0 *2 profile name...
*1
1 Byte 4 Bits 1 1 32 Bytes
2 Bits
Bit Bit
profile name
[...]
profile name
...
profile name max pre alarm time
... 2 Bytes
pre alarm time post alarm time
2 Bytes 2 Bytes
motion alarm
4 Bytes
alarm input and virtual alarm
4 Bytes
video loss alarm
4 Bytes
8 24
Flags
Mask Name
Bit 6 0x40 MANAGED_BY_ONVIF
Bit 5 0x20 IMMEDIATE_ALARM_BACKUP
Bit 4 0x10 ALARM_RECORDING_PRE_ALARM_BUFFER
Bit 3 0x08 ALARM_FILE_BACKUP
Bit 2 0x04 META_RECORDING_DISABLE
Bit 1 0x02 AUDIO_RECORDING_DISABLE
Bit 0 0x01 ALARM_RECORDING_PRE_ALARM_RING
Combined Values
Mask Name
0x11 ALARM_RECORDING_PRE_ALARM_AUTO
stream config nr
Video preset number used for recording
Values:
no recording on this 0
profile
stream configuration 1 - 2
nr for pre alarm
I-frames only from 3
stream 1 for pre
alarm
Values:
not set 0 uses stream config nr if set
stream configuraton 1 - 2
nr for post alarm
I-frames only from 3
stream 1 for post
alarm
encoder index
Index of the encoder stream starting with 0, index 255 is for the backup output
Back Up Account
Backup account Number from 0 (first account) to 3(fourth account), for choosing the back up account in
case activated ALARM_FILE_BACKUP flag
profile name
Profile name is a zero terminated string
motion alarm
The bits represent the activation
Mask Name
Bit 31 0x80000000 Alarm Nbr. 32
...
Bit 1 0x00000002 Alarm Nbr. 2
Bit 0 0x00000001 Alarm Nbr. 1
Mask Name
Bit 31 0x80000000 Alarm Nbr. 0
...
Bit 17 0x00020000 Alarm Nbr. 14
Bit 16 0x00010000 Alarm Nbr. 15
Bit 15 0x8000 Virtual Nbr. 16
...
Bit 1 0x0002 Virtual Nbr. 2
Bit 0 0x0001 Virtual Nbr. 1
Mask Name
Bit 31 0x80000000 Alarm Nbr. 32
...
Bit 1 0x00000002 Alarm Nbr. 2
Bit 0 0x00000001 Alarm Nbr. 1
2.273 CONF_HD_RECORD_SCHEDULE
[API: recording settings]
Description
This command reads/writes the recording schedule for all cameras (primary and secondary recording).
The entries are 4 bit each and represent a recording profile for a 15 min time period(payload 336 bytes
total). The recording profiles with same profile number can be different for each camera. See command
HD_RECORD_PROFILES. The schedule will be written to the storage medium. In case of span recording
mode (see CONF_RECORD_MODE_SPANS) the schedule will be only read from or stored in the config.
This schedule is used as default schedule for each span that is mounted by this device for recording.
Payload Structure
Saturday Saturday
[0] ... [95]
4 Bits 4 Bits
Sunday
Sunday [0]
... [95]
4 Bits
4 Bits
Monday
Monday [0]
... [95]
4 Bits
4 Bits
Tuesday
Tuesday [0]
... [95]
4 Bits
4 Bits
Wednesday Wednesday
...
[0] [95]
4 Bits 4 Bits
Thursday Thursday
[0] ... [95]
4 Bits 4 Bits
Friday [0] Friday [95]
...
4 Bits 4 Bits
Saturday
96 entries of recording profile numbers, each represents the recording profile for a 15 min time period. First
entry is from 00:00 to 00:15. The following entries are for the following 15 min time periods until 24:00.
recording off 0
recording profile 1 - 10
number
Sunday
See 'Saturday' for details.
Monday
See 'Saturday' for details.
Tuesday
See 'Saturday' for details.
Wednesday
See 'Saturday' for details.
Thursday
See 'Saturday' for details.
Friday
See 'Saturday' for details.
2.274 CONF_HD_RECORD_SCHEDULE_SECONDARY
[API: recording settings]
Description
This command reads/writes the secondary recording schedule for the camera specified by the num
parameter. This command only works for span recording. The entries are 4 bit each and represent a recording
profile for a 15 min time period(payload 336 bytes total). The recording profiles with same profile number
can be different for each camera. See command HD_RECORD_PROFILES. The schedule will be only read
from or stored in the config. This schedule is used as default schedule for each span that is mounted by this
cam for secondary span recording.
Payload Structure
Saturday Saturday
[0] ... [95]
4 Bits 4 Bits
Sunday
Sunday [0]
... [95]
4 Bits
4 Bits
Monday
Monday [0]
... [95]
4 Bits
4 Bits
Tuesday
Tuesday [0]
... [95]
4 Bits
4 Bits
Wednesday Wednesday
...
[0] [95]
4 Bits 4 Bits
Thursday Thursday
[0] ... [95]
4 Bits 4 Bits
Friday [0] Friday [95]
...
4 Bits 4 Bits
Saturday
96 entries of recording profile numbers, each represents the recording profile for a 15 min time period. First
entry is from 00:00 to 00:15. The following entries are for the following 15 min time periods until 24:00.
recording off 0
recording profile 1 - 10
number
Sunday
See 'Saturday' for details.
Monday
See 'Saturday' for details.
Tuesday
See 'Saturday' for details.
Wednesday
See 'Saturday' for details.
Thursday
See 'Saturday' for details.
Friday
See 'Saturday' for details.
2.275 CONF_HD_RECORDING_ACTIVE
[API: recording settings]
Values:
yes 1
no 0
2.276 CONF_HD_RECORDING_REPORT
[API: recording settings]
Description
This comand reads the recording report of an actual running recording of a cam. The recording report
contains information about RTP and VDP packets as well as VDP allocation of a running recording. The
cam is specified by the num parameter.
Payload Structure
16 32
Version Reserved
1 Byte 3 Bytes
Start Seconds
4 Bytes
Start Milliseconds
4 Bytes
VDP Allocation No Wait
4 Bytes
VDP Allocation Wait
4 Bytes
VDP Allocation Fail
4 Bytes
Encoder Data...
(see description)
Encoder Data
[...]
Encoder Data
...
Storage Data...
(see description)
Storage Data
[...]
Storage Data
...
Network Data...
(see description)
Network Data
[...]
Network Data
...
8 24
Version
Version information.
Start Seconds
Timestamp in seconds since 2000 when the counting of recording data started.
Start Milliseconds
Milliseconds of the timestamp when the counting of recording data started.
Encoder Data
16 32
Video RTP Packet Count
4 Bytes
Video Byte Count
4 Bytes
Reserved
4 Bytes
Storage Data
16 32
Video VDP Packet Count
4 Bytes
Video Byte Count
4 Bytes
Reserved
4 Bytes
Audio VDP Packet Count
4 Bytes
Audio Byte Count
4 Bytes
Reserved
4 Bytes
Meta Packet Count
4 Bytes
Meta Byte Count
4 Bytes
Reserved...
16 Bytes
Reserved
...
Reserved
...
Reserved
...
8 24
Network Data
16 32
Bytes Read
4 Bytes
Bytes Write
4 Bytes
Reserved...
40 Bytes
Reserved
[...]
Reserved
...
8 24
Bytes Read
Number of Bytes that are read from storage.
Bytes Write
Number of Bytes that are written to storage.
2.277
CONF_HD_RECORDING_REPORT_SECONDARY
[API: recording settings]
Payload Structure
This payload equals the payload of the command 'CONF_HD_RECORDING_REPORT'
2.278 CONF_HD_RELOAD_PARTITION_FILE_INFO
[API: recording settings]
2.279 CONF_HD_REPLAY_AUTHENTICITY_OUT
[API: recording settings]
Description
This message will be send from a replay session, if authenticity ckeck is enabled for that session
Payload Structure
16 32
hash type hash status signature status certificate status
1 Byte 1 Byte 1 Byte 1 Byte
start time sec
4 Bytes
start time ms
4 Bytes
start tz qh reserved start rtp sq nr
1 Byte 1 Byte 2 Bytes
start rtp clock
4 Bytes
last time sec
4 Bytes
last time ms
4 Bytes
last tz qh reserved last rtp sq nr
1 Byte 1 Byte 2 Bytes
last rtp clock
4 Bytes
8 24
hash type
Hash type for authenticity check
none 0
md5 1
sha1 2
sha265 3
hash status
Hash status for authenticity check
missing 0
not checked 1
invalid 2
valid 3
signature status
Signature status
missing 0
not checked 1
missing certificate 2
invalid 3
valid 4
certificate status
Signing certificate status
not checked 0
unknown 1
invalid 2
trusted 3
owned 4
start time ms
Start time milli seconds offset
start tz qh
Start time time zone offset in quarter hours (7 lowest bits), and sign (highest bit)
reserved
start rtp sq nr
Rtp sequence number of the first packet in the sequence
last time ms
Last time milli seconds offset
last tz qh
Last time time zone offset in quarter hours (7 lowest bits), and sign (highest bit)
reserved
last rtp sq nr
Rtp sequence number of the last packet in the sequence
2.280 CONF_HD_REPLAY_CERTIFICATES_LIST
[API: replay control]
Description
This command can be used to query the certificates from the records of a camera via replay session (session
ID required), in order to verify the signed video record data within that records. The response will deliver all
certificates of the records and time intervall addressed by the specidfied replay session. The maximum size
of the response can be limited by the caller but it will not exceed 16 kb for the certificates list. If the response
payload size isnt't enough to hold all valid certificates, a flag in the response will signal the existence of
further certificates, which didn't fit in the response payload. A second query in that case with a smaller time
interval may help to get the remaining certificates. The response will have a certificates list with several
enries of different size, there are no gaps between the entries.
Request Payload Structure
16 32
Start Time
4 Bytes
End Time
4 Bytes
TZ QH Reserved
1 Byte 3 Bytes
Max List Len
4 Bytes
8 24
Start Time
Start time of the intervall in seconds since 2000 local time based on the Timezone offset in TZ QH
End Time
End time of the intervall in seconds since 2000 local time based on the Timezone offset in TZ QH
TZ QH
Timezone offset (from utc) in quarter hours as signed char value
...
Certificate [N]
(see description)
8 24
Start Time
Start time of the intervall in seconds since 2000 local time based on the Timezone offset in TZ QH
End Time
End time of the intervall in seconds since 2000 local time based on the Timezone offset in TZ QH
TZ QH
Timezone offset (from utc) in quarter hours as signed char value
Flags
Mask Name Description
Bit 0 0x01 Max Length Exceeded More certificates available, but the max length of the
certificates list was exceeded
List Len
Size of the certificates list in response payload in bytes
Certificate
16 32
Timestamp
4 Bytes
TZ QH Reserved Length
1 Byte 1 Byte 2 Bytes
Certificate...
Length Bytes
Certificate
...
8 24
Timestamp
Local time in seconds since 2000
TZ QH
Timezone offset (from utc) in quarter hours as signed char value
Length
Length of the Certificates List Entry (certificate including these 8 bytes header infos)
Certificate
One certificate
2.281 CONF_HD_REPLAY_CUSTOM_SETTINGS
[API: replay control]
Description
This command is used to configure the behaviour of an existing replay session. A valid replay session id
has to be provided.
Payload Structure
16 32
flags
4 Bytes
flags mask
4 Bytes
kbps max
4 Bytes
time shift
4 Bytes
8 24
flags
Flag field for configuring custom behavior of an replay session
Mask Name
Bit 13 0x00002000 aac 16 khz rtp clock
Bit 12 0x00001000 ignore start and end of files
Bit 11 0x00000800 transcode
Bit 10 0x00000400 set time shift
Bit 9 0x00000200 patch pic id
Bit 8 0x00000100 add rtp hdr extension
Bit 7 0x00000080 use UTC
Bit 6 0x00000040 L16 to G711
Bit 5 0x00000020 set kbps max
flags mask
Mask for the flag field, it is used to set only choosen values without changing the other values. To set a
choosen value in the flag field, the corresponding flag in the flags mask has to be set also. All other setting
will be left unchanged
kbps max
Set the max send data rate in kbit per seconds, 'set kbps max' flag has to be set in order to change that value.
time shift
Set time shift in seconds, 'set time shift' flag has to be set in order to change that value.
2.282 CONF_HD_REPLAY_ENCRYPTED_DATA
[API: recording settings]
2.283 CONF_HD_REPLAY_EVENT_INFO
[API: replay control]
Description
This command returns a list of recorded alarm events in backward order, since fw 4.0 events are only alarm
state changes. Max size of the list is 128 entries. The command needs a valid replay session. The events
start from the given end time (first 4 bytes of payload) in secconds since 2000. If the payload consists of at
least 8 bytes and the bytes 5-8 are filled with the value 0xeeeeeeee the extended event structure is used in
the response payload. Payload size with all optional parameters is 12 bytes (see "In Payload"). The response
contains a flag field, containing the alarm flags, which give information about the alarm, which are activated
at this event or if all alarms went to off state, if no one of the alarm flags were set. the flags also contains
the time zone information with sign and number of quarter hours.
Request Payload Structure
16 32
search begin time
4 Bytes
special field
4 Bytes
earliest time
4 Bytes
8 24
special field
Optional parameter, if set to 0xeeeeeeee, the reply will contain data in extended event structure format. Any
other value has no meaning yet.
earliest time
Optional parameter, Erliest time in seconds since 2000. The search won't search in record files, which lie
before that time. The search will be performed on file which lie completely or partialy within the search
interval of earliest time and search begin time. If not set, the default will be 0.
...
Event [N]
(see description)
Event
'Event' payload for '??' = 'Simple Event' (??)
16 32
Event Time
4 Bytes
Flags
4 Bytes
8 24
Event Time
Seconds since 2000.
Flags
Mask Name Description
Bit 31 0x80000000 time zone quarter hours sign 1 - negativ
Bit 30 0x40000000 time zone quarter hours
Bit 29 0x20000000 time zone quarter hours
Bit 28 0x10000000 time zone quarter hours
Bit 27 0x08000000 time zone quarter hours
Bit 26 0x04000000 time zone quarter hours
Bit 25 0x02000000 time zone quarter hours
Bit 24 0x01000000 time zone quarter hours
Bit 3 0x00000008 Virtual alarm (see CONF_VIRTUAL_ALARM_STATE)
Bit 2 0x00000004 Video Loss
Bit 1 0x00000002 Input Alarm
Bit 0 0x00000001 Motion Alarm
Combined Values
Mask Name Description
0x7f000000 time zone quarter hours
Upper X
Specifies a bounding box (upper left corner and lower right corner). If an object can be associated with the
alarm then the bounding box will be around this object otherwise the whole image is the bounding box. The
values are normalized to the image size and are between 0 and 255. The origin of the coordinate system
is the upper left corner of the image.
Upper Y
See 'Upper X' for details.
Lower X
See 'Upper X' for details.
Lower Y
See 'Upper X' for details.
Event Time
Seconds since 2000.
Flags
Mask Name Description
Bit 31 0x80000000 time zone quarter hours sign 1 - negativ
Bit 30 0x40000000 time zone quarter hours
Bit 29 0x20000000 time zone quarter hours
Bit 28 0x10000000 time zone quarter hours
Bit 27 0x08000000 time zone quarter hours
Bit 26 0x04000000 time zone quarter hours
Bit 25 0x02000000 time zone quarter hours
Bit 24 0x01000000 time zone quarter hours
Bit 3 0x00000008 Virtual alarm (see CONF_VIRTUAL_ALARM_STATE)
Bit 2 0x00000004 Video Loss
Bit 1 0x00000002 Input Alarm
Bit 0 0x00000001 Motion Alarm
Combined Values
Mask Name Description
0x7f000000 time zone quarter hours
2.284 CONF_HD_REPLAY_FAST_INTRA_DELAY
[API: replay control]
2.285 CONF_HD_REPLAY_FAST_INTRA_FPS
[API: replay control]
2.286
CONF_HD_REPLAY_FORENSIC_SEARCH_CANCEL
[API: replay control]
2.287
CONF_HD_REPLAY_FORENSIC_SEARCH_RESULT
[API: replay control]
Description
This command is a messages command. It successively delivers the results of a forensic search request.
Payload Structure
16 32
Forensic Search ID
4 Bytes
Sequence Number Number of Events Last Message
2 Bytes 1 Byte 1 Byte
Progress Time
4 Bytes
Timezone Event type Reserved
1 Byte 1 Byte 2 Bytes
Event [0]
(see description)
...
Event [
Number of Events
- 1]
(see description)
8 24
Forensic Search ID
With the forensic search ID this event message can be assigned to the corresponding search request.
Sequence Number
The sequence number is increasing and missing packets can be detected.
Last Message
The last message byte is signalling that the search has been accomplished with this message.
Progress Time
This time informs about the progress of the search. The time is given in seconds since 1-1-2000 (local time).
This time is updated every second (search time) and forces to throw this message. Hence, it can be expected
that at least every second a message will be thrown.
Timezone
Timezone in quarter hours (signed byte in two's complement representation).
Event type
Object Event 0
Error Event 1
Event
'Event' payload for 'Event type' = 'Object Event' (0)
16 32
Begin
4 Bytes
Duration Rule ID Reserved
2 Bytes 1 Byte 1 Byte
Event duration in ms
4 Bytes
Object ID
4 Bytes
Bounding Box
4 Bytes
8 24
Begin
The beginning of the event is provided in local time in seconds since 2000 and milliseconds.
Duration
Duration of the event in ms.
Rule ID
The Rule ID informs which rule is related to this event.
Object ID
Object ID which has caused the alarm.
Bounding Box
Bounding box of object in normalized coordinates from 0 to 255. First, the upper left point is encoded then
the lower right point of the bounding box. The coordinate (0,0) is the upper left corner of the image and the
point (255,255) is the lower right corner of teh image. The bounding box is from the begin time.
Error
type Error text...
1 64 Bytes
Byte
Error text
...
Error text
...
Error text
...
Error type
Values:
e_ForensicSearchErrorNone 0x00
e_ForensicSearchErrorInternal 0x02
e_ForensicSearchErrorNoMetaData 0x07
e_ForensicSearchErrorDataDoesNotMatch 0x08
Error text
The error text is a detailed description of the error. E.g. for syntax errors the line of the script and error
type are mentioned.
2.288
CONF_HD_REPLAY_FORENSIC_SEARCH_SETUP
[API: replay control]
Description
This command is related to a replay session. The replay session will start a forensic search with the provided
ruleengine script.
In the successful mode the return payload consists of an unique 4 byte ForensicSearch ID which
can be refound in the corresponding message (HD_REPLAY_FORENSIC_SEARCH_RESULT). In the
case of an error the RCP_ERROR_COMMAND_SPECIFIC error is returned with an error code (see
HD_REPLAY_FORENSIC_SEARCH_RESULT).
Request Payload Structure
16 32
Start Time
4 Bytes
End Time
4 Bytes
Reserved
4 Bytes
Script Length Script Mode VCA Profile ID
2 Bytes 1 Byte 1 Byte
Layer Mode Flags Layer Mask
1 Byte 1 Byte 2 Bytes
Script Data...
(see description)
Script Data
...
8 24
Start Time
Start time of forensic search in seconds since 2000 (local time).
End Time
End time of forensic search in seconds since 2000 (local time).
Script Length
Length of the script. If the length of the script is zero a default search is performed, i.e. 'Detect any object
or Detect any Flow or Detect any Motion'.
Script Mode
The mode defines how the configuration data has to interpreted. See detailed description of configuration
data for each case below.
VCA Profile ID
VCA profile id search is supported. The recommended profile id is zero resulting in an exhausting search
over the given interval. With a non zero profile id the seacrh speed can be increased because meta data
recorded with different a profile are skipped.
Layer Mode
Flags
Mask Name Description
Bit 3 0x08 Flag Clear Cache Collected VCD packets will be deleted, next search
will start new replay
Bit 2 0x04 Flag Cache Data Collects compressed VCD data, next search will use
collected VCD packets
Bit 1 0x02 Flag Verbose Additional printouts
Bit 0 0x01 Flag Send Send layer data
Layer Mask
The layer mask is only used if layer mode is set to 1.
Script Data
'Script Data' payload for 'Script Mode' = 'Rule Engine Configuration' (0x00)
In this mode the configuration data contains the whole rule engine configuration (eg including camera
calibration). For more detailed information see the rcp command: CONF_VCD_OPERATOR_PARAMS.
'Script Data' payload for 'Script Mode' = 'Rule Engine Script Only' (0x01)
If the script mode is selected to "rule engine script only" the configuration data contains the rule engine
script. The script is encoded in plain text. One of these examples can be used as a valid script.
'Script Data' payload for 'Script Mode' = 'In Field Search' (0x02)
16 32
Upper left x-coordinate Upper left y-coordinate
2 Bytes 2 Bytes
Lower right x-coordinate Lower right y-coordinate
2 Bytes 2 Bytes
Debounce time Field flags
2 Bytes 2 Bytes
8 24
A field search is define by two normalized points. Each point is normalized between 0 and 65535. The upper
left corner of the image has the coordinates (0,0) and the lower right corner (65535,65535). Additionally,
debounce time and intersection mode can be addressed.
Debounce time
The debounce time is given in units of 10 ms.
Field flags
Mask Name Description
Bit 1 0x0002 Field mode BaryCenter (0, default) or Boundingbox (1)
Bit 0 0x0001 Object mode Intersection (0, default) or Covering (1)
'Script Data' payload for 'Script Mode' = 'Crossing Line Search' (0x03)
16 32
Upper left x-coordinate Upper left y-coordinate
2 Bytes 2 Bytes
Lower right x-coordinate Lower right y-coordinate
2 Bytes 2 Bytes
Debounce time Direction Reserved
2 Bytes 1 Byte 1 Byte
8 24
A line crossing search is define by two normalized points. Each point is normalized between 0 and 65535.
The upper left corner of the image has the coordinates (0,0) and the lower right corner (65535,65535).
Debounce time
The debounce time is given in units of 10 ms.
Direction
One can choose whether any object which passes the line triggers an event or whether only objects which
pass from left to right respectively right to left are relevant:
Any Direction 0 Any object which passes the line triggers an event
Left To Right 1 Only objects which pass from left to right triggers an event
Right To Left 2 Only objects which pass from right to left triggers an event
2.289 CONF_HD_REPLAY_LIVE
[API: replay control]
2.290 CONF_HD_REPLAY_MOTION_SAMPLES
[API: replay control]
2.291 CONF_HD_REPLAY_PREFETCH_JPEGS
[API: replay control]
2.292 CONF_HD_REPLAY_SEEK_IFRAME
[API: replay control]
2.293 CONF_HD_REPLAY_SEEK_TIME
[API: replay control]
Description
This command will return a write error if the timeposition is outside a recording set. The Session ID is
needed.
Response Payload Structure
16 32
Seconds
4 Bytes
8 24
Seconds
Absolute time in seconds since 1.1.2000 00:00h.
Seconds
Absolute time in seconds since 1.1.2000 00:00h.
Rtp Timestamp
Rtp timestamp of the first replayed RTP packet of this second.
16 32
Seconds
4 Bytes
DetailedData (optional)
(see description)
8 24
Seconds
Absolute time in seconds since 1.1.2000 00:00h.
DetailedData (optional)
16 32
Miliseconds Flags Payload
2 Bytes 1 Byte 1 Byte
Conf_roi...
(see description)
Conf_roi
...
Reserved...
16 Bytes
Reserved
...
Reserved
...
Reserved
...
8 24
Flags
Mask Name Description
Bit 2 0x04 Sec Accuracy seek time accuracy to seconds (transcoder case only)
Bit 1 0x02 Iframe Preview sends the Iframe on the seek position (transcoder
case only)
Bit 0 0x01 Time Zone payload contains the timezone as quarter hours
offset (signed char)
Payload
One payload byte, conntend depends on the flags field
Conf_roi
Select region of interest hPos,vPos,hSize,vSize (each entry 2 bytes): starting left upper edge, each 2bytes
0..32768, vSize==0 means keep aspect ratio
16 32
hPos vPos
2 Bytes 2 Bytes
hSize vSize
2 Bytes 2 Bytes
8 24
2.294 CONF_HD_REPLAY_SEQUENCE_VERIFY
[API: replay control]
2.295 CONF_HD_REPLAY_SIZE_INFO
[API: replay control]
Description
Replay session id required. Start time and stop time has to be within one file.
Request Payload Structure
16 32
Starttime
4 Bytes
Stoptime
4 Bytes
8 24
Starttime
In seconds since 2000.
Stoptime
In seconds since 2000.
Max Size
Max size in bytes on storage, including recording overhead, replay stream size will be less.
2.296 CONF_HD_REPLAY_START
[API: replay control]
2.297 CONF_HD_REPLAY_START_EX
[API: replay control]
2.298 CONF_HD_REPLAY_STOP
[API: replay control]
2.299 CONF_HD_REPLAY_STOP_TIME
[API: replay control]
Description
This command will return a write error if the timeposition is outside a recording set. The Session ID is
needed. A value of zero clears the stop marker.
Payload Structure
16 32
Seconds
4 Bytes
Milliseconds
4 Bytes
8 24
Seconds
Absolute time in seconds since 1.1.2000 00:00h.
2.300 CONF_HD_REPLAY_VCD_CONFIG_ID
[API: replay control]
2.301 CONF_HD_REPLAY_VCD_LAYER
[API: replay control]
2.302 CONF_HD_SET_VRM_LOCK
[API: recording settings]
Payload Structure
16 32
Target ID
4 Bytes
Target idx Lun Reserved
1 Byte 1 Byte 2 Bytes
Flags
4 Bytes
8 24
Target ID
Target id of the lun (may be the ipv4 address for older versions or with default target resolve configuration,
see CONF_TARGET_ID_RESOLVE_RULES)
Target idx
Target index of the storage device
Lun
Lun of the storeage device
Flags
Mask Name
Bit 0 0x00000001 SET_VRM_LOCK
2.303 CONF_HD_SIZE_MB
[API: recording settings]
2.304
CONF_HDD_RECORD_ALARM_RING_INIT_SIZE
[API: storage]
2.305 CONF_HDD_RECORD_ENCRYPTION
[API: storage]
2.306 CONF_HDD_VCD_CACHE_SIZE
[API: recording settings]
Description
This command can be used to configure the size of the vcd cache on a span for recording. The size parameters
are rellativ to 1 GB span size. If recording is running on soans with diffrent sizes than 1 GB, the values will
be internally scaled to the propper size, so it will also work for diffrent span sizes. The usage of a vcd cache
on spans will cause space overhead on a storage, so it is possible to switch it of by setting both values to 0. If
enabled, the recording will use these values to adjust the size of the vcd cache on spans. The used adjusted
sizes will be than limited by these two values, upper limit and lower limit. The adjusment starting value
will be between these to values. While recording, the uses space for cached vcd data will be measured and
after each span switch, the size will be adjusted by using the measurement values for new mounted spans
in order to avoid overhead. It is also possible to set a fix size for the vcd cache by this command by setting
the upper and lower limit to equal values. The default value for the command is 1 for lower limit and 128
for upper limit. For read direction an input payload is needed same as the described payload but only line
and rec idx are required, the remaining part of the payload can be clipped away.
Payload Structure
16 32
line rec idx
2 Bytes 2 Bytes
lower size limit upper size limit
2 Bytes 2 Bytes
8 24
line
Line from 1 to n.
rec idx
Rec index: 1 - primary recording, 2 - secondary recording.
2.307 CONF_HEATER_MODE
[API: system.settings]
Values:
off 0
on 1
auto 2
2.308 CONF_HOME_EVENT
[API: system.settings]
Payload Structure
Number of tagged elements
4 Bytes
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: HOME_EVENT_TAGS_TOPIC
onvif topic
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
HOME_EVENT_TAGS_TOPIC (p_string)
Length - 4 Bytes
8 24
Tag 2: HOME_EVENT_TAGS_MESSAGE
event payload
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
HOME_EVENT_TAGS_MESSAGE (p_string)
Length - 4 Bytes
8 24
Tag 3: HOME_EVENT_TAGS_ISPROPERTY_EVENT
16 32
Length = 0x0024 Tag = 0x0003
2 Bytes 2 Bytes
HOME_EVENT_TAGS_ISPROPERTY_EVENT (t_dword)
4 Bytes
8 24
Values:
event is a property event 0
event is no property event 1
2.309 CONF_HOST_NAME
[API: system.settings]
2.310 CONF_HSTS_ENABLED
[API: http settings]
Values:
OFF 0
ON 1
ON plus HTTP redirection 2 ON+ Http port redirect to HTTPS when HTTP port is
also set to 0
2.311 CONF_HTTP_LIVE_AUDIO
[API: http live streaming]
2.312 CONF_HTTP_LIVE_BITRATE
[API: http live streaming]
2.313 CONF_HTTP_SESSION_COOKIE_NAME
[API: browser]
2.314 CONF_HUMIDITY_VALUE
[API: system.status]
2.315 CONF_IGMP_VERSION
[API: multicast]
Values:
Automatic from network 0
Version1 1
Version2 2
Version3 3
2.316 CONF_ILLUMINATION_INTENSITY
[API: I/Os]
2.317 CONF_ILLUMINATOR_OPTIONS
[API: I/Os]
2.318 CONF_ILLUMINATOR_STATE
[API: I/Os]
2.319 CONF_INFO_STAMP_VAL
[API: stamping]
2.320 CONF_INPUT_PIN_NAME
[API: alarm]
2.321 CONF_INPUT_PIN_STATE
[API: alarm]
2.322 CONF_INPUT_SOURCE_VAL
[API: video input]
Values:
camera 1
vcr 2
color_plane 3
auto 4
2.323 CONF_INSTALLER_SEQUENCE
[API: system.settings]
Values:
installer sequence deactivated 0
installer sequence allowed 1
2.324 CONF_INTERNAL_STORAGE_ENCRYPTION
[API: storage]
2.325 CONF_IP
[API: ethernet]
2.326 CONF_IP_STR
[API: ethernet]
2.327 CONF_IP_V6_PREFIX_LEN
[API: ethernet]
2.328 CONF_IP_V6_STR
[API: ethernet]
2.329 CONF_IPV4_ENABLE
[API: ethernet]
Values:
IPv4 enabled 1
IPv4 disabled 0
2.330 CONF_IPV4_FILTER
[API: ethernet]
2.331 CONF_IPV6_ENABLE
[API: ethernet]
Values:
IPv6 enabled 1
IPv6 disabled 0
2.332 CONF_ISCSI_AUTH
[API: iscsi]
Payload Structure
Authentication Descriptor
(see description)
Authentication Descriptor
This Authentication Descriptor can, but must not, repeat up to 2 times on camera and encoder devies an up
to 16 times on Windows Generic variants.
16 32
Target Address...
(see description)
Target Address
...
Type
4 Bytes
Params...
(see description)
Params
[...]
Params
...
8 24
Target Address
The address of the iscsi target. If this field is set to zero, it is used as the default entry for authenticaion.
16 32
Target ID
4 Bytes
Target Index Flags Target Port
1 Byte 1 Byte 2 Bytes
8 24
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES). If this field is set to -1 (0xFFFFFFFF), this
descriptor is used for all remaining targets, for that no explicit descriptor is provided (default).
Target Index
The target index of the iscsi target. If this field is set to -1 (0xFF), this descriptor is used for all remaining
iscsi targets with the same ip, for that no explicit descriptor is provided (default).
Flags
Mask Name
Bit 1 0x02 Not For Target
Bit 0 0x01 HTTP Tunnel
Target Port
The port of the iscsi target. If this value is set to zero, the port configured in CONF_ISCSI_PORT is used.
Note: For an iscsi session, all authentication descriptors are searched for the target address. If this address
is found, the authentication information is used. If that descriptor is not found, but the array contains a
descriptor with the same ip and the target index set to default (0xFF), the information in this record is
used instead. If that descriptor is not found, but the array contains an descriptor with the ip address set to
default (0xFFFFFFFF), the information in this record is used instead. If that descriptor is not found, no
authentication will be performed for that iscsi session.
Type
None 0
CHAP 1
SMB (not supported)2
Params
This field with the the two entries for user and password only need to be in place when "Type" is set to
"CHAP" (1).
Username and password is presented as ASCII string with fixed length of 64 characters. Not used trailing
characters must be filled with null character.
User
The user name that is used for authentication.
Password
The password that is used for authentication (CHAP: N = 64 Bytes, SMB: N = 32 Bytes).
Note: On a read command, the characters of the password are replaced by the '*'. On a write command, the
password is only stored, if not all characters equal the '*' sign. Otherwise the old stored value is retained.
2.333 CONF_ISCSI_DATARATE
[API: iscsi]
2.334 CONF_ISCSI_DISCOVERY
[API: iscsi]
2.335 CONF_ISCSI_DISV_CACHE
[API: iscsi]
Description
This command can be used to read and write individual entries of the discovery cache.
The command supports reading and writing cache entries.
Read Payload Structure
16 32
...
8 24
On input you can provide one, two or all three of the following tags. With these tags you can define filters
for the cache entries returned. The payload of the response is sequence of Cache Entry structure as described
below.
If provide no parameters (no tag) the command returns all known IP of all target indexes and LUNs in
the discovery cache. Be aware, that the output could get too long for the output buffer and there might be
missing entries.
If you provide only the IP address tag, the command will return all targets and all known LUNs and the
paths for the given IP address in the discovery cache.
If you provide both IP address and a target index tag, the command will return all known LUNs and all the
paths for this target in the discovery cache.
If you only provide a LUN number, the paths for this LUN in all discovery cache entries will be returned.
There is a reserved LUN number 0xFFFFFFFF which will always return only the first LUN of an entry in
the discovery cache. If you provide this reserved LUN number without an IP address, you will get all entries
in the discovery cache with only the paths for the first LUN. This is a good way to get the IP and target
index of all known targets in the discovery cache without overflowing the output buffer.
If you provide an IP address, a target index and a LUN number the command will return only the paths
for this target and the given LUN.
If there is no cache entry available which matches the given filter, the command returns the 'Tag 0x0003:
No entry available' tag. In case of this command the tag always return 0x00000000 as error code (no error).
Filter tags
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
IP Addresses Tag (p_octet)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
LUN Number Tag (p_octet)
Length - 4 Bytes
8 24
16 32
Length Tag = 0x000b
2 Bytes 2 Bytes
Target Index Tag (p_octet)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0003
2 Bytes 2 Bytes
Response: No entry found tag (t_dword)
4 Bytes
8 24
Error Codes:
ISCSI_ERR_NONE 0x00
ISCSI_ERR_CONNECT 0x31
ISCSI_ERR_INV_LUN 0x33
ISCSI_ERR_LOGIN 0x34
ISCSI_ERR_INV_TARG_IDX 0x35
ISCSI_ERR_PWD 0x36
ISCSI_ERR_PROTO 0x37
ISCSI_ERR_TARG_NOT_REACH 0x38
ISCSI_ERR_NO_MEM 0x3a
ISCSI_ERR_SESS_CREATE 0x3b
ISCSI_ERR_INV_PARAMS 0x3c
ISCSI_ERR_SESS_NOT_FOUND 0x3d
ISCSI_ERR_DISCONN 0x3e
ISCSI_ERR_TIMEOUT 0x3f
ISCSI_ERR_TARGET_NOT_SUPP 0x40
ISCSI_ERR_TARGET_SESSION_LIMIT0x41
ISCSI_ERR_CMD_NOT_SUPP 0x42
ISCSI_ERR_TARGET_NOT_FOUND 0x43
ISCSI_ERR_SOCK 0x5f
ISCSI_ERR_TARG_PM 0x6f
ISCSI_SOCK_CLOSED 0x7f
ISCSI_ERR_TCP_CONN_RST 0x8f
ISCSI_ERR_INTR_NOT_SUPP 0x9f
ISCSI_ERR_IP_ZERO 0xa0
ISCSI_ERR_OUT_OF_RES 0xa1
CacheEntry
In write direction the command expects the Cache Entry encoding described below. This encoded cache
entry is written to the discovery cache. Cache entries which are written with this command are stored in
persistent cache and are persistent over a device reset.
In write direction this command must carry a valid external instance bitmask which has to be unequal 0. If
it is 0 the command is returned with an error.
To delete such an entry you must provide the Cache Entry encoding with only the target IP, target index
and external instance tag. The entry is cleared, when all external instance bits are cleared.
Every cache entry is started with a surrounding start tag (0x8009) followed by the IP for which this entry
was generated (tag 0x000a). After this IP entry the target index is indicated to resolve a unique target on
this IP (tag 0x000b). A surrounding tag (0x8008) marks one LUN entry which has several path entries, each
surrounded by a 0x8004 tag.
If there is no entry the 'Tag 0x0003: No entry available' tag is returned."
CacheEntry
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x8009
2 Bytes 2 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x000a
2 Bytes 2 Bytes
Target IP Tag (t_dword)
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x000b
2 Bytes 2 Bytes
Target Index Tag (t_dword)
4 Bytes
8 24
16 32
Length Tag = 0x000c
2 Bytes 2 Bytes
IQN String Tag (p_string)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x000d
2 Bytes 2 Bytes
External Instance Bitfield Tag (t_dword)
4 Bytes
8 24
16 32
Length = 0x0020 Tag = 0x8008
2 Bytes 2 Bytes
8 24
16 32
Length = 0x0020 Tag = 0x8004
2 Bytes 2 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0005
2 Bytes 2 Bytes
Path IP Tag (t_dword)
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0006
2 Bytes 2 Bytes
LUN Number Tag (t_dword)
4 Bytes
8 24
2.336 CONF_ISCSI_FLUSH_DISVCACHE
[API: iscsi]
Description
This command flushes one entry in iSCSI discovery cache. Providing an IP and target index is mandatory.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0014 Tag = 0x02
2 Bytes 2 Bytes
IPv6...
16 Bytes
IPv6
...
IPv6
...
IPv6
...
8 24
16 32
Length = 0x0024 Tag = 0x03
2 Bytes 2 Bytes
Target Index (t_dword)
4 Bytes
8 24
2.337 CONF_ISCSI_INITIATOR_NAME
[API: iscsi]
2.338 CONF_ISCSI_INITIATOR_NAME_EXTENTION
[API: iscsi]
2.339 CONF_ISCSI_IP
[API: iscsi]
2.340 CONF_ISCSI_LOCK_OVERRIDE
[API: iscsi]
Payload Structure
Target
N Bytes
Note: The datatype of this command was FLAG and changed to STRING with fw 2.50. The target_id needs
o be resolved by rules configured by CONF_TARGET_ID_RESOLVE_RULES. In older version the target
id was the ipv4 address, which is now the default rule for target id resolving. The string format of the target
id is the same as of the ipv4.
2.341 CONF_ISCSI_LOCK_RELEASE_ON_LEAVE
[API: iscsi]
2.342 CONF_ISCSI_LOWERDATARATE
[API: iscsi]
2.343 CONF_ISCSI_LUN
[API: iscsi]
2.344 CONF_ISCSI_MNI
[API: iscsi]
Description
Use this command to monitor iscsi targets.
If you write this command, all the targets of the request packets are added/delete to the current monitoring
list.
If you read this command, you will get the description of all currently monitored iscsi targets in the response
packet.
Every time the status of a monitored target changes, a message is sent out with the current status of this
target.
Request Payload Structure
Target Descriptor [0]
(see description)
...
Target Descriptor
16 32
Target Address...
(see description)
Target Address
...
Action Reserved...
1 Byte 19 Bytes
Reserved
...
Reserved
...
Reserved
...
Reserved
...
8 24
Target Address
16 32
Target ID
4 Bytes
Target Index Flags Target Port
1 Byte 1 Byte 2 Bytes
8 24
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES). If this field is set to -1 (0xFFFFFFFF), this
descriptor is used for all remaining targets, for that no explicit descriptor is provided (default).
Target Index
The target index of the iscsi target. If this field is set to -1 (0xFF), this descriptor is used for all remaining
iscsi targets with the same ip, for that no explicit descriptor is provided (default).
Flags
Mask Name
Bit 1 0x02 Not For Target
Bit 0 0x01 HTTP Tunnel
Target Port
The port of the iscsi target. If this value is set to zero, the port configured in CONF_ISCSI_PORT is used.
Action
Delete 0x00
Add 0x01
...
Target Descriptor
16 32
Target Address...
8 Bytes
Target Address
...
Action Status Error Reserved
1 Byte 1 Byte 1 Byte 1 Byte
Starttime
4 Bytes
Session Status Session Error Reconnects
1 Byte 1 Byte 2 Bytes
Reserved
4 Bytes
Uptime
4 Bytes
8 24
Target Address
16 32
Target ID
4 Bytes
Target Index Flags Target Port
1 Byte 1 Byte 2 Bytes
8 24
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES). If this field is set to -1 (0xFFFFFFFF), this
descriptor is used for all remaining targets, for that no explicit descriptor is provided (default).
Target Index
The target index of the iscsi target. If this field is set to -1 (0xFF), this descriptor is used for all remaining
iscsi targets with the same ip, for that no explicit descriptor is provided (default).
Flags
Mask Name
Bit 1 0x02 Not For Target
Bit 0 0x01 HTTP Tunnel
Target Port
The port of the iscsi target. If this value is set to zero, the port configured in CONF_ISCSI_PORT is used.
Action
The value of the request packet. Zero in messages.
Delete 0x00
Add 0x01
Status
Fail 0x00
Success 0x01
Error
ISCSI_NO_ERROR 0x00
ISCSI_MNI_ERR_INV_TARG 0x01 if the assigned target address is invalid (e.g. zero).
ISCSI_MNI_ERR_FULL 0x02 if the maxium of 64 iscsi targets is reached and a
request packet with the ADD action was sent.
ISCSI_MNI_ERR_TARG_PRES 0x03 if a request packet if the ADD action was sent and the
target address is already monitored.
ISCSI_MNI_ERR_NOT_FOUND 0x04 if a request packet if the DELETE action was sent and
the target address is not currently monitored.
ISCSI_MNI_ERR_INTERN 0x05
Starttime
The time when the monitoring process was started (in seconds since 2000).
Session Status
OFFLINE 0x00
ONLINE 0x01
ERROR 0x02
Session Error
ISCSI_ERR_CONNECT 0x31
ISCSI_ERR_LOGIN 0x34
ISCSI_ERR_INV_TARG_IDX 0x35
ISCSI_ERR_PWD 0x36
ISCSI_ERR_PROTO 0x37
ISCSI_ERR_TARG_NOT_REACH 0x38
ISCSI_ERR_NO_MEM 0x3a
ISCSI_ERR_SESS_CREATE 0x3b
ISCSI_ERR_INV_PARAMS 0x3c
ISCSI_ERR_SESS_NOT_FOUND 0x3d
ISCSI_ERR_DISCONN 0x3e
ISCSI_ERR_TIMEOUT 0x3f
ISCSI_ERR_SOCK 0x5f
ISCSI_SOCK_CLOSED 0x7f
ISCSI_ERR_TCP_CONN_RST 0x8f
ISCSI_ERR_IP_ZERO 0xa0
Reconnects
The number of times the session was reconnected since the begin of the monitoring process.
Uptime
The number of seconds the session is online.
2.345 CONF_ISCSI_MP_DISCOVER
[API: iscsi]
Description
This command initiates a multipath discovery of a target. This means iSCSI stack tries to detect all known
alternative pathes for all LUNs for the given main path.
The user can select alternative pathes to be scanned with the 0x0003 tag. If no 0x0003 tag is given all pathes
found at discovery are scanned.
ATTENTION: The command can take up to the amount of scanned pathes multiplied with 10 seconds to
complete! This scan does not create any persistent discovery cache entries. All cached data is cleared after
the scan.
Request Payload Structure
16 32
Tag-Structure [0]
...
Tag-Structure [N]
8 24
The payload must contain the tag 0x0001 and the tag 0x0002. Optionally you can pass one or more tag
0x0003 to tell the command to only scan the given pathes. The payload of the tag 0x0001 and tag 0x0003
can either be IPv4 or IPv6. Which IP is contained is indiacted by the tag length. 0x0008 is IPv4 0x0014 is
IPv6. The tag 0x0002 indicates a target index.
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 0x0001: IP
Indicates the main path to the target to scan
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
IP (p_octet)
Length - 4 Bytes
8 24
IP
Payload for 'Length' = '8'
16 32
IPv4
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0002
2 Bytes 2 Bytes
Target Index (t_dword)
4 Bytes
8 24
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
Alternative path (p_octet)
Length - 4 Bytes
8 24
Alternative path
Payload for 'Length' = '8'
16 32
IPv4
4 Bytes
8 24
IPv6
...
IPv6
...
8 24
2.346 CONF_ISCSI_MULTIPATH
[API: iscsi]
Values:
off 0
only use prefered pathes 1
use all pathes 2
use NetApp specific path selection 3
2.347 CONF_ISCSI_MULTIPATH_STATE
[API: iscsi]
Description
The message normally contains one or more 0x00 tags or one 0x04 tag if there is no active iSCSI connection.
Inside the 0x00 tag there should appear one 0x01, 0x05, 0x02, 0x03 and 0x06 tag.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
The length field contains the length of all included subtags plus the group header itself.
The group tag is present to simplify parsing and to join subtags to a unique connection description.
16 32
Length = 0x0020 Tag = 0x8000
2 Bytes 2 Bytes
8 24
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Main path IP (p_octet)
Length - 4 Bytes
8 24
Main path IP
Payload for 'Length' = '8'
16 32
IPv4
4 Bytes
8 24
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
Connected IP (p_octet)
Length - 4 Bytes
8 24
Connected IP
Payload for 'Length' = '8'
16 32
IPv4
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0003
2 Bytes 2 Bytes
Connection state (t_dword)
4 Bytes
8 24
16 32
Length = 0x0020 Tag = 0x0004
2 Bytes 2 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0005
2 Bytes 2 Bytes
Target index (t_dword)
4 Bytes
8 24
No Multipath 0 The target has no multipath support and only one of the states Bit 0 (offline)
and Bit 1 (connected optimized) is reported, as the target can only be on- or
offline. It has no alternative pathes.
Multipath 1 The target supports multipathing and there are alternative pathes available.
All states from above can be reported for the target.
Example
This is the payload when a target supports multipathing. The IP of the origin connection is 10.1.1.10. The
target with index 2 on this IP is used. The connection runs over the IP 10.1.1.12 at the moment. This is a
path which is marked as non optimized.
16 32
Length Group Tag
0x001c 0x8000
Length Subtag
0x0008 0x0001
IPv4
0x0a 0x01 0x01 0x0a
Length Subtag
0x001c 0x0005
Target Index
0x00 0x00 0x00 0x02
Length Subtag
0x001c 0x0002
IPv4
0x0a 0x01 0x01 0x0c
Length Subtag
0x001c 0x0003
Flags
0x00 0x00 0x1 0x00 (uint32 0x00000010)
Length Subtag
0x001c 0x0006
Multipath support
0x00 0x00 0x00 0x01 (uint32 0x00000001)
8 24
When no iSCSI connection is requested/active at the moment (e.g. no recording running), the following
payload is returned
16 32
Length No active connection Tag
0x001c 0x0004
8 24
2.348 CONF_ISCSI_PORT
[API: iscsi]
2.349 CONF_ISCSI_READDATARATE
[API: iscsi]
2.350 CONF_ISCSI_SEG_SIZE
[API: iscsi]
2.351 CONF_ISCSI_SERVER_STATE
[API: iscsi]
Note: The iscsi server is also started or stopped when you write the command CONF_STORAGE_LIST. If
the storage list is empty or only contains entries with the 'iSCSI export' field set to 'For local use only' (0x00),
the server is stopped if it is running cause no targets and luns would be provided. If the list contains at least
one entry with the 'iSCSI export' field set to 'Make storage available through iSCSI' (0x01), the server is
started, if not already running, to provide the iscsi service.
2.352 CONF_ISCSI_TARGET
[API: iscsi]
2.353 CONF_ISCSI_TARGET_IDX
[API: iscsi]
2.354 CONF_ISCSI_TARGET_PWD
[API: iscsi]
2.355 CONF_ISCSI_TCP_CONNECTIONS
[API: iscsi]
2.356 CONF_IVA_COUNTER_VALUES
[API: viproc]
Description
This command, which is at the same time a message, is used to retrieve the list of configured counters with
the their current values. The output has the following structure: Initially the number of configured counters
is set. Afterwards for each counter the data consisting of counter id, counter type, counter name in unicode
and counter value is provided.
Payload Structure
Number of Counters Counter Data [0] ...
1 Byte (see description)
Counter Data [0]
...
(see description)
Number of Counters
This values gives the number of counters available in the payload. In the subsequent the data of each counter
are sequentially provided.
Counter Data
16 32
Id Type Name...
1 Byte 1 Byte 64 Bytes
Name
[...]
Name
...
Name Value...
... 4 Bytes
Value
...
8 24
Id
Each counter has a unique id.
Type
Not supported yet.
Name
A unique name can be assigned to a counter, which is stored in unicode (maximum: 32 characters).
Value
The current counter value (DWORD).
2.357 CONF_JPEG
[API: encoder]
Description
Reads a jpeg that can be configured by the optional input payload.
Request Payload Structure
16 32
Jpeg resolution Jpeg quality reserved...
1 Byte 1 Byte 14 Bytes
reserved
...
reserved
...
reserved
...
borderY borderU borderV borderWidth
1 Byte 1 Byte 1 Byte 1 Byte
8 24
Jpeg resolution
QCIF 0
CIF 1
CIF 2
4CIF 3
Jpeg quality
Quality 0 - 100 0 is best.
JPEG picture
N Bytes
2.358 CONF_JPEG_BANDWIDTH_KBPS
[API: encoder]
2.359 CONF_JPEG_STREAM_FRAME_RATES
[API: encoder]
Description
Only read is supported.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Global frame rates, independent from the resolution (p_octet)
Length - 4 Bytes
8 24
...
Frame Rate
Frame rate in mHz
2.360 CONF_JPEG_STREAM_SETUP
[API: encoder]
Payload Structure
16 32
Id
4 Bytes
FPS in mHz
4 Bytes
Quality
4 Bytes
8 24
Quality
Quality 0 - 100
Auto 0
Worst 1
Best 100
2.361
CONF_JPEG_STREAM_SETUP_OPTIONS_VERBOSE
[API: encoder]
Description
Allows to query information about the ids and the allowed ids configurable via
CONF_JPEG_STREAM_SETUP. Only read is supported.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0014 Tag = 0x0000
2 Bytes 2 Bytes
Setup id with width and height (p_octet)
16 Bytes
8 24
Id
Id supported in CONF_JPEG_STREAM_SETUP command
Width
Jpeg width, 0 -> device automaticaly decides which resolution delivers the best performance in conjuction
with the current encoder configuration
Height
Jpeg height, 0 -> device automaticaly decides which resolution delivers the best performance in conjuction
with the current encoder configuration
2.362 CONF_KBD_CONFIG_CAMERA
[API: Keyboard]
Payload Structure
16 32
IP
4 Bytes
Line Coder Preset Reserved
1 Byte 1 Byte 1 Byte 1 Byte
8 24
IP
Encoder/Camera IP
Line
Video input line
Coder
Relative coder number (relative to line)
Preset
(Dome-) Preset Position (optional). (Every Preset of a Dome can be treated as a seperate camera). Set to
'0' for don't care.
2.363 CONF_KBD_CONFIG_CAMERA_STR
[API: Keyboard]
Payload Structure
16 32
Line Coder Preset URL Length
1 Byte 1 Byte 1 Byte 1 Byte
URL
URL Length Bytes
8 24
Line
Video input line
Coder
Relative coder number (relative to line)
Preset
(Dome-) Preset Position (optional). (Every Preset of a Dome can be treated as a seperate camera). Set to
'0' for don't care.
URL Length
Length of the following url (actual limit is 80).
URL
Encoder/Camera URL
2.364 CONF_KBD_CONFIG_MONITOR
[API: Keyboard]
Payload Structure
16 32
IP
4 Bytes
Line Coder Reserved
1 Byte 1 Byte 2 Bytes
8 24
IP
Decoder/Monitor IP
Line
Video output line
Coder
Relative coder number (relative to line)
2.365 CONF_KBD_CONFIG_MONITOR_STR
[API: Keyboard]
Payload Structure
16 32
Line Coder URL Length Reserved
1 Byte 1 Byte 1 Byte 1 Byte
URL
URL Length Bytes
8 24
Line
Video output line
Coder
Relative coder number (relative to line)
URL Length
Length of the following url (actual limit is 80).
URL
Decoder/Monitor URL
2.366 CONF_KBD_CONFIG_SALVO
[API: Keyboard]
Payload Structure
16 32
Duration Reserved
2 Bytes 2 Bytes
Camera [0] Camera [N]
...
1 Byte 1 Byte
8 24
Duration
Duration of one salvo position in seconds
Camera
Camera number for salvo
2.367 CONF_KBD_CONNECT_PARAMS
[API: Keyboard]
Payload Structure
16 32
Flags Reserved
2 Bytes 2 Bytes
8 24
Flags
Mask Name Description
Bit 1 0x0002 Request Audio RX Speak at decoder side
Bit 0 0x0001 Request Audio TX Listen at decoder side
2.368 CONF_KBD_KEY_LABEL
[API: Keyboard]
2.369 CONF_KBD_PASSWORD
[API: Keyboard]
2.370 CONF_KBD_PASSWORD_CAMERA
[API: Keyboard]
2.371 CONF_KBD_SET_ALARM
[API: Keyboard]
2.372 CONF_LED_BLINKING
[API: debug]
2.373 CONF_LED_CAPS
[API: system.settings]
2.374 CONF_LENS_ROTATION
[API: calibration]
2.375 CONF_LICENSE_LOCK_CODE
[API: system.settings]
2.376 CONF_LIST_APPS
[API: app management]
Description
Command CONF_LIST_APPS returns all 3rd-party applications installed from the App Store onto an Inteox
camera.
Payload Structure
App Entry
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x0001
2 Bytes 2 Bytes
8 24
Tag 2: ID (Required)
app id
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
ID (p_string)
Length - 4 Bytes
8 24
Tag 3: Name
app name
16 32
Length Tag = 0x0003
2 Bytes 2 Bytes
Name (p_string)
Length - 4 Bytes
8 24
Tag 4: License
unique license identifier
16 32
Length Tag = 0x0004
2 Bytes 2 Bytes
License (p_string)
Length - 4 Bytes
8 24
Tag 5: Version
app version
16 32
Length Tag = 0x0005
2 Bytes 2 Bytes
Version (p_string)
Length - 4 Bytes
8 24
Tag 6: Autostart
autostart enabled or not
16 32
Length = 0x0021 Tag = 0x0006
2 Bytes 2 Bytes
Autostart (t_octet)
1 Byte
8 24
16 32
Length = 0x0024 Tag = 0x0007
2 Bytes 2 Bytes
Installation Time (t_dword)
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0008
2 Bytes 2 Bytes
Last update Time (t_dword)
4 Bytes
8 24
Tag 9: State
state of the app (0: inactive, 1: active)
16 32
Length = 0x0024 Tag = 0x0009
2 Bytes 2 Bytes
State (t_dword)
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x000a
2 Bytes 2 Bytes
License available (t_dword)
4 Bytes
8 24
16 32
Length Tag = 0x000b
2 Bytes 2 Bytes
License ID (p_string)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x000c
2 Bytes 2 Bytes
License valid from (t_dword)
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x000d
2 Bytes 2 Bytes
License valid to (t_dword)
4 Bytes
8 24
2.377 CONF_LIST_OF_VIPROC_SCENES
[API: viproc]
Description
This command works only for Gen4 autodomes. It returns the list of defined scenes together with their
names. Thereby the first byte specifies the scene number, followed by the length L of the scene name. The
next L bytes belong to the scene name in unicode without 0 termination. This structure repeats until either
the payload ends or the scene number is zero.
Payload Structure
Viproc Scene Entry [0]
(see description)
...
2.378 CONF_LIVE_AUDIO_CONNECTION_ACTIVE
[API: audio]
2.379 CONF_LIVE_VIDEO_CONNECTION_ACTIVE
[API: video input]
Values:
no live video connection established 0
live video connections active 1 one or more live video connections currently active
2.380 CONF_LLDP_ALLOCATED_POWER_TOTAL
[API: lldp]
2.381 CONF_LLDP_POWER_ADDER
[API: lldp]
2.382 CONF_LLDP_REQUESTED_POWER_CAM
[API: lldp]
2.383 CONF_LLDP_REQUESTED_POWER_TOTAL
[API: lldp]
2.384 CONF_LOADED_VIPROC_CONFIG
[API: viproc]
2.385 CONF_LOCAL_HTTP_PORT
[API: http settings]
2.386 CONF_LOCAL_HTTPS_PORT
[API: http settings]
2.387 CONF_LOGIN_LIMITER_MESSAGE
[API: security]
Payload Structure
16 32
Number Of Entries Total Length
2 Bytes 2 Bytes
Entry [0]
...
Entry [ - 1]
8 24
Number Of Entries
Number of Entries following
Total Length
Total Length in Bytes, including all entries and this header
Entry
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: LOGIN_LIMITER_MSG_STATUS
16 32
Tag = 0x0001 Length = 0x0021
2 Bytes 2 Bytes
LOGIN_LIMITER_MSG_STATUS (t_octet)
1 Byte
8 24
Values:
Fail Msg 0
Success Msg 1
Tag 2: LOGIN_LIMITER_SERVER_NAME
16 32
Tag = 0x0002 Length
2 Bytes 2 Bytes
LOGIN_LIMITER_SERVER_NAME (p_string)
Length - 4 Bytes
8 24
Tag 3: LOGIN_LIMITER_REMOTE_ADDRESS
16 32
Tag = 0x0003 Length
2 Bytes 2 Bytes
LOGIN_LIMITER_REMOTE_ADDRESS (p_string)
Length - 4 Bytes
8 24
Tag 4: LOGIN_LIMITER_USER_NAME
16 32
Tag = 0x0004 Length
2 Bytes 2 Bytes
LOGIN_LIMITER_USER_NAME (p_string)
Length - 4 Bytes
8 24
2.388 CONF_LOGIN_PAGE_TEXT
[API: browser]
2.389 CONF_LOGO
[API: decoder/videoout]
2.390 CONF_LOGO_STAMP_VAL
[API: stamping]
2.391 CONF_LOW_AMBIENT_LIGHT_THRESHOLD
[API: system.status]
2.392 CONF_MAC_ADDRESS
[API: ethernet]
2.393 CONF_MANAGE_APPS
[API: app management]
2.394 CONF_MANAGING_VRM
[API: recording settings]
Description
This command can be used to set or read the IP address, port and user and to set the password of the
managing VRM and the backup VRM. The command cannot be used for reading the VRM password, it
will return the string "********" instead.
Payload Structure
16 32
IP
4 Bytes
Port Flags Reserved
2 Bytes 1 Byte 1 Byte
User...
32 Bytes
User
[...]
User
...
Password...
32 Bytes
Password
[...]
Password
...
Backup IP
4 Bytes
Backup Port Reserved
2 Bytes 2 Bytes
8 24
IP
IP address of the managing VRM
Port
Port of the managing VRM
Flags
Mask Name
Bit 0 0x01 USE_SSL
User
VRM user: Max 31 ASCII character string with zero termination. If the user is shorter than 31 characters,
the remaining bytes need to be filled up with 0x00 values.
Password
VRM password: Max 31 ASCII character string with zero termination. If the password is shorter than 31
characters, the remaining bytes need to be filled up with 0x00 values.
Backup IP
IP address of the backup VRM
Backup Port
Port of the backup VRM
2.395 CONF_MANIPULATION_ALARM_STATE
[API: alarm]
2.396 CONF_MANUFACTURER_NAME
[API: system.settings]
2.397 CONF_MASTERPWD_CHALLENGE
[API: user management]
2.398 CONF_MASTERPWD_CHALLENGE_STATE
[API: user management]
2.399 CONF_MAX_GOP_LENGTH_VALUE
[API: recording settings]
2.400 CONF_MAX_NBR_OF_ENC_STREAMS
[API: encoder]
2.401 CONF_MAX_RECORDING_RETENTION_TIME
[API: recording settings]
Description
This command sets the max retention time for recording identified by the rec idx and the camera in the num
parameter starting from 1. For read direction a inpayload is required with same format as described above,
except the max retention time field can be ignored. The max retention time will be stored as absolute local
time in seconds since 2000 in each span unit header. It will be used to clear a recording span when this time
expires. If a max retention time is configured unequal 0 and less than maximum, the recording time on a span
is limited to a one day time span. If this limit is reached by the recording, a span switch will be triggered.
Payload Structure
16 32
Max retention time
4 Bytes
Rec Idx Reserved
2 Bytes 2 Bytes
8 24
Rec Idx
Recording Index
Primary Recording 1
Secondary Recording 2 Secondary recording (active low)
2.402 CONF_MEDIA_SOCKETS_COMPLETE
[API: rcp.connection]
2.403 CONF_MESSAGE_BROKER_MSG
[API: alarm]
Payload Structure
Number of tagged elements
4 Bytes
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: MESSAGE_BROKER_TAGS_PUBLISHER_ID
publisherID
16 32
Tag = 0x0001 Length = 0x000
2 Bytes 2 Bytes
MESSAGE_BROKER_TAGS_PUBLISHER_ID (p_string)
Length Bytes
8 24
Tag 2: MESSAGE_BROKER_TAGS_TOPIC
topic
16 32
Tag = 0x0002 Length = 0x000
2 Bytes 2 Bytes
MESSAGE_BROKER_TAGS_TOPIC (p_string)
Length Bytes
8 24
Tag 3: MESSAGE_BROKER_TAGS_PAYLOAD
payload
16 32
Tag = 0x0003 Length = 0x000
2 Bytes 2 Bytes
MESSAGE_BROKER_TAGS_PAYLOAD (p_string)
Length Bytes
8 24
2.404 CONF_MIN_TLS_VERSION
[API: cert store]
2.405 CONF_MODE_AUTO_TRACKER
[API: autotracker]
2.406 CONF_MONITOR_NAME
[API: decoder/videoout]
2.407 CONF_MOTION_ALARM_STATE
[API: alarm]
2.408 CONF_MPEG_AUDIO_SAMPLING_FREQ
[API: audio]
2.409 CONF_MPEG4_AVC_BITRATE_OPTIMIZATION
[API: encoder]
Payload Structure
16 32
reserved reserved...
1 Byte 7 Bytes
reserved
...
8 24
2.410
CONF_MPEG4_AVC_BITRATE_OPTIMIZATION_OPTIONS
[API: encoder]
Payload Structure
4 8
basicSupport
1 Byte
2 6
2.411 CONF_MPEG4_AVC_CABAC
[API: encoder]
2.412 CONF_MPEG4_AVC_CHROMA_QUANT_OFF
[API: encoder]
2.413 CONF_MPEG4_AVC_CODING_MODE
[API: encoder]
2.414 CONF_MPEG4_AVC_DEBLOCKING_ALPHA
[API: encoder]
2.415 CONF_MPEG4_AVC_DEBLOCKING_BETA
[API: encoder]
2.416 CONF_MPEG4_AVC_DEBLOCKING_ENABLE
[API: encoder]
2.417 CONF_MPEG4_AVC_DELTA_IPQUANT
[API: encoder]
2.418 CONF_MPEG4_AVC_GOP_STRUCTURE
[API: encoder]
2.419 CONF_MPEG4_AVC_I_FRAME_QUANT
[API: encoder]
2.420 CONF_MPEG4_AVC_P_FRAME_QUANT
[API: encoder]
2.421 CONF_MPEG4_AVC_P_FRAME_QUANT_MIN
[API: encoder]
Values:
auto 0
2.422 CONF_MPEG4_AVC_QUANT_ADJ_REGION_1
[API: encoder]
2.423 CONF_MPEG4_AVC_QUANT_ADJ_REGION_2
[API: encoder]
2.424 CONF_MPEG4_BANDWIDTH_KBPS
[API: encoder]
2.425
CONF_MPEG4_BANDWIDTH_KBPS_SOFT_LIMIT
[API: encoder]
2.426 CONF_MPEG4_CURRENT_PARAMS
[API: encoder]
2.427
CONF_MPEG4_CURRENT_PARAMS_REL_CODER
[API: encoder]
Payload Structure
16 32
Line Coder Coding Capabilities
1 Byte 1 Byte 2 Bytes
Preset Reserved
1 Byte 3 Bytes
8 24
Line
Video input line
Coder
Relative coder number (relative to line)
Coding Capabilities
Coding capabilities of encoder. All coding capabilities are one or multiple of:
Mask Name
Bit 6 0x0040 H.264
Bit 3 0x0008 Mpeg 2
Bit 2 0x0004 Mpeg 4
Bit 1 0x0002 H.263
Preset
Number of the encoder preset profile
Note: When reading the preset profile, the according byte in the payload will be set.
2.428
CONF_MPEG4_CURRENT_PARAMS_TRANSCODER
[API: encoder]
Values:
no transcoding 0
video preset of the transcoder 1-8
2.429 CONF_MPEG4_DEFAULTS
[API: encoder]
2.430 CONF_MPEG4_FRAME_SKIP_RATIO
[API: encoder]
2.431 CONF_MPEG4_INTRA_FRAME_DISTANCE
[API: encoder]
2.432 CONF_MPEG4_INTRA_FRAME_REQUEST
[API: rcp.connection]
2.433 CONF_MPEG4_NAME
[API: encoder]
2.434 CONF_MPEG4_PARAMS_MAX_NUM
[API: encoder]
2.435 CONF_MPEG4_RESOLUTION
[API: encoder]
2.436 CONF_MQTT_SETTINGS
[API: system.settings]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: MQTT_BROKER_ADDRESS
Address of the remote broker. Example 'mqtt
16 32
Length = 0x000 Tag = 0x0001
2 Bytes 2 Bytes
MQTT_BROKER_ADDRESS (p_string)
Length Bytes
8 24
Tag 2: MQTT_BROKER_USERNAME
Utf-8 encoded username
16 32
Length = 0x000 Tag = 0x0002
2 Bytes 2 Bytes
MQTT_BROKER_USERNAME (p_string)
Length Bytes
8 24
Tag 3: MQTT_BROKER_PASSWORD
Utf-8 encoded password (write only)
16 32
Length = 0x000 Tag = 0x0003
2 Bytes 2 Bytes
MQTT_BROKER_PASSWORD (p_string)
Length Bytes
8 24
Tag 4: MQTT_BROKER_PREFIX
Optional topic prefix to be used for publishing events.
16 32
Length = 0x000 Tag = 0x0004
2 Bytes 2 Bytes
MQTT_BROKER_PREFIX (p_string)
Length Bytes
8 24
Tag 5: MQTT_BROKER_TOPIC_FILTER
Optional ONVIF topic filter. Encoding is outside of scope of this specification.
16 32
Length = 0x000 Tag = 0x0005
2 Bytes 2 Bytes
MQTT_BROKER_TOPIC_FILTER (p_octet)
Length Bytes
8 24
Tag 6: MQTT_BROKER_QOS
Optional QoS value. Default=0
16 32
Length = 0x0001 Tag = 0x0006
2 Bytes 2 Bytes
MQTT_BROKER_QOS (t_octet)
1 Byte
8 24
2.437 CONF_MTU_SIZE
[API: ethernet]
2.438 CONF_MULTICAST_AUDIO_GROUP_IP
[API: multicast]
2.439 CONF_MULTICAST_AUDIO_GROUP_IP_STR
[API: multicast]
2.440 CONF_MULTICAST_AUDIO_PORT
[API: multicast]
2.441 CONF_MULTICAST_AUDIO_PORT_STR
[API: multicast]
2.442 CONF_MULTICAST_TTL
[API: multicast]
2.443 CONF_MULTICAST_VIDEO_GROUP_IP
[API: multicast]
2.444 CONF_MULTICAST_VIDEO_GROUP_IP_STR
[API: multicast]
2.445 CONF_MULTICAST_VIDEO_PORT
[API: multicast]
2.446 CONF_MULTICAST_VIDEO_PORT_STR
[API: multicast]
2.447 CONF_MUTE_MEDIA_CHANNEL
[API: rcp.connection]
Values:
Mask Name
Bit 2 0x000 meta
Bit 1 0x000 audio
Bit 0 0x000 video, session id is needed,
don't mute if media channel is
in multicast
2.448 CONF_NAME_STAMP_VAL
[API: stamping]
2.449 CONF_NBR_OF_ACCOUNTS
[API: account]
2.450 CONF_NBR_OF_ALARM_IN
[API: alarm]
2.451 CONF_NBR_OF_ALARM_OUT
[API: alarm]
2.452 CONF_NBR_OF_ALTERNATIVE_ALARM_IPS
[API: alarm connections]
2.453 CONF_NBR_OF_AUDIO_IN
[API: audio]
2.454 CONF_NBR_OF_AUDIO_OUT
[API: audio]
2.455 CONF_NBR_OF_DNS_SERVERS
[API: ethernet]
2.456 CONF_NBR_OF_ENC_STREAMS
[API: encoder]
2.457 CONF_NBR_OF_EXT_ETH_COPPER_PORTS
[API: ethernet]
2.458 CONF_NBR_OF_EXT_ETH_FIBER_PORTS
[API: ethernet]
2.459 CONF_NBR_OF_EXT_ETH_PORTS
[API: ethernet]
2.460 CONF_NBR_OF_HUMIDITY_SENSORS
[API: system.status]
2.461 CONF_NBR_OF_IMU
[API: system.settings]
2.462 CONF_NBR_OF_MANIPULATION_ALARMS
[API: alarm]
2.463 CONF_NBR_OF_MOTION_DETECTORS
[API: alarm]
2.464 CONF_NBR_OF_PIR
[API: I/Os]
2.465 CONF_NBR_OF_SD_CARD_SLOTS
[API: storage]
2.466 CONF_NBR_OF_TEMP_SENS
[API: system.status]
2.467 CONF_NBR_OF_TRAPS_HOSTS
[API: snmp]
2.468 CONF_NBR_OF_VIDEO_IN
[API: video input]
2.469 CONF_NBR_OF_VIDEO_OUT
[API: decoder/videoout]
2.470 CONF_NBR_OF_VIRTUAL_ALARMS
[API: alarm]
2.471 CONF_NETWORK_SERVICES
[API: network services]
Description
Reading the CONF_NETWORK_SERVICES command returns a list of TCP/UDP services which are
available on the device. Each entry represents one service. The entry show if the service is enabled at the
moment and what TCP/UDP port it is assigned to if a port is available. If the port cannot be adjusted the
0x0004 tag is simply missing. Client software can show this list to give the user the opportunity to check
and configure all runiing network services.
Writing this command allows to configure the services returned by a preceding read. In write direction the
command payload has the same structure. The client does not need to include all services returned by the
read. It can only add the services to change to the write payload. The tag 0x0002 (label) must not be included
in write payload. The service ID must provided and identitfies the service to change. The ID is not fixed
across firmware versions and must be retrieved by a preceeding read.
Writing this command is only a request to the device to shutdown or start the services. That's why the device
cannot answer with with the new state of the services. The device replies to a write operation with the actual
state of the network services (the complete list). This does eventually not reflect the changes which will be
done by the requests in this write operation.
Note: Most network services need a reboot of the device to be stopped or started. After writing this command
the device should be rebootet!
Payload Structure
...
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0020 Tag = 0x8000
2 Bytes 2 Bytes
8 24
Tag 1: Numerical ID
This tag gives each service a numerical ID. The ID should be retrieved via reading this command first. You
can assume, that the ID for a special service keeps constant in newer firmware versions. So this ID can be
treated as a unique identifier for a specific service. When using this command in write direction to configure
a service this ID must be presented to identify the service.
16 32
Length = 0x0024 Tag = 0x0001
2 Bytes 2 Bytes
Numerical ID (t_dword)
4 Bytes
8 24
Tag 2: Label
A printable label for this service. If the client does not know how to translate this label it can show this label
as default. The label is not used to identify the service and can be omitted when writing this command.
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
Label (p_string)
Length - 4 Bytes
8 24
Tag 3: Enable
A value != 0 indicates that this service is enabled and the port is open at UDP/TCP level. A value == 0
indeicates that the service is disabled.
16 32
Length = 0x0024 Tag = 0x0003
2 Bytes 2 Bytes
Enable (t_dword)
4 Bytes
8 24
Values:
Enable 1
Disable 0
Tag 4: Port
This tag is only present if the UDP/TCP port is adjustable for this service. Else this tag is simply omitted.
For historical reasons most services set their port to 0 to show that they are disabled. If you set the 'Enable'
tag to 0 at write and set the port != 0 the command will automaticly set the port to 0. Setting 'Enabled' tag
to != 0 and the port to 0 will use default port. Else the given port will be used.
16 32
Length = 0x0024 Tag = 0x0004
2 Bytes 2 Bytes
Port (t_dword)
4 Bytes
8 24
2.472 CONF_NIGHT_MODE_STATE
[API: system.settings]
2.473 CONF_NTP_SERVER_IP_STR
[API: local time and time server settings and configuration]
2.474 CONF_NTP_START_SERVER
[API: local time and time server settings and configuration]
Values:
do not start 0
start server 1
2.475 CONF_NTP_SYNC_MODE
[API: local time and time server settings and configuration]
Values:
time server 0
SNTP server 1
off 2
tls_date 3
2.476 CONF_NUMBER_OF_VIPROC_CONFIGS
[API: viproc]
2.477 CONF_OBEY_ICMP_REDICRECTS
[API: ethernet]
Values:
ignore 0
obey 1
2.478 CONF_OEM_DEVICE_DOMAIN
[API: system.settings]
2.479 CONF_OEM_DEVICE_NAME
[API: system.settings]
2.480 CONF_OEM_EXT_ID
[API: system.settings]
2.481 CONF_ONVIF_PROFILE_INFO
[API: onvif]
Description
Command CONF_ONVIF_PROFILE_INFO returns information about onvif media profiles.
Payload Structure
Profile
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: Profile
The payload of this tag entry contains further tagged values described below.
16 32
Length = 0x0020 Tag = 0x0001
2 Bytes 2 Bytes
8 24
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
ProfileToken (p_string)
Length - 4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0003
2 Bytes 2 Bytes
RCP Coder (t_dword)
4 Bytes
8 24
16 32
Length = 0x0024 Tag = 0x0004
2 Bytes 2 Bytes
Encoder Profile (t_dword)
4 Bytes
8 24
Tag 5: Line
line
16 32
Length = 0x0024 Tag = 0x0005
2 Bytes 2 Bytes
Line (t_dword)
4 Bytes
8 24
Tag 6: Stream
stream
16 32
Length = 0x0024 Tag = 0x0006
2 Bytes 2 Bytes
Stream (t_dword)
4 Bytes
8 24
2.482 CONF_ONVIF_STREAM_MODE
[API: onvif]
2.483 CONF_ONVIF_STREAM_URI_EX
[API: onvif]
2.484 CONF_OPTIONAL_TIME_SERVER_PORT
[API: local time and time server settings and configuration]
Values:
the according standard port will be used 0 depending on the configured time server mode
Values:
the according standard port will be used 0 depending on the configured time server mode).
2.485 CONF_OSD_ACCESS
[API: stamping]
Description
Up to version 4.50, this command only applies to decoders to display text onto the video output. The num
field carries the video output number. A value of 0 indicates that the text should be displayed on all screens.
Remind that the num value numbering scheme takes quad mode into account for the lines where quad is
possible, even if quad mode is not active. (E.g. to have an OSD stamped into the fourth line of a VIP X1600
XFMD, you need to use num value of 10). To delete previously submitted strings, send an empty string
(not space characters!).
From version 4.50 on this command applies to encoders as well. In that case, the encoder will embed the
text information into the RTP data stream to be overlayed by the receiving decoder. The attribute and flag
fields are not applicable to the decoder's video output. The num field applies to the video input number.
Payload Structure
16 32
ID Len
2 Bytes 2 Bytes
x y bg_luma bg_chroma
1 Byte 1 Byte 1 Byte 1 Byte
attributes
4 Bytes
font_luma font_chroma flags
1 Byte 1 Byte 2 Bytes
Text
Len - 16 Bytes
8 24
ID
Tag ID, for addressing different strings. Values 0x04-0x08 are possible.
Len
Length of the complete payload in bytes. Maximum length is 64 bytes.
x
X-Position (0...255) where the string should be displayed (0 is left)
y
Y-Position (0...255) where the string should be displayed (0 is up)
bg_luma
Background color: 8 bit luma (Y)
bg_chroma
Background color: 2 x 4 bit chroma (U/V); 'lower 4 bit' = U, 'upper 4 bit' = V
attributes
Mask Name Description
Bit 20 0x00100000 ShowBorder Draw a box around the text or transparent text
background (0=box, 1=transparent)
Bit 11 0x00000800 Center Centered display (0=off, 1=on)
Bit 10 0x00000400 BackgroundBox Big text background box (0=off, 1=on)
Bit 8 0x00000100 Use custom font and background color given
in bg_luma, bg_chroma, font_luma and
font_chroma (0=off, 1=on)
font_luma
Font color: 8 bit luma (Y)
font_chroma
Font color: 2 x 4 bit chroma (U/V); 'lower 4 bit' = U, 'upper 4 bit' = V
flags
Mask Name Description
Bit 0 0x0001 Unicode Interpret text as unicode characters (UTF-16)
Text
Text to be displayed
2.486 CONF_OSD_POS
[API: stamping]
Description
Set or get the position of OSD objects (see CONF_OSD_ACCESS). For "write" the num field carries the
video number; 0 indicates that the string positions on all video lines will be set.
Up to version 4.50, this command only applies to decoders to display text onto the video output. The num
field carries the video output number. A value of 0 indicates that the text should be displayed on all screens.
Remind that the num value numbering scheme takes quad mode into account for the lines where quad is
possible, even if quad mode is not active. (E.g. to have an OSD stamped into the fourth line of a VIP X1600
XFMD, you need to use num value of 10). To delete previously submitted strings, send an empty string
(not space characters!).
From version 4.50 on this command applies to encoders as well. In that case, the encoder will embed the
text information into the RTP data stream to be overlayed by the receiving decoder. The attribute and flag
fields are not applicable to the decoder's video output. The num field applies to the video input number.
Request Payload Structure
8 16
ID
2 Bytes
4 12
ID
Tag ID, for addressing different strings. Values 0x04-0x08 are possible.
ID
Tag ID, for addressing different strings. Values 0x04-0x08 are possible.
x
X-Position (0...255) of the string (0 is left)
y
Y-Position (0...255) of the string (0 is top)
2.487 CONF_PASSWORD_SETTINGS
[API: user management]
2.488 CONF_PIC_INFO
[API: rcp.connection]
2.489 CONF_PIR_ALARM_STATE
[API: I/Os]
2.490 CONF_PIR_SENSITIVITY
[API: I/Os]
Values:
disabled 0
lowest 1
highest 10
2.491 CONF_PIR_STATUS
[API: I/Os]
2.492 CONF_PMPP_ADDRESS
[API: snmp]
2.493 CONF_PMPP_PORT
[API: snmp]
Values:
off 0
2.494 CONF_POE_GRANTED_POWER
[API: lldp]
2.495 CONF_PORT_FC_MODE
[API: ethernet]
Values:
off 0
on 1
2.496 CONF_POWER_MONITOR_NAMES
[API: system.settings]
Payload Structure
16 32
Number of power rails
4 Bytes
...
2.497 CONF_POWER_MONITOR_VALUES
[API: system.settings]
Payload Structure
16 32
Number of rails
4 Bytes
Rail value [0]
(see description)
...
Rail value [
Number of rails
- 1]
(see description)
8 24
Number of rails
Number of monitored rails. Payload of complete command is 4 + (Number Of Rails)*40 Bytes
Rail value
16 32
Options
4 Bytes
Actual Voltage
4 Bytes
Min Voltage
4 Bytes
Max Voltage
4 Bytes
Actual Current
4 Bytes
Min Current
4 Bytes
Max Current
4 Bytes
Actual Power
4 Bytes
Min Power
4 Bytes
Max Power
4 Bytes
8 24
Options
Mask Name
Bit 2 0x00000004 Power Measurement Valid
Bit 1 0x00000002 Voltage Measurement Valid
Bit 0 0x00000001 Current Measurement Valid
Actual Voltage
Actual measured voltage, which is measured last, in uV
Min Voltage
Minimum measured voltage in uV
Max Voltage
Maximum measured voltage in uV
Actual Current
Actual measured current, which is measured last in uA
Min Current
Minimum measured current in uA
Max Current
Maximum measured current in uA
Actual Power
Actual measured power, which is measured last in uW
Min Power
Minimum measured power in uW
Max Power
Maximum measured power in uW
2.498 CONF_PREDEFINED_MOUNTING_LIST
[API: calibration]
2.499 CONF_PREPARE_FOR_RECORDING
[API: storage]
Description
This command is used to prepare a remote device for recording via a another device (e.g remote recording
on a transcoder). Normally the remote device will be configured to record on one or more (upto 8) local
managed storage, which is already configured by the command CONF_STORAGE_LIST. The Storage can
be a local storage on the remote device or any storage on the local device. This is choosen by the flag
"remote managed storage". If this flag is set, the storage/lun idx refers the lun index of a local storage on
the remote device. Otherwise it is the index from the storage list of the local device. The preparation will be
the configuration of the micro vrm on the recording device and in case of remote recording constellation,
it will allow the remote recording on the storage managing device.
Payload Structure
16 32
Remote Device Index Recording Index
2 Bytes 2 Bytes
Flags Storage/Lun Count Storage/Lun Index [0]
...
1 Byte 1 Byte 1 Byte
Storage/Lun Index [
Storage/Lun Count
...
- 1]
1 Byte
8 24
Recording Index
Primary Recording 1
Secondary 2
Recording
Flags
Mask Name
Bit 0 0x01 Remote Managed Storage
Storage/Lun Count
Number of following index enties for storages/luns (max. 8)
Storage/Lun Index
Index of an as managed configured storage or the lun index of local storage of the remote device.
2.500 CONF_PRIV_MASK_DOME_PTZ_POS
[API: video input]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Command
Move To Defined 0 Move dome to position stored at maskId
Position
Mask ID
Define mask ID which is used in conjunction with the command. Use CONF_PRIV_MSK_OPTIONS to
query number of supported masks. (CONF_PRIV_MSK_OPTIONS / Max Number Of Priv Masks Per
Line).
2.501 CONF_PRIV_MSK
[API: video input]
2.502 CONF_PRIV_MSK_OPTIONS
[API: video input]
Payload Structure
16 32
Max Number Of
Color Support Rectangle Support Polygon Support
Polygon Vertices
1 Byte 1 Byte 1 Byte
1 Byte
Only Legacy
Max Number Of Only Legacy Dome rcp priv
Dome Cmd
Priv Masks Per Line Cmd Support mask support
Support Via Bicom
1 Byte 1 Byte 1 Byte
1 Byte
Dome zoom Number Of Priv Dome Priv Mask IVA Behind Priv
threshold support Masks Lines Enlargement Support Mask Support
1 Byte 1 Byte 1 Byte 1 Byte
Supported feature bits Reserved
1 Byte 3 Bytes
8 24
Color Support
Definition of color via
(R,G,B) is supported
No 0
Yes 1
Rectangle Support
No 0
Yes 1
Polygon Support
No 0
Yes 1 May not be self intersecting
2.503 CONF_PRIV_MSK_POLY
[API: video input]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 0: Color Id
Configure the priv mask color only supported if CONF_PRIV_MSK_OPTIONS allows the color
configuration
16 32
Length = 0x0008 Tag = 0x0000
2 Bytes 2 Bytes
Color Id (p_octet)
4 Bytes
8 24
Color Id
16 32
Color Mode Red Green Blue
1 Byte 1 Byte 1 Byte 1 Byte
8 24
Color Mode
RGB 0 Red, Green, Blue values are used.
Auto Color Mode 1 Privacy mask color is auto selected from the surrounding. Red, Green, Blue
values are ignored (use CONF_PRIV_MSK_OPTIONS to query support)
Off 2 Use CONF_PRIV_MSK_OPTIONS to query support.
Pixelized 3 Use CONF_PRIV_MSK_OPTIONS to query support.
Blurred (cpp14) 4 CONF_PRIV_MSK_OPTIONS to query support.
Blurred (cpp13) 5 Use CONF_PRIV_MSK_OPTIONS to query support.
Red
Value 0 - 255
Green
Value 0 - 255
Blue
Value 0 - 255
16 32
Length = 0x0005 Tag = 0x0000
2 Bytes 2 Bytes
Color Mode (t_octet)
1 Byte
8 24
16 32
Length Tag = 0x0001
2 Bytes 2 Bytes
Polygon (fixed camera) description id (p_octet)
Length - 4 Bytes
8 24
...
Vertex [
Number Of Vertices
- 1]
(see description)
8 24
Enable
Disabled 0 Privacy mask is not shown.
Enabled 1 Privacy mask is shown.
Id
Mask number in range [0... max number privacy masks] (defined via CONF_PRIV_MSK_OPTIONS)
Number Of Vertices
Number of points for this polygon, must be in range [0... max number points] (defined via
CONF_PRIV_MSK_OPTIONS)
Vertex
Definition of the coordinate system for privacy masking (stick to sei information)
Upper left edge : (0,0)
Upper right edge: (32678,0)
Lower left edge : (0,32678)
Lower right edge: (32768,32678)
16 32
X Y
2 Bytes 2 Bytes
8 24
X
X Coordinate 0 - 32678
Y
Y Coordinate 0 - 32678
16 32
Length Tag = 0x0002
2 Bytes 2 Bytes
Polygon Config @ moving camera (p_octet)
Length - 4 Bytes
8 24
...
Vertex [
Number Of Vertices
- 1]
(see description)
8 24
Enable
Disabled 0 Privacy mask is not shown.
Enabled 1 Privacy mask is shown.
Id
Mask number in range [0... max number privacy masks] (defined via CONF_PRIV_MSK_OPTIONS)
Number Of Vertices
Number of points for this polygon, must be in range [0... max number points] (defined via
CONF_PRIV_MSK_OPTIONS)
Zoom Threshold
Availability defined via CONF_PRIV_MSK_OPTIONS
Disabled 0
Enabled 1
Vertex
Definition of the coordinate system for privacy masking (stick to sei information)
Upper left edge : (0,0)
Upper right edge: (32678,0)
Lower left edge : (0,32678)
Lower right edge: (32678,32678)
16 32
X Y
2 Bytes 2 Bytes
8 24
X
X Coordinate 0 - 32678
Y
Y Coordinate 0 - 32678
16 32
Length = 0x000c Tag = 0x0003
2 Bytes 2 Bytes
Global Options @ moving camera (p_octet)
8 Bytes
8 24
Disable masks
Disable all privacy masks
16 32
Length = 0x001c Tag = 0x0004
2 Bytes 2 Bytes
Dome position (p_octet)
24 Bytes
8 24
Dome position
16 32
enable id Reserved
1 Byte 1 Byte 2 Bytes
panPosition
4 Bytes
tiltPosition
4 Bytes
zoomPosition
4 Bytes
reserved
4 Bytes
8 24
16 32
Length = 0x0005 Tag = 0x0005
2 Bytes 2 Bytes
Blur/Pixelization Level (t_octet)
1 Byte
8 24
2.504 CONF_PRIVACY_MODE
[API: system.settings]
Status
off 0
on 1
Status
off 0
on 1
reserved
Set to '0'
2.505 CONF_PRODUCT_NAME
[API: system.settings]
2.506 CONF_PROTECT_HTTP_COOKIE
[API: http settings]
Values:
Disabled 0
Enabled 1
2.507 CONF_PTZ_AUTO_ROTATE_MODE
[API: system.settings]
2.508 CONF_PTZ_CONTROLLER_AVAILABLE
[API: viproc]
2.509 CONF_PUBLISH_MEDIA_KEYS
[API: security]
2.510 CONF_RAW_IMAGE
[API: video input]
Requested Format
Raw YUV 0x0000 (default)
TIFF encoded raw 0x0001 (default)
Selected Scaler
VCS Scaler 0x0001 (default)
Image Width
Image Height
YUV Format
Planar420 1 420 planar, YYYY...UUUU...VVVV
Chroma420 -1 420 chroma interleaved, YYYY....UVUVUV
Planar422 2 422 planar, YYYY...UUUU...VVVV
Chroma422 -2 422 chroma interleaved, YYYY....UVUVUV
2.511 CONF_RCP_CLIENT_REGISTRATION
[API: rcp.control]
Description
The registration is a standard RCP packet with the command code 0xFF00 with data type P_OCTET (0x0c).
The Numeric Descriptor is not used. The Client ID in the header section is ignored.
Request Payload Structure
16 32
Registration Type Reserved Client ID
1 Byte 1 Byte 2 Bytes
PE PL Number Of Tags
1 Byte 1 Byte 2 Bytes
Tag [0]
...
2 Bytes
Tag [
Number Of Tags Password...
- 1] N Bytes
2 Bytes
Password
...
8 24
Registration Type
Modify Registration 0x00
Normal Registration 0x01
Hook Back 0x03
Registration
Client ID
Unused
PE
Password and User Delivery Encryption.
PL
Password and User String Length. Number of bytes to follow for the password string.
Number Of Tags
Number of message tags inside this packet.
Tag
Tag codes for the messages which should be passed to the RCP client (see tag code table for capability to
generate messages) - A Tag code of 0xFFFF will force the VideoJet to generate a message on all possible
events.
Password
Password string itself. NOTE: No \0 termination!
Result
Registration failed 0x00
Registration 0x01
successful
Level
The level after this registration.
no 0
live 3
user 1
service 2
Client ID
Identification number under which the client is now registered at the VideoJet.
2.512 CONF_RCP_CLIENT_REGISTRATION_V2
[API: rcp.control]
Description
The registration is a standard RCP packet with the command code 0xFF00 with data type P_OCTET (0x0c).
The Numeric Descriptor is not used. The Client ID in the header section is ignored.
Request Payload Structure
16 32
Registration Type Flags Client ID
1 Byte 1 Byte 2 Bytes
PE PL Number Of Tags
1 Byte 1 Byte 2 Bytes
Tag [0]
...
2 Bytes
Tag [
Number Of Tags Password...
- 1] N Bytes
2 Bytes
Password
...
8 24
Registration Type
Modify Registration 0x00
Normal Registration 0x01
Hook Back 0x03
Registration
Flags
Mask Name Description
Bit 2 0x04 TAGGED_OPTION_HDR Signal that the client will send extra tagged option
list on each request. Internal only
Bit 1 0x02 MESSAGES_IN_V2_FORMATRegister for messages with extended timestamp and
sequence number header. If this flag is set, then all
messages sent from the server to this client have an
additional timestamp and sequence number header
right after the RCP+ Header. This header is identical
to the 'Timestamp Header Structure' returned by
CONF_RCP_MSG_V2_HISTORY. Please see
description of CONF_RCP_MSG_V2_HISTORY
for details.
Client ID
Unused
PE
Password and User Delivery Encryption.
PL
Password and User String Length. Number of bytes to follow for the password string.
Number Of Tags
Number of message tags inside this packet.
Tag
Tag codes for the messages which should be passed to the RCP client (see tag code table for capability to
generate messages) - A Tag code of 0xFFFF will force the VideoJet to generate a message on all possible
events.
Password
Password string itself. NOTE: No \0 termination!
16 32
Result Level Client ID
1 Byte 1 Byte 2 Bytes
8 24
Result
Registration failed 0x00
Registration 0x01
successful
Level
The level after this registration.
no 0
live 3
user 1
service 2
Client ID
Identification number under which the client is now registered at the VideoJet.
• The identification string in the register packet must have the following format:
+Username:random_string:response_string+
Note: No additional whitespaces are allowed.
2.513 CONF_RCP_CLIENT_TIMEOUT_WARNING
[API: rcp.control]
Description
The RCP server has to deal with lots of RCP connections at the same time. If an RCP client is going
down without notification to the server, an orphan table entry will remain. To avoid this, a timeout
mechanism is provided. Each RCP client must show any activity within 10 minutes. After this time the
registration of a specific RCP client is invalid. For easy handling, the RCP client can register itself for an
RCP_CLIENT_TIMEOUT_WARNIG message. The client will be notified 1 minute before the timeout
occurs.
The timeout renewal can be achieved by any RCP read or write command. A good advise is to read the
RCP_CLIENT_REGISTRATION.
2.514 CONF_RCP_CLIENT_UNREGISTER
[API: rcp.control]
Result
Unregister failed 0x00
Unregister 0x01
successful
Level
The level before this unregister.
Client ID
Identification number under which the client was registered at the VideoJet.
2.515 CONF_RCP_CODER_LIST
[API: rcp.connection]
Description
This command is used to retrieve the list of encoders and decoders from a VideoJet. There are two reply
formats supported, the compact and the extended list view. The compact view only reports the absolute
coder numbers available on a given line input or output. The extended view offers more information about
coding capabilities and other parameters of a coder.
Request Payload Structure
12 24
MediaType Direction Flags
1 Byte 1 Byte 1 Byte
6 18
MediaType
Video 0x01
Audio 0x02
Data 0x03
Direction
Input 0x00
Output 0x01
Flags
Mask Name Description
Bit 0 0x01 Extended Format Request extended format instead of compact.
Coder Number
Absolute coder numbers.
...
Coder Definition
16 32
Coder Number Coding Capabilities
2 Bytes 2 Bytes
Current Coding Resolution Capabilities
2 Bytes 2 Bytes
Resolution Current Reserved...
2 Bytes 6 Bytes
Reserved
...
8 24
Coder Number
Absolute coder numbers.
Coding Capabilities
All coding capabilities is one or multiple of:
Mask Name
Bit 15 0x8000 Mpeg2 PrgStr
Bit 14 0x4000 Recorded Media
Bit 9 0x0200 H.265
Current Coding
See 'Coding Capabilities' for details.
Resolution Capabilities
All resolution capabilities is one or multiple of:
Mask Name
Bit 12 0x1000 HD5M
Bit 11 0x0800 WD432
Bit 10 0x0400 WD288
Bit 9 0x0200 WD144
Bit 8 0x0100 HD1080
Bit 7 0x0080 HD720
Bit 6 0x0040 VGA
Bit 5 0x0020 QVGA
Bit 4 0x0010 Custom
Bit 3 0x0008 4CIF
Bit 2 0x0004 2CIF
Bit 1 0x0002 CIF
Bit 0 0x0001 QCIF
Resolution Current
See 'Resolution Capabilities' for details.
...
Coder Definition
16 32
Coder Number Coding Capabilities
2 Bytes 2 Bytes
Current Coding CodParameter Capabilities
2 Bytes 2 Bytes
CodParameter Current Reserved...
2 Bytes 6 Bytes
Reserved
...
8 24
Coder Number
Absolute coder numbers.
Coding Capabilities
All coding capabilities is one or multiple of:
Mask Name
Bit 15 0x8000 Mpeg2 PrgStr
Bit 14 0x4000 Recorded Media
Bit 4 0x0010 L16
Bit 3 0x0008 L16 (16kHz timestamps)
Bit 2 0x0004 G.711 (8kHz timestamps)
Bit 1 0x0002 AAC
Bit 0 0x0001 G.711
Current Coding
See 'Coding Capabilities' for details.
CodParameter Capabilities
Currently none available
CodParameter Current
Currently none available
...
Coder Definition
16 32
Coder Number Coding Capabilities
2 Bytes 2 Bytes
Current Coding CodParameter Capabilities
2 Bytes 2 Bytes
CodParameter Current Reserved...
2 Bytes 6 Bytes
Reserved
...
8 24
Coder Number
Absolute coder numbers.
Coding Capabilities
All coding capabilities is one or multiple of:
Mask Name
Bit 0 0x0001 RCP
Current Coding
See 'Coding Capabilities' for details.
CodParameter Capabilities
Mask Name
Bit 2 0x0004 RS422
Bit 1 0x0002 RS485
Bit 0 0x0001 RS232
CodParameter Current
See 'CodParameter Capabilities' for details.
2.516 CONF_RCP_CONNECT_SALVO
[API: rcp.connection]
Description
A replay connection can be established in two steps: 1) build up a "dry" (replay) connection by setting
the flag in the CONNECT_PRIMITIVE request. A Rcp connection is established and a session id to
control the connection is returned. Data is not sent out as long as no source is connected. 2) connect a
source to the connection (only implemented for replay) using this RCP_CONNECT_SALVO_COMMAND
with the provided session id. The connection will retrieve the data from the specified device If a
source is already connected a second call of this command will replace the first connection. The num
parameter can be used to refere to an entry from CONF_ADD_REMOTE_DEVICE (num 1 to 4). In
that case only a shorter payload (line and relative coder) is required. All other parameters will be taken
from the CONF_ADD_REMOTE_DEVICE command. For port and ssl port the first two ports of a
CONF_ADD_REMOTE_DEVICE entry will be used in that order. If the num parameter is set to zero, all
other parameters are required and used if the connection is a remote device. If num is zero and the short
payload (line and rel coder) is also used, it is asumed, that the local device is addressed.
Payload Structure
16 32
Flags Line Decoder Instance Relative Coder
1 Byte 1 Byte 1 Byte 1 Byte
Port SSL Port
2 Bytes 2 Bytes
VRM Track Id Reserved
2 Bytes 2 Bytes
URL Length URL...
2 Bytes URL Length Bytes
URL
...
Flags
Mask Name Description
Bit 6 0x40 Delete cam delete cam connected to dec inst (multi view only)
Bit 3 0x08 Replay live only
Bit 1 0x02 Use TCP to get live video
Bit 0 0x01 Live video
Line
Line from 1 to max lines (line 0 is mapped to line 1)
Decoder Instance
Decoder instance from 1 to max ... (decoder instance 0 means any) for multiview capable de/transcoders
Relative Coder
Relative coder number from 1 to ... (coder number 0 is mapped to coder number 1)
VRM Track Id
Only relevant for VRM
URL Length
Length of the following url (actual limit is 64)
URL
URL for the connection salvo. ASCII string including zero termination. If the special url starting with
'trackid://' is used, the following decimal value is the VRM Track ID (e.g. 'tackid://15096')
Password Length
Length of the following password (actual limit is 64)
Password
Password for the salvo connection. ASCII string including zero termination.
2.517 CONF_RCP_CONNECTIONS_ALIVE
[API: rcp.connection]
2.518 CONF_RCP_MSG_V2_HISTORY
[API: rcp.control]
Mode
By Sequence Number 0x0000 Select the mode to read messages indicated by a initial sequence
number.
By Timestamp 0x0001 Select the mode to read messages indicated by by relative
timestamp
MaxResultMsg
Maximum number of result messages to be returned by one execution of this command.
ModeSpecificData
'ModeSpecificData' payload for 'Mode' = 'Sequence Number' (0x0000)
24 48
MsgSeqNo BootCount
4 Bytes 2 Bytes
12 36
MsgSeqNo
The first returned message will be the next in device buffer after those indicated by this number. e.g. if
MsgSeqNo is 7, then first result is 8 or even a higher number if there is no message 8 according to filters in
this data path. If value 0 is supplied then the result starts with the oldest message which is still available on
the device. To perform a chunked read the last MsgSeqNo returned by prior request to this command can
be the argument of the next request to retreive the next chunk.
BootCount
Boot counter. This in combination with MsgSeqNo makes a unique ID for a message. If supplied BootCount
is lower than actual BootCount then all messages in Buffer are returned up to MaxResultMsg
LastNumSeconds
The first returned message will be those indicated by this number of seconds back in the past. E.g. value
of 30 will start returning the oldest messages which was triggered 30 seconds ago, and then continue with
all subsequent up to MaxResultMsg.
MsgSeqNo
Message counter starts with 0 on each bootup
SecSince2000
Time in seconds from RTC in UTC
Milliseconds
Millisecond extension to SecSince2000
BootCount
Number of reboots. Use in combination with MsgSeqNo to get a unique Message-ID
SkippedSeqNo
Number of skipped sequence numbers in this stream due to registering/filtering rules
Timezone
Timezone in 15 minute steps. Negative values have the leading bit 7 set. E.g. 0x03 = +45 minutes; 0x84
= -60 minutes
2.519 CONF_RCP_REG_MD5_RANDOM
[API: rcp.control]
Note: To avoid 'denial of service' attacks, the RCP server will only grant up to 5 random strings at the same
time. Maximum time from the request of a random string to its use: 5 seconds. Multiple requests from the
same host are ignored.
2.520 CONF_RCP_SERVER_PORT
[API: rcp.control]
2.521 CONF_RCP_TRANSFER_TRANSPARENT_DATA
[API: rcp.control]
Description
The transparent data from and to the serial interfaces is handled by RCP to achieve reliable transfer of
information. To gather control over the remote serial interface a successful registration is necessary.
Once the VideoJet has received a TRANSFER_TRANSPARENT_DATA command, it checks whether the
RCP client is in control or not. If the RCP client is allowed to send data to the serial interface, the reply will
present an OK. If the RCP client is not allowed to send data, a FAIL will be returned. In this case another
RCP client is controlling the serial out. The timeout and priority handling of the serial ports is beyond the
scope of this document.
Note: This command is NOT readable in a sense to obtain data from a serial port. In can only be read in
order to check if serial port access is currently granted. See further details below.
The reply to the Read command will be the same as the reply to the write command. The returned code will
present the availability of the serial port.
NOTE: Despite a positive reply to a read command, the port may be locked by another RCP client in the
time slice between the read and a following write command.
The data coming from the serial input is delivered using an RCP message. All RCP clients which want
to receive this data must be registered for the message 0xFFDD. Data is posted if the corresponding RCP
client is in control only.
If no client has a lease on the serial port, a message to all registered clients will be generated.
NOTE: The received message will carry NO header.
Num Descriptor Values
Any Port to write to
16 32
Options Reserved Lease Time
1 Byte 1 Byte 2 Bytes
Transparent Data
N Bytes
8 24
Options
Currently no options used
Lease Time
Time in seconds the lease is requested
Note: The lease time should be treated as a request; the VideoJet may switch leases before the requested
time is over due to a higher prioritized RCP client
Response Payload Structure
16 32
Code Reserved
1 Byte 3 Bytes
8 24
Code
Access Denied 0x00 Access to the serial port denied
Access Granted 0x01 Access to the serial port granted
Code
Access Denied 0x00 Access to the serial port denied
Access Granted 0x01 Access to the serial port granted
2.522 CONF_REC_MGNT
[API: recording settings]
Values:
LOCAL 0
VRM 1
VRM+ANR 2
ONLY LOCAL 3 obsolete
DUAL VRM 4
ONVIF 5
2.523 CONF_REC_MONITOR_STATUS
[API: recording settings]
Description
This command can be used to get the status of recording, whether it records all data as desired or if
unintentional loss is occuring. It also gives a hint as utc time interval, when the data where lost. The status
is also send as message on status changes from nominal to critical and vise versa.The status changes to
critical, when loss occures and returns to status nominal after 2 minitus without further data loss
Request Payload Structure
16 32
Camera Recording Index
2 Bytes 2 Bytes
8 24
Camera
The camera index 1 to n
Recording Index
Primary Recording 1
Secondary Recording 2
recorded low
4 Bytes
lost high
4 Bytes
lost low
4 Bytes
issue start time utc
4 Bytes
issue end time utc
4 Bytes
latest issue time utc
4 Bytes
info time stamp
4 Bytes
State ID
4 Bytes
8 24
Camera
The camera index from 1 to n
Recording Index
Primary Recording 1
Secondary Recording 2
Status
NONE 0 no info
NOMINAL 1 no actual recording issue
CRITICAL 2 record data loss within the last 2 minutes
Version
Payload version (actual 1).
reserved
recorded high
Upper 32 bit of 64 bit counter for recorded packets.
recorded low
Lower 32 bit of 64 bit counter for recorded packets.
lost high
Upper 32 bit of 64 bit counter for recorded packets.
lost low
Lower 32 bit of 64 bit counter for recorded packets.
State ID
Changes every time the status changes
2.524 CONF_REC_SPAN_MGR
[API: recording settings]
Description
Use this command to edit the recording span manager list. This list is consulted every time when a device
is recording in VRM mode and its span list runs out resources. The entry with the highest priority is picked
out of this list, the corresponding span manager is contacted and queried for spans. If the span manager is
not accessable or will not return a span for some reason (maybe it has no more free spans to export), the
entry with the next lower priority is picked out of the list. If at least one span manager for primary recording
is configured, all entries of managed vrm (configured by CONF_MANAGING_VRM) will be deleted.
Payload Structure
Span Manager Config [0]
(see description)
...
16 32
Span Mananger IP Address
4 Bytes
Target ID
4 Bytes
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES).
Target Index
The iSCSI target index.
Lun
The iSCSI lun of the storage.
Priority
Priority as recording storage, higher values mean lower priority, 0 - highest priority
Flags
Mask Name Description
Bit 0 0x0001 OVERWRITE_OLDEST_RECORDINGS
(obsolete)
Note: If no free spans are available on all span manager of the devices recording span manager list, the
recording with the retention time that expires next is overwritten.
2.525 CONF_REC_STORAGE_REQ_CFG
[API: recording settings]
2.526
CONF_RECOMMENDED_JPEG_POSTING_RESOLUTIONS
[API: encoder]
Description
Obtain a list of recommended JPEG resolutions for image posting.
The format has a tagged structure. Each tagged command consits of a length field a tag id + payload. Only
read is supported. Notice: this command is not suitable to obtain the possible resolutions for a JPEG stream.
It is only suitable for single JPEG snapshots (like e.g. image posting)
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
width
JPEG width
height
JPEG height
2.527 CONF_RECORDING_BUFFER_LEVEL
[API: recording settings]
2.528 CONF_RECORDING_RETENTION_TIME
[API: recording settings]
2.529
CONF_RECORDING_RETENTION_TIME_SECONDARY
[API: recording settings]
2.530 CONF_RECORDING_STATUS
[API: recording settings]
Camera
The camera index
Recording Index
Primary Recording 1
Secondary Recording 2
Camera
The camera index
Recording Index
Primary Recording 1
Secondary Recording 2
Status
OFFLINE 1 configured for not recording
IDLE 2 (obsolete)
PEND 3 trying to connect storage or waiting for block list from vrm
RUNNING 4 storage connected and recording running or prepared for recording
ERROR 5 error on storage ocurred
REC_SRC_ERROR 6 error of recorder source(encoder)
Error
See error codes of CONF_SPAN_USE_STATUS.
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES).
Target Index
In index of the iscsi target.
Lun
The lun indentifier.
Span Index
The index of the span.
Flags
Mask Name Description
Bit 0 0x01 ENCRYPTION Encrypted recording
Datarate
The datarate that is written to the storage.
2.531
CONF_REFERENCE_IMAGE_CHECK_INFO_MESSAGE
[API: viproc]
Payload Structure
20 40
Flags Correlation Threshold SecondsToAlarm
1 Byte 1 Byte 1 Byte 2 Bytes
10 30
Flags
If no info available may have one of the following reason: reference image check was not enabled or
reference image has not enough contours to perform reference image check
Values:
Mask Name
Bit 7 0x80 CheckFailed
Bit 6 0x40 NoInfoAvailable
Correlation
Current correlation value between recent image and reference image
Threshold
Threshold value
SecondsToAlarm
Seconds until alarm is triggered
2.532 CONF_RELAIS_NAME
[API: I/Os]
2.533 CONF_RELAIS_SWITCH
[API: I/Os]
2.534 CONF_RELAY_OUTPUT_MODE
[API: I/Os]
Values:
output pin is normally open 1
output pin is normally closed 2
Values:
set output pin to normally open 1
set output pin to normally closed 2
2.535 CONF_RELAY_OUTPUT_STATE
[API: I/Os]
2.536 CONF_REMOTE_PASSWORD
[API: alarm connections]
2.537 CONF_REMOTE_PORTAL_INFO
[API: Cbs]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: RP_INFO_TAG_DEVICE_URL
Direct link to the device in the Remote Portal
16 32
Tag = 0x0001 Length = 0x000
2 Bytes 2 Bytes
RP_INFO_TAG_DEVICE_URL (p_string)
Length Bytes
8 24
2.538 CONF_REMOTE_REC_DEVICE
[API: recording settings]
2.539 CONF_REQ_FAST_UPDATE
[API: rcp.connection]
2.540 CONF_ROI
[API: roi]
Description
Select region of interest. The Session-ID identifies the video coder.
Payload Structure
16 32
hPos vPos
2 Bytes 2 Bytes
size reserved
2 Bytes 2 Bytes
8 24
hPos
Center position of the cropping window in relative coordinates (0..32768). E.g. (0, 0) is upper left; (16384,
16384) is the center of the original image.
vPos
Center position of the cropping window in relative coordinates (0..32768). E.g. (0, 0) is upper left; (16384,
16384) is the center of the original image.
size
Size of the cropping window in relative coordinates (0..32768). The aspect ratio will be preserved.
reserved
2 Bytes reserved
2.541 CONF_ROI_OPTIONS
[API: roi]
Description
Get CONF_VIDEO_STATIC_SCENE_REGIONS encoding options per line.
Payload Structure
4 8
Opt1
1 Byte
Opt2
1 Byte
Opt3
1 Byte
2 6
Opt1
Mask Name Description
Bit 1 0x02 h.265 Supports static scene options in h.265
Bit 0 0x01 h.264 Supports static scene options in h.264
Opt2
Mask Name Description
Bit 0 0x01 POS Supports preset pos inside
CONF_VIDEO_STATIC_SCENE_REGIONS
Opt3
Mask Name Description
Bit 0 0x01 QP+ Only positive QP offsets at encoder regions
2.542 CONF_RTSP_PORT
[API: rtsp settings]
Values:
Rtsp off 0
2.543 CONF_RTSPS_PORT
[API: rtsp settings]
Values:
Rtsps off 0
2.544 CONF_RULE_ENGINE_ID
[API: viproc]
2.545 CONF_SAST_CLAIM_DEVICE_URI
[API: app management]
2.546 CONF_SAST_CLOUD_CONNECTION
[API: app management]
2.547 CONF_SCAN_ID
[API: system.settings]
2.548 CONF_SCHEDULED_PTZ_PROFILE
[API: recording settings]
Description
Read/Write one scheduled ptz profiles for a camera, payload upto 12 bytes total. The profiles will be written
to the config. Based on the record schedule the profiles will become active and a PTZ/ROI Tour/Preset will
be activated or deativated. The flag SCHEDULED_PTZ_PROFILE_FLAG_TOUR, will use a PTZ tour on
PTZ domes. If the cam isn't a PTZ camera, ROI is used instead, if the line is capable of it. The preset/tour
will be applied on changes only, except the SCHEDULED_PTZ_PROFILE_FLAG_RETRIGGER flag is
set, this will repeat the apply periodically. An User will be always able to change the PTZ state on a camera
after the scheduled apply. In read direction only the command header (4 bytes) is required. The response
will have the full payload size of 12 bytes including the PTZ profile.
Payload Structure
16 32
Camera Reserved Profile Number
2 Bytes 1 Byte 1 Byte
PTZ Profile...
(see description)
PTZ Profile
...
8 24
Camera
Camara line of the requested PTZ profile (1 to n)
Profile Number
Profile number of the requested PTZ profile (1 to 10)
PTZ Profile
16 32
PTZ/ROI Preset/Tour Flags Reserved...
2 Bytes 1 Byte 5 Bytes
Reserved
...
8 24
PTZ/ROI Preset/Tour
Number of a preset or tour for PTZ or ROI depending on the flags settings, if the tourflag is set, following
values are defined, 1 - Tour A, 2 - Tour B, 3 - Custom Tour
Flags
Mask Name Description
Bit 1 0x02 RETRIGGER_LOCK If set, the preset (not tour) setting will be reapplied
about every 10th second and ptz from user will be
locked for both tour and preset (except bicom aux)
Bit 0 0x01 FLAG_TOUR If set, the preset number specifies a PTZ tour (only
for PTZ domes)
2.549 CONF_SCHEDULED_PTZ_PROFILES
[API: recording settings]
Description
Read/Write one scheduled ptz profiles for a camera, payload upto 12 bytes total. The profiles will be written
to the config. Based on the record schedule the profiles will become active and a PTZ/ROI Tour/Preset will
be activated or deativated. The flag SCHEDULED_PTZ_PROFILE_FLAG_TOUR, will use a PTZ tour on
PTZ domes. If the cam isn't a PTZ camera, ROI is used instead, if the line is capable of it. The preset/tour
will be applied on changes only, except the SCHEDULED_PTZ_PROFILE_FLAG_RETRIGGER flag is
set, this will repeat the apply periodically. An User will be always able to change the PTZ state on a camera
after the scheduled apply. In read direction only the command header (4 bytes) is required. The response
will have the full payload size of 12 bytes including the PTZ profile.
Payload Structure
PTZ Profile [0]
(see description)
...
PTZ Profile
16 32
PTZ/ROI Preset/Tour Flags Reserved...
2 Bytes 1 Byte 5 Bytes
Reserved
...
8 24
PTZ/ROI Preset/Tour
Number of a preset or tour for PTZ or ROI depending on the flags settings, if the tourflag is set, following
values are defined, 1 - Tour A, 2 - Tour B, 3 - Custom Tour
Flags
Mask Name Description
Bit 1 0x02 RETRIGGER_LOCK If set, the preset (not tour) setting will be reapplied
about every 10th second and ptz from user will be
locked for both tour and preset (except bicom aux)
Bit 0 0x01 FLAG_TOUR If set, the preset number specifies a PTZ tour (only
for PTZ domes)
2.550
CONF_SD_CARD_LIFE_SPAN_ALARM_THRESHOLD
[API: storage]
2.551 CONF_SD_CARD_LIFE_SPAN_ENABLE
[API: storage]
2.552 CONF_SD_CARD_LIFE_SPAN_MANF
[API: storage]
Values:
Autodetect 0
SANDISK 1
SONY 2
MICRON 3
EMMC_GENERIC 4
2.553 CONF_SD_CARD_LIFE_SPAN_STATUS
[API: storage]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: MANF_ID
SD Card manufacturer ID.
Tag 2: PROD_ID
SD Card product ID.
Tag 3: PROD_STRING
SD Card product string.
Tag 4: NUM_BLOCKS
Number of SD Card 512 byte blocks.
Tag 5: ESTIMATED_LIFE_SPAN_PERCENT_DONE
Consumed value of estimated lifespan for SD-Card in percent (only for supported cards)
Tag 6: MANF_NAME
Manufacturer plain text name (only for supported cards)
Tag 7: SERIAL_NO
SD-Card serial number
2.554 CONF_SD_CARD_STATUS
[API: system.status]
Description
This command will return the sd card status.
Payload Structure
8 16
Status
2 Bytes
4 12
Status
Some Flag Values:
Mask Name Description
Bit 1 0x0002 type SD = 0; CF = 1
Bit 0 0x0001 card detected Set to 1 if a card is detected.
2.555 CONF_SECURITY_COPROC_AUTHENTICATE
[API: system.settings]
2.556 CONF_SECURITY_COPROC_CERTIFICATE
[API: system.settings]
2.557 CONF_SECURITY_COPROC_VERSION
[API: system.settings]
Values:
no TPM 0
TPM with varying feature set 1
TPM with varying feature set 2
TPM with varying feature set 3
TPM with varying feature set 4
TPM with varying feature set 5
TPM with varying feature set 6
FIPS compliant TPM 7
4k TPM 8
2.558 CONF_SEI_ENABLE
[API: rcp.connection]
2.559 CONF_SENSITIVITY_OBJECT_BASED_VCA
[API: viproc]
2.560 CONF_SENSOR_ORIENTATION
[API: calibration]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: Pan
Pan angle (magnetic sensor present).
16 32
Length = 0x000c Tag = 0x0001
2 Bytes 2 Bytes
Pan (t_dword)
4 Bytes
Error Estimation (t_dword)
4 Bytes
8 24
Pan
Specifies the pan angle in units of (2*pi/(2^32))
Error Estimation
Specifies the estimation error in units of (2*pi/(2^32))
Tag 2: Tilt
Tilt angle (acceleration sensor present).
16 32
Length = 0x000c Tag = 0x0002
2 Bytes 2 Bytes
Tilt (t_dword)
4 Bytes
Error Estimation (t_dword)
4 Bytes
8 24
Tilt
Specifies the tilt angle in units of (2*pi/(2^32))
Error Estimation
Specifies the estimation error in units of (2*pi/(2^32))
Tag 3: Roll
Roll angle (acceleration sensor present).
16 32
Length = 0x000c Tag = 0x0003
2 Bytes 2 Bytes
Roll (t_dword)
4 Bytes
Error Estimation (t_dword)
4 Bytes
8 24
Roll
Specifies the roll angle in units of (2*pi/(2^32))
Error Estimation
Specifies the estimation error in units of (2*pi/(2^32))
Tag 4: Rotate
Image Sensor rotation is active (if tag is missing an unrotated image has to be assumed).
16 32
Length = 0x0008 Tag = 0x0004
2 Bytes 2 Bytes
Rotate
4 Bytes
8 24
Rotate
Specifies the rotate angle in units of (2*pi/(2^32)). This value can be added to the roll angle.
Tag 5: Vector
Acceleration vector (acceleration sensor present).
16 32
Length = 0x0010 Tag = 0x0005
2 Bytes 2 Bytes
x (t_dword)
4 Bytes
y (t_dword)
4 Bytes
z (t_dword)
4 Bytes
8 24
x
Accelaration in x direction in milli g
y
Accelaration in y direction in milli g
z
Accelaration in z direction in milli g
2.561 CONF_SERIAL_ACTS_ACCESS_RIGHTS
[API: serial port]
Values:
user rights 0 mainly PTZ) (default
service rights 1 change settings
2.562 CONF_SERIAL_NUMBER
[API: system.settings]
2.563 CONF_SERIAL_PORT_APP_VAL
[API: serial port]
Values:
terminal mode 0 serial port application is in terminal mode
transparent datamode 255 serial port application is in transparent datamode
camera type mode 1
camera type mode 2
camera type mode 3
camera type mode 4
camera type mode 5
camera type mode 6
camera type mode 7
camera type mode 8
camera type mode 9
camera type mode 10
piped mode 248 serial port application is in a mode where incoming
CONF_BICOM_COMMAND are piped to the serial
port. This is only applicable on encoder devices and
only for video line 1, a device reboot is necessary!
2.564 CONF_SERIAL_PORT_BITS
[API: serial port]
Values:
seven data bits 7
eight data bits 8
2.565 CONF_SERIAL_PORT_HD_MODE_VAL
[API: serial port]
Values:
halfduplex mode off 0
halfduplex mode on 1
halfduplex mode on and buffered data 2 NOT avalibale in conventional VideoJet
2.566 CONF_SERIAL_PORT_MODE_VAL
[API: serial port]
Values:
port mode RS232 1
port mode RS422/RS485 2 NOT available in conventional VideoJet
2.567 CONF_SERIAL_PORT_PAR
[API: serial port]
Values:
no parity 0
even parity 1
odd parity 2
2.568 CONF_SERIAL_PORT_RATE
[API: serial port]
2.569 CONF_SERIAL_PORT_STBITS
[API: serial port]
Values:
1 modemport stopbit 1
2 modemport stopbits 2
2.570 CONF_SET_REC_BUFFER_SIZE
[API: recording settings]
2.571 CONF_SET_VIRTUAL_ALARM_ID
[API: alarm]
2.572 CONF_SHIFT_CALIBRATION_ELEMENT
[API: calibration]
2.573 CONF_SIGNALLED_POE_CLASS
[API: lldp]
Values:
class0 1
class1 2
class2 3
no PoE 255
2.574 CONF_SND_MSS
[API: ethernet]
2.575 CONF_SNMP_READ_COMMUNITY
[API: snmp]
2.576 CONF_SNMP_SERVER_MODE
[API: snmp]
2.577 CONF_SNMP_SRV_PORT
[API: snmp]
2.578 CONF_SNMP_TRAP_COMMUNITY
[API: snmp]
2.579 CONF_SNMP_TRAP_LIST
[API: snmp]
Payload Structure
Trap Descriptor [0]
(see description)
...
Trap Descriptor
16 32
RCP Msg Code Bitmask of Flags
2 Bytes 2 Bytes
8 24
Bitmask of Flags
SNMP_TRAP_ENABLED 1
2.580 CONF_SNMP_TRAPS_HOST
[API: snmp]
2.581 CONF_SNMP_TRAPS_HOST_STR
[API: snmp]
2.582 CONF_SNMP_USER_PROFILE
[API: snmp]
Payload Structure
16 32
User Name...
32 Bytes
User Name
[...]
User Name
...
Auth Password...
32 Bytes
Auth Password
[...]
Auth Password
...
Privacy Password...
32 Bytes
Privacy Password
[...]
Privacy Password
...
Auth Mode Privacy Mode Snmp Version IsTrapUser
1 Byte 1 Byte 1 Byte 1 Byte
Profile Reserved...
1 Byte 15 Bytes
Reserved
...
Reserved
...
Reserved
...
8 24
User Name
Zero terminated string with user name. Or zero to delete this user entry.
Auth Password
Zero terminated string with authentication password.
Privacy Password
Zero terminated string with privacy password.
Auth Mode
No authentication 1
MD5 authentication 2
SHA1 authentication3
Privacy Mode
No privacy 1
DES privacy 2
AES privacy 4
Snmp Version
SNMP version for this user
SNMP Version 3 3
IsTrapUser
Define if this account is a local account or a account to sent traps to.
Local Account 0
Remote Trap 1
Account
Profile
Read Only 0
Read Write 1
2.583 CONF_SNMP_V3_ENGINEID
[API: snmp]
2.584 CONF_SNMP_WRITE_COMMUNITY
[API: snmp]
2.585 CONF_SOCKET_KNOCKER_DESTINATION
[API: Socket Knocker]
Payload Structure
16 32
Port SSL Number of sockets
2 Bytes 1 Byte 1 Byte
Try connect timeout Reserved
1 Byte 3 Bytes
URL
N Bytes
8 24
Port
Destination port
SSL
Provide ssl socket:
No SSL 0
SSL 1
Number of sockets
Number of idle sockets to distribute. As soon as a socket is used, a new one is provided.
Reserved
Reserved for future use. Set to zero.
URL
Destination url. Zero-terminated ascii string. Currently max. 128 characters (incl. zero termination).
2.586
CONF_SOCKET_KNOCKER_DESTINATION_NAME
[API: Socket Knocker]
2.587 CONF_SOCKET_KNOCKER_MODE
[API: Socket Knocker]
2.588 CONF_SOCKET_KNOCKER_STATUS
[API: Socket Knocker]
Payload Structure
16 32
State Reason Reserved
1 Byte 1 Byte 2 Bytes
8 24
State
Current status of socket knocker
Not running 0
Trying to connect 1
Connected 2 (ready for cloud service)
Reason
Reason for current state
As expected 0
Unknown 1
Auto mode: DHCP off or not successful 2
Auto mode: max knocking attempts reached 3
Auto mode: max knocking time reached 4
URL could not be resolved 5
Destination not responding 6
2.589 CONF_SOFT_VARIANT_ID
[API: system.settings]
2.590 CONF_SOFT_VARIANT_ID_OPTIONS
[API: system.settings]
Payload Structure
16 32
Number of variants Flags reserved
1 Byte 1 Byte 2 Bytes
Variant Description [0]
(see description)
...
Variant Description [
Number of variants
- 1]
(see description)
8 24
Number of variants
The number of software variants described in this payload.
Flags
Mask Name
Bit 0 0x01 No 'factory defaults' performed
Variant Description
16 32
Variant ID
4 Bytes
Variant Name (p_string)...
60 Bytes
Variant Name
[...]
Variant Name
...
8 24
Note: If no soft variant IDs are possible, an empty payload will be returned.
2.591 CONF_SOFTWARE_VERSION
[API: system.settings]
2.592 CONF_SOFTWARE_VERSION_FORMATTED
[API: system.settings]
2.593 CONF_SPAN_ADDRESS_LIST
[API: recording settings]
Description
The reply to an read request always contains up to n (n=512) entrys. The response in case of an empty span
list is one zeroed span entry.
On a write request, a list of max n (n=512) span addresses must be supplied. List entrys that are zero are
not used by the unit for recording. The unit uses the supplied ordering of the list and begins with the first
entry. The order of the supplied list is the preferred order, not the guaranted order. There are some cases,
in which the device changes the use order (e.g. one target not reachable).
If the device is already recording on spans (a span list is already present on the device), the new list must
contain the span addresses, that the unit is currently recording on. The latter information can be obtained
by reading the current span address list form the unit and check the corresponding write lock header (if the
units IP and MAC address is found this means the unit is recording). If the unit receives a list and the span
addresses of the spans the device is currently recording on is not present, the list is rejected (not saved in
the configuration) and an error is returned.
A message of this cmd tag will be send always, if somone sets the span address lists by using rcp set spans list
commands or if the span list is cleared by indirectly by changing other settings of the device (e.g. rec mgmt).
Payload Structure
Span Address [0]
(see description)
...
Span Address
16 32
Target ID
4 Bytes
Target IDX Lun IDX Span IDX
1 Byte 1 Byte 2 Bytes
8 24
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES).
Target IDX
Index of the iSCSI server target. The index of the desired target can be obtained from the reply to an iSCSI
discover.
Lun IDX
Index of the lun of the specified target.
Span IDX
Index of the span in the specified lun.
Note: A list of all defined error types can be found in the Appendix.
2.594 CONF_SPAN_ADDRESS_LIST_NEW
[API: recording settings]
2.595 CONF_SPAN_CERTIFICATES_LIST
[API: recording settings]
Description
This Command can be used to query the certificates of a span, in order to verify the signed video record
data within that span. The response will deliver all certificates of the specified span and time intervall. The
maximum size of the response can be limited by the caller but it will not exceed 16 kb for the certificates
list. If the response payload size isnt't enough to hold all valid certificates, a flag in the response will signal
the existence of further certificates, which didn't fit in the response payload. A second query in that case
with a smaller time interval may help to get the remaining certificates. The response will have a certificates
list with several enries of different size, there are no gaps between the entries.
Request Payload Structure
16 32
Target Id
4 Bytes
Target IdX LUN Span IDX
1 Byte 1 Byte 2 Bytes
Start Time
4 Bytes
End Time
4 Bytes
TZ QH Reserved
1 Byte 3 Bytes
Max List Len
4 Bytes
8 24
Target Id
Target ID of the Span
Target IdX
Target Index of the Span
LUN
LUN of the Span
Span IDX
Span Index of the Span
Start Time
Start time of the interval in seconds since 2000 local time based on the Timezone offset in TZ QH
End Time
End time of the interval in seconds since 2000 local time based on the Timezone offset in TZ QH
TZ QH
Timezone offset (from utc) in quarter hours as signed char value
...
Certificate [N]
(see description)
8 24
Target Id
Target ID of the Span
Target IdX
Target Index of the Span
LUN
LUN of the Span
Span IDX
Span Index of the Span
Start Time
Start time of the interval in seconds since 2000 local time based on the Timezone offset in TZ QH
End Time
End time of the interval in seconds since 2000 local time based on the Timezone offset in TZ QH
TZ QH
Timezone offset (from utc) in quarter hours as signed char value
Flags
Mask Name Description
Bit 0 0x01 Len Exeeded More certificates available, but the max length of the
certificates list was exceeded.
List Len
Size of the certificates list in response payload in bytes.
Certificate
16 32
Timestamp
4 Bytes
TZ QH Reserved Length
1 Byte 1 Byte 2 Bytes
Certificate...
Length - 8 Bytes
Certificate
...
8 24
Timestamp
Local time in seconds since 2000
TZ QH
Timezone offset (from utc) in quarter hours as signed char value
Length
Length of the Certificates List Entry (certificate including these 8 bytes header infos)
Certificate
One certificate
2.596 CONF_SPAN_FILES_DIR
[API: recording settings]
Description
This command allows to set the path to a mounted span formatted storage or directory. You have to send
the in payload to set the path. The min payload size is 16 bytes. The max path name length is 1024 bytes
including the zero termination. payload size must be set to the size that includes the zero termination but
min size is 16 bytes even in case of an empty string (at least zero termination). You can set up to 32768
pathes. Use the num param to specify the index of an entry. If you set the path it will check the path. To pass
this check, at least a valid Lun info file (INFO.TXT) has to exist. The span are needed later when accessing
the storage(e.g header access, replay). The response to the write direction is has the out payload format.
If success the error field is zero and the payload includes the set path and the exported lun address. This
storage is now accessable by using this address for other commands. if the set failes, the error field is non
zero and contains an error code. It is allowed to set path on an index that was already set. The old values
will be overwritten, but remember that the effect takes place later, if there are still open references based
on the old entry (e.g. running replay, header access).
The cmd can be used for read direction. The response payload contains the export lun address and the path.
error code is always zero. If the entry is empty, the path is empty and has only the zero termination.
Write Payload Structure
16 32
Action
4 Bytes
Reserved...
8 Bytes
Reserved
...
Path...
N Bytes
Path
...
8 24
Action
Specifies the action, you can set an entry or clear an entry.
Clear entry 0
Set entry 1
Path
Path to a mounted span formatted storage or directory containing the span files.
Exported target id
Target id of the exported lun, specified by the directory path.
Target index
Target index of the exported lun, specified by the directory path.
Lun
Lun id of the exported lun, specified by the directory path.
Error
Error code, in case of set path failed. Is always 0 in the payload of read direction. Only relevant for return
payload of write direction.
No error 0
Invalid directory 1
path
Invalid lun info file 2
Common error 3
Path
Path to a mounted span formatted storage or directory containing the span files.
2.597 CONF_SPAN_HDR_ACCESS
[API: recording settings]
Payload Structure
16 32
Span Header
(see description)
8 24
Span Header
Data of the span header. Length and structure differs for the specified header type. The header type is
specified with the numeric descriptor.
Lock owner IP
IP address of the unit that holds the write lock of the span.
Cluster Id
Cluster id of the recorder 1 - n, default value is 0 if not set, should be treated as cluster id 1.
Note: In the request packet, the header values are ignored (may be zero). The reply contains the values read
or written. On write requests, the local IPv4 and MAC addresses are converted to ascii strings and written
to the file LCKxxxxx.txt (xxxx = span index) on disk. On read requests, the ascii strings of that file are
scanned into binary values and send with the reply.
'Span Header' payload for numeric descriptor = 'Manager Header' (0x02)
16 32
Manager Header Data...
N Bytes
Manager Header Data
...
8 24
Note: The reply always returns the 1024 Bytes of the manager header file MGRxxxx.txt (xxxx = span index).
GUID...
32 Bytes
GUID
[...]
GUID
...
8 24
Span owner IP
IP address of the unit that holds the write lock of the span.
Retention Time
Retention Time for the recordings on this span in sec since 2000
Recording
Primary Recording 1 (default)
Secondary Recording 2
Cluster Id
Cluster id of the recorder 1 - n, default value is 0 if not set, should be treated as cluster id 1
Modification MAC
Hardware address of the instance, which modifies the unit header (must be non zero for write direction)
User Data
Byte field for any user data (16 bytes)
GUID
GUID (managed by vrm) of the device which recorded on this span (32 bytes)
Note: In the read request packet, the header values are ignored (may be zero). In the write requst packet,
only the camera field is evaluated, the values for IP and MAC are taken from local configuration. The reply
packet contains the values read or written. On write requests, the local IPv4 and MAC addresses and the
supplied camera value are converted to ascii strings and written to the file UNTxxxxx.txt (xxxx = span
index) on disk. On read requests, the ascii strings of that file are scanned into binary values and send with
the reply. The modification seal values cannot be set by this command as write request directly, they will
be set automatically on span header write requests or on starting or stopping a recording. The content of
this fields will be ignored in a write request.
Command Specific Errors
SPAN_ERR_INTERNAL 0x01
SPAN_ERR_INV_SPN_IDX 0x02
SPAN_ERR_INV_HDR_TYPE 0x03
SPAN_ERR_NOT_MNTD 0x05
SPAN_ERR_INV_FS 0x06
SPAN_ERR_INV_LUN_NFO 0x07
SPAN_ERR_BAD_HDR_CKSM 0x08
SPAN_ERR_RD_ONLY 0x0a
ISCSI_ERROR_CONNECT 0x31
ISCSI_ERROR_INV_LUN 0x33
ISCSI_ERROR_LOGIN 0x34
ISCSI_ERROR_INV_TRG_IDX 0x35
Note: A list of all defined error types can be found in the Appendix.
2.598 CONF_SPAN_HISTORY
[API: recording settings]
Description
This command is used by the device to store the span history in the device config, that means it adds (action
add) an span adress entry to the config, for each recorded span. The history can be seen by read commando
and action show. The history can be cleared by sending a action clear command.
Payload Structure
16 32
cam rec idx
2 Bytes 2 Bytes
action span count
2 Bytes 2 Bytes
span address [0]
(see description)
...
span address [
span count
- 1]
(see description)
8 24
cam
Camera line from 1 to max cam
rec idx
Primary Recording 1 (default)
Secondary Recording 2
action
Action to do in this command.
span count
Number of span address following in this command payload. For action show you can specifie the max
number of span history entries to show for in payload. the reply payload will then return a max. of this
number of span address. max 32.
span address
16 32
Target Id
4 Bytes
Target IdX LUN Span IDX
1 Byte 1 Byte 2 Bytes
8 24
Target Id
Target ID of the Span
Target IdX
Target Index of the Span
LUN
LUN of the Span
Span IDX
Span Index of the Span
2.599 CONF_SPAN_PARTITION_FILE_INFO
[API: recording settings]
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES).
Target IDX
Index of the iSCSI server target. The index of the desired target can be obtained from the reply to an iSCSI
discover.
LUN
The logical unit.
Span IDX
Index of the span in the specified lun.
MaxEntries (optional)
Max Number of entries, optional, if missing, default is max. 256 files which is also the max. limit for this
value
Mask Name
Bit 0 0x00000001 Add span info flags
For the payload structure of the response see documentation of HD_PARTITION_FILE_INFO. In case of
the optional "add span info flag" flag the first four bytes of the responspayload will contain a flag field with
additional infos. Without the option, the payload will start with the file info without offset.
Mask Name
Bit 0 0x00000001 Encrypted span key list present
2.600 CONF_SPAN_PARTITION_PROP
[API: recording settings]
2.601 CONF_SPAN_PARTITION_PROP_SECONDARY
[API: recording settings]
2.602 CONF_SPAN_SWITCH
[API: recording settings]
Description
This command can be used to influence the span usage of the recording. It is able to cause a replace of the
premounted span and or switch to the next premounted span.
The flag SWITCH_SPAN causes the switch to the next span and releasing the actual recording span. Flag
REPLACE_PREMOUNTED will cause the release of the premounted span and mounting another one if
available. If both flags are activated, the premounted block will be replaced, as soon as a new premounted
span is mounted and available, the next step switch to premounted span will be performed. Before replacing
the premounted span, the actual recording span will be checked, if the replace could get in conflict with a
device internal triggered span switch. In that case the whole Span switch command will fail with rcp error
RCP_ERROR_TRY_LATER, no switch or replace will be performed.
When performing a switch to next span job, the recording span address in the payload will be checked. If
on execution of this job the recording span doesn't match the recording span from the payload, the switch
will not be performed. When performing a replace premounted span job, the premounted span address in
the payload will be checked. If on execution of this job the premounted span doesn't match the premounted
span from the payload, the replace will not be performed. The idea of these checks is to avoid conflicts with
the automatic span switching of the recording, that can lead to gaps in the recording and unwanted waste of
recording spans. The flag FORCE will skip these checks. Flag CHECK_PREMOUNTED is only relevant
for the switch to next span job without replacing the premounted span and without FORCE flag. If this flag is
active on switching ton next span, the premounted span parameter in the payload will be matched against the
actual premounted span. If no match the switch won't be performed. If this flag including the FORCE flag
isn't set on switch, a negative match will be performed on the premounted span. The TARGET_RETREAT
Bit means, than a complete retreate from this target is intended, the span history will be modified in order
to avoid a remount on that target. That state will stay active for that target until the device records on a new
target and adds a span from the new target to the history, or if the span history will be cleared or the the
target will be reintroduced with the bit TARGET_REINTRODUCE. The TARGET_REINTRODUCE Bit
is needed to undo a TARGET_RETREAT action, which is specialy in the case needed, when a device shall
return to a target, from that it had retreated erlier and no recording took place on another target between these
events. In that case the remount feature for that target is still disabled. The TARGET_REINTRODUCE Bit
will reenable the remount feature for that target without the nessessarity of clearing the whole span history.
Warning: A possible conflict, when requesting a replace of the premounted span with an automatic span
switch of the recording that causes gaps in the recording is unavoidable. So an excesive usage of replacing
premounted spans should be avoided.
Payload Structure
16 32
Recording Span...
(see description)
Recording Span
...
Premounted span...
8 Bytes
Premounted span
...
Flags Recording Reserved
2 Bytes 1 Byte 1 Byte
8 24
Recording Span
16 32
Target id
4 Bytes
Target idx Lun Span idx
1 Byte 1 Byte 2 Bytes
8 24
Target id
The target id of the span
Target idx
The target index of the span
Lun
The lun of the span
Span idx
The span index of the span
Premounted span
16 32
Target id
4 Bytes
Target idx Lun Span idx
1 Byte 1 Byte 2 Bytes
8 24
Target id
The target id of the span
Target idx
The target index of the span
Lun
The lun of the span
Span idx
The span index of the span
Flags
These flags are used to specify the behavior of the command
Mask Name
Bit 15 0x8000 ERROR_CHECK_RECORDING
Bit 14 0x4000 ERROR_CHECK_PREMOUNTED
Bit 5 0x0020 TARGET_REINTRODUCE
Bit 4 0x0010 TARGET_RETREAT
Bit 3 0x0008 SWITCH_SPAN
Bit 2 0x0004 REPLACE_PREMOUNTED
Bit 1 0x0002 CHECK_PREMOUNTED
Bit 0 0x0001 FORCE
Recording
Primary Recording 1 (default)
Secondary Recording 2
2.603 CONF_SPAN_USE_STATUS
[API: recording settings]
Description
This messages reports the use status of a span for this device and which cammera for primary recording.
If a span was opened for a planned recording, this message will be send with status MOUNTED.
If the mounting fails status will be ERROR. If a span was closed after recording status will be
RELEASE, if it was closed before a recording ever took place, status will be RELEASE_UNUSED.
HD_SPAN_USE_STATUS_RETENTION_TIME status will be send as message if the first time an
retention time update took place on the span. In case of a read request the reply payload cantains this status
message upto twice. the command can be used to query the actual used spans from a camera specified by
the num parameter. the status for a span can be RECORDING, if the cam is actual recording on this span
or MOUNTED, if the span is mounted and prepared for a future recording by this camera.
Payload Structure
Use Status Message [0]
(see description)
...
16 32
err/spec code status cam
1 Byte 1 Byte 2 Bytes
target id
4 Bytes
target idx lun span idx
1 Byte 1 Byte 2 Bytes
8 24
err/spec code
Additional error or status code to the status, for status HD_SPAN_USE_STATUS_ERROR_MOUNT
see section 'status HD_SPAN_USE_STATUS_ERROR_MOUNT error codes', for status RELEASE and
RELEASE_UNUSED see section 'status RELEASE error codes', for status MOUNTED see section 'status
MOUNTED special codes'
status
Use status of this span
MOUNTED 0x00
RELEASE 0x01
RELEASE_UNUSED 0x02
ERROR 0x03
RECORDING 0x04
PENDING_SPAN_REQUEST 0x05
HD_SPAN_USE_STATUS_RETENTION_TIME 0x06
HD_SPAN_USE_STATUS_RELEASE_REMOUNT_INTENDED
0x07
HD_SPAN_USE_STATUS_ERROR_WRT_UNT_HDR 0x10
HD_SPAN_USE_STATUS_ERROR_FORMAT_REC_REGION
0x11
HD_SPAN_USE_STATUS_ERROR_MOUNT 0x12
HD_SPAN_USE_STATUS_ERROR_RETENTION_TIME 0x13
If the status is PENDING_SPAN_REQUEST, the ip will be 255.255.255.255, target index and lun will be
255, and span index will be 65535, which should be interpreted as still unknown, because this cam had
requested a span, but it doesn't know yet which span it gets.
Status HD_SPAN_USE_STATUS_RELEASE_REMOUNT_INTENDED means, the cam has released the
block but has left the span lock, because it will try to remount the span later. The span is stored in the span
history for remount(see CONF_SPAN_HISTORY).
cam
Which camera is or was using the reported span
target id
Target id of the lun (may be the ipv4 address for older versions or with default target resolve configuration,
see CONF_TARGET_ID_RESOLVE_RULES)
target idx
Target Index of the storage device from 0 to 255.
lun
Lun of the storage device from 0 to max. 255.
span idx
Index of the span on the storage device.
None 0x00
SPAN_ERROR_INTERNAL 0x01
SPAN_ERROR_INV_SPN_IDX 0x02
SPAN_ERROR_INV_HDR_TYPE 0x03
SPAN_ERROR_INV_ADDR_LIST 0x04
SPAN_ERROR_NOT_MNTD 0x05
SPAN_ERROR_INV_FS 0x06
SPAN_ERROR_INV_LUN_NFO 0x07
SPAN_ERROR_BAD_HDR_CKSM 0x08
SPAN_ERROR_INV_IDX 0x09
SPAN_ERROR_RD_ONLY 0x0a
SPAN_ERROR_NO_REC_DAT 0x0b
SPAN_ERROR_INV_PART_NFO 0x0c
SPAN_ERROR_SPAN_REQUEST_FAILED 0x0e
SPAN_ERROR_SPAN_REQUEST_RETENTION_TIME0x0f
SPAN_ERROR_REMOUNT_REFUSED 0x10
ISCSI_ERROR_CONNECT 0x31
ISCSI_ERROR_INV_LUN 0x33
ISCSI_ERROR_LOGIN 0x34
ISCSI_ERR_PWD 0x36
ISCSI_ERR_PROTO 0x37
ISCSI_ERR_TARG_NOT_REACH 0x38
ISCSI_ERR_NO_MEM 0x3a
ISCSI_ERR_SESS_CREATE 0x3b
ISCSI_ERR_INV_PARAMS 0x3c
ISCSI_ERR_SESS_NOT_FOUND 0x3d
ISCSI_ERR_DISCONN 0x3e
ISCSI_ERR_TIMEOUT 0x3f
ISCSI_ERR_SOCK 0x5f
ISCSI_ERR_TARG_PM 0x6f
ISCSI_SOCK_CLOSED 0x7f
ISCSI_ERR_TCP_CONN_RST 0x8f
ISCSI_ERR_INTR_NOT_SUPP 0x9f
ISCSI_ERR_IP_ZERO 0xa0
ISCSI_ERR_OUT_OF_RES 0xa1
HDD_ERROR_TIMEOUT 0x12
HDD_ERROR_CREATE_FAILED 0x22
HDD_ERROR_ACCESS_DENIED 0x32
HDD_ERROR_DEVICE_PRESENT_TIMEOUT 0x42
HD_PMM_ERROR_LUN_LOCK 0x52
HD_PMM_ERROR_INVALID_ACCESS 0x62
HD_PMM_ERROR_LUN_MGMT_FILE_NOT_FOUND0x72
HD_PMM_ERROR_LUN_WRITE_PROTECTED 0x82
HD_PMM_ERROR_COMMON 0xf2
None 0x00
RELEASE_ERROR_HD_MGR_ERROR 0x01
RELEASE_ERROR_SPAN_LIST_INCONSISTENCY 0x02
RELEASE_ERROR_RECORD_HANDLE_DISMISS_ERROR
0x03
RELEASE_ERROR_BIG_TIME_JUMP 0x04
RELEASE_ERROR_CLOSED_WHILE_MOUNTING 0x05
RELEASE_ERROR_INITIAL_MOUNT_ABORT 0x06
RELEASE_ERROR_INITIAL_MOUNT_UNFINISHED 0x07
RELEASE_ERROR_NEXT_SPAN_NOT_MOUNTED 0x08
RELEASE_ERROR_RECORDING_ERROR 0x09
RELEASE_ERROR_ENCODER_ERROR 0x0a
RELEASE_ERROR_REPLACE 0x0b (release was caused by
CONF_SPAN_SWITCH command)
RELEASE_ERROR_SWITCH_REQUEST 0x0c (release was caused by
CONF_SPAN_SWITCH command)
RELEASE_ERROR_SPAN_TIME_LIMIT_REACHED 0x0d (one day limit per span, if max
retention configured)
RELEASE_ERROR_RECORD_FORMAT_HARD_LIMIT
0x0e (initiated span switch by recording
internal for record format related
issues (gop alignment violation at span
end))
RELEASE_ERROR_RECORD_FORMAT_RING_BREAK
0x0f (initiated span switch by recording
internal for record format related
issues (ring limit violation at span
end))
2.604 CONF_SPAN_USE_STATUS_SECONDARY
[API: recording settings]
2.605 CONF_STAMP
[API: stamping]
Payload Structure
Region Info [0]
(see description)
...
Region Info
16 32
Stamping Region ID Region Payload Length
2 Bytes 2 Bytes
Region Payload
(see description)
8 24
Stamping Region ID
All regions (global settings) 0
Time Stamp Region 1
Name Stamping Region 2
Alarm Stamping Region 3
Info Stamping Region 4
Live Indicator Region 5 Spinner Region
System Controller Title Region 6 System Controller Region 1
System Controller Telemetry Region 7 System Controller Region 2
Region Payload
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: Visibility
Values:
Hidden 0
Visible 1
Tag 2: Position
Position
12 24
Position Type Position X Position Y
1 Byte 1 Byte 1 Byte
6 18
Position Type
OFF 0
Bottom 1 in this case position X anx Y is ignored
Top 2 in this case position X anx Y is ignored
Custom 3
Position X
Position X is an integer value from 0 to 255, where 0 is the left border of the image and 255 is the right
border of the image.
Position Y
Position Y is an integer value from 0 to 255, where 0 is the top border of the image and 255 is the bottom
border of the image.
Tag 3: Text
Text
16 32
text encoding text [0] ...
line length
type (char set) UTF16CharsPerLine
2 Bytes
1 Byte * 16 Bits
text [0]
...
...
8 24
line length
Characters per line, e.g. 32 utf16 symbols. Notice: please use the value 'UTF16CharsPerLine' returned by
CONF_ENC_STAMPING_PROPERTIES.
text
Consists of n * UTF16CharsPerLine utf16 chars
Font size
font mode
Normal 0
Big 1
Custom 255 custom font size
Values:
No transparent 0
background
Transparent 1
background
Tag 6: Color
Color
16 32
Color Mode Reserved
1 Byte 3 Bytes
Background - Red Background - Green Background - Blue Reserved
1 Byte 1 Byte 1 Byte 1 Byte
Text - Red Text - Green Text - Blue Reserved
1 Byte 1 Byte 1 Byte 1 Byte
8 24
Color Mode
RGB 0 Red, Green, Blue values are used.
Background - Red
Value 0 - 255
Background - Green
Value 0 - 255
Background - Blue
Value 0 - 255
Text - Red
Value 0 - 255
Text - Green
Value 0 - 255
Text - Blue
Value 0 - 255
2.606 CONF_STAMP_ATTR_ALARM
[API: stamping]
Payload Structure
16 32
x y reserved
1 Byte 1 Byte 2 Bytes
attributes
4 Bytes
reserved reserved
2 Bytes 2 Bytes
8 24
x
X-Position (0...255) where the string should be displayed (0 is left)
y
Y-Position (0...255) where the string should be displayed (0 is up)
attributes
(use CONF_ENC_STAMPING_PROPERTIES to determine supported options)
2.607 CONF_STAMP_ATTR_DEC_FREEZE
[API: stamping]
Description
This command is used only on decoders
Payload Structure
16 32
reserved bg_luma bg_chroma
2 Bytes 1 Byte 1 Byte
attributes
4 Bytes
font_luma font_chroma flags
1 Byte 1 Byte 2 Bytes
8 24
bg_luma
Background color: 8 bit luma (Y)
bg_chroma
Background color: 2 x 4 bit chroma (U/V); 'lower 4 bit' = U, 'upper 4 bit' = V
attributes
Mask Name Description
Bit 10 0x00000400 Background Box Big text background box
Bit 8 0x00000100 Custom Font Use custom font and background color given
in bg_luma, bg_chroma, font_luma and
font_chroma
font_luma
Font color: 8 bit luma (Y)
font_chroma
Font color: 2 x 4 bit chroma (U/V); 'lower 4 bit' = U, 'upper 4 bit' = V
flags
Flags not in use for freeze string, set to all-zero
2.608 CONF_STAMP_ATTR_INFO
[API: stamping]
2.609 CONF_STAMP_ATTR_LOGO
[API: stamping]
2.610 CONF_STAMP_ATTR_NAME
[API: stamping]
Description
Supported for CPP4, CPP6, CPP7 and CPP7.3. For other platforms use CONF_STAMP instead.
Payload Structure
16 32
x y reserved
1 Byte 1 Byte 2 Bytes
attributes
4 Bytes
reserved flags
2 Bytes 2 Bytes
8 24
x
X-Position (0...255) where the string should be displayed (0 is left)
y
Y-Position (0...255) where the string should be displayed (0 is up)
attributes
(use CONF_ENC_STAMPING_PROPERTIES to determine supported options)
flags
Mask Name
Bit 3 0x0008 Display only logo
Bit 2 0x0004 Logo position relative to font
Bit 1 0x0002 Enable logo stamping
2.611 CONF_STAMP_ATTR_TIME
[API: stamping]
Payload Structure
16 32
x y reserved
1 Byte 1 Byte 2 Bytes
attributes
4 Bytes
reserved reserved
2 Bytes 2 Bytes
8 24
x
X-Position (0...255) where the string should be displayed (0 is left)
y
Y-Position (0...255) where the string should be displayed (0 is up)
attributes
(use CONF_ENC_STAMPING_PROPERTIES to determine supported options)
2.612 CONF_STAMP_DEC_FREEZE_STRING
[API: stamping]
2.613 CONF_START_CLIENT
[API: account]
2.614 CONF_START_MULTICAST_STREAMING
[API: multicast]
2.615 CONF_START_RECORD
[API: recording settings]
2.616 CONF_START_SPAN_RECORD
[API: recording settings]
2.617 CONF_START_VIPROC_CONFIG_EDITING
[API: viproc]
2.618 CONF_STARTPAGE_BACKGROUND_URL
[API: browser]
2.619 CONF_STARTPAGE_LOGO_URL
[API: browser]
2.620
CONF_STARTPAGE_PRESENTATION_SWITCHES
[API: browser]
2.621 CONF_STATELESS_IP_V6_PREFIX_LEN
[API: ethernet]
2.622 CONF_STATELESS_IP_V6_STR
[API: ethernet]
2.623 CONF_STATELESS_IP_V6_STRINGS
[API: ethernet]
2.624 CONF_STATIC_PRIV_MSK_OVERLAY
[API: video input]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Cross hair
16 32
Enable Reserved Reserved Reserved
1 Byte 1 Byte 1 Byte 1 Byte
Reserved Reserved Reserved Reserved
1 Byte 1 Byte 1 Byte 1 Byte
8 24
Enable
OFF 0
On 1
2.625
CONF_STATIC_PRIV_MSK_OVERLAY_OPTIONS
[API: video input]
Payload Structure
16 32
Cross Hair reserved...
1 Byte 15 Bytes
reserved
...
reserved
...
reserved
...
8 24
Cross Hair
Cross Hair Not 0
Supported
Basic Support Of 1
Cross Hair
2.626 CONF_STATIC_SERVER_URL
[API: system.settings]
2.627 CONF_STATUS_AUTO_TRACKER
[API: autotracker]
2.628 CONF_STD_MEDIA_CONNECTION_DIRECTION
[API: alarm connections]
Values:
outgoing media for alarm connections 0
req. incoming media for alarm 1
connections
req. bidirectional media for alarm 2
connections
2.629
CONF_STD_MEDIA_ENCAPSULATION_PROTOKOL
[API: alarm connections]
2.630 CONF_STEALTH_MODE
[API: user management]
Values:
disabled 0
enabled 1
2.631 CONF_STOP_CLIENT
[API: account]
2.632 CONF_STOP_VIPROC_CONFIG_EDITING
[API: viproc]
2.633 CONF_STORAGE_IO
[API: storage]
Reserved
[...]
Reserved
...
Reserved
...
8 24
Lun Address
16 32
iSCSI IP
4 Bytes
Target Idx
4 Bytes
Lun
4 Bytes
Span Idx
4 Bytes
8 24
iSCSI IP
The ip address of the iscsi server
Target Idx
The index of the target on the iscsi server.
Lun
The logical unit.
Span Idx
The index of the span. Only used, if the flag RESTRICT TO SPAN is set.
Repeat
The number of times the test is repeated which means how often the specified burst sequence is run.
Mode
The test may run in the following modes. The modes RECORDING SIMULATION, LATENCY and
REPLAY SIMULATION use different fields in the request packet which are not documented yet.
LINEAR 0x0000
RANDOM 0x0001
RECORDING SIMULATION 0x0002
LATENCY 0x0003
REPLAY SIMULATION 0x0004
If the mode is set to LINEAR then the test reads/writes from/to consecutive lba addresses. If the maximum
lba is reached and the STORAGE_IO_FLAG_MAX_LBA_END flag is set, the test stops. Otherwise the
test wraps its lba pointer to the beginning of its storage.
If the mode is set to RANDOM then the test reads/writes from/to randomly chosen lba addresses of the
storage.
Flags
Mask Name Description
Bit 9 0x0200 MAX LBA END If set, the tests stops when the write pointer
reaches the maximum lba address of the lun/
span (only in sequential access mode).
Bit 8 0x0100 ISCSI SESSION EXCLUSIVE If set, the tests use an exclusive iscsi session
which is not shared among other tests.
Bit 7 0x0080 RESTRICT TO SPAN If set, the tests only uses the span of the lun,
which is specified in the 'Span Idx' field of the
lun-address.
Bit 6 0x0040 ERROR STOP If set, the tests stops when an io error occurrs.
Bit 5 0x0020 EXP BURST INCREASE If set, the field 'Burst Size Increase' is ignored.
Instead the burst size is doubled after each run.
Bit 4 0x0010 VERIFY WRITE If set, every lba that was written is read
afterwards to verify that the data was correctly
written.
Bit 3 0x0008 KEEP DATA If set, all lbas that are written are read before
so that no recording data should be destroyed.
Be careful that no one else writes to this lun
simultaneously. In the latter case data on the
storage could be lost.
Bit 1 0x0002 WRITE ONLY If set, only write operations are performed.
May not be used simultaneously with the
READ ONLY flag.
Bit 0 0x0001 READ ONLY If set, only read operations are performed. May
not be used simultaneously with the WRITE
ONLY flag.
ID
Identifier of the storage io. Set to zero when starting a new storage io. Set to the from the start request
returned value for stopping a storage io.
Action
STOP 0x00
START 0x01
Lun Address
16 32
iSCSI IP
4 Bytes
Target Idx
4 Bytes
Lun
4 Bytes
Span Idx
4 Bytes
8 24
iSCSI IP
The ip address of the iscsi server
Target Idx
The index of the target on the iscsi server.
Lun
The logical unit.
Span Idx
The index of the span. Only used, if the flag RESTRICT TO SPAN is set.
Repeat
The number of times the test is repeated which means how often the specified burst sequence is run.
Mode
The test may run in the following modes. The modes RECORDING SIMULATION, LATENCY and
REPLAY SIMULATION use different fields in the request packet which are not documented yet.
LINEAR 0x0000
RANDOM 0x0001
RECORDING SIMULATION 0x0002
LATENCY 0x0003
REPLAY SIMULATION 0x0004
If the mode is set to LINEAR then the test reads/writes from/to consecutive lba addresses. If the maximum
lba is reached and the STORAGE_IO_FLAG_MAX_LBA_END flag is set, the test stops. Otherwise the
test wraps its lba pointer to the beginning of its storage.
If the mode is set to RANDOM then the test reads/writes from/to randomly chosen lba addresses of the
storage.
Flags
Mask Name Description
Bit 9 0x0200 MAX LBA END If set, the tests stops when the write pointer
reaches the maximum lba address of the lun/
span (only in sequential access mode).
Bit 8 0x0100 ISCSI SESSION EXCLUSIVE If set, the tests use an exclusive iscsi session
which is not shared among other tests.
Bit 7 0x0080 RESTRICT TO SPAN If set, the tests only uses the span of the lun,
which is specified in the 'Span Idx' field of the
lun-address.
Bit 6 0x0040 ERROR STOP If set, the tests stops when an io error occurrs.
Bit 5 0x0020 EXP BURST INCREASE If set, the field 'Burst Size Increase' is ignored.
Instead the burst size is doubled after each run.
Bit 4 0x0010 VERIFY WRITE If set, every lba that was written is read
afterwards to verify that the data was correctly
written.
Bit 3 0x0008 KEEP DATA If set, all lbas that are written are read before
so that no recording data should be destroyed.
Be careful that no one else writes to this lun
ID
Identifier of the storage io. This value must be specified on actions other than start.
Status
STOPPING 0x00
STARTING 0x01
RUNNING 0x02
DONE 0x03
ERROR 0x04
Error
INTERNAL 0x01
LUN 0x02
INVALID 0x03
PARAMS
READ 0x04
WRITE 0x05
WRITE VALIDATE0x06
Repeat Count
The number of turns the test repeated so far.
Current Offset
The current position of the i/o pointer in percentage of the whole storage. This value is not significant in
random access mode.
Read Bytes
The number of bytes that were read since the test was started.
Write Bytes
The number of bytes that were written since the test was started.
Read Operations
The number of read operations successfully performed since the test was started.
Write Operations
The number of write operations successfully performed since the test was started.
Read Errors
The number of read errors since the test was started.
Write Errors
The number of read errors since the test was started.
2.634 CONF_STORAGE_LIST
[API: storage]
Description
Use this command to configure and manage local or remote storage. The storage list may contain up to 16
entries. If a remote (iscsi) storage is to be managed, the lun address has to be specified. Realize, that if you
export an remote storage, the device will have preformance drawbacks cause the ip- and iscsi-stack will be
passed through twice. Prefer to access the remote storage directly instead.
The storage lun can be write protected. If this state was recognized, the Mgr Status will inform about
this state by the value "WRITE PROTECTION". There are three ways for a storage lun to become write
protected here. First to configure explicite the storage lun(Span Mgr) to be in read only mode, second by a
defect storage lun, which will cause a fall back into a write protection mode, and third if the storage is set
physically to write protection (e.g. user moves the lever on the sd card into the write protection position).
The storage devices will be exported through iscsi in the order of this list (storage devices with the 'iSCSI
export' field set to 'For local use only' [0x00] are omitted) and the storage will appear in the same place of
the target name list of an iscsi discovery on that device.
This command will be send as msg (can also be send as snmp trap with same pyload) in case of crossing
the storage threshold with Mgr status ALARM THRESHOLD or in case of overwriting recording, that is
still protected by unexpired retention time with mgr status ALARM OVERWRITE.
Write Payload Structure
16 32
Storage Type
4 Bytes
Target ID
4 Bytes
Target Index Lun Rec Region Size
1 Byte 1 Byte 2 Bytes
Storage Type
The type of the storage.
FILE 0x02
RAM 0x03
ISCSI 0x04
USB 0x05
IDE 0x08
CF 0x09
IMG File 0x0a
SD 0x0b
SMB 0x11
SD OVER USB 0x16
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES). Will be ignored, if the storage type is not
iscsi.
Target Index
The target index on the iscsi server. Will be ignored, if the storage type is not iscsi.
Lun
The iscsi lun. Will be ignored, if the storage type is not iscsi.
iSCSI export
For local use only 0x00
Make storage available through iSCSI 0x01
Span Manager
Span manager off 0x00
Span manager on 0x01
Span format lun and start span manager 0x02
Migrate lun and start span manager 0x03
read only mode 0x04
erase lun and format 0x05
Flags
Mask Name Description
Bit 0 0x01 default setting just info, that this is a default setting
Storage threshold
This is the threshold of free storage in percent and means that at least this amount of memory should be
free. A Message of this command will be send always, this treshold is crossed in eiher direction.
Storage Type
The type of the storage.
FILE 0x02
RAM 0x03
ISCSI 0x04
USB 0x05
IDE 0x08
CF 0x09
Target ID
The target id of the lun (may be the ipv4 address for older versions or with default target resolve
configuration, see CONF_TARGET_ID_RESOLVE_RULES). Will be ignored, if the storage type is not
iscsi.
Target Index
The target index on the iscsi server. Will be ignored, if the storage type is not iscsi.
Lun
The iscsi lun. Will be ignored, if the storage type is not iscsi.
Fmt Progress
If the storage is in state formatting, the field indicates the formatting progress in percentage.
Utilization
If the storage is span formatted, this field indicates the amount capacity used (in percentage).
iSCSI export
For local use only 0x00
Make storage available through iSCSI 0x01
Span Manager
Span manager off 0x00
Span manager on 0x01
Span format lun and start span manager 0x02
Migrate lun and start span manager 0x03
read only mode 0x04
erase lun and format 0x05
Mgr Status
The status of the span manager in the response packet. Set to zero in the request packet.
OFF 0x00
ON 0x01
FORMATING 0x02
MIGRATING 0x03
Mgr Error
If the span manager status is ERROR, this field contains details of the error that occurred. See command
CONF_SPAN_USE_STATUS for possible error codes.
Mgr Flags
Mask Name Description
Bit 0 0x01 lun scan running scan job for all spans on the lun is running
Flags
Mask Name Description
Bit 0 0x01 default setting just info, that this is a default setting
Storage threshold
This is the threshold of free storage in percent and means that at least this amount of memory should be
free. A Message of this command will be send always, this treshold is crossed in eiher direction.
Note: If the storage list is empty or only contains entries with the 'iSCSI export' field set to 'For local
use only' (0x00), the iscsi server is stopped, if it is running, cause no targets and luns would be provided.
If the list contains at least one entry with the 'iSCSI export' field set to 'Make storage available through
iSCSI' (0x01), the iscsi server is started, if not already running, to provide the iscsi service. The iscsi server
can be controlled through the command CONF_ISCSI_SERVER_STATE too.
2.635 CONF_STORAGE_LOAD
[API: system.status]
2.636 CONF_STORAGE_MEDIUM_AVAIL
[API: storage]
Description
"List of dwords with available storage medium types"
Read Payload Structure
Storage Type [0]
4 Bytes
...
Storage Type
The type of the storage.
None 0x00
USB 0x05
IDE 0x08
CF 0x09
IMG File 0x0a
SD 0x0b
SPAN FILES 0x0c
SD NOT 0x0e
INSERTED
CF NOT 0x0f
INSERTED
IMG NOT 0x10
INSERTED
SMB SPAN FILES 0x11
SECOND SD 0x12
SECOND SD NOT 0x13
INSERTED
2.637 CONF_STORAGE_MEDIUM_TYPE
[API: storage]
2.638 CONF_STORAGE_REPORT
[API: storage]
...
Type
None 0x00
RAM Recording 0x03
iSCSI 0x04
USB 0x05
IDE 0x08
Compact Flash 0x09
SMB 0x0B
Availability
Unknown 0x00
No 0x01
Yes 0x02
locked by another device 0x03
Access Type
Unknown 0x00
Read Only 0x01
Read Write 0x02
IO Error Type
None 0x00
Read 0x01
Write 0x02
IO Error Count
Number of arised I/O errors.
Throughput Read
Kilobytes read from device.
Throughput Write
Kilobytes written to device.
Phase
Indicates the phase, the iSCSI client has reached on login.
Error
Indicates the error that happend in that state.
2.639 CONF_STORAGE_REPORT_SECONDARY
[API: storage]
2.640 CONF_STORAGE_TARGET_ID
[API: storage]
2.641 CONF_STRATOCAST_ONOFF
[API: stratocast]
2.642 CONF_STRATOCAST_REGISTER
[API: stratocast]
2.643 CONF_STRATOCAST_STATE
[API: stratocast]
Values:
inactive 0
connecting 1
registering 2
connected 3
2.644 CONF_STREAM_EXCLUSIVE_CHECK
[API: roi]
Values:
non-exclusive 0
exclusive 1
2.645 CONF_STREAM_PRIORITY
[API: encoder]
2.646 CONF_STREAM_SECURITY_OPTIONS
[API: security]
2.647 CONF_STREAM_SECURITY_V2
[API: security]
2.648
CONF_STREAMING_GATEWAY_ACTIVE_LINES
[API: streaming gateway]
2.649 CONF_STREAMING_GATEWAY_CONFIG
[API: streaming gateway]
Description
This command is used to read and write the configuration of the streaming gateway. For the read direction
only "gateway line" and "gateway stream" parameter are relevant for the send diretion. The reply payload
will contain the full parameter set. For write direction use the full parameter set to configure a streaming
gate camera, if the action is "add camera". Depending on the camera type and connection type, additional
optional parameters are nessessary. E.g. the device simulator is able to connect to another bosch camera or
device specified by the url ([ip]:[port]/[line (1,2,...)]/[coder idx (1,2,...)]). E.g. with url "10.1.10.20:80/1/1"
it connects to the device on ip 10.1.10.20 and port 80 on the first line and the first video encoder.
Payload Structure
16 32
gateway line gateway stream action
2 Bytes 1 Byte 1 Byte
protocol version connection Reserved
1 Byte 1 Byte 1 Byte 1 Byte
manufacturer id
4 Bytes
device type...
32 Bytes
device type
[...]
device type
...
Tag-Structure [0]
...
Tag-Structure [N]
8 24
gateway line
Local line of streaming gateway id
gateway stream
Local stream of streaming gateway starting with 0 for the first stream
action
Action for write direction, choose between add camera and remove camera, in case of remove camera,
except this field, 'gateway line', 'gateway stream' and 'version' all other fields in the payload are irrelevant
add camera 0
remove camera 1
protocol
Choose protocol type
none 0
onvif 1
jpeg 2
bosch 3
rtsp 4
rtsp h263 5
rtsp h264 6
rtsp jpeg 7
version
Version of the command, current version is 1
connection
Connection type
udp unicast 0
udp multicast 1
tcp 2
manufacturer id
Distinguish between bosch cameras and foreign cameras
unknown 0
bosch 1
device type
32 ascii characters including zero termination
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 0: None
16 32
Tag = 0x0000 Length = 0x0000
2 Bytes 2 Bytes
8 24
Tag 1: URL
zero terminated ascii string containing the url of the remote camera. Length of the string including zero
termination is limited by the 'length' of the optional parameter
16 32
Tag = 0x0001 Length = 0x000
2 Bytes 2 Bytes
URL (p_string)
Length Bytes
8 24
Tag 2: Stream
16 32
Tag = 0x0002 Length = 0x000
2 Bytes 2 Bytes
Stream (p_octet)
Length Bytes
8 24
Stream
16 32
Remote camera line Remote camera stream Reserved
2 Bytes 1 Byte 1 Byte
8 24
16 32
Tag = 0x0003 Length = 0x000
2 Bytes 2 Bytes
Camera token (p_octet)
Length Bytes
8 24
16 32
Tag = 0x0004 Length = 0x000
2 Bytes 2 Bytes
Profile token (p_octet)
Length Bytes
8 24
2.650 CONF_STREAMING_GATEWAY_MAX_LINES
[API: streaming gateway]
2.651 CONF_STREAMING_VAL
[API: multicast]
Values:
set multicast streaming mode to off 0
set multicast streaming mode mpeg4 to on1
set multicast streaming mode mpeg2 to on2
set multicast streaming mode 3
mpeg4+mpeg2 to on
2.652 CONF_SUBNET
[API: ethernet]
2.653 CONF_SUBNET_STR
[API: ethernet]
2.654 CONF_SUPPORTED_UPLOAD_TARGETS
[API: system.settings]
2.655 CONF_SYSCONTACT
[API: snmp]
2.656 CONF_SYSLOCATION
[API: snmp]
2.657 CONF_SYSLOG_HOST_STR
[API: syslog]
2.658 CONF_SYSLOG_LOG_LEVEL
[API: syslog]
2.659 CONF_SYSLOG_MESSAGE
[API: syslog]
2.660 CONF_SYSLOG_PORT
[API: syslog]
2.661 CONF_SYSLOG_PROTOCOL
[API: syslog]
Values:
UDP 0
TCP 1
TLS 2
2.662 CONF_SYSTEM_DATETIME_V2
[API: local time and time server settings and configuration]
2.663 CONF_SYSTEM_INFO_FILE
[API: system.settings]
2.664 CONF_SYSTEM_LOAD
[API: system.status]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: CPU_LOAD_OF_CORE_N
Container tag which contains information about current CPU-load on a single CPU-core
CPU_LOAD_OF_CORE_N
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 3: CORE_IDX
Index of the core described by the current container.
Tag 5: IDLE_PERC
Idle value for this core in percent
Tag 6: ENC_PERC
CPU-load in percent caused by the encoder on this core. Only supported on CPP6/CPP7/CPP7.3, '0'
otherwise
Tag 7: VCA_PERC
CPU-load in percent caused by the VCA on this core. Only supported on CPP6/CPP7/CPP7.3, '0' otherwise
Tag 2: RECORDER_N
Container tag which contains information about a local recording media.
The availability of a index in this tag depends on the availability of a media slot on the device, and not on
wether a media is currently plugged.
This means: If a device has 2 SD-Card slots then this command always returns 2 descriptors (idx 0,1) also
when only one or none card is plugged.
RECORDER_N
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 4: REC_IDX
Index of the media slot, e.g. SD-Card, described by the current container.
Tag 8: RECORDING_LOAD_PERC
Current load of a local recording media in percent
Tag 9: RECORDING_MEDIA_STATUS
Current status of a local recording media
Values:
No device plugged 1
Device detected and can be used 2
Hardware init failed 3
Hardware driver IO error 4
Hardware CRC error 5
Hardware IO timeout 6
Warning, Media has sometimes slow IO 7
Warning, Media is read-only (Either 8
write-protected or end of life)
Media not suitable 9
Media too small 10
2.665 CONF_SYSTEM_OS_VERSION
[API: system.settings]
2.666 CONF_SYSUPTIME
[API: system.status]
2.667 CONF_TARGET_ID_RESOLVE_RULES
[API: storage]
Description
This command configures the rules for resolving a storage target id to the parameter for connecting the
storage server. The target id is an 32 bit system wide unique identifier and replaces the ipv4 addresses for
storages. The display format of an id in text will be "xxx.xxx.xxx.xxx" like ipv4 addresses. There are special
values for the target id, which are 0.0.0.0 for invalid target id, 255.255.255.255 for wildcard and 127.0.0.1
for the local target in order to be backward compartible with older devices and software which expect an
ipv4 address instead. The default state for the configured rules containes only one rule for the complete
range 0.0.0.1 to 255.255.255.254 and lowest priority 0 for DIRECT_IPV4 for backard compartibility. In
order to change or add rules, all which shall be changed or added needs to be send including the table entry
index. Entries which shall not be changed doesn't need to be send. Also the read response payload will only
contain valid rules, except if the table is empty, in that case only one empty rule will be in the payload.
Payload Structure
target id resolve rule [0]
(see description)
...
16 32
target id range start
4 Bytes
target id range end
4 Bytes
index priority type
2 Bytes 1 Byte 1 Byte
reserved
4 Bytes
type specific parameter... (optional)
(see description)
type specific parameter
[...]
type specific parameter
...
8 24
index
Index of the target id resolve table, where to change the actual entry. Valid range is 0 to 127, as the table
has an actual size of 128 entries.
priority
The rules target id range my overlap, therefor the priority will be used, which rule wins in conflic case. The
valid range is from 0 to 255, where 0 is the lowest priority and 255 the highest.
type
The rules target id range my overlap, therefor the priority will be used, which rule wins in conflic case. The
valid range is from 0 to 255, where 0 is the lowest priority and 255 the highest.
url
The url of the iscsi server as zero terminated ascii string. Only ipv4 as string is actual supported.
port
The port of the iscsi service socket on the server. Default 0 means use the default port. Actual it is just a
place holder and other ports than the the default port are not supported.
path
...
port reserved
2 Bytes 2 Bytes
8 24
url
The url of the smb server as zero terminated ascii string. Only ipv4 or ipv6 as string is actual supported.
path
The path on the smb server as zero terminated ascii string.
port
The port of the iscsi service socket on the server. Default 0 means use the default port. Actual it is just a
place holder and other ports than the the default port are not supported.
Note: On the Generic (Windows and Linux) the whole table will be persisted in the table. The generic dll
won't persist it. All other devices will only persist the first four valid rules.
2.668 CONF_TCP_BANDWIDTH_CHECK
[API: transcoder]
2.669 CONF_TCP_BANDWIDTH_CHECK_RESULT
[API: transcoder]
2.670 CONF_TCP_FWD
[API: transcoder]
2.671 CONF_TCP_RATE_CONTROL
[API: encoder]
2.672 CONF_TELNET_PORT
[API: debug]
2.673 CONF_TEMP_SENS
[API: system.status]
2.674 CONF_THALES_FEATURE_LIST
[API: system.settings]
2.675 CONF_THALES_LIC_INSTALL
[API: system.settings]
2.676 CONF_THALES_LIC_UNINSTALL
[API: system.settings]
2.677 CONF_TIME_HRS
[API: local time and time server settings and configuration]
2.678 CONF_TIME_MIN
[API: local time and time server settings and configuration]
2.679 CONF_TIME_SC_CONNECT_FAIL_MSG
[API: local time and time server settings and configuration]
Values:
connect to server for time sync failed 1
2.680 CONF_TIME_SEC
[API: local time and time server settings and configuration]
2.681 CONF_TIME_STAMP_RESOLUTION
[API: stamping]
2.682 CONF_TIME_STAMP_VAL
[API: stamping]
2.683 CONF_TIMEZONE
[API: local time and time server settings and configuration]
2.684 CONF_TPPP_PORT
[API: serial port]
2.685 CONF_TRANSCODER_CAPABILITIES
[API: system.settings]
Payload Structure
Number of tagged elements
4 Bytes
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: TC_TAG_MAX_INPUT_RESOLUTION
maximum transcoder input resolution
16 32
Tag = 0x0001 Length = 0x000
2 Bytes 2 Bytes
TC_TAG_MAX_INPUT_RESOLUTION (p_octet)
Length Bytes
8 24
Tag 2: TC_TAG_MAX_SUBVIEWS
maximum transcoder subviews
16 32
Tag = 0x0002 Length = 0x0001
2 Bytes 2 Bytes
TC_TAG_MAX_SUBVIEWS (t_octet)
1 Byte
8 24
2.686 CONF_TRANSCODER_INFORMATION
[API: rcp.connection]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value without length and tag field
Tag
Tag specifying the encoding and meaning of the value
Not present 0
Connected 1
Tag 2: Version
16 32
Tag = 0x0002 Length = 0x000
2 Bytes 2 Bytes
Version (p_string)
Length Bytes
8 24
2.687 CONF_TRANSPARENT_DATA_OVER_IP
[API: viproc]
2.688 CONF_UNIT_ID
[API: system.settings]
2.689 CONF_UNIT_NAME
[API: system.settings]
2.690
CONF_UNSOLICITED_AUTODETECT_REPLY_TIME
[API: rcp.discovery]
2.691 CONF_UPLINK_KBPS
[API: ethernet]
2.692 CONF_UPLOAD_HISTORY
[API: system.status]
Description
Command CONF_UPLOAD_HISTORY allows to get insights on what was uploaded to the queried device
lately. The order of the entries in the upload history is always a chronological order. New entries are
appended at the end. In case all ten entries of the list are filled, the oldest entry is overwritten. Therefore, the
Latest Entry number in the header needs to be considered to find the latest entry in the list. The 2nd newest
entry is the preceding one in the list, and so on. While finding timely preceding entries, make sure to wrap in
the list to the last entry, where necessary. Handling the order of the entries in the list this way makes parsing
slightly more complicated than absolutely necessary, but helps to raise the MTBF of the flash hardware.
Considering these two aspects lead to the aforementioned organization of the upload history.
Uploads interrupted by power failure and consequent recovery measures like upload of a new firmware via
the recovery application APP0 can make it necessary to interpret the content of the upload history manually
with the help of the given flags, the firmware version, the file type and the date.
Response Payload Structure
16 32
Upload History Header...
(see description)
Upload History Header
...
Upload History Entry [0] ...
(see description)
Upload History Entry
...
Upload History Entry
...
8 24
Latest Entry
Number that points to the most recent entry in the upload history.
Reserved
Reserved Bits.
16 32
Firmware Version
4 Bytes
Upload Start Time
4 Bytes
Upload File Type Upload Error Code Flags
1 Byte 1 Byte 2 Bytes
8 24
Firmware Version
Version Information of the Firmware, that was uploaded.
Possible Values:
BSP_ROM_AREA_UNKNOWN
0
BSP_ROM_AREA_APP_0
3
BSP_ROM_AREA_APP_1
4
Note: Other file type values are possible, but documentation of those is kept confidential.
Possible Values:
UPLOAD_GEN_ERR_NO_ERR
0
UPLOAD_GEN_ERR_FLUSH_NO_HEADER
1
UPLOAD_GEN_ERR_FLUSH_WRITE
2
UPLOAD_GEN_ERR_FLUSH_READBACK
3
UPLOAD_GEN_ERR_FLUSH_VERIFY
4
UPLOAD_GEN_ERR_FINALFLUSH_FLASH_CHKSUM
5
UPLOAD_GEN_ERR_FINALFLUSH_HEADER_CHKSUM
6
UPLOAD_GEN_ERR_MAGIC
10
UPLOAD_GEN_ERR_VERSION_TOO_LOW
11
UPLOAD_GEN_ERR_VERSION_VS_FLASH
12
UPLOAD_GEN_ERR_CHECK_DEVICE
13
UPLOAD_GEN_ERR_FILE_ENTRY_MARKER
14
UPLOAD_GEN_ERR_CHUNK_TOO_BIG
15
UPLOAD_GEN_ERR_AREA_ALREADY_WRITTEN
16
UPLOAD_GEN_ERR_BLACK_WHITE_LIST_CHECK
17
UPLOAD_GEN_ERR_SIGNATURE_REQUIRED
18
UPLOAD_GEN_ERR_SIGNATURE_INVALID
19
UPLOAD_GEN_ERR_APPLYING_FILE
20
Flags
Flags related to this upload history entry.
Bit 2 0x0004 UPLOAD_FAILED If set, the upload was finished with an error.
Bit 1 0x0002 UPLOAD_FINISHED If set, the upload was finished at all.
Bit 0 0x0001 UPLOAD_STARTED If set, the upload was started.
Note: For a successful upload, all defined bits should be set, except for the UPLOAD_FAILED bit.
Write Payload Structure
16 32
Upload History Header...
(see description)
Upload History Header
...
Upload History Entry [0] ...
(see description)
Upload History Entry
...
Upload History Entry
...
8 24
Latest Entry
Number that points to the most recent entry in the upload history.
Reserved
Reserved Bits.
16 32
Firmware Version
4 Bytes
Upload Start Time
4 Bytes
Upload File Type Upload Error Code Flags
1 Byte 1 Byte 2 Bytes
8 24
Firmware Version
Version Information of the Firmware, that was uploaded.
Possible Values:
BSP_ROM_AREA_UNKNOWN
0
BSP_ROM_AREA_APP_0
3
BSP_ROM_AREA_APP_1
4
Note: Other file type values are possible, but documentation of those is kept confidential.
Possible Values:
UPLOAD_GEN_ERR_NO_ERR
0
UPLOAD_GEN_ERR_FLUSH_NO_HEADER
1
UPLOAD_GEN_ERR_FLUSH_WRITE
2
UPLOAD_GEN_ERR_FLUSH_READBACK
3
UPLOAD_GEN_ERR_FLUSH_VERIFY
4
UPLOAD_GEN_ERR_FINALFLUSH_FLASH_CHKSUM
5
UPLOAD_GEN_ERR_FINALFLUSH_HEADER_CHKSUM
6
UPLOAD_GEN_ERR_MAGIC
10
UPLOAD_GEN_ERR_VERSION_TOO_LOW
11
UPLOAD_GEN_ERR_VERSION_VS_FLASH
12
UPLOAD_GEN_ERR_CHECK_DEVICE
13
UPLOAD_GEN_ERR_FILE_ENTRY_MARKER
14
UPLOAD_GEN_ERR_CHUNK_TOO_BIG
15
UPLOAD_GEN_ERR_AREA_ALREADY_WRITTEN
16
UPLOAD_GEN_ERR_BLACK_WHITE_LIST_CHECK
17
UPLOAD_GEN_ERR_SIGNATURE_REQUIRED
18
UPLOAD_GEN_ERR_SIGNATURE_INVALID
19
UPLOAD_GEN_ERR_APPLYING_FILE
20
Flags
Flags related to this upload history entry.
Note: For a successful upload, all defined bits should be set, except for the UPLOAD_FAILED bit.
Read Payload Structure
16 32
Upload History Header...
(see description)
Upload History Header
...
Upload History Entry [0] ...
(see description)
Upload History Entry
...
Upload History Entry
...
8 24
Latest Entry
Number that points to the most recent entry in the upload history.
Reserved
Reserved Bits.
16 32
Firmware Version
4 Bytes
Upload Start Time
4 Bytes
Upload File Type Upload Error Code Flags
1 Byte 1 Byte 2 Bytes
8 24
Firmware Version
Version Information of the Firmware, that was uploaded.
Possible Values:
BSP_ROM_AREA_UNKNOWN
0
BSP_ROM_AREA_APP_0
3
BSP_ROM_AREA_APP_1
4
Note: Other file type values are possible, but documentation of those is kept confidential.
Possible Values:
UPLOAD_GEN_ERR_NO_ERR
0
UPLOAD_GEN_ERR_FLUSH_NO_HEADER
1
UPLOAD_GEN_ERR_FLUSH_WRITE
2
UPLOAD_GEN_ERR_FLUSH_READBACK
3
UPLOAD_GEN_ERR_FLUSH_VERIFY
4
UPLOAD_GEN_ERR_FINALFLUSH_FLASH_CHKSUM
5
UPLOAD_GEN_ERR_FINALFLUSH_HEADER_CHKSUM
6
UPLOAD_GEN_ERR_MAGIC
10
UPLOAD_GEN_ERR_VERSION_TOO_LOW
11
UPLOAD_GEN_ERR_VERSION_VS_FLASH
12
UPLOAD_GEN_ERR_CHECK_DEVICE
13
UPLOAD_GEN_ERR_FILE_ENTRY_MARKER
14
UPLOAD_GEN_ERR_CHUNK_TOO_BIG
15
UPLOAD_GEN_ERR_AREA_ALREADY_WRITTEN
16
UPLOAD_GEN_ERR_BLACK_WHITE_LIST_CHECK
17
UPLOAD_GEN_ERR_SIGNATURE_REQUIRED
18
UPLOAD_GEN_ERR_SIGNATURE_INVALID
19
UPLOAD_GEN_ERR_APPLYING_FILE
20
Flags
Flags related to this upload history entry.
Bit 2 0x0004 UPLOAD_FAILED If set, the upload was finished with an error.
Bit 1 0x0002 UPLOAD_FINISHED If set, the upload was finished at all.
Bit 0 0x0001 UPLOAD_STARTED If set, the upload was started.
Note: For a successful upload, all defined bits should be set, except for the UPLOAD_FAILED bit.
2.693 CONF_UPLOAD_PROGRESS
[API: system.status]
Payload Structure
4 8
Progress
1 Byte
2 6
Progress
Informs about current progress of an upload or possible error states. Values in the range of 1 ... 100 represent
the upload progress in percent. Other values need to be handled as error during the upload and inform about
the kind of the error that was encountered during the upload.
Percent 1 - 100
header error 101
write error 102
read back error 103
verify error 104
checksum mismatch written data 105 read back flash content vs.
written data
checksum mismatch received data 106 announced in header vs.
received data
magic error 110
version too low 111
flash type incompatible 112
device check failed 113
file entry marker failed 114
chunk size error 115
area already written 116
black white list check 117
wrong or no signature 118
signature invalid 119
invalid file name 130
ROM init error 131
2.694 CONF_UPNP_SEARCH_IP_CONN_SERVICE
[API: upnp]
2.695 CONF_UPNP_TCP_FWD
[API: upnp]
2.696 CONF_USB_PORT_PLUG_STATUS
[API: system.status]
2.697 CONF_USER_AUTH_MODE
[API: user management]
Description
Command CONF_USER_AUTH_MODE allows to query or enable/disable user authentication modes.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length = 0x0024 Tag = 0x0000
2 Bytes 2 Bytes
Auth Modes (t_dword)
4 Bytes
8 24
Mask Name
Bit 2 0x00000004 Active Directory (ADFS) Auth
Bit 1 0x00000002 Certificate Auth
Bit 0 0x00000001 Password Auth
2.698 CONF_UTC_ZONEOFFSET
[API: local time and time server settings and configuration]
2.699 CONF_VCA_BRIGHTNESS_INFO
[API: viproc]
2.700 CONF_VCA_MASK_DOME_PTZ_POS
[API: video input]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Command
MoveDomeToDefinedPos
0 Move dome to position stored at maskId
Mask Id
Use CONF_VCA_MSK_OPTIONS to query number of supported masks
(@CONF_VCA_MSK_OPTIONS Byte[4] maxNrOfVcaMasks per line). Define maskID which is used in
conjunction with the command
2.701 CONF_VCA_MSK_OPTIONS
[API: video input]
Payload Structure
16 32
Max Number Of
reserved Rectangle Support Polygon Support
Polygon Vertices
1 Byte 1 Byte 1 Byte
1 Byte
Max Number Of rcp vca mask
reserved reserved
Priv Masks Per Line support @ dome
1 Byte 1 Byte
1 Byte 1 Byte
reserved reserved reserved reserved
1 Byte 1 Byte 1 Byte 1 Byte
reserved reserved reserved reserved
1 Byte 1 Byte 1 Byte 1 Byte
8 24
Rectangle Support
No 0
Yes 1
Polygon Support
No 0
Yes 1 May not be self intersecting
2.702 CONF_VCA_MSK_POLY
[API: video input]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Polygon description
16 32
Enable Id Number Of Vertices Reserved...
1 Byte 1 Byte 1 Byte 5 Bytes
Reserved
...
Vertex [0]
(see description)
...
Vertex [
Number Of Vertices
- 1]
(see description)
8 24
Enable
Inactive 0 vca mask is not active
Active 1 vca mask is active
Id
0... max number vca masks (defined via CONF_VCA_MSK_OPTIONS)
Number Of Vertices
0... max number points (defined via CONF_VCA_MSK_OPTIONS)
Vertex
16 32
X Y
2 Bytes 2 Bytes
8 24
X
X Coordinate 0 - 32768
Y
Y Coordinate 0 - 32768
Use CONF_VCA_MSK_OPTIONS to query if supported ( Byte[7] rcp vca mask support @ dome )
Disable Masks
Do not change 0
Disable Masks 1
2.703 CONF_VCA_ORIENTATION_INFO
[API: viproc]
2.704 CONF_VCA_OUTPUT_FORMAT
[API: viproc]
Payload Structure
16 32
Image Width
4 Bytes
Image Height
4 Bytes
8 24
2.705 CONF_VCA_SHAPES
[API: encoder]
Values:
off 0
on 1
pixelized 2
blur 3
2.706 CONF_VCA_SHAPES_LEVEL
[API: encoder]
2.707 CONF_VCA_SUGGESTED_FIREMASK
[API: viproc]
2.708 CONF_VCA_TASK_RUNNING_STATE
[API: viproc]
2.709 CONF_VCD_OPERATOR_PARAMS
[API: viproc]
2.710
CONF_VID_H264_ENC_BASE_OPERATION_MODE_CAPS
[API: encoder]
Payload Structure
16 32
Number of streams
4 Bytes
Mode Combination [0]
(see description)
...
Mode Combination
Mode [0]
4 Bytes
...
Mode [
Number of streams
- 1]
4 Bytes
Mode
See 'Stream Operation Mode' of command '
CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE ' for details.
2.711 CONF_VID_IN_BRIGHTNESS
[API: video input]
2.712 CONF_VID_IN_CONTRAST
[API: video input]
2.713 CONF_VID_IN_SATURATION
[API: video input]
2.714 CONF_VIDEO_ALARM_STATE
[API: alarm]
2.715 CONF_VIDEO_BITRATE_AVERAGING_PERIOD
[API: encoder]
2.716 CONF_VIDEO_CURRENT_PARAMS_CODNBR
[API: encoder]
2.717 CONF_VIDEO_ENC_P_REF_LIST_SIZE
[API: encoder]
Values:
unrestricted 0
Values:
unrestricted. 0
2.718 CONF_VIDEO_ENC_PRIO
[API: encoder]
2.719 CONF_VIDEO_ENC_STREAMING
[API: multicast]
2.720 CONF_VIDEO_ENC_TEMP_QUANT_ADJ
[API: encoder]
Description
The encoder, to which the quality adjustment is to be applied is identified via the RCP session.
The area, in which the qualtiy is adjusted is characterized by the position of the edges of a rectangle within a
virtual coordinate system with a nominal range of [0..+32768]x[0..32768] for the complete encoded picture
(0=top/left edge, 32768=bottom/right edge). The actually adjusted area will be enlarged as needed by the
encoder.
Note, that the payload may contaion only first octet, if enable is set to 0
Payload Structure
16 32
En
DeltaQp Reserved
1
7 Bits 3 Bytes
Bit
Left Right
2 Bytes 2 Bytes
Top Bottom
2 Bytes 2 Bytes
8 24
En
Setup temporary quality
adjustments:
Enable 0
Disable 1
DeltaQp
Intended quality adjustment in H.264 QP units. If enable is 0, this field must also be set to 0. Otherwise the
allowed range is -51..51 with negative values indicating higher quality and positive ones lower quality.
Left
Relative position of the left edge of the adjustment region within the complete encoded image
Right
Relative position of the right edge of the adjustment region within the complete encoded image
Top
Relative position of the upper edge of the adjustment region within the complete encoded image
Bottom
Relative position of the lower edge of the adjustment region within the complete encoded image
2.721 CONF_VIDEO_ENCODER_ENCODED_BYTES
[API: encoder]
2.722 CONF_VIDEO_ENCODER_STATUS
[API: encoder]
Payload Structure
16 32
frames per 10 seconds
4 Bytes
KBPS
4 Bytes
8 24
2.723 CONF_VIDEO_ENCODER_STATUS_EXT
[API: encoder]
Payload Structure
16 32
frames per 10 seconds
4 Bytes
KBPS
4 Bytes
grab frames per 10 seconds
4 Bytes
lost frames per 10 seconds
4 Bytes
skipped frames per 10 seconds
4 Bytes
8 24
2.724
CONF_VIDEO_H264_ENC_BASE_OPERATION_MODE
[API: encoder]
Payload Structure
Stream Operation Mode [0]
4 Bytes
...
2.725 CONF_VIDEO_H264_ENC_CONFIG
[API: encoder]
Description
gets/sets the profile for each h.26x encoder per line for each time. Notice: the number of expected streams
can be queried with CONF_NBR_OF_ENC_STREAMS. If recording on that cam isn't running, the setting
for live mode(0) will take place immediately
Payload Structure
16 32
Mode
4 Bytes
StreamProfileNumber [0]
4 Bytes
...
StreamProfileNumber [N]
4 Bytes
8 24
Mode
0: live mode; 1-10: schedule number
StreamProfileNumber
List of profile numbers: profile of 1st stream, profile of 2nd stream, ...
2.726 CONF_VIDEO_H264_ENC_CONFIG_BULK
[API: encoder]
payload of VIDEO_H264_ENC_CONFIG
...
payload of VIDEO_H264_ENC_CONFIG
...
8 24
2.727 CONF_VIDEO_H264_ENC_CONFIG_DEFAULTS
[API: encoder]
Description
Set the default profile for each h.264 encoder per line for each time. (if recording on that cam isn't running,
the setting for live mode will take place imidiatly) Payload: Mode: recording scheduler number 1-10 or
live profile (0)
Values:
Live 0
Recording Schedule Number 1 - 10
2.728 CONF_VIDEO_H264_ENC_CURRENT_PROFILE
[API: encoder]
2.729 CONF_VIDEO_INPUT_DESCRIPTION
[API: video input]
Values:
Optical Video 0
Thermal Video 1
2.730 CONF_VIDEO_INPUT_FORMAT
[API: video input]
2.731 CONF_VIDEO_INPUT_FORMAT_EX
[API: video input]
Payload Structure
16 32
Video Format Electronic Image
Video Format Mode Video Format Id
Image Orientation Stabilization
1 Byte 1 Byte
1 Byte 1 Byte
Rotation Low Byte Rotation High Byte Rotation Mode Reboot required
1 Byte 1 Byte 1 Byte 1 Byte
Reserved Reserved Reserved Reserved
1 Byte 1 Byte 1 Byte 1 Byte
Reserved Reserved Reserved Reserved
1 Byte 1 Byte 1 Byte 1 Byte
Reserved Reserved Reserved Reserved
1 Byte 1 Byte 1 Byte 1 Byte
8 24
Fixed 0
Autodetect 1 Signals during read if device is in auto state -> 1 device is in auto mode;
active id will be shown in Video Format Id
Video Format Id
Valid ids can be queried with CONF_VIDEO_INPUT_FORMAT_EX_VERBOSE
Rotation Mode
Standard 0
Crop 1
Zoom 2
Reboot required
After video mode change, '0x01' indicates reboot is required to adopt new video mode
2.732 CONF_VIDEO_INPUT_FORMAT_EX_OPTIONS
[API: video input]
2.733 CONF_VIDEO_INPUT_FORMAT_EX_VERBOSE
[API: video input]
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
16 32
Length Tag = 0x0000
2 Bytes 2 Bytes
Basic verbose of CONF_VIDEO_INPUT_FORMAT_EX (p_octet)
Length - 4 Bytes
8 24
Id
Auto Mode 0 special id to signal availability of auto mode
Available
ID 1 - 255 All available ids can be set via
CONF_VIDEO_INPUT_FORMAT_EX defines (Video Format
Id Byte [2])
Flags
Mask Name Description
Bit 7 0x80 Electronic image stabilitiation Defines if Electronic image stabilitiation is
Support supported
Bit 6 0x40 Reboot required Defines if change to this mode requires reboot
Bit 5 0x20 HDR-X Mode Defines if mode is a HDR-X mode
Bit 4 0x10 CustomRotationSupport Defines if custom rotation is supported
(rotation low and heigh byte in
CONF_VIDEO_INPUT_FORMAT_EX)
Bit 0 0x01 Cropped If the crop is set, the view will be changed when
switching between different resolutions takes place.
Combined Values
Mask Name Description
0x0E nr of HDR exposure nr of HDR exposure-1 0-> 1 exposure,1-> 2
exposure ...
Rotation Options
Mask Name
Bit 7 0x80 rotate 270° mirror
Bit 6 0x40 rotate 270° no mirror
Bit 5 0x20 rotate 180° mirror
Bit 4 0x10 rotate 180° no mirror
Bit 3 0x08 rotate 90° mirror
Bit 2 0x04 rotate 90° no mirror
Bit 1 0x02 rotate 0° mirror
Bit 0 0x01 rotate 0° no mirror
Width
Maximum available picture width for encoding
Height
Maximum available picture height for encoding
Framerate In mHz
Maximum available framerate for encoding
Example
Rotation Options = 0x44
-> bit 2 and bit 6 are available (of bit 0...7)
-> rotate 90° no mirror = 2 and rotate 270° no mirror = 6 are
supported
2.734 CONF_VIDEO_LINE_DEWARPING_MODE
[API: video input]
2.735
CONF_VIDEO_LINE_DEWARPING_MODE_CAPS
[API: video input]
Values:
no dewarping 0
virtual PTZ 1
quad view 2
panoramic 3
double panoramic 4
corridor 5
full panoramic 6
2.736 CONF_VIDEO_LINE_DUO
[API: video input]
Values:
off 0
on 1
2.737 CONF_VIDEO_OUT_CROPPING
[API: decoder/videoout]
2.738 CONF_VIDEO_OUT_MONITOR_SPEC
[API: decoder/videoout]
Payload Structure
16 32
width_mm height_mm
2 Bytes 2 Bytes
native_width native_height
2 Bytes 2 Bytes
hSyncMin
4 Bytes
hSyncMax
4 Bytes
vSyncMin
4 Bytes
vSyncMax
4 Bytes
dotClockMax
4 Bytes
Reserved Sync Flags compSync sepSync
20 Bits 4 Bits 4 Bits 4 Bits
Reserved...
32 Bytes
Reserved
[...]
Reserved
...
8 24
width_mm
Physical width of the actual display region in mm
height_mm
Physical height of the actual display region in mm
native_width
(maximum) width of the active display in pixel
native_height
(maximum) height of the active display in pixel
hSyncMin
Lowest supported scan line (hsync) frequency in Hz
hSyncMax
Highest supported scan line (hsync) frequency in Hz
vSyncMin
Lowest supported vertical refresh frequency in mHz
vSyncMax
Highest supported vertical refresh frequency in mHz
dotClockMax
Upper limit on the pixel clock
Sync Flags
Mask Name Description
Bit 0 0x1 SyncOnGreen 1: Supported, 0: Not supported
compSync
Supported composite sync signals:
sepSync
Supported separate sync signals:
Note: In addition to the specified limits, default modes corresponding to the respective physical
connector (e.g. standard VGA timing on a VGA connector, PAL/NTSC on BNC) are typically also
assumed to be supported by the display device. The device will only allow video output timings (see
CONF_VIDEO_OUT_CURRENT_SPEC, CONF_VIDEO_OUT_STANDARD) within these limits and
may use the mentioned default timings as fallback values.
2.739 CONF_VIDEO_OUT_STANDARD
[API: decoder/videoout]
2.740 CONF_VIDEO_OUT_STANDARD_FORCE
[API: decoder/videoout]
2.741 CONF_VIDEO_OUT_STANDARD_OPTIONS
[API: decoder/videoout]
Description
Allows to query information about the ids and the allowed ids configurable via
CONF_VIDEO_OUT_STANDARD. Only read is supported.
Payload Structure
Entry [0]
(see description)
...
Entry [N]
(see description)
Entry
16 32
Id
4 Bytes
width
4 Bytes
height
4 Bytes
flags
4 Bytes
reserved...
16 Bytes
reserved
...
reserved
...
reserved
...
8 24
Id
Values:
AUTO 0
PAL 1
NTSC 2
VGA modes 3 - 10
720p50 11
720p60 12
1080i50 13
1080i60 14
1080p25 15
1080p30 16
OFF 255
flags
Off 0
auto/default 1
2.742
CONF_VIDEO_OUT_STANDARD_VIDEO_INPUT_SRC
[API: decoder/videoout]
2.743 CONF_VIDEO_OVER_SSL
[API: security]
Values:
disabled 0
enabled 1
2.744 CONF_VIDEO_QUALITY
[API: encoder]
Values:
auto 0
worst to best 1 - 100
2.745 CONF_VIDEO_RECOVERY
[API: recording settings]
Description
This command is used to recover video data from VDP packets on a damaged span and convert it to an MP4
file. During recovery, all data but the VDP packets are ignored. Client ID, session ID, and numeric descriptor
ID in the RCP header are not used. The payload contains all relevant information as a tag structure. This
command is only supported on Windows.
Payload Structure
Tag-Structure [0]
...
Tag-Structure [N]
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
Tag 1: Subject
Request or event for which this command is sent.
16 32
Length = 0x0022 Tag = 0x0001
2 Bytes 2 Bytes
Subject (t_word)
2 Bytes
8 24
Start 1 Sent in a request to start video recovery. The payload must contain the
'source' tag and can optionally contain the 'destination' tag. If no destination
tag is sent, a default filename is used. The response will contain the 'started'
subject and the 'thread ID' tag.
Started 2 Sent in a response to the 'start' subject to indicate that video recovery has
been started. The payload contains the 'thread ID' tag.
Progress 3 Sent in a message to indicate the progress of video recovery. The payload
contains the 'thread ID' and 'percentage' tags.
Finished 4 Sent in a message to indicate that video recovery has finished. The payload
also contains the 'thread ID' tag.
Stop 5 Sent in a request to stop a video recovery thread. The payload must contain
the 'thread ID' tag. The response will contain the 'stopped' subject and the
'thread ID' tag.
Stopped 6 Sent in a response to the 'stop' subject or in a message to indicate that the
video recovery thread has been stopped. The payload contains the 'thread
ID' tag.
Tag 2: Source
Source span from which video data is recovered. Sent with the 'start' subject.
16 32
Length = 0x000c Tag = 0x0002
2 Bytes 2 Bytes
Target ID (t_dword)
4 Bytes
Target index (t_octet) Lun index (t_octet) Span index (t_word)
1 Byte 1 Byte 2 Bytes
8 24
Target ID
IPv4 address of the target
Tag 3: Thread ID
Unique ID of the video recovery thread. Sent with the 'started', 'progress', 'finished', 'stop', and 'stopped'
subject.
16 32
Length = 0x0024 Tag = 0x0003
2 Bytes 2 Bytes
Thread ID (t_dword)
4 Bytes
8 24
Tag 4: Percentage
Percentage ratio of storage space on the span where VDP packets could potentially exist which has already
been analyzed. Sent with the 'progress' subject.
16 32
Length = 0x0021 Tag = 0x0004
2 Bytes 2 Bytes
Percentage (t_octet)
1 Byte
8 24
Tag 5: Destination
Destination filename to which video data is written. Can be sent with the 'start' subject.
16 32
Length Tag = 0x0005
2 Bytes 2 Bytes
Destination (p_string)
Length - 4 Bytes
8 24
2.746 CONF_VIDEO_STATIC_SCENE_REGIONS
[API: encoder]
Description
The actual payload of this command consist of a sequence of variable length records, each specifying a
region and a corresponding category to be used during encoding. The region is characterized by a mandatory
rectangle and optionally a shape. Up to 8 regions and in total up to 96 32-bit data for shapes are supported.
Depending on the firmware version the shape data may be ignored. In this case the rectangle is used instead.
This may also happen, if the restrictions indicated below are violated by the shape data.
Normally the "background" category is used for unimportant parts of the scene and the "object" category for
important ones. For this two categories, specific quality adjustments can be defined via the encoding profile
of every encoder. An area not belonging to any region is implicitly assigned to the "Default" category with no
specific adjustments. The forth category is currently assigned via the VIDEO_ENC_TEMP_QUANT_ADJ
command separately for each encoder.
Note, that by using overlapping regions, more than one category can be assigned to some areas of the scene.
In this case the category with the best quality adjustment for an encoder takes preceedence. Therefore it
may be usefull to assign the "Default" category explicitly to some regions.
Payload Structure
Region Specification [0]
(see description)
...
Region Specification
16 32
Shrink
Preset id Exclude Reserved Category N
1
1 Byte 1 Byte 5 Bits 2 Bits 1 Byte
Bit
Left Edge Right Edge
2 Bytes 2 Bytes
Upper Edge Lower Edge
2 Bytes 2 Bytes
Vertex [0]
(see description)
...
Vertex [
N
- 1]
(see description)
8 24
Preset id
Only valid for a Dome
Exclude
This bitmask indicates for which encoders this area shall NOT be used. The bits are allocated according to
the the relative coder number starting with the rightmost bit (LSB) for the relative coder number 1.
Mask Name
Bit 1 0x02 Coder 2
Bit 0 0x01 Coder 1
Category
By default the complete scene is assumed to belong to the 'default' category.
Default 0
Background 1
Objects 2
Reserved 3
Shrink
Depending on the encoding resolution, the quality may only be adjusted on quite a coarse grid. This bit
allows to specifiy whether the required rounding shall be performed by shrinking or enlarging the specified
region.
Enlarge as needed 0
Shrink as needed 1
N
This field indicates the number of 32-bit items defining the optional shape of this region and therefore also
specifies indirectly the total size of this record (12 + N * 4 octets). For compatibility with future version
of this RCP PLUS specification, clients SHOULD set this item to 0 for any region which they define or
modify, but keep it and the corresponding shape data unmodified for regions they don't change.
Vertex
32-bit item used for shape data. The item describes a vertex of a polygonal shape boundary in the order as
included in the record (the closing edge between vertex N and vertex 1 is added automatically). The vertices
should all be different and the edges between them should have no point in common beside the vertex
between them. (If the resulting area inside the polygon is not single connected the behaviour is undefined)
16 32
X Y
2 Bytes 2 Bytes
8 24
X
X Coordinate 0 - 32768
Y
Y Coordinate 0 - 32768
The rectangles and the future shapes are specified via a virtual coordinate system with a nominal range of
0..32768 x 0..32768 for the usable sensor area (or incoming video). All rectangles and shapes should be
completely inside this area, otherwise, the exact behaviour is undefined.
2.747 CONF_VIDEO_TERMINATION_RESISTOR_OFF
[API: video input]
Values:
enabled 1 75 Ohms on
disabled 0 75 Ohms off
2.748 CONF_VIDEO_TERMINATION_RESISTOR_ON
[API: video input]
Values:
enabled 1 75 Ohms on
disabled 0 75 Ohms off
2.749 CONF_VIN_BASE_FRAMERATE
[API: video input]
2.750 CONF_VIPROC_ALARM
[API: viproc]
Description
The message is sent whenever any of the bit values changes. Additionally it is sent once per 10 seconds
when any of the bits is set.
Payload Structure
20 40
Alarm Flags Detector ConfigId
2 Bytes 2 Bytes 1 Byte
10 30
Alarm Flags
Mask Name
Bit 15 0x8000 default task
Bit 14 0x4000 global change flag
Bit 13 0x2000 signal too bright flag
Bit 12 0x1000 signal too dark flag
Bit 11 0x0800 reserved
Bit 10 0x0400 image too blurry flag
Bit 9 0x0200 signal loss flag
Bit 8 0x0100 reference image check failed
flag
Bit 7 0x0080 invalid configuration flag
Bit 6 0x0040 flame detection flag
Bit 5 0x0020 smoke detection flag
Bit 4 0x0010 orientation change flag
Detector
State of the detectors. 0x0001 corresponds to detector one, 0x0002 to detector two and so on.
ConfigId
Identifcation number of the VCA profile caused this alarm.
2.751 CONF_VIPROC_ALARM_AGGREGATION_TIME
[API: viproc]
2.752
CONF_VIPROC_ALARM_EXT_AGGREGATION_TIME
[API: viproc]
2.753 CONF_VIPROC_ALARM_MASK
[API: viproc]
2.754
CONF_VIPROC_CONFIG_CHANGE_IN_RECORDING
[API: viproc]
2.755 CONF_VIPROC_CONFIG_NAME
[API: viproc]
2.756 CONF_VIPROC_CUSTOM_PARAMETERS
[API: viproc]
2.757 CONF_VIPROC_CUSTOM_PARAMETERS_TAGS
[API: viproc]
2.758 CONF_VIPROC_DEFAULT
[API: viproc]
Description
This commands deploys a dedicated config file to set VCA config. The list of available scenario defaults can
be retrieved with the command VIPROC_DEFAULT_LIST. In case of an error this command may return
with a command specific error code. For a list of the specific error code see below. The value associated
to scenario will be kept constant.
Payload Structure
4 8
Default Scenario
1 Byte
2 6
Default Scenario
Default 0
Intrusion (one field) 1
Intrusion (two fields) 2
People counting 3
Traffic incidents 4
Traffic wrong way 5
2.759 CONF_VIPROC_DEFAULT_LIST
[API: viproc]
2.760 CONF_VIPROC_DETECTOR_PARAMS
[API: viproc]
2.761 CONF_VIPROC_DLL_NAME
[API: viproc]
2.762 CONF_VIPROC_DLL_NAME_LIST
[API: viproc]
2.763 CONF_VIPROC_FIRE_PARAMETERS
[API: viproc]
2.764 CONF_VIPROC_GLOBAL_PARAMETERS
[API: viproc]
2.765 CONF_VIPROC_GLOBAL_PARAMETERS_TAGS
[API: viproc]
2.766 CONF_VIPROC_HOLIDAYS_SCHEDULE
[API: viproc]
Description
This command reads/writes the holidays VCA schedule of the specified line. The format of the payload is
the same as the one of the CONF_HD_RECORD_HOLIDAYS command.
Payload Structure
holiday schedule entry [0]
(see description)
...
16 32
day month year number of days
1 Byte 1 Byte 1 Byte 1 Byte
vca [0] vca [95]
...
4 Bits 4 Bits
8 24
day
Day of the month, which is a holiday
Values:
invalid 0
day of the month 1 - 31
month
Month of the year
Values:
invalid 0
january 1
february 2
march 3
april 4
may 5
june 6
july 7
august 8
september 9
october 10
november 11
december 12
year
Year since 2000
Values:
year 2000 to 2255 0 - 255
number of days
Number of days that follow the specified holiday, which are also scheduled as holidays. If only the specified
date is the holiday, this field should be set to 1.
Values:
invalid 0
number of days 1 - 255
vca
This is the vca schedule containing 96 entries of vca profile numbers for the holiday, each represents the
vca profile for a 15 min time period. First entry is from 00:00 to 00:15. The following entries are for the
following 15 min time periods until 24:00.
Values:
Silent VCA 0
vca profile numbers 1-2
2.767 CONF_VIPROC_ID
[API: viproc]
2.768 CONF_VIPROC_MODE
[API: viproc]
Values:
vca 0
manual 1 - 32
off 0xfd
scheduler 0xfe
script 0xff
2.769 CONF_VIPROC_MOTION_DEBOUNCE_TIME
[API: viproc]
2.770
CONF_VIPROC_OLD_AGGREGATION_TIME_USED
[API: viproc]
2.771 CONF_VIPROC_ONOFF
[API: viproc]
2.772 CONF_VIPROC_RE_TASK_NAMES
[API: viproc]
Description
This command reads out the task names of the current configured rule engine.
Read Payload Structure
16 32
Algorithm type Number of tasks
2 Bytes 2 Bytes
Task [0]
(see description)
...
Task [
Number of tasks
- 1]
(see description)
8 24
Algorithm type
IVA algorithm 1
IVA flow algorithm 2
Motion algorithm 4
Number of tasks
Number of configured user tasks.
Task
16 32
Id Type Name...
1 Byte 1 Byte 64 Bytes
Name
[...]
Name
...
Name
...
8 24
Id
Id of the user task. Defines the alarm bit of the CONF_VIPROC_ALARM message.
Type
Object in field 1
Line crossing 2
Loitering 3
ConditionChange 5
FollowingRoute 6
Tampering 7
RemovedObject 8
IdleObject 9
EnteringField 10
LeavingField 11
SimilaritySearch 13
CrowdDetection 14
Counter 15
BEV people counter 16
Line Counter 17
Occupancy 18
Man over Board 19
FlowInField 40
CounterFlowInField 41
MotionInField 42
Name
The task name is UTF8 encoded and maximal 64 byte. Zero termination is not mandatory.
2.773 CONF_VIPROC_REF_ORIENTATION
[API: viproc]
2.774
CONF_VIPROC_REFERENCE_IMAGE_FILENAME
[API: viproc]
2.775 CONF_VIPROC_SAVE_REFERENCE_IMAGE
[API: viproc]
2.776 CONF_VIPROC_SCENE
[API: viproc]
2.777 CONF_VIPROC_SENSITIVE_AREA
[API: viproc]
Description
This command reads/sets the sensitivity mask of the viproc algorithm. Please use the read functionality to
get the dimensions. All values are in pixel. If no viproc algorithm is running the command fails.
Payload Structure
16 32
Width Height
2 Bytes 2 Bytes
Cells X Cells Y Step X Step Y
1 Byte 1 Byte 1 Byte 1 Byte
Start X Start Y Bitmask...
1 Byte 1 Byte N Bytes
Bitmask
...
8 24
Width
Image width of the viproc algorithm.
Height
Image height of the viproc algorithm.
Cells X
Number of cells in X direction.
Cells Y
Number of cells in Y direction.
Step X
Number of cell size in X direction.
Step Y
Number of cell size in Y direction.
Start X
Offset of bit mask from left edge.
Start Y
Offset of bit mask from upper edge.
Bitmask
Bitstream which signals which cell is activated or not. Upper left cell is the first going to the left and then
down.
Example:
A 3x3 mask with cross activated:
oxo
xxo
oxo
has the following binary 0b010110010 or hexadecimal 0x590 structure. Alignment bits can be set to zero
but will be ignored.
2.778 CONF_VIPROC_SET_REF_ORIENTATION
[API: viproc]
2.779 CONF_VIPROC_STATUS
[API: viproc]
2.780 CONF_VIPROC_TAGGED_CONFIG
[API: viproc]
Description
This command is an extension of the already existing RCP+
commands CONF_VIPROC_DLL_NAME, CONF_VIPROC_ONOFF, CONF_VIPROC_SCENE,
CONF_VIPROC_CONFIG_NAME, CONF_VIPROC_CUSTOM_PARAMETERS,
CONF_VCD_OPERATOR_PARAMS, CONF_VIPROC_ALARM_MASK,
CONF_VIPROC_ALARM_AGGREGATION_TIME, and
CONF_VIPROC_MOTION_DEBOUNCE_TIME. Each of these commands can only access one specific
item of the currently active viproc configuration. The new command allows an atomic access to an arbitrary
subset of configuration items, not only of the currently active one but of any configuration of a line.
Num Descriptor Values
VideoLine Any The video line to which the configuration belongs
Payload Structure
16 32
Config ID
4 Bytes
Tag-Structure [0]
...
Tag-Structure [N]
0x00000000
4 Bytes
8 24
Config ID
An integer between 1 and the maximum number of configurations available for this line (this maximum
number can be retrieved by the command CONF_NUMBER_OF_VIPROC_CONFIGS).
Tag-Structure
Payload containing tagged values. Each tag structure consists of a length and a tag field defining the meaning
of the following data.
Length
Length of tagged value including length and tag field
Tag
Tag specifying the encoding and meaning of the value
2.781 CONF_VIPROC_TAGGED_CONFIG_INTERNAL
[API: viproc]
2.782 CONF_VIPROC_WEEKLY_SCHEDULE
[API: viproc]
Description
This command reads/writes the weekly VCA schedule of the specified line. The format of the payload is
the same as the one of the CONF_HD_RECORD_SCHEDULE command..
Payload Structure
Saturday Saturday
[0] ... [95]
4 Bits 4 Bits
Sunday
Sunday [0]
... [95]
4 Bits
4 Bits
Monday
Monday [0]
... [95]
4 Bits
4 Bits
Tuesday
Tuesday [0]
... [95]
4 Bits
4 Bits
Wednesday Wednesday
...
[0] [95]
4 Bits 4 Bits
Thursday Thursday
[0] ... [95]
4 Bits 4 Bits
Friday [0] Friday [95]
...
4 Bits 4 Bits
Saturday
96 entries of VCA profile numbers, each represents the recording profile for a 15 min time period. First
entry is from 00:00 to 00:15. The following entries are for the following 15 min time periods until 24:00.
Silent VCA 0
VCA profile number 1 - 2
Sunday
See 'Saturday' for details.
Monday
See 'Saturday' for details.
Tuesday
See 'Saturday' for details.
Wednesday
See 'Saturday' for details.
Thursday
See 'Saturday' for details.
Friday
See 'Saturday' for details.
2.783 CONF_VIRTUAL_ALARM_PARAMETER
[API: alarm]
Description
This command is used to trigger a virtual alarm along with parameters for alarm recording. The alarm
can be activated, deactivated or triggered as single shot, which is an activate and deactivate within on
command. Its also possible to trigger a silent alarm, by setting the activate and deactivate flag to zero.
This works like a single shot alarm, the user data will be recorded and backups between the recordings
will be scheduled, but the virtual alarm won't be triggered. If silent alarm is used, the num parameter
doesn't choose the virtual alarm number, but it is mapped directly to the recording line. The command can
have user data which can be recorded as meta data along to the video data. Also the pre and post alarm
time can be specified but is only valid, if the alarm recording is done via backuped recording setup and
the Flag ALARM_IGNORE_ALARM_TIME_PARAMETER isn't set. This will cause an alarm backup
from the recording (primary or secondary, depending on the virtual alarm configuration and encoder index
configuration) with this parameter, but the pre alarm time is limited by the max pre alarm time which is the
same as the configured prealarm time of the secondary recording on the internal storage. It is also limited
by the storage space of the internal storage. The max pre alarm time is also the delay for the recording. That
means the recording of the alarm file triggered by an alarm will be started after this delay expires. Until
that time the records of that file are only available on the internal storage. When a new alarm is triggered
by activate, the reply returns an alarm content handle (only on activation, not on single shot). The limit
for open content handle at the same time per line (includes also deactivated alarms or alarm shots within
the post alarm time) is 32. This handle can be used to deactivate the alarm later by sending this command
with the handle in the payload or it can be used to retrigger the alarm with new user data. For retrigger the
playload looks the same as for activate, except a valid handle is required. Only for deactivation or retrigger
of the alarm, the handle is required for in payload. A valid handle is a non zero handle, if the handle is set
to zero, it will be interpreted as wild card on deactivate, which will deactivate/close all active handles or as
invalid. In case of activate, a new handle will be opened and returned in the reply, if the handle is invalid/
zero. If a handle(or all handles) will be deactivated/closed, it will decay with the post alarm time. An alarm
can also used on first activation to add the "protected" attribute to the file, which includes the record data
of the alarm. The limit for pending intervals for protection are limited to 32 per line. Pending is an interval
in the time from the occurence of the protecting alarm and the backup of the alarm record data.
Payload Structure
16 32
flags reserved
1 Byte 3 Bytes
alarm content handle
4 Bytes
pre alarm time
4 Bytes
post alarm time
4 Bytes
user data len
4 Bytes
user data
user data len Bytes
8 24
flags
Mask Name Description
Bit 4 0x10 ALARM_USER_DATA_1X user data will be recorded only once
Bit 3 0x08 ALARM_IGNORE_ALARM_TIME_PARAMETER
the pre and post alarm time has no meaning,
parameter from the record profiles will be used
instead
Bit 2 0x04 ALARM_FILE_PROTECTIONprotects the file, which contains the alarm video data
(only on activate or shot)
Bit 1 0x02 ALARM_DEACTIVATE deactivate the alarm
Bit 0 0x01 ALARM_ACTIVATE activate the alarm
Combined Values
Mask Name Description
0x03 ALARM_SINGLE_SHOT activate and then deactivate the alarm
(ALARM_ACTIVATE | ALARM_DEACTIVATE)
user data
User data which will be recorded repeatedly, as long as the alarm is aktive or while within the post alarm
time of the alarm
2.784 CONF_VIRTUAL_ALARM_STATE
[API: alarm]
2.785 CONF_VIRTUAL_AUDIO_LINES
[API: audio]
Description
The command returns which audio input lines are virtual and which is the associated physical line. A
physical line is phyical audio input - that's the usual case. A virtual line is just a copy of a physical line
and supports only a subset of the RCP commands compared to a physical line. Some commands only make
sense on physical line (e.g. input volume). Those commands fail on virtual lines and must be applied on
the associated physcial line instead. The required information can be read out using this command. Virtual
lines are introduced to provide a copy to an existing physical line. A single physical audio input can be
associated to multiple video input lines. This keeps our known behaviour to have an audio line with the
same number as the video line.
Payload Structure
16 32
No. of Entries Length per entry
2 Bytes 2 Bytes
Entry [0]
(see description)
...
Entry [
No. of Entries
- 1]
(see description)
8 24
No. of Entries
The number of virtual line descriptions.
Entry
16 32
No. of virtual line No. of physical Line
2 Bytes 2 Bytes
8 24
2.786 CONF_VIRTUAL_LINES
[API: video input]
Description
The command returns which video input lines are virtual and which is the assiciated physical line. A physical
line has it's own video signal - that's the usual case. A virtual line is derived from a physical line and
supports only a subset of the RCP commands compared to a physical line. Some commands only make
sense on physical line (e.g. brightness, contrast, ...). Those fail on virtual lines and must be applied on the
associated physcial line instead. The required information can be read out using this command. Virtual
lines are introduced to provide a second view on an existing physical line. This is useful e.g. to have a
dewarped image on a 180 or 360 degree camera. Furthermore each virtual line has its own video analysis
meta data stream (a.k.a. "VCD stream") which is also derived from the image on the physical line but already
preprocessed (cropped, dewarped, ...) to fit the view on the virtual line.
Payload Structure
16 32
No. of Entries Length per entry
2 Bytes 2 Bytes
Entry [0]
(see description)
...
Entry [
No. of Entries
- 1]
(see description)
8 24
No. of Entries
The number of virtual line descriptions.
Entry
16 32
No. of virtual line No. of physical Line
2 Bytes 2 Bytes
8 24
2.787 CONF_VRM_RTSP_AUTHENTICATE
[API: rtsp settings]
2.788 CONF_WATERMARK
[API: security]
2.789 CONF_WIFI_CONFIG_TOKEN
[API: security]
2.790 CONF_WLAN_DEFAULT_CHANNEL
[API: wlan]
2.791 CONF_WLAN_IOCTRL
[API: wlan]
2.792 CONF_WLAN_LINK_QUALITY
[API: wlan]
2.793 CONF_WLAN_LINK_TEST
[API: wlan]
2.794 CONF_WLAN_OPERATING_MODE
[API: wlan]
Values:
Off 0
Auto 1 Station only
Access point 2
2.795 CONF_WLAN_REGION_CODE
[API: wlan]
Values:
USA 16
Canada 32
EU 48
Spain 49
France 50
Japan 64
Japan 65
2.796 CONF_WLAN_SCAN
[API: wlan]
Payload Structure
Number of Entries
4 Bytes
Entry [0]
(see description)
...
Entry [
Number of Entries
- 1]
(see description)
Number of Entries
Number of scan entries
Entry
16 32
SSID...
32 Bytes
SSID
[...]
SSID
...
MAC Address...
6 Bytes
SSID
Name of network.
MAC Address
MAC address of AccessPoint
Strength
Signal strength in range [0;5]
Channel
Channel used by AccessPoint [0;14]
Flags
Mask Name Description
Bit 3 0x00000008 WPS encryption Is set when WPS encryption is supported.
Bit 2 0x00000004 WPA2 encryption Is set when WPA2 encryption is supported.
Bit 1 0x00000002 WPA encryption Is set when WPA encryption is supported.
Bit 0 0x00000001 WEP encryption Is set when WEP encryption is supported.
2.797 CONF_WLAN_SSID
[API: wlan]
2.798 CONF_WLAN_WPA_PSK
[API: wlan]
2.799 CONF_WLAN_WPS_SETUP
[API: wlan]
2.800 CONF_WLAN_WPS_STATUS
[API: wlan]
Payload Structure
Status
1 Byte
Status
Mask Name
Combined Values
Mask Name
0xF0 Status
Not 0
started
Ongoing 1
Successful2
Rejected 3
by the
access
point
Timeout 4
Invalid 5
PIN
0x0F Mode
None 0
PBC 1
PIN 2
2.801 CONF_WPS_BUTTON_ENABLED
[API: wlan]
Values:
enabled 1
disabled. 0
2.802 CONF_WRITE_XML_TO_VCD
[API: viproc]
3 Appendix
Sample application in C..........................................................................................................1256
Sample code for connecting to a VideoJet using the UDP protocol.......................................1278
Sample code for connecting to a VideoJet using the TCP protocol....................................... 1295
Sample code for connecting to VideoJet’s internal HDD and start replay.............................. 1313
Starting a replay service on the VCS VideoJet using the VCS MPEG-Active-X.....................1340
Specific error codes................................................................................................................ 1349
Bicom Command Access Levels............................................................................................ 1351
/*
RCPSample.c
*/
#include <stdio.h>
#include <winsock.h>
//a second VJ with video decoder for testing interconnect via the RCP
'connect to' command
#define DECODER_IP 0x0a000002 //is "10.0.0.2"
//some datatypes
typedef unsigned long DWORD;
typedef unsigned short WORD;
typedef unsigned char OCTET;
OCTET PwdEncryption;
OCTET PwdLen;
WORD NbrOfMessages;
//followed by
//WORD Messages[n];
//OCTET Password[nn];
};
DWORD PutChannels;
DWORD GetChannels;
};
//init winsock
wVersionRequested = MAKEWORD( 2, 2 );
printf("===========================================\n");
printf("\n\nTry to register...\n");
Sleep(2000);
ClientID = Register(Socket);
Sleep(3000);
printf("===========================================\n");
printf("\n\nTry to read out the software version...\n");
Sleep(2000);
SoftwareVersion = GetSoftwareVersion(Socket, ClientID);
printf("Software version %08x\n", SoftwareVersion);
Sleep(3000);
printf("===========================================\n");
printf("\n\nNow try to connect to a second VJ...\n");
Sleep(2000);
SessionID = ConnectTo(Socket, ClientID, DECODER_IP);
printf("connected with SessionID %08x\n",SessionID);
Sleep(5000);
printf("===========================================\n");
printf("\n\nEnough for today; close connection...\n");
Sleep(2000);
Disconnect(Socket, ClientID, SessionID);
Sleep(3000);
printf("===========================================\n");
printf("\n\nNow waiting for messages...\n");
}
}
}
//
reply inside a buffer
WORD NbrOfMessages, n; //
counts the number of messages in the
//
regitration command
WORD Messages[]={0xFFC3, 0x01C0}; //
the messages to be registerd
OCTET *Payload , *pw; //
pointer to access the payload section
WORD PayloadLen, wTPKTsize; //
length descriptors
char RX_Buf[2048]; //
buffer for data from socket
WORD ClientID; //
assigned client IP; to be taken
//
from the reply
//registration
prcp_reg_hdr->PwdEncryption = 0x00;
//Plain text password encrytion
prcp_reg_hdr->PwdLen = LOGIN_STRING_LENGTH;
//Length of password
NbrOfMessages = sizeof(Messages) /
sizeof(WORD);
prcp_reg_hdr->NbrOfMessages = htons( NbrOfMessages);
//Nbr of messages that follow
pw += sizeof(struct h_RCP_ClientRegister);
printf("Register reply:\n");
printf("Result: %02x\n",rcp_reg_reply_hdr->Result);
printf("Level: %02x\n",rcp_reg_reply_hdr->Level);
printf("ClientID %04x\n",ClientID);
}
else
{
printf("Register failed\n");
}
return ClientID;
version = ntohl(*pDWORD);
}
else
{
printf("failed to read software version\n");
}
return version;
}
rcp_hdr.method = 0x00;
//REQUEST
rcp_hdr.reserved = 0;
rcp_hdr.client_id = htons( ClientID);
//use clientID from register reply
rcp_hdr.session_id = htonl( 0x00000000);
//currently no SessionID available
rcp_hdr.num = htons( 0x0000);
//no num parameter needed
rcp_hdr.len = htons( sizeof(rcp_con_hdr));
//length of the payload section
printf("connect to reply:\n");
printf("Dest IP: %08x\n",ntohl(rcp_con_reply_hdr-
>Dest_IP));
printf("PutChannels %08x\n",ntohl(rcp_con_reply_hdr-
>PutChannels));
printf("GetChannels %08x (Note VJ1000 V1.0 may return invaild
data here)\n",ntohl(rcp_con_reply_hdr->GetChannels));
sessionID = ntohl(prcp_hdr->session_id);
}
else
{
printf("Connect to failed\n");
}
return sessionID;
}
printf("Disconnect reply:\n");
printf("Status %02x\n",rcp_discon_reply_hdr->status);
printf("Remote Host %08x\n",ntohl(rcp_discon_reply_hdr-
>remote_host));
}
else
{
printf("Disconnect failed\n");
}
return 0;
}
int SendPacket (
SOCKET Socket,
OCTET *TPKT_hdr, int TPKT_hdr_len,
OCTET *RCP_hdr, int RCP_hdr_len,
OCTET *Payload, int Payload_len
)
{
int err=0;
printf("\n");
printf("\n");
printf("\n");
{
//just check; do not empty TCP buffer
len = recv(Socket, RX_Buf, sizeof(struct TPKT_header),
MSG_PEEK);
} while(len != sizeof(struct TPKT_header));
//all bytes arrived - empty TCP buffer
recv(Socket, RX_Buf, sizeof(struct TPKT_header), 0);
do
{
//just check; do not empty TCP buffer
len = recv(Socket, RX_Buf, wait_bytes, MSG_PEEK);
} while(len != wait_bytes);
//all bytes arrived - empty TCP buffer
recv(Socket, RX_Buf, wait_bytes, 0);
return wait_bytes;
}
int i;
for (i=0;i<l;i++)
{
if(!(i%16) && i) printf("\n");
printf("%02x ",p[i]);
}
printf("\n");
}
/*
===========================================
Try to register...
Register reply:
Result: 01
Level: 02
connect to reply:
Dest IP: 0a000002
PutChannels 00000001
GetChannels 00000000 (Note VJ1000 V1.0 may return invaild data here)
connected with SessionID c8280026 <<-- Note: this may vary
===========================================
Disconnect reply:
Status 01
Remote Host 0a000002
===========================================
*/
/*
RCPConnect_UDP.c
*/
#include <stdio.h>
#include <winsock.h>
//some datatypes
typedef unsigned long DWORD;
typedef unsigned short WORD;
typedef unsigned char OCTET;
DWORD session_id;
WORD num;
WORD len;
};
OCTET PwdEncryption;
OCTET PwdLen;
WORD NbrOfMessages;
//followed by
//WORD Messages[n];
//OCTET Password[nn];
};
struct media_desc_video
{
OCTET media_encapsulation;
OCTET flags;
WORD media_port;
DWORD media_host;
OCTET coder;
OCTET line;
WORD media_ctrl_port;
DWORD media_ctrl_host;
WORD coding;
WORD resolution;
WORD reserved6;
WORD bandwidth;
};
//init winsock
wVersionRequested = MAKEWORD( 2, 2 );
if ( WSAStartup( wVersionRequested, &wsaData ) != 0 )
{
printf("Error starting winsock\n");
exit(0);
}
printf("===========================================\n");
printf("\n\nTry to register...\n");
Sleep(2000);
ClientID = Register(Socket);
Sleep(3000);
printf("===========================================\n");
printf("\n\nOpen UDP socket for receiving video data...\n");
{
exit(0);
}
while(1)
{
cnt++;
Sleep(1);
}
}
//registration
prcp_reg_hdr->PwdEncryption = 0x00;
//Plain text password encrytion
prcp_reg_hdr->PwdLen = LOGIN_STRING_LENGTH;
//Length of password
rcp_hdr.method = 0x00;
//REQUEST
rcp_hdr.reserved = 0;
rcp_hdr.client_id = htons( 0x0000);
//currently no ClientID available
rcp_hdr.session_id = htonl( 0x00000000);
//currently no SessionID available
rcp_hdr.num = htons( 0x0000);
//no num parameter needed
rcp_hdr.len = htons( PayloadLen);
//length of the payload section
printf("Register reply:\n");
printf("Result: %02x\n",rcp_reg_reply_hdr->Result);
printf("Level: %02x\n",rcp_reg_reply_hdr->Level);
printf("ClientID %04x\n",ClientID);
}
else
{
printf("Register failed\n");
}
return ClientID;
DWORD sessionID=0;
po = TX_Buf;
sessionID = ntohl(prcp_hdr->session_id);
}
else
{
printf("Connect to failed\n");
}
return sessionID;
}
return 0;
}
int SendPacket (
SOCKET Socket,
OCTET *TPKT_hdr, int TPKT_hdr_len,
OCTET *RCP_hdr, int RCP_hdr_len,
OCTET *Payload, int Payload_len
)
{
int err=0;
printf("\n");
printf("\n");
if(len == SOCKET_ERROR)
{
//nothing to do
return -1;
}
return -1;
}
do
{
//just check; do not empty TCP buffer
len = recv(Socket, RX_Buf, wait_bytes, MSG_PEEK);
} while(len != wait_bytes);
//all bytes arrived - empty TCP buffer
recv(Socket, RX_Buf, wait_bytes, 0);
return wait_bytes;
}
int i;
for (i=0;i<l;i++)
{
if(!(i%16) && i) printf("\n");
printf("%02x ",p[i]);
}
printf("\n");
}
/*
RCPConnect_TCP80.c
*/
#include <stdio.h>
#include <winsock.h>
//some datatypes
typedef unsigned long DWORD;
typedef unsigned short WORD;
typedef unsigned char OCTET;
WORD num;
WORD len;
};
OCTET PwdEncryption;
OCTET PwdLen;
WORD NbrOfMessages;
//followed by
//WORD Messages[n];
//OCTET Password[nn];
};
struct media_desc_video
{
OCTET media_encapsulation;
OCTET flags;
WORD media_port;
DWORD media_host;
OCTET coder;
OCTET line;
WORD media_ctrl_port;
DWORD media_ctrl_host;
WORD coding;
WORD resolution;
WORD reserved6;
WORD bandwidth;
};
//init winsock
wVersionRequested = MAKEWORD( 2, 2 );
if ( WSAStartup( wVersionRequested, &wsaData ) != 0 )
{
printf("Error starting winsock\n");
exit(0);
}
//the connect of the the socket goes to the HTTP server on the
VideoJet
//advice the HTTP server to pass the socket internally to the RCP
server
printf("===========================================\n");
printf("\n\nTry to register...\n");
Sleep(2000);
ClientID = Register(Socket);
Sleep(3000);
printf("===========================================\n");
printf("\n\nSend connect primitive...\n");
{
exit(0);
}
printf("===========================================\n");
printf("\n\nOpen TCP socket for receiving video data...\n");
//the connect of the the socket goes to the HTTP server on the
VideoJet
//advice the HTTP server to pass the socket internally to the RCP
server
//signal that this is a video receive socket to the corresponding
session ID
if ((int)strlen(PassVideoDataSocketToRCP) != send(VideoDataSocket,
PassVideoDataSocketToRCP, strlen(PassVideoDataSocketToRCP), 0))
{
exit(0);
}
while(1)
{
cnt++;
Sleep(1);
}
}
prcp_reg_hdr->Reserved = 0;
prcp_reg_hdr->ClientID = htons( 0x0000);
//no ClientID in normal
//registration
prcp_reg_hdr->PwdEncryption = 0x00;
//Plain text password encrytion
prcp_reg_hdr->PwdLen = LOGIN_STRING_LENGTH;
//Length of password
printf("Register reply:\n");
printf("Result: %02x\n",rcp_reg_reply_hdr->Result);
printf("Level: %02x\n",rcp_reg_reply_hdr->Level);
printf("ClientID %04x\n",ClientID);
}
else
{
printf("Register failed\n");
}
return ClientID;
DWORD sessionID=0;
po = TX_Buf;
h_req->reverse_login = FALSE;
po += sizeof(struct con_prim_header);
sessionID = ntohl(prcp_hdr->session_id);
}
else
{
printf("Connect to failed\n");
}
return sessionID;
}
//inside
an RX buffer
//Next task; read out the software version number
//fill out the RCP header
rcp_hdr.command = htons( 0xFFC2); //Command
'Retrigger'
rcp_hdr.datatype = 0x08; //Datatype
T_DWORD
rcp_hdr.rd_wr = 0x0; //READ
rcp_hdr.version = 0x3; //Version
3
rcp_hdr.method = 0x00; //REQUEST
rcp_hdr.reserved = 0;
rcp_hdr.client_id = htons( ClientID); //use
clientID from register reply
rcp_hdr.session_id = htonl( SessionID);
rcp_hdr.num = htons( 0x0000); //no num
parameter needed
rcp_hdr.len = 0; //no
payload in READ command
return 0;
}
int SendPacket (
SOCKET Socket,
OCTET *TPKT_hdr, int TPKT_hdr_len,
printf("\n");
printf("\n");
if(len == SOCKET_ERROR)
{
//nothing to do
return -1;
}
if(doprint)
{
printf("rcv TPKT hdr:\n"); view_hex(RX_Buf, len);
}
do
{
//just check; do not empty TCP buffer
if(doprint)
{
printf("rcv Payload:\n"); view_hex(RX_Buf, len);
printf("\n");
}
return wait_bytes;
}
int i;
for (i=0;i<l;i++)
{
if(!(i%16) && i) printf("\n");
printf("%02x ",p[i]);
}
printf("\n");
}
/*
RCPConnect_UDP.c
*/
#include <stdio.h>
#include <winsock.h>
//some datatypes
typedef unsigned long DWORD;
typedef unsigned short WORD;
typedef unsigned char OCTET;
OCTET reserved;
WORD client_id;
DWORD session_id;
WORD num;
WORD len;
};
OCTET PwdEncryption;
OCTET PwdLen;
WORD NbrOfMessages;
//followed by
//WORD Messages[n];
//OCTET Password[nn];
};
struct media_desc_video
{
OCTET media_encapsulation;
OCTET flags;
WORD media_port;
DWORD media_host;
OCTET coder;
OCTET line;
WORD media_ctrl_port;
DWORD media_ctrl_host;
WORD coding;
WORD resolution;
WORD reserved6;
WORD bandwidth;
};
struct HdPartitionFileInfo
{
SEC_SINCE_2000 secBeg;
SEC_SINCE_2000 secEnd;
DWORD flags;
DWORD ID;
};
#define CONNECTED 0
#define WAIT_FOR_FILE_LIST 1
#define WAIT_FOR_STOPTIME_ACK 2
#define WAIT_FOR_STARTTIME_ACK 3
#define REPLAY_RUNNING 4
//init winsock
wVersionRequested = MAKEWORD( 2, 2 );
if ( WSAStartup( wVersionRequested, &wsaData ) != 0 )
{
printf("Error starting winsock\n");
exit(0);
}
else
{
exit(0);
}
printf("===========================================\n");
printf("\n\nTry to register...\n");
Sleep(2000);
ClientID = Register(Socket);
Sleep(3000);
printf("===========================================\n");
printf("\n\nOpen UDP socket for receiving video data...\n");
printf("===========================================\n");
printf("Send connect primitive\n");
SessionID = SendConnectPrimitive(Socket, ClientID, VIDEO_RX_PORT);
replay_state = CONNECTED;
while(1)
{
cnt++;
switch(replay_state)
{
case CONNECTED:
//first of all, request the current file list from the
VideoJet
printf("===========================================\n");
printf("Request file list\n");
RequestFileList(Socket, ClientID);
replay_state = WAIT_FOR_FILE_LIST;
break;
case WAIT_FOR_FILE_LIST:
//when a packet arrives,...
len = GetPacket(Socket, RX_Buf, sizeof(RX_Buf));
if(len > 0)
{
//check wheather this is the reply to the file list
command,...
if (WaitForResponse(0x0901, RX_Buf, len))
{
//if so, extrace the first entry,...
if ( (p = ReadFileList(RX_Buf, len)) )
{
//and request setting the stop time for the next
replay.
printf("===========================================\n");
printf("Set the stop time for replay\n");
RequestReplayStoptime(Socket, ClientID,
SessionID, p->secEnd);
replay_state = WAIT_FOR_STOPTIME_ACK;
}
}
}
break;
case WAIT_FOR_STOPTIME_ACK:
//when a packet arrives,...
len = GetPacket(Socket, RX_Buf, sizeof(RX_Buf));
if(len > 0)
{
case WAIT_FOR_STARTTIME_ACK:
//when a packet arrives,...
len = GetPacket(Socket, RX_Buf, sizeof(RX_Buf));
if(len > 0)
{
//check wheather this is the reply to the start time
command,...
if (WaitForResponse(0x0905, RX_Buf, len))
{
//if so, request starting the replay with 100% speed
printf("===========================================
\n");
printf("Start replay with 100%% speed\n");
replay_state = REPLAY_RUNNING;
}
}
break;
case REPLAY_RUNNING:
break;
}
Sleep(1);
}
}
//registration
prcp_reg_hdr->PwdEncryption = 0x00;
//Plain text password encrytion
prcp_reg_hdr->PwdLen = LOGIN_STRING_LENGTH;
//Length of password
printf("Register reply:\n");
printf("Result: %02x\n",rcp_reg_reply_hdr->Result);
printf("Level: %02x\n",rcp_reg_reply_hdr->Level);
printf("ClientID %04x\n",ClientID);
}
else
{
printf("Register failed\n");
}
return ClientID;
DWORD sessionID=0;
po = TX_Buf;
if ( -1 == SendPacket(Socket, (OCTET*)&tpkt_hdr,
sizeof(tpkt_hdr),
(OCTET*)&rcp_hdr,
sizeof(rcp_hdr),
TX_Buf, payload_len))
{
printf("Send packet error\n");
exit(0);
}
sessionID = ntohl(prcp_hdr->session_id);
}
else
{
printf("Connect to failed\n");
}
return sessionID;
}
return 0;
}
return 0;
DWORD entries;
//interpret the reply from the file list command, the list is a
array of type 'struct HdPartitionFileInfo'
//we do only read the first entry if there is one
if(entries > 0)
{
pfileinfo->secBeg = ntohl(pfileinfo->secBeg);
pfileinfo->secEnd = ntohl(pfileinfo->secEnd);
pfileinfo->flags = ntohl(pfileinfo->flags);
pfileinfo->ID = ntohl(pfileinfo->ID);
printf("===========================================\n");
printf("Select first entry from file list\n");
printf("Recording from %lu ... %lu\n",pfileinfo->secBeg,
pfileinfo->secEnd);
return pfileinfo;
}
else
{
printf("no recording available for replay\n");
exit(0);
}
return NULL;
}
return FALSE;
}
//send the stop time, the first dword carries the stop seconds from
the file list,
//the seconds dword is currently not used
Payload[0] = htonl(Stoptime);
Payload[1] = htonl(0);
rcp_hdr.reserved = 0;
rcp_hdr.client_id = htons( ClientID);
//use clientID from register reply
rcp_hdr.session_id = htonl( SessionID);
rcp_hdr.num = htons( 0x0000);
//no num parameter needed
rcp_hdr.len = htons( sizeof(Payload));
//length of the payload section
return 0;
}
//send the stop time, the first dword carries the start seconds
from the file list,
//the seconds dword is currently not used
Payload[0] = htonl(Starttime);
Payload[1] = htonl(0);
return 0;
}
return 0;
}
*p = ntohl(*p);
int SendPacket (
SOCKET Socket,
OCTET *TPKT_hdr, int TPKT_hdr_len,
OCTET *RCP_hdr, int RCP_hdr_len,
OCTET *Payload, int Payload_len
)
{
int err=0;
printf("\n");
printf("\n");
if(len == SOCKET_ERROR)
{
//nothing to do
return -1;
}
do
{
//just check; do not empty TCP buffer
len = recv(Socket, RX_Buf, wait_bytes, MSG_PEEK);
} while(len != wait_bytes);
//all bytes arrived - empty TCP buffer
recv(Socket, RX_Buf, wait_bytes, 0);
return wait_bytes;
}
int i;
for (i=0;i<l;i++)
{
if(!(i%16) && i) printf("\n");
printf("%02x ",p[i]);
}
printf("\n");
}
m_mpeg.EnableRCPEvents(short sEnable);
with sEnable = 1.
with strDestination being the IP address of the requested unit. Set sClient = 0 and strUserPass = NULL as
long as the referenced unit is not password-protected.
The response of the unit will be forwarded via the event method.
If the registration succeeded, sState will be set to 4 and sClient specifies the client ID provided by the remote
unit. This client ID has to be used subsequently in all RCP+ commands.
Connect the VCS MPEG Active-X with the internal HDD of the VideoJet
with
• type = 0x80FF to accept both MPEG2 and MPEG4 recordings
• bandwith has be unequal to 0, but is otherwise not evaluated
The state of the video connection will be forwarded via event method
If the connection succeeded, sState will be set to 2 and ssession specifies the session ID provided by the
remote unit. This session ID has to be used subsequently in all RCP+ commands referencing this connection.
In the callback reply from the command, a session ID, assigned by the VideoJet will be retrieved. Using
this session ID, all replay related commands will affect this connection to the HDD of the VideoJet.
To retrieve the current available recordings on the VideoJet, a list can be loaded from the HDD.
The RCP command is HD_PARTITION_FILE_INFO (0x0901):
m_mpeg.SendRCP(VARIANT rcp);
with rcp being a VARIANT representation of the RCP command. From the above byte array the VARIANT
can be built as follows:
VARIANT* pVar = 0;
SAFEARRAY FAR* psa;
SAFEARRAYBOUND rgsabound[1];
rgsabound[0].lLbound = 0;
Any RCP responses from the unit will be forwarded via event method
ReceivedRCP(VARIANT rcp)
with rcp being a VARIANT representation of the received response. The contained byte array can be
extracted as follows:
long i;
SAFEARRAY FAR* psa = NULL;
BYTE * pbytes;
HRESULT hr;
LONG cElements, lLBound, lUBound;
VARIANT* pVariant;
{
psa = RCP.parray;
if(psa == NULL)
return FALSE;
// Check dimensions of the array.
if (SafeArrayGetDim(psa) != 1)
return FALSE;
cElements = lUBound-lLBound+1;
SafeArrayUnaccessData(psa);
For the above command the VideoJet will return a list of all current recordings. The structure of this list
follows this data structure:
struct HdPartitionFileInfo
{
DWORD secBeg;
DWORD secEnd;
DWORD flags;
DWORD ID;
};
secBeg: Start of the recording (counted in seconds since the 1.1.2000 00:00)
secEnd: End of the recording (counted in seconds since the 1.1.2000 00:00)
flags:
Mask Name Description
Bit 29 0x20000000 FLAG_TIME_ZONE_SIGN The time zone sign of this file
Bit 21 0x00200000 FLAG_VIDEO_MUX when set, multiple cameras are recorded in this
file
Bit 7 0x00000080 FLAG_ALARM_RECORDING
0x00000080 when set, this is a
alarm recording
Bit 6 0x00000040 FLAG_TIME_RECORDING
0x00000040 when set, this is a
time recording
Bit 5 0x00000020 FLAG_VIDEO_LOSS
0x00000020 when set, a video
loss alarm has been asserted
since the beginning of this
recording
Bit 3 0x00000008 FLAG_ALARM_MOTION When set, a motion alarm has been asserted
since the beginning of this recording
Bit 2 0x00000004 FLAG_ALARM_INPUT When set, a input alarm has been asserted since
the beginning of this recording
Bit 1 0x00000002 FLAG_OVERWRITING When set, the recording of this file is currently
overwriting a previous recording
Bit 0 0x00000001 FLAG_RECORDING when set, the recording of this file is currently
running
Combined Values
Mask Name Description
0x1F800000 MASK_TIME_ZONE_QH the time zone offset in quarter hours of this file
struct TimeSet
{
DWORD sec;
DWORD unused;
};
cmd[0] = 0x09;
cmd[1] = 0x04;
cmd[2] = 0x0c;
cmd[3] = 0x13;
cmd[4] = 0x00;
cmd[5] = 0x00;
cmd[6] = (clientID & 0xFF00) >> 8;
cmd[7] = (clientID & 0x00FF);
cmd[8] = (sessiondID & 0xFF000000) >> 24;
cmd[9] = (sessiondID & 0x00FF0000) >> 16;
cmd[10] = (sessiondID & 0x0000FF00) >> 8;
cmd[11] = (sessiondID & 0x000000FF);
cmd[12] = 0x00;
cmd[13] = 0x00;
cmd[14] = 0x00;
cmd[15] = 0x08;
Transfer the command into a VARIANT and send it as described above. A corresponding response via
ReceivedRCP() should be waited for.
The send the start marker:
cmd[0] = 0x09;
cmd[1] = 0x05;
cmd[2] = 0x0c;
cmd[3] = 0x13;
cmd[4] = 0x00;
cmd[5] = 0x00;
cmd[6] = (clientID & 0xFF00) >> 8;
cmd[7] = (clientID & 0x00FF);
cmd[8] = (sessiondID & 0xFF000000) >> 24;
cmd[9] = (sessiondID & 0x00FF0000) >> 16;
cmd[10] = (sessiondID & 0x0000FF00) >> 8;
cmd[11] = (sessiondID & 0x000000FF);
cmd[12] = 0x00;
cmd[13] = 0x00;
cmd[14] = 0x00;
cmd[15] = 0x08;
Transfer the command into a VARIANT and send it as described above. A corresponding response via
ReceivedRCP() should be waited for.
Now the replay can be started by sending RCP command HD_REPLAY_START (0x0902). The integer
parameter specifies the speed of the replay. Normally 100% is live speed, slow motion is less than 100%
and fast forward is more than 100%. For backup purposes, the speed can be increased up to 99999. this
signals the VideoJet to send the recorded data as fast as possible. A value of 0% will pause the replay.
int Speed=100;
unsigned long sessionID;
unsigned short clientID;
unsigned char cmd[64];
cmd[0] = 0x09;
cmd[1] = 0x02;
cmd[2] = 0x04;
cmd[3] = 0x13;
cmd[4] = 0x00;
cmd[5] = 0x00;
cmd[6] = (clientID & 0xFF00) >> 8;
cmd[7] = (clientID & 0x00FF);
cmd[8] = (sessiondID & 0xFF000000) >> 24;
cmd[9] = (sessiondID & 0x00FF0000) >> 16;
cmd[10] = (sessiondID & 0x0000FF00) >> 8;
cmd[11] = (sessiondID & 0x000000FF);
cmd[12] = 0x00;
cmd[13] = 0x00;
cmd[14] = 0x00;
cmd[15] = 0x04;
Transfer the command into a VARIANT and send it as described above. A corresponding response via
ReceivedRCP() should be waited for.
To jump to a certain time, the HD_REPLAY_SEEK_TIME (0x0905) can also be used during a replay
service. In paused mode, the VideoJet will perform jumps to next frames or previous intra frames. The
command for this is HD_REPLAY_SEEK_IFRAME (0x0907). The integer parameter specifies the number
of frames to go. Positive values will lead to the next frames; negative values direct to previous intra frames.
Due to the limitation of compressed video data, backward skips will lead to intra frames only. The intra
frame distance is 5 seconds on VideoJet X00 and is scalable on VideoJet X000. To terminate a replay, the
RCP command HD_REPLAY_STOP (0x0903) may be send.
cmd[0] = 0x09;
cmd[1] = 0x03;
cmd[2] = 0x00;
cmd[3] = 0x31;
cmd[4] = 0x00;
cmd[5] = 0x00;
cmd[6] = (clientID & 0xFF00) >> 8;
cmd[7] = (clientID & 0x00FF);
cmd[8] = (sessiondID & 0xFF000000) >> 24;
cmd[9] = (sessiondID & 0x00FF0000) >> 16;
cmd[10] = (sessiondID & 0x0000FF00) >> 8;
cmd[11] = (sessiondID & 0x000000FF);
cmd[12] = 0x00;
cmd[13] = 0x00;
cmd[14] = 0x00;
cmd[15] = 0x01;
cmd[16] = 0x01;
Transfer the command into a VARIANT and send it as described above. A corresponding response via
ReceivedRCP() should be waited for. An alternative is to disconnect the connection by calling
m_mpeg.DisconnectVideo();
ISCSI errors
ISCSI_ERR_CONNECT 0x31
ISCSI_ERR_INV_LUN 0x33
ISCSI_ERR_LOGIN 0x34
ISCSI_ERR_INV_TARG_IDX 0x35
ISCSI_ERR_PWD 0x36
ISCSI_ERR_PROTO 0x37
ISCSI_ERR_TARG_NOT_REACH 0x38
ISCSI_ERR_NO_MEMORY 0x3a
ISCSI_ERR_SESS_CREATE 0x3b
ISCSI_ERR_INV_PARAMS 0x3c
ISCSI_ERR_SESS_NOT_FOUND 0x3d
ISCSI_ERR_DISCONN 0x3e
ISCSI_ERR_TIMEOUT 0x3f
ISCSI_ERR_TARGET_NOT_SUPP 0x40
ISCSI_ERR_TARGET_SESSION_LIMIT 0x41
ISCSI_ERR_CMD_NOT_SUPP 0x42
ISCSI_ERR_TARGET_NOT_FOUND 0x43
ISCSI_ERR_SOCK 0x5f
ISCSI_ERR_TARG_PM 0x6f
ISCSI_SOCK_CLOSED 0x7f
ISCSI_ERR_TCP_CONN_RESET 0x8f
ISCSI_ERR_INTR_NOT_SUPP 0x9f
ISCSI_ERR_IP_ZERO 0xa0
ISCSI_ERR_OUT_OF_RESOURCES 0xa1