ONVIF
TM
Application Programmer's Guide
Version 1.0
May 2011
ONVIF
TM
– 2 – ONVIF APG - Ver. 1.0
© 2011 by ONVIF: Open Network Video Interface Forum Inc. 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.
ONVIF
TM
– 3 – ONVIF APG - Ver. 1.0
Table of Contents
1 Introduction ....................................................................................................................6
1.1 How to Use This Document....................................................................................6
1.2 Conventions and Labels.........................................................................................6
1.3 Example Application Overview ...............................................................................8
1.4 Language Definition...............................................................................................8
2 References.....................................................................................................................9
3 Abbreviations ...............................................................................................................11
4 Discovery .....................................................................................................................12
4.1 Prerequisites .......................................................................................................14
4.2 Targeted Services and Technologies....................................................................14
4.3 ONVIF::Discovery................................................................................................14
5 Initial Setup and Administration.....................................................................................16
5.1 First Actions After Discovery................................................................................16
5.2 Getting the Network Interface Configuration .........................................................20
5.3 Setting Network Interface Configuration ...............................................................22
5.4 Time Synchronization Including NTP Configuration (Set Manually)........................24
5.5 Time Synchronization Including NTP Configuration (Set by DHCP) .......................26
5.6 Backup System Configuration Files from a Device................................................28
5.7 Restore System Configuration Files to a Device ...................................................30
5.8 Start System Restore via HTTP Post....................................................................32
6 Security........................................................................................................................34
6.1 Authentication .....................................................................................................35
6.2 User Management ...............................................................................................40
6.3 Certificate Management and Usage......................................................................43
6.4 Real-Time Streaming via RTP / RTSP / HTTPS ....................................................52
7 Streaming.....................................................................................................................55
7.1 Using an Existing Profile for Media Streaming ......................................................57
7.2 Media Profile Configuration..................................................................................59
7.3 Creating a New Media Profile and Adding an Entity ..............................................61
7.4 Multicast Streaming .............................................................................................63
7.5 Audio Backchannel Handling................................................................................67
7.6 Setting Up Metadata Streaming............................................................................69
8 Controlling....................................................................................................................72
8.1 Adding a PTZ Configuration into a Media Profile...................................................73
8.2 Changing a PTZ Configuration .............................................................................74
8.3 Move Operation...................................................................................................76
8.4 Set / Goto Preset Position....................................................................................78
9 Eventing.......................................................................................................................80
9.3 Setting Up WS-BaseNotification...........................................................................83
9.4 Processing NotificationMessage...........................................................................85
10 Storage ........................................................................................................................86
10.1 Starting a Local Recording...................................................................................86
ONVIF
TM
– 4 – ONVIF APG - Ver. 1.0
10.2 Starting a Recording from a Remote Device .........................................................88
10.3 Finding a Recording.............................................................................................90
11 Display.........................................................................................................................92
11.1 Configuring a Display Device to Show a Stream ...................................................95
11.2 Creating and Deleting PaneConfiguration.............................................................98
11.3 Changing the Layout Based on LayoutOptions ...................................................102
11.4 Configuring a Receiver Based on DecoderCapabilities .......................................105
Annex A WSDL-Structures ................................................................................................109
Annex B SOAP Communication Traces from Use Case Examples ......................................110
B.1 SOAP Communication Trace for Discovery.........................................................110
B.2 SOAP Communication Traces for Initial Setup and Administration.......................112
B.3 SOAP Communication Traces for Security..........................................................123
B.4 SOAP Communication Traces for Streaming ......................................................135
B.5 SOAP Communication Traces for Controlling .....................................................151
B.6 SOAP Communication Traces for Eventing.........................................................158
B.7 SOAP Communication Traces for Storage ..........................................................164
B.8 SOAP Communication Traces for Display...........................................................171
Annex C List of Functions with References........................................................................182
Annex D Pseudo Code Conventions..................................................................................194
D.1 General Language Style ....................................................................................195
D.2 while .................................................................................................................196
D.3 if-else................................................................................................................197
D.4 foreach..............................................................................................................198
D.5 break.................................................................................................................199
D.6 try catch throw...................................................................................................200
D.7 optional Elements..............................................................................................201
ONVIF
TM
– 5 – ONVIF APG - Ver. 1.0
Contributors
Johan Adolfsson Axis Communications AB
Susanne Kinza Bosch Security Systems
Daniel Fiala Dallmeier electronic GmbH & Co.KG
Günther Frank Dallmeier electronic GmbH & Co.KG
Takeshi Asahi Hitachi, Ltd.
Hiroyuki Kanda Panasonic System Networks Co., Ltd.
Hirokazu Kitaoka Panasonic System Networks Co., Ltd.
Yohei Kushido Panasonic System Networks Co., Ltd.
Scott Hudson Pelco by Schneider Electric
Mike Kirby Pelco by Schneider Electric
Kazunori Sakaki Sony Corporation
评论1
最新资源