IQinVision Network API Manual - API Manual Release Date: August 9, 2011 . ... ONVIF Support.....53 14.1. Supported ONVIF commands

  • View
    213

  • Download
    1

Embed Size (px)

Transcript

  • IQinVision Network API

    Manual

    Release Date: August 9, 2011

  • Page 2 of 60

    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. GSAUCE discovery protocol ........................................................................... 7

    2.2. IQdevice DLL .................................................................................................... 7

    3. Object Identifiers .......................................................................... 8 3.1. OID description .................................................................................................. 8 3.2. Reading OIDs ..................................................................................................... 8 3.3. Setting OIDs ....................................................................................................... 8 3.4. Efficiently setting multiple OID values ............................................................. 9 3.5. Commonly used OIDs ...................................................................................... 10

    3.5.1. Audio support ................................................................................................ 10 3.5.2. Crop window .................................................................................................. 10 3.5.3. Flash disk ....................................................................................................... 11 3.5.4. General camera .............................................................................................. 11 3.5.5. H.264 control ................................................................................................. 12 3.5.6. H.264 RTSP stream control ........................................................................... 13 3.5.7. Image control ................................................................................................. 14 3.5.8. Image gain control ......................................................................................... 15 3.5.9. Input/Output control ....................................................................................... 16 3.5.10. Motion windows .......................................................................................... 16 3.5.11. Overlay control ............................................................................................ 17 3.5.12. Virtual camera (VCAM) .............................................................................. 17

    3.6. OIDs supported by camera family ................................................................... 18 3.6.1. Audio support ................................................................................................ 18 3.6.2. Crop window .................................................................................................. 18 3.6.3. Flash disk ....................................................................................................... 18 3.6.4. General camera .............................................................................................. 19 3.6.5. H.264 control ................................................................................................. 20 3.6.6. H.264 RTSP stream control ........................................................................... 21 3.6.7. Image control ................................................................................................. 21 3.6.8. Image gain control ......................................................................................... 22 3.6.9. Input/Output control ....................................................................................... 23 3.6.10. Motion windows .......................................................................................... 23 3.6.11. Overlay control ............................................................................................ 24 3.6.12. Virtual camera (VCAM) .............................................................................. 24

  • Page 3 of 60

    4. Image Data Formats ................................................................... 25 4.1. Image data supported by camera family .......................................................... 25 4.2. URI modifiers supported by camera family ..................................................... 26

    5. Single JPEG Image ..................................................................... 27 5.1. Requesting a single JPEG image...................................................................... 27

    6. Serverpush Stream ...................................................................... 28 6.1. Serverpush stream format ................................................................................ 28 6.2. Requesting a serverpush stream ....................................................................... 28

    6.2.1. Serverpush modifiers ..................................................................................... 29 6.2.2. Image control modifiers ................................................................................. 29 6.2.3. Source/Destination resolution ........................................................................ 29

    6.3. Serverpush stream with embedded motion data ............................................... 30 6.4. Serverpush stream with embedded trigger data ............................................... 30 6.5. Motion only serverpush stream ........................................................................ 31 6.6. Serverpush stream with no image data ............................................................. 31

    7. PGM Image Data ........................................................................ 32 7.1. PGM grayscale data ......................................................................................... 32 7.2. PGM serverpush stream ................................................................................... 32

    8. Standalone Motion Data ............................................................. 33

    9. Bitmap Motion Map ................................................................... 34

    10. H.264 Streams .............................................................................. 35 10.1. Requesting H.264 image data ........................................................................ 35

    10.1.1. Unicast/Multicast UDP or TCP stream ........................................................ 35 10.1.2. Unicast TCP stream tunneled over HTTP .................................................... 36

    10.2. H.264 mode based operation .......................................................................... 37 10.2.1. IQ732/IQ832/IQD3xx/IQM3xx modes of operation ................................... 37 10.2.2. IQA3xx modes of operation ......................................................................... 38

    10.3. H.264 stream based operation ........................................................................ 40 10.4. H.264 request URI modifiers ......................................................................... 41 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. IQA1xx series cameras .................................................................................. 48 12.5. IQA2xx series cameras .................................................................................. 49 12.6. IQA3xx series cameras .................................................................................. 50 12.7. IQ73xx/83xx/D3xx/M3xx series cameras ...................................................... 51

  • Page 4 of 60

    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