©2009 – 2014 by HIKVISION. All rights reserved. 1
Revision History
Revision History
Description
Date
By
v2.0-draft-0920
Initial version
2012-09
Meng Hong
v2.0.1
Update the document
2014-01
Meng Hong
©2009 – 2014 by HIKVISION. All rights reserved. 2
Notices
The information in this documentation is subject to change without notice and does not
represent any commitment on behalf of HIKVISION. HIKVISION disclaims any liability
whatsoever for incorrect data that may appear in this documentation. The product(s)
described in this documentation are furnished subject to a license and may only be used
in accordance with the terms and conditions of such license.
Copyright © 2012-2017 by HIKVISION. All rights reserved. This documentation is
issued in strict confidence and is to be used only for the purposes for which it is
supplied. It may not be reproduced in whole or in part, in any form, or by any means or be
used for any other purpose without prior written consent of HIKVISION and then only on
the condition that this notice is included in any such reproduction. No information as to the
contents or subject matter of this documentation, or any part thereof, or arising directly or
indirectly therefrom, shall be given orally or in writing or shall be communicated in any
manner whatsoever to any third party being an individual, firm, or company or any
employee thereof without the prior written consent of HIKVISION. Use of this product is
subject to acceptance of the HIKVISION agreement required to use this product.
HIKVISION reserves the right to make changes to its products as circumstances may
warrant, without notice.
This documentation is provided “as-is,” without warranty of any kind. Please send
any comments regarding the documentation to:
overseabusiness@hikvision.com
Find out more about HIKVISION at www.hikvision.com.
©2009 – 2014 by HIKVISION. All rights reserved. 3
Content
1 Introduction ............................................................................................................ 7
2 Conformance ......................................................................................................... 7
3 Glossary and Relationship .................................................................................... 7
3.1 Glossary of Terms ................................................................................................. 7
3.2 Relationship of Entities and Terminology ............................................................. 8
3.3 XML Reserved Characters .................................................................................... 8
4 General Rules and Guidelines .............................................................................. 9
4.1 DVR & NVR Design Considerations ..................................................................... 9
4.2 Input Source Management (Remote Camera Configuration) ............................. 11
5 ContentMgmt Base Service ................................................................................ 13
5.1 /ISAPI/ContentMgmt/sourceSupport ................................................................ 13
5.1.1 Source Support XML Schema Definition .............................................. 15
5.1.2 Access and Operation of Source Support ............................................ 15
6 /ISAPI/ContentMgmt/Capabilities ........................................................................ 19
7 /ISAPI/ContentMgmt/record ................................................................................ 21
7.1 /ISAPI/ContentMgmt/record/storageMounts .................................................... 21
7.2 /ISAPI/ContentMgmt/record/profile .................................................................. 23
7.2.1 /ISAPI/ContentMgmt/record/profile Schema Definition ........................ 23
7.3 /ISAPI/ContentMgmt/record/tracks ..................................................................... 24
7.3.1 Custom Configuration Data (Extensions) ............................................. 25
7.3.2 ISAPI-REST List-Entry <id> Creation method ..................................... 25
7.3.3 Streaming URL implied in <Track> configuration ................................. 25
7.3.4 Recording Source Description .............................................................. 25
7.3.5 Recording Schedule overview .............................................................. 25
7.3.6 Track Description NVP ......................................................................... 26
7.3.7 /ISAPI/ContentMgmt/record/tracks ....................................................... 28
7.3.8 /ISAPI/ContentMgmt/record/tracks/<id> ............................................... 28
7.3.9 Example Track Creation Message Exchange ...................................... 29
7.3.10 Track List Schema ................................................................................ 31
7.3.11 /ISAPI/ContentMgmt/record/tracks/<id>/dailyDistribution .................... 32
7.4 /ISAPI/ContentMgmt/record/control .................................................................... 32
7.4.1 /ISAPI/ContentMgmt/record/control/manual/start/tracks/<ID> ............. 32
7.4.2 /ISAPI/ContentMgmt/record/control/manual/stop/tracks/<ID> ............. 34
7.4.3 /ISAPI/ContentMgmt/record/control/locks ............................................ 34
8 /ISAPI/ContentMgmt/search................................................................................ 36
8.1 /ISAPI/ContentMgmt/search/profile .................................................................. 36
8.1.1 /ISAPI/ContentMgmt/search/profile Schema Definition ....................... 37
8.2 /ISAPI/ContentMgmt/search................................................................................ 37
©2009 – 2014 by HIKVISION. All rights reserved. 4
8.2.1 Search Query Parameter Schema Definition ....................................... 39
8.2.2 Search Query Results Schema ............................................................ 41
9 /ISAPI/ContentMgmt/logSearch .......................................................................... 44
9.1.1 Search Query Parameter Schema Definition ....................................... 45
9.1.2 Search Query Results Schema ............................................................ 45
10 Metadata Identity String (MIDS; “metaID”) ......................................................... 46
10.1 MIDS Field Definitions ......................................................................................... 46
10.1.1 Domain: event.hikvision.com ................................................................ 47
10.1.2 Domain: log.hikvision.com .................................................................... 47
10.1.3 Domain: recordType.meta.hikvision.com ............................................. 50
11 Streaming and Playback ..................................................................................... 52
11.1 Streaming URIs ................................................................................................... 52
11.1.1 Live Streams ......................................................................................... 52
11.1.2 Archive Streams.................................................................................... 52
11.1.3 Time-related Streaming ........................................................................ 53
11.2 Playback .............................................................................................................. 54
11.2.1 Use of RTSP ......................................................................................... 54
11.2.2 Initiating Playback ................................................................................. 54
12 /ISAPI/ContentMgmt/InputProxy ......................................................................... 56
12.1 /ISAPI/ContentMgmt/InputProxy/sourceCapability ............................................. 56
12.2 /ISAPI/ContentMgmt/InputProxy/search ............................................................. 57
12.3 /ISAPI/ContentMgmt/InputProxy/ipcConfig ......................................................... 57
12.4 /ISAPI/ContentMgmt/InputProxy/customProtocols .......................................... 58
12.4.1 /ISAPI/ContentMgmt/InputProxy/customProtocols/<ID>...................... 59
12.5 /ISAPI/ContentMgmt/InputProxy/channels ......................................................... 60
12.6 /ISAPI/ContentMgmt/InputProxy/channels/status ............................................... 60
12.7 /ISAPI/ContentMgmt/InputProxy/channels/<ID> ................................................ 60
12.8 /ISAPI/ContentMgmt/InputProxy/channels/<ID>/password ................................ 61
12.9 /ISAPI/ContentMgmt/InputProxy/channels/<ID>/netParam ................................ 62
12.10 /ISAPI/ContentMgmt/InputProxy/channels/<ID> /status ............................. 62
12.11 /ISAPI/ContentMgmt/InputProxy/channels/<ID>/video ............................... 63
12.12 /ISAPI/ContentMgmt/InputProxy/channels/<ID>/video/overlays ................. 63
12.12.1 ./InputProxy/channels/<ID>/video/overlays/text ................................... 64
12.12.2 ./InputProxy/channels/<ID>/video/overlays/text/<ID> .......................... 64
12.12.3 ./InputProxy/channels/<ID>/video/overlays/image ............................... 65
12.12.4 ./InputProxy/channels/<ID>/video/overlays/image/<ID> ...................... 65
12.13 /ISAPI/ContentMgmt/InputProxy/channels/<ID>/video/privacyMask .......... 65
12.13.1 ./InputProxy/channels/<ID>/video/privacyMask/regions ...................... 66
12.13.2 ./InputProxy/channels/<ID>/video/privacyMask/regions/<ID> ............. 66
12.14 /ISAPI/ContentMgmt/InputProxy channels/<ID>/video/tamperDetection .... 67
12.14.1 ./InputProxy/channels/<ID>/video/tamperDetection/regions ................ 67
12.14.2 ./InputProxy/channels/<ID>/video/tamperDetection/regions/<ID> ....... 67