Table of Contents
Advertisement
Advertisement
Table of Contents
Summary of Contents for Iqinvision IQ510
-
Page 1: Iqinvision Network Api Manual
IQinVision Network API Manual Release Date: August 9, 2011... -
Page 2: Table Of Contents
Table of Contents IQinVision Network API Manual ... 1 Notices ... 5 1. About This Manual ... 6 1.1. General ... 6 2. Discovery and Control ... 7 2.1. Discovering IQeye cameras ... 7 2.1.1. Zeroconf discovery protocol ... 7 2.1.2. - Page 3 10.5. H.264 stream with motion/time SEI data ... 42 11. Two-way Audio Support ... 44 11.1. Camera setup ... 44 11.2. Sending audio data ... 44 12. IQinVision Cameras ... 45 12.1. IQ04xx/D4xx/54xx series ... 45 12.2. IQeye51x series ... 46 12.3. IQeye70x/75x/8xx series cameras ... 47 12.4.
- Page 4 13. Host Based Interfacing ... 52 13.1. IQstream sample client software ... 52 13.2. ActiveX control ... 52 13.3. Win32 .Net interface ... 52 14. ONVIF Support ... 53 14.1. Supported ONVIF commands ... 53 15. PSIA Support... 54 15.1. Service requirements ... 54 15.2.
-
Page 5: Notices
Notices ©2011, IQinVision. All rights reserved. No part or contents of this manual may be transmitted or reproduced without written permission from IQinVision. The release date for this manual is August 9, 2011. Due to updates in the camera’s operating software, this manual will change periodically and may change without notice. -
Page 6: About This Manual
Control ("vSMAC") advanced programmatic interface. This allows a very feature-rich host based interface with IQeye cameras. For example, the Cameo tab which is available on all IQinVision Pro Line cameras (IQeye7xx/8xx/Axx) demonstrates the vSMAC functionality of VCAMS whereby the user is able to create multiple video streams each with independent frame rate, resolution and area of interest. -
Page 7: Discovery And Control
Future firmware releases for the Pro Line will also support Zeroconf so that there will be a consistent mechanism for finding all IQinVision cameras. In addition, IQinVision will be providing a Windows DLL and sample source code that performs both GSAUCE and Zeroconf queries and will return to the caller a list of cameras found. -
Page 8: Object Identifiers
3. Object Identifiers All configurable options on IQeye cameras can be controlled using Object Identifiers. (“OIDs”) 3.1. OID description OIDs are SNMP-like Object IDentifiers that allow host based applications and on-camera web pages to get and set values on the camera. An object is a single piece of information that can be displayed and possibly changed, i.e. -
Page 9: Efficiently Setting Multiple Oid Values
In order to change permanent parameters using the set.oid URL the request must be authenticated using either basic or secure authentication. Basic authentication can be specified by including the username and password as part of the URL. If the privileged password has not been changed use the URL: http://root:system@<camera_ip>/set.oid?OidTB2.4=”IQcam”... -
Page 10: Commonly Used Oids
Note: For a complete list of available OIDs, request the URL http://<camera_ip>/oidtable.html from any IQinVision camera. For more information on any of these OIDs see the IQinVision Reference Manual. 3.5.1. Audio support Name OID Value Audio input state 1.9.5... -
Page 11: Flash Disk
Writing this write only OID with the value “1” will reboot the camera. Read only OID returns the two character product family code. Read only OID returns the manufacturer name. Currently this value is IQinVision except for private labeled or OEM cameras. Page 11 of 60... -
Page 12: H.264 Control
3.5.5. H.264 control Name OID Value H.264 enable 1.17.7 Audio enable 1.17.1.1 Audio bitrate 1.17.1.2 Video enable 1.17.2.1 Video bitrate 1.17.2.2 Video deblocking 1.17.2.3 Video frame rate 1.17.2.4 Video iframe 1.17.2.5 Video Mode 1.17.2.6 Video style 1.17.2.7 Video preference 1.17.2.8 RTSP listener port 1.17.3.1 H.264 factory... -
Page 13: Rtsp Stream Control
3.5.6. H.264 RTSP stream control Selected H.264 cameras have the ability to associate image parameters with streams. The OIDs in this table are available for stream “n” where the number of streams is determined by the camera model. The value with index 0 is a comma separated list of the current settings for all available streams. -
Page 14: Image Control
3.5.7. Image control Name OID Value Gamma 1.2.1 Downsample 1.2.2 Sharpness 1.2.3 Image flip 1.2.4 JPEG Quality 1.2.7 Lighting Frequency 1.2.12.1 Saturation 1.2.21 Lightgrabber 1.2.30 Maximum frame 1.2.31 rate Reset image parameters to 1.2.14 factory defaults Description Image gamma setting. Default value depends on the camera model. Specifies the factor that will be used to reduce the size of an image when a default image is requested. -
Page 15: Image Gain Control
3.5.8. Image gain control Name OID Value Left edge main 1.2.8.1 Width main 1.2.8.2 Height main 1.2.8.3 Top edge main 1.2.8.8 Left edge 1.2.8.23.1.1.n Top edge 1.2.8.23.1.2.n Width 1.2.8.23.1.3.n Height 1.2.8.23.1.4.n Include 1.2.8.23.1.5.n Exclude 1.2.8.23.1.6.n Delete 1.2.8.23.1.7.n Autogain target 1.2.8.4 Gain hold value 1.2.8.5 Autogain state... -
Page 16: Input/Output Control
3.5.9. Input/Output control Name OID Value LED activity 1.2.17 LED2 activity 2.45 Input state 1.3.15 Simulate input 1.3.10 trigger Output relay state 1.3.5.1 Output relay 1.3.5.2 duration Simulate output 1.3.11 trigger Last trigger was 1.3.17 closed Activate output 17.4 relay 3.5.10. -
Page 17: Overlay Control
Reset to Factory 1.16.4 Default Window index list 1.16.5 The Virtual Camera (VCAM) functionality is available on specific IQinVision camera models. See Section 3.6.12, “Virtual Camera (VCAM) Support” for detailed information. Description Overlay <n> state. Overlay <n> text string Writing this write only OID with the value “1” will reset the overlay parameters to their factory default values. -
Page 18: Oids Supported By Camera Family
3.6. OIDs supported by camera family The following tables show which OIDs are supported by each camera family. 3.6.1. Audio support Name OID Value Audio input state 1.9.5 Audio input gain 1.9.1 Audio output state 1.9.6 Audio output gain 1.9.4 Audio duplex mode 1.9.7 Audio password... -
Page 19: General Camera
3.6.4. General camera Name OID Value Camera name Firmware version Uptime Ethernet address Product name Reboot camera 2.11 Camera ID code 2.21 Company Name 2.27 IQ04xx IQ70x IQD4xx IQ51x IQA1xx IQ75x IQ54xx IQ8xx <X> IQ73xx IQ83xx IQA2xx IQA3xx IQD3xx IQM3xx Page 19 of 60... -
Page 20: H.264 Control
3.6.5. H.264 control Name OID Value H.264 enable 1.17.7 Audio enable 1.17.1.1 Audio bitrate 1.17.1.2 Video enable 1.17.2.1 Video bitrate 1.17.2.2 Video deblocking 1.17.2.3 Video frame rate 1.17.2.4 Video iframe 1.17.2.5 Video Mode 1.17.2.6 Video style 1.17.2.7 Video preference 1.17.2.8 Motion SEI enable 1.17.2.15 RTSP listener port... -
Page 21: Rtsp Stream Control
3.6.6. H.264 RTSP stream control Name OID Value Available streams 1.17.2.18 Stream <n> codec 1.17.2.19.1.n Stream <n> resolution 1.17.2.19.2.n Stream <n> framerate 1.17.2.19.3.n Stream <n> video style 1.17.2.19.4.n Stream <n> bitrate 1.17.2.19.5.n Stream <n> profile 1.17.2.19.6.n Stream <n> width 1.17.2.19.7.n Stream <n>... -
Page 22: Image Gain Control
3.6.8. Image gain control Name OID Value Left edge main 1.2.8.1 Width main 1.2.8.2 Height main 1.2.8.3 Top edge main 1.2.8.8 Left edge 1.2.8.23.1.1.n Top edge 1.2.8.23.1.2.n Width 1.2.8.23.1.3.n Height 1.2.8.23.1.4.n Include 1.2.8.23.1.5.n Exclude 1.2.8.23.1.6.n Delete 1.2.8.23.1.7.n Autogain target 1.2.8.4 Gain hold value 1.2.8.5 Autogain state... -
Page 23: Input/Output Control
3.6.9. Input/Output control Name OID Value LED activity 1.2.17 LED2 activity 2.45 Input state 1.3.15 Simulate input trigger 1.3.10 Output relay state 1.3.5.1 Output relay duration 1.3.5.2 Simulate output trigger 1.3.11 Last trigger event time 1.3.20 Activate output relay 17.4 * The IQM3xx and IQD3xx families support OID 1.2.17. -
Page 24: Overlay Control
3.6.11. Overlay control Name OID Value Overlay state 1.2.9.1.8.index Overlay text 1.2.9.1.9.index Reset overlay to Factory 1.2.9.3 Default Save to NVR 1.2.9.4 3.6.12. Virtual camera (VCAM) Name OID Value Window Name 1.16.1.1.n Frame rate 1.16.1.2.n Left edge 1.16.1.3.n Top edge 1.16.1.4.n Width 1.16.1.5.n... -
Page 25: Image Data Formats
4. Image Data Formats IQinVision cameras can deliver image data in a number of different formats. The basic structure of these formats will be documented in this chapter. Please see the following chapters for specific information on how to request data. -
Page 26: Uri Modifiers Supported By Camera Family
4.2. URI modifiers supported by camera family The following table shows which URI modifiers are supported by each camera family. Modifier snap=spushn snap=spushn&pragma=motion snap=spushn&pragma=trigger snap=spushn&pramga=motion-only snap=spushn&pragma=motion &noimage * The IQ73xx/IQ83xx/IQD3xx/IQM3xx families only support “low” and “high” as parameters. IQ04xx IQ70x IQD4xx IQ51x IQA1xx... -
Page 27: Single Jpeg Image
5. Single JPEG Image All IQinVision cameras can deliver single JPEG images. The JPEG image format is defined by the Joint Photographic Experts Group and can be seen in ISO document 10918. IQinVision cameras include a default comment in the JPEG header to identify the camera which created the image. -
Page 28: Serverpush Stream
6. Serverpush Stream Server push is a method for sending updating data to a web page. The camera sends streaming images as server push streams of JPEG images separated by HTML tags using multipart MIME encoding. The camera will continue sending image data as fast as it is allowed until the HTTP connection is closed. 6.1. -
Page 29: Serverpush Modifiers
6.2.1. Serverpush modifiers The following table explains serverpush modifiers. Modifier X value Effect snap=X Spush Uses server push connection Spushn Uses server push, but updates it at most every n seconds (n can be a floating point) Spush with a value of 0 will send images as fast as the camera can acquire them. -
Page 30: Serverpush Stream With Embedded Motion Data
The camera can also do scaling to take a source image and “fit it into” a destination region. For example, to ask for a scaled-up version of a stream of 320 by 240 pixels, 10 pixels to the right and 20 pixels down from the upper left corner of the full image, use the URL: http://<camera_ip>/now.jpg?snap=spush&wl=10&wt=20&wrw=320&wrh=240&wdw=640 This will resample the image using bicubic interpolation and deliver it as a 640x480 stream... -
Page 31: Motion Only Serverpush Stream
6.5. Motion only serverpush stream The camera can deliver a stream of images only when motion is detected. Request this stream using the standard now.jpg?snap=spush URL and include the URI modifier ?motiononly. http://<camera_IP>/now.jpg?snap=spush&pragma=motiononly 6.6. Serverpush stream with no image data The camera can deliver a serverpush stream with motion data and no image frames. -
Page 32: Pgm Image Data
7. PGM Image Data The IQeye 7xx and 8xx series cameras will have the ability to provide eight-bit monochrome data extracted from the Y plane of YCbCr frames. 7.1. PGM grayscale data To request the monochrome (Y plane) data as a single frame use the URL: http://<camera_ip>/now.pgm?ds=<size>... -
Page 33: Standalone Motion Data
8. Standalone Motion Data To request motion data without using a standard serverpush stream you must first enable motion detection on the camera either using the camera web pages or via OIDs. You then request the URL: http://<camera_IP>/now.motiondata This will return a stream of data of the format: HTTP/1.0 200 OK Cache-Control: no-cache Content-Type: multipart/x-mixed-replace;... -
Page 34: Bitmap Motion Map
9. Bitmap Motion Map The IQeye7xx and IQeye8xx series cameras can provide a “motion map” that shows where in the source image motion has been detected. To request a stream of PGM motion detection images, use the URL: http://<camera_ip>/now.mmap?snap=spush This results in an HTTP stream that is very similar to a MJPEG serverpush stream, but the content type is x- portable-bitmap. -
Page 35: Streams
Full duplex audio is not supported. All other IQinVision H.264 camera models can be configured to operate in either mode or stream based operation. The following documentation will describe how to configure the H.264 encoders and how to request image data from these cameras. -
Page 36: Unicast Tcp Stream Tunneled Over Http
10.1.2. Unicast TCP stream tunneled over HTTP To request an H.264 stream via Unicast TCP tunneled over HTTP request a http connection using the URL: http://<camera_ip>/rtsp/now.mp4 Once the HTTP connection has been established the specific transport mechanism and H.264 request must then be negotiated using the protocol established in RFC 3984. -
Page 37: Mode Based Operation
10.2. H.264 mode based operation All current H.264 cameras support mode based operation. When using this style of interface an administrator can change the mode using the configuration web pages or an NVR platform can change the mode using OID values. -
Page 38: Iqa3Xx Modes Of Operation
10.2.2. IQA3xx modes of operation Mode Description IQA35 MJPEG, 5MP 4:3 (2592x1944), 5 fps boot mode Analog out, NTSC or PAL, full FOV mode0 IQA33N MJPEG, 3.6MP 16:9 (2560x1440), 8 fps boot mode Analog out, NTSC or PAL, full FOV mode0 IQA32N H.264 720p (1280x720), CBR or VBR... - Page 39 Mode Description H.264, 3.6MP, 16:9 (2560x1440), CBR or VBR mode13 MJPEG (720x480) H.264, 3MP , 4:3 (2048x1536), CBR or VBR mode14 MJPEG (640x480) H.264, 2MP, 4:3 (1600x1200), CBR or VBR MJPEG mode15 (640x480) H.264, 1MP, 4:3 (1280x960), CBR or VBR mode16 MJPEG (640x480) MJPEG (2592x1944)
-
Page 40: Stream Based Operation
10.3. H.264 stream based operation The IQA3xx camera family supports stream based configuration. Using streams does not require configuring a specific mode of operation. The OID values defined in Section 3.5.6, “H.264 RTSP stream control” can be used to configure the encoder, resolution and framerate parameters for camera streams. -
Page 41: Request Uri Modifiers
10.4. H.264 request URI modifiers The following modifiers can be used when requesting H.264 streams. Modifier X value mm=x res=x high 5MP or 2592x1944 3MPwide or 2560x1440 3MP or 2048x1536 1080p or 1920x1080 2MP or 1600x1200 1.2MP or 1280x960 720p or 1280x720 480p or 720x480... -
Page 42: Stream With Motion/Time Sei Data
Enhancement Information (SEI) messages. For additional information on SEI messages, refer to Annex D of ITU-T H.264. Note: IQinVision defined SEI messages are disabled by default and must be enabled by setting oid 1.17.2.15 to 1. The SEI’s are found in the first RTP packet of each frame and have the following format. - Page 43 A frame where motion had been detected in zones 1 and 3 will include the motion zone identifiers in the pragma text. nal_length = 0x<nnnn> (length depends on data) nal_code = 0x06 (SEI) sei_payload_type = 0x05 (User data) sei_payload_length = 0x3d uuid = 0x<nnnn>...
-
Page 44: Two-Way Audio Support
11. Two-way Audio Support Specific IQinVision cameras are capable of receiving digital audio data via an Ethernet TCP connection and playing it via the sound output device. The setup, data format and transport mechanism are documented in the following sections. -
Page 45: Iqinvision Cameras
12. IQinVision Cameras 12.1. IQ04xx/D4xx/54xx series All IQeye IQ04xx/D4xx /54xx Series cameras can have the following capabilities. Single JPEG image or serverpush Motion-JPEG image stream via HTTP Image cropping Motion detection with one built-in detection window ... -
Page 46: Iqeye51X Series
12.2. IQeye51x series All IQeye51x series cameras have the following capabilities. Single JPEG image or serverpush Motion-JPEG image stream via HTTP Simultaneous downsampled image streams On-camera motion detection IQfocus analog configuration IEEE 802.3af POE power ... -
Page 47: Iqeye70X/75X/8Xx Series Cameras
12.3. IQeye70x/75x/8xx series cameras All IQeye70x/75x/8xx series cameras have the following capabilities: Single JPEG image or serverpush Motion-JPEG image stream via HTTP Simultaneous independent image streams Image downsampling Destination resolution Virtual Camera (VCAM) windows On-camera motion detection ... -
Page 48: Iqa1Xx Series Cameras
12.4. IQA1xx series cameras All IQA1xx series Alliance cameras have the following capabilities: Single JPEG image or serverpush Motion-JPEG image stream via HTTP Simultaneous independent image streams Image downsampling Destination resolution Virtual Camera (VCAM) windows ... -
Page 49: Iqa2Xx Series Cameras
12.5. IQA2xx series cameras All IQA2xx series Alliance H.264 cameras have the following capabilities: Single JPEG image or serverpush Motion-JPEG image stream via HTTP H.264 based RTP/RTSP stream at VGA resolution Simultaneous independent image streams Image downsampling ... -
Page 50: Iqa3Xx Series Cameras
12.6. IQA3xx series cameras All IQA3xx series Alliance H.264 cameras have the following capabilities: Single JPEG image or serverpush Motion-JPEG image stream via HTTP H.264 based RTP/RTSP image data “Stream” or “Mode” based H.264 operation Stream based H.264 configuration ... -
Page 51: Iq73Xx/83Xx/D3Xx/M3Xx Series Cameras
12.7. IQ73xx/83xx/D3xx/M3xx series cameras All IQ73xx/83xx/D3xx/M3xx series H.264 enabled cameras have the following capabilities: Single JPEG image or serverpush Motion-JPEG image stream via HTTP H.264 based RTP/RTSP image data “Mode” based H.264 operation On-camera motion detection ... -
Page 52: Host Based Interfacing
13.2. ActiveX control IQinVision supplies an ActiveX component that can be used to interface to cameras in a Microsoft Visual Studio or web page environment. This component has been optimized to transport and display a JPEG serverpush stream very efficiently. In addition, the control provides a mechanism for reading and writing OID values. -
Page 53: Onvif Support
14. ONVIF Support The ONVIF open industry forum developed a global standard for the interface of IP-based physical security products. 14.1. Supported ONVIF commands The following table shows commands supported by selected IQinVision cameras. Number ONVIF Command List GetProfile GetProfiles... -
Page 54: Psia Support
/PSIA/Security/AAA /PSIA /Streaming /PSIA /PTZ /PSIA /Custom/MotionDetection /PSIA /Custom/Event Note: Not all IQinVision cameras support the PSIA Service Model. Please see each camera description to determine supported status. Notes Not all IP media devices support storage. Page 54 of 60... -
Page 55: Resource Requirements
15.2. Resource requirements The following resources are required for each implemented service. The check boxes denote “support required” PSIA commands. The green colored fields show the PSIA commands supported by IQinVision cameras. 15.2.1. /PSIA root service index indexr ... -
Page 56: Psia/System/Network
15.2.4. /PSIA/System/Network interfaces interfaces/<ID> interfaces/<ID>/ipAddress interfaces/<ID>/wireless interfaces/<ID>/ieee802.1x interfaces/<ID>/ipFilter interfaces/<ID>/ipFilter/filterAddresses interfaces/<ID>/ipFilter/filterAddresses/<ID> interfaces/<ID>/snmp interfaces/<ID>/snmp/v2c interfaces/<ID>/snmp/v2c/trapReceivers interfaces/<ID>/snmp/v2c/trapReceivers/<ID> interfaces/<ID>/snmp/advanced interfaces/<ID>/snmp/advanced/users interfaces/<ID>/snmp/advanced/users/<ID> interfaces/<ID>/snmp/advanced/notificationFilters interfaces/<ID>/snmp/advanced/notificationFilters/<ID> interfaces/<ID>/snmp/advanced/notificationReceivers interfaces/<ID>/snmp/advanced/notificationReceivers/<ID> interfaces/<ID>/snmp/v3 interfaces/<ID>/qos interfaces/<ID>/qos/cos interfaces/<ID>/qos/cos/<ID> interfaces/<ID>/qos/dscp interfaces/<ID>/qos/dscp/<ID> interfaces/<ID>/discovery interfaces/<ID>/syslog interfaces/<ID>/syslog/servers interfaces/<ID>/syslog/servers/<ID> 15.2.5. /PSIA/System/IO status inputs inputs/<ID> inputs/<ID>/status outputs outputs/<ID>... -
Page 57: Psia/System/Video
15.2.7. /PSIA/System/Video overlayImages overlayImages/<ID> inputs inputs/channels inputs/channels/<ID> inputs/channels/<ID>/focus inputs/channels/<ID>/iris inputs/channels/<ID>/lens inputs/channels/<ID>/overlays inputs/channels/<ID>/overlays/text inputs/channels/<ID>/overlays/text/<ID> inputs/channels/<ID>/overlays/image inputs/channels/<ID>/overlays/image/<ID> inputs/channels/<ID>/privacyMask inputs/channels/<ID>/privacyMask/regions inputs/channels/<ID>/privacyMask/regions/<ID> 15.2.8. /PSIA/System/Serial ports ports/<ID> ports/<ID>/command 15.2.9. /PSIA/Diagnostics commands commands/<ID> 15.2.10. /PSIA/Security srtpMasterKey deviceCertificate 15.2.11. /PSIA/Security/AAA users users/<ID> certificate adminAccesses adminAccesses/<ID>... -
Page 58: Psia/Streaming
15.2.12. /PSIA/Streaming status channels channels/<ID> channels/<ID>/status channels/<ID>/http channels/<ID>/picture channels/<ID>/requestKeyFrame 15.2.13. /PSIA/PTZ channels channels/<ID> channels/<ID>/homePosition channels/<ID>/continuous channels/<ID>/momentary channels/<ID>/relative channels/<ID>/absolute channels/<ID>/digital channels/<ID>/status channels/<ID>/presets channels/<ID>/presets/<ID> channels/<ID>/presets/<ID>/goto channels/<ID>/patrols channels/<ID>/patrols/status channels/<ID>/patrols/<ID> channels/<ID>/patrols/<ID>/start channels/<ID>/patrols/<ID>/stop channels/<ID>/patrols/<ID>/pause channels/<ID>/patrols/<ID>/status channels/<ID>/patrols/<ID>/schedule 15.2.14. /PSIA/Custom/MotionDetection <ID> <ID>/regions <ID>/regions/<ID> Command Command Command... -
Page 59: Psia/Custom/Event
15.2.15. /PSIA/Custom/Event trigger trigger/triggers trigger/triggers/<ID> trigger/triggers/<ID>/notifications trigger/triggers/<ID>/notifications/<ID> trigger/schedule notification notification/mailing notification/mailing/<ID> notification/ftp notification/ftp/<ID> notification/httpHost notification/httpHost/<ID> notification/alertStream Command POST ... -
Page 60: Technical Support
IQinVision web site, located at http://www.iqeye.com If you cannot find an answer to your problem by referencing either the Troubleshooting section of the IQeye Reference Manual or the support FAQs on the IQinVision web site, please contact an IQinVision representative for technical support.