ONVIF Core Specification
Total Page:16
File Type:pdf, Size:1020Kb
Open Network Video Interface Forum – 1 – ONVIF Core Spec. – Ver. 1.02 Open Network Video Interface Forum Core Specification Version 1.02 June, 2010 Open Network Video Interface Forum – 2 – ONVIF Core Spec. – Ver. 1.02 2008-2010 by ONVIF: Open Network Video Interface Forum. All rights reserved. Recipients of this document may copy, distribute, publish, or display this document so long as this copyright notice, license and disclaimer are retained with all copies of the document. No license is granted to modify this document. THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS DOCUMENT ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS. IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT, WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT. THE FOREGOING DISCLAIMER AND LIMITATION ON LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION. Open Network Video Interface Forum – 3 – ONVIF Core Spec. – Ver. 1.02 Table of Contents 1 Scope 14 2 References 15 2.1 Normative references .................................................................................................... 15 2.2 Informative references .................................................................................................. 18 3 Terms and Definitions 20 3.1 Conventions .................................................................................................................. 20 3.2 Definitions...................................................................................................................... 20 3.3 Abbreviations ................................................................................................................ 20 4 Specification overview 23 4.1 Web Services ................................................................................................................ 23 4.2 IP configuration ............................................................................................................. 24 4.3 Device discovery ........................................................................................................... 24 4.4 Device management ..................................................................................................... 25 4.4.1 Capabilities ............................................................................................................... 25 4.4.2 Network ..................................................................................................................... 26 4.4.3 System ...................................................................................................................... 26 4.4.4 Security ..................................................................................................................... 27 4.4.5 Input/Output .............................................................................................................. 27 4.5 Imaging configuration .................................................................................................... 27 4.6 Media configuration ....................................................................................................... 27 4.6.1 Media profiles............................................................................................................ 28 4.7 Real-time streaming ...................................................................................................... 31 4.8 Event handling .............................................................................................................. 32 4.9 PTZ control .................................................................................................................... 32 4.10 Video analytics .............................................................................................................. 33 4.11 Security ......................................................................................................................... 35 4.12 Client code examples .................................................................................................... 35 4.12.1 Requesting Stream URI ....................................................................................... 35 4.12.2 Media Setup ......................................................................................................... 36 5 Web Services frame work 37 5.1 Services overview ......................................................................................................... 37 5.1.1 Device service........................................................................................................... 38 5.1.2 Media service ............................................................................................................ 38 5.1.3 Event service ............................................................................................................ 38 5.1.4 Imaging service ......................................................................................................... 38 5.1.5 PTZ service ............................................................................................................... 38 5.1.6 Analytics service ....................................................................................................... 38 5.1.7 Storage service ......................................................................................................... 38 5.1.8 Services requirements .............................................................................................. 39 5.2 WSDL overview ............................................................................................................. 39 5.3 Namespaces ................................................................................................................. 40 Open Network Video Interface Forum – 4 – ONVIF Core Spec. – Ver. 1.02 5.4 Types ............................................................................................................................. 41 5.5 Messages ...................................................................................................................... 42 5.6 Operations ..................................................................................................................... 42 5.6.1 One-way operation type ............................................................................................ 43 5.6.2 Request-response operation type............................................................................. 44 5.7 Port Types ..................................................................................................................... 44 5.8 Binding .......................................................................................................................... 45 5.9 Ports .............................................................................................................................. 45 5.10 Services......................................................................................................................... 45 5.11 Error handling ................................................................................................................ 45 5.11.1 Protocol errors ...................................................................................................... 46 5.11.2 SOAP errors ......................................................................................................... 46 5.12 Security ......................................................................................................................... 49 5.12.1 User-based access control ................................................................................... 50 5.12.2 User token profile ................................................................................................. 50 6 IP configuration 52 7 Device discovery 53 7.1 General .......................................................................................................................... 53 7.2 Modes of operation ....................................................................................................... 53 7.3 Discovery definitions ..................................................................................................... 54 7.3.1 Endpoint reference ................................................................................................... 54 7.3.2 Service addresses .................................................................................................... 54 7.3.3 Hello .......................................................................................................................... 54 7.3.4 Probe and Probe Match ...........................................................................................