Home

IP Surveillance API (RaCM Part) User Guide

Contents

1. URI ISAPI ContentMgmt IOProxy inputs Type Resource Function Access dynamic input ports Methods Query String s Inbound Data Return Result GET lt hik IOProxyInputPortList gt PUT lt hik 1OProxyInputPortList gt lt ResponseStatus gt POST lt hik IOProxyInputPort gt lt ResponseStatus gt Notes The resource is or not support POST method the device support create IO IOProxyInputPortList XML Block lt IOProxyInputPortList version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt IOProxyInputPort gt lt opt gt lt IOProxyInputPortList gt 13 3 ISAPI ContentMgmt IOProxy inputs ID URI ISAPI ContentMgmt IOProxy inputs ID Type Resource Function Access the particular dynamic input port Methods Query String s Inbound Data Return Result GET lt hik IOProxyInputPort gt PUT lt hik 1OProxyInputPort gt lt ResponseStatus gt DELETE lt ResponseStatus gt Notes IOlnputPort XML Block 2009 2014 by HIKVISION All rights reserved 70 lt IOProxyInputPort version 1 0 xmInsz http www isapi org ver20 XMLSchema lt id gt lt req xs string gt lt id gt lt enabled gt lt req xs boolean gt lt enabled gt lt lODescriptor gt lt req xs string gt lt proxyProtocol gt lt req xs enumeration HIKVISION AXIS PANASONIC BOSCH PELCO SONY gt lt pro
2. URI ISAPI ContentMgmt ZeroStreaming status Type Resource Function Query the device zero streaming status Methods Query String s Inbound Data Return Result GET lt ZeroStreamingStatus gt Notes This command accesses the status of all devices zero streaming sessions ZeroStreamingStatus XML Block lt totalStreamingSessions gt lt StreamingSessionStatusList gt lt ZeroStreamingStatus gt lt ZeroStreamingStatus version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt req xs integer gt lt totalStreamingSessions gt lt dep only if there are sessions gt 19 2 ISAPI ContentMgmt ZerStreaming channels URI ISAPI ContentMgmt ZeroStreaming channels Type Resource Function Zero Streaming channels 2009 2014 by HIKVISION All rights reserved 77 Methods Query String s Inbound Data Return Result GET lt ZeroStreamingChannelList gt PUT lt ZeroStreamingChannelList gt lt ResponseStatus gt POST lt ZeroStreamingChannel gt lt ResponseStatus gt DELETE lt ResponseStatus gt Zero Streaming channels may be hardwired or it may be possible to create multiple streaming channels per input if the device supports it To determine whether it is Notes possibly to dynamically create streaming channels check the defined HTTP methods in ISAPI ContentMgmt Streaming channels description Z
3. devicePowerOff deviceRecycle stopAbnormal localLogin localLogOut localCfgPara localUpdate localStartRec localStopRec localCtrlPtz localLockFile localUnlockFile localManulAlarm localFormatDisk localAddlpc localDellpc localSetlpc localPlayByFile localPlayByTime localDownloadCfgFile localUploadCfgFile localDownloadRecFile localDownloadPicFile 2009 2014 by HIKVISION All rights reserved 48 localAddNas localDelNas localSetNas localConfRebRaid localConfSpareRaid localAddRaid locaDelRaid localMigRaid localRebRaid localQuickConfRaid localAddVd localDelVd localStartPicRec localStopPicRec localSetSnmp localResetPasswd localTagOperation localLock localUnlock localHdTest remotePowerOff remotePowerRecycle remoteLogin remotel ogout remoteCfgPara remoteUpgrade remoteStartRec remoteStopRec remoteCtrIPtz remoteLockFile remoteUnlockFile remoteManulAlarm remoteFormatHd remoteAddlpc remoteDellpc remoteSetlpc remotePlayByFile remotePlayByTime remoteDownloadCfgFile remoteUploadCfgFile remoteDownloadRecFile remoteGetPara remoteGetStatus remoteStartTransChan remoteStopTrans
4. HIKVISION 7 ASAPI ContentMgmt record This section describes the REST Interfaces to configure the logical storage used for media archival along with the actual recording session configurations A recording session is also known as a track in the RaCM Device A track archives media Audio Video and Metadata from a Source The Source can be local e g DVR recording from a local analog port or remote e g IP Network Media Device 7 1 ISAPI ContentMgmt record storageMounts This REST Interface is used to configure the total storage available to the RaCM Device to be used to archive media This storage is described as a List of Mount points along with root directories and sizes There is no affinity specified at this time with regards to assigning tracks or range of tracks to a particular Disk or Mount URI ISAPI ContentMgmt record storageMounts Type Resource RequirementL Basic evel 5 Description of the REST method parameters and formats available to functionally manipulate Function the record storage resource Methods Query String s Inbound Data Return Result GET None None lt MountList gt PUT None lt MountList gt lt ResponseStatus gt POST None lt Mount gt lt ResponseStatus gt DELETE None None lt ResponseStatus gt This resource is used to manage the total storage allocation and logical mounts of the Recorder It is allowable to DELETE the entire list though a
5. lt PostRecordTimeSeconds gt 30 lt PostRecordTimeSeconds gt lt Actions gt lt ScheduleAction gt lt ScheduleBlock gt lt ScheduleBlockList gt lt TrackSchedule gt lt Track gt lt TrackList gt 7 3 10 Track List Schema XSD File cmTrackList xsd 2009 2014 by HIKVISION All rights reserved 31 7 3 11 ISAPI ContentMgmt record tracks lt id gt dailyDistributi on URI ISAPI ContentMgmt record tracks lt id gt dailyDistribution Type Resource Function get the track record segments s daily distribution Methods Query String s Inbound Data Return Result GET lt trackDailyParam gt lt trackDailyDistribution gt POST lt trackDailyParam gt lt trackDailyDistribution gt lt monthOfYear gt month of year start from 1 Not lt dayOfMonth gt day of month start from 1 sera lt record gt detect if someday has video recording lt recordType gt record type time normal record type event event record type XSD File cmTrackList xsd 7 4 ISAPI ContentMgmt record control This resource is used to send explicit control command to the record service 7 4 1 ISAPI ContentMgmt record control manual start tracks lt ID gt URI ISAPI ContentMgmt record control manual start tracks lt id gt Type Resource RequirementL Basic evel i Description of the REST method parameters and formats available to functionally Function manipulate the recor
6. top versus middle versus bottom Also note that the MediaDeviceModelCount size varies since the number of IP media device models varied per response The next section describes the ability for consumers to ask for specific forms of information 5 1 2 2 mfgr Query String Parameter The mfgr QSP enables consumers to ask for supported IP media device information related to a specific manufacturer or standards organization Consumers using this capability can ask for supported model information related to a specific manufacturer or standard An example request would look like GET ISAPI ContentMgmt souceSupport mfgr GoodVision 2009 2014 by HIKVISION All rights reserved 18 HIK VISION This type of request instructs the RaCM to only return a CMSourceSupport schema instance that lists the supported models for the manufacturer GoodVision The following is an example of what is expected to be returned request GET ISAPI ContentMgmt sourceSupport mfgr HIKVISION HTTP 1 1 response HTTP 1 1 200 OK Content type application xml Content length lt nnn gt lt xml version 1 0 encoding UTF 8 gt lt CMSourceSupport version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt MediaDeviceListSize gt 3 lt MediaDeviceListSize gt lt SupportedMediaDeviceSourceList gt lt MediaDeviceSource gt lt MediaDeviceMfgr gt HIKVISION lt MediaDeviceMfgr gt lt MediaDeviceMgmtMode gt
7. ISAPI ContentMgmt search Devices that support the Full search profile must outline their parameter limits as described in the following schema XSD File cmSearchProfile xsd 8 2 ISAPI ContentMgmt search The Content Management Search service is the primary component for conducting searches of content bases managed by a ISAPI recording device Fundamentally searches are initiated using a parameter based criteria set which is conveyed by the initiator to the device via the CMSearchDescription XML schema Since not all programming languages allow content bodies with HTTP GET methods both GET and POST are supported as message types for initiating searches The responding device passes back the results in a CMSearchResult XML schema instance for search requests that had valid syntax If a search request is syntactically invalid i e no payload malformed schema instance etc an HTTP response with status code 400 Bad Request and a corresponding Response Status are returned to the requester Please note that a syntactically correct search that has no matching criteria returns a CMSearchResult schema instance with a NO MATCHES status string 2009 2014 by HIKVISION All rights reserved 37 Essentially most searches are conducted based on time and or track and or source related search parameters Full profile Content Management devices also support the potential for metadata search rel
8. lt hddName gt lt ro req xs string gt lt hddName gt lt hddPath gt lt ro opt xs string gt lt hddPath gt lt hddType gt lt ro req xs string IDE SATA eSATA NFS iSCSI Virtual Disk etc gt lt hddType gt lt hdd gt lt ro req xs float in MB gt lt freeSpace gt lt status gt lt ro req xs string ok unformatted error idle mismatch offline smartFailed reparing formating notexist gt lt status gt lt capacity gt lt ro req xs float in MB gt lt capacity gt lt freeSpace gt lt property gt lt req xs string RW RO Redund gt lt property gt lt group gt lt opt xs string id gt lt group gt 20 3 ISAPI ContentMgmt Storage hdd lt ID gt format URI ISAPI ContentMgmt Storage hdd lt ID gt format Type Resource Function Format specified hdd disk Methods Query String s Inbound Data Return Result PUT lt hdd gt Notes 20 4 ISAPI ContentMgmt Storage hdd lt ID gt formatStatus URI ISAPI ContentMgmt Storage hdd lt ID gt formatStatus Type Resource Function Methods Query String s Inbound Data Return Result GET lt formatStatus gt Notes formatStatus XML Block 2009 2014 by HIKVISION All rights reserved 81 lt formatStatus version 1 0 xmIns http www isapi org ver20 XMLSchema 5
9. which is part of the track configuration The lt SourceDescriptor gt contains two important tags which help uniquely identify the media source lt SreGUID gt and lt SrcUrl gt The lt SrcGUID gt is a GUID UUID for a stream source which may also provide multiple channels of output The lt SrcChannel gt value allows for more specific description of the input media stream at a logical level For a local port the lt SrcUrl gt should contain a symbolic reference to a local stream encoded from a local System Video inputs channels as follows rtsp localhost ISAPI Streaming channels lt id gt Also for both local and remote sources the lt SrcDriver gt provides an optional vendor specific hint with regards to the name of an executable driver to use for stream acquisition 7 3 5Recording Schedule overview The lt TrackSchedule gt defines the recording schedule for the Track It generally contains either external references to schedules in the schedule database ISAPI ContentMgmt schedules or an embedded sequence of lt ScheduleBlock gt s typically just one A lt ScheduleBlock gt is a single logical schedule identified by GUID The default embedded lt ScheduleBlock gt in the example contains the required identifiers lt ScheduleBlockGUID gt and lt ScheduleBlockType gt along with a sequence of lt ScheduleAction gt s which are used to build a day of week schedule This default day of week schedule contains
10. The REST resource that advertises these recording attributes i e track types is defined here URI Function Methods GET PUT POST DELETE Notes Example ISAPI ContentMgmt record profile Type Resource Description of the REST resource that advertises the track types supported by a RaCM device lt ResponseStatus w Error Code gt lt ResponseStatus w Error Code gt lt ResponseStatus w Error Code gt This resource is read only lt xml version 1 0 encoding UTF 8 gt lt CMRecordProfile version 1 0 xmins http www isapi org ver20 XMLSchema gt lt trackType gt standard lt trackT ype gt lt trackType gt polymorphic lt trackT ype gt lt trackT ype gt polytemporal lt trackT ype gt lt CMRecordProfile gt The above example XML response instance indicates that the RaCM device supports all of track types defined by RaCM specifications See ISAPI ContentMgmt record Recorder Configuration amp Control for details about the attributes and behaviors of track types The ISAPI ContentMgmt record profile REST resource is a read only advertisement to management applications VMSs etc of the supported track types which in turn governs their configuration options All RaCM devices are required to support at least one of the sanctioned track types described in this specification The CMRecordProfile schema definition also enables vendors to provide their own extensions to this info
11. i e a URI of the responder s definition that contains all the information necessary to play the segment via RTSP without the responder having to recommit another search Optionally the responder can include the following information in a matchElement where applicable and or supported e The channel ID of the source corresponding the match segment if the input channel is still active i e live e For metadata searches the fully qualified ISAPI Domain Class Type REST URI S of the corresponding events that correlate to the match segment 8 2 2 1 Search Response Examples The following example XML schema instances describe some of the potential responses to search queries Please note that these examples are provided for reference but there are still many potential scenarios not directly addressed 2009 2014 by HIKVISION All rights reserved 41 lt xml version 1 0 encoding UTF 8 gt lt CMSearchResult version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt searchlD gt 812F04E0 4089 11A3 9A0C 0305E82C2906 lt searchlD gt lt responseStatus gt true lt responseStatus gt lt responseStatusStrg gt OK lt responseStatusStrg gt lt numOfMatches gt 1 lt numOfMatches gt lt matchList gt lt matchElement gt lt sourcelD gt b049902e72 0049 1158 c0d2 7e330680d93c lt sourcelD gt lt trackID gt 27 lt trackID gt lt timeSpan gt lt startTime gt 2013 05 18T10 31 26 lt startTime gt lt endTime
12. lt formating gt sl ro req xs boolean gt lt formating gt lt percent gt lt ro req xs integer 0 100 gt lt percent gt lt formatStatus gt 20 5 ISAPI ContentMgmt Storage nas URI ISAPI ContentMgmt Storage nas Type Resource Function Methods Query String s Inbound Data Return Result GET lt nasList gt PUT lt nasList gt lt ResponseStatus gt POST lt nas gt lt ResponseStatus gt Notes nasList XML Block lt nasList version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt nas gt lt opt gt lt nas gt lt nasList gt 20 6 ISAPI ContentMgmt Storage nas lt ID gt URI ISAPI ContentMgmt Storage nas lt D gt Type Resource Function Methods Query String s Inbound Data Return Result GET lt nas gt PUT lt nas gt lt ResponseStatus gt DELETE lt ResponseStatus gt lt nasType gt support NFS iSCSI Notes lt property gt attribute RW RO and RDD lt group gt nas XML Block lt nas version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt id gt lt req xs string id gt lt id gt lt addressingFormatType gt lt req xs string ipaddress hostname gt lt addressingFormatType gt 2009 2014 by HIKVISION All rights reserved 82 lt hostName gt lt dep xs string lt hostNam
13. they are only required to contain whatever information the responder needs to playback the corresponding media segment via RTSP 2009 2014 by HIKVISION All rights reserved 42 lt xml version 1 0 encoding UTF 8 gt lt CMSearchResult version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt searchID gt 812F04E0 4089 1 1 A3 9A0C 0305E82C2906 lt searchID gt lt responseStatus gt false lt responseStatus gt lt responseStatusStrg gt NO MATCHES lt responseStatusStrg gt lt numOfMatches gt 0 lt numOfMatches gt lt CMSearchResult gt In this example a valid search query had no matches for the original criteria provided 8 2 2 2 Search Result Schema Definition XSD File cmSearchResult xsd 2009 2014 by HIKVISION All rights reserved 43 9 ISAPI ContentMgmt logSearch The services defined log search protocol The service from the implementation of RaCM protocol in serach in addition to the request and the corresponding XML content is different the log search mechanism and RaCM in the same search services URI RequirementL evel Function Methods GET PUT POST DELETE Notes ISAPI ContentMgmit logSearch Type Service AII Profiles Mandatory description of the REST method parameters and formats available to functionally manipulate the logSearch resource object Query String s Inbound Data Return Result lt CMSearchDescription gt lt CMSearchResult
14. 39 8 2 2 Search Query Results Schema sica 41 9 ISAPI ConteniMgmilogSearch csa ra AE AE ER as lina lane hunni 44 9 1 1 Search Query Parameter Schema Definition 45 9 1 2 Search Query Results Schema ii 45 10 Metadata Identity String MIDS metalD i 46 10 1 MIDS FV CN aU AA lele 46 10 1 1 Domain event hikvision com Re Re ee Re ee 47 10 1 2 Domain log hikvision com Re Re Re ee Re gee 47 10 1 3 Domain recordType meta hikvision com ee ee ee ee ee 50 11 Streaming and Playback ESE SERS nn 52 11 1 NG AE EE OE EE EE ED EE ED EE 52 ER OE ii ES iL LL Lai 52 11 12 Archive Streams ila 52 Ma Time related Streaming ca EER EG Ke Re ke be Re EE ke EER RENE 53 lala Playbaek EE EE DEE ER EE ER a a 54 ZA Basel RTSP EE ee DE EER 54 11 22 Initiating Playback aaa 54 12 ASAPI ContentMgmt lInputProxy isi ERAS AE KAR lai fiala illo 56 12 1 ISAPI ContentMgmt InputProxy sourceCapability i 56 12 2 ISAPI ContentMgmt InputProxy search ii 57 12 3 ISAPI ContentMgmt InputProxy ipcConfig 57 12 4 ISAPI ContentMgmt InputProxy customProtocols esse ese ee ee ee 58 12 4 1 ISAPI ContentMgmt InputProxy customProtocols lt ID gt 59 12 5 ISAPI ContentMgmt InputProxy channels iese see ee ee Ee Re ee Ee Re ge 60 12 6 ISAPI Cont
15. GET lt formatStatus gt Notes formatStatus XML Block please refer to Chapter 20 4 20 9 ISAPI ContentMgmt Storage nas search URI ISAPI ContentMgmt Storage nas search Type Resource Function Get nas directoryList from a specify nas server 2009 2014 by HIKVISION All rights reserved 83 Methods Query String s Inbound Data Return Result GET lt nasServerDescriptor gt lt nasDirectoryList gt POST lt nasServerDescriptor gt lt nasDirectoryList gt Notes nasServerDescriptor XML Block lt nasServerDescriptor version 1 0 xmins http www isapi org ver20 XMLSchema xsd gt lt nasType gt lt req xs string NFS iSCSI lt nasType gt lt nasServerlP gt lt req xs string gt lt nasServerlP gt lt nasServerPort gt lt opt xs integer gt lt nasServerPort gt lt nasServerDescriptor gt nasDirectoryList XML Block lt nasDirectoryList version 1 0 xmins http www isapi org ver20 XMLSchema xsd gt lt nasDirectory gt lt opt gt lt id gt lt req xs integet gt lt id gt lt directory gt lt req xs string gt lt directory gt lt nasDirectory gt lt nasDirectoryList gt 20 10 ISAPI ContentMgmt Storage quota URI ISAPI ContentMgmt Storage quota Type Resource Function Manage disk quota Methods Query Stri
16. Methods Query String s Inbound Data Return Result GET TextOverlay gt PUT lt TextOverlay gt lt ResponseStatus gt DELETE lt ResponseStatus gt Notes A text overlay can contain time information and static text with color and transparency information TextOverlay XML Block refer to IPMD 2009 2014 by HIKVISION All rights reserved 64 12 12 3 InputProxy channels lt ID gt video overlays image URI PIA EE Type Resource Function Access and configure image overlays for a particular video channel Methods Query String s Inbound Data Return Result GET lt ImageOverlayList gt PUT lt ImageOverlayList gt lt ResponseStatus gt POST lt ImageOverlay gt lt ResponseStatus gt DELETE lt ResponseStatus gt Notes A set of image overlays is managed They are composited over the video signal in increasing ID order ImageOverlayList XML Block please refer to IPMD 12 12 4 InputProxy channels lt ID gt video overlays image lt ID gt URI ISAPI ContentMgmt InputProxy channels D video overlays Type R souree image ID Function Access and configure a particular image overlay for a video channel Methods Query String s Inbound Data Return Result GET lt ImageOverlay gt PUT lt ImageOverlay gt lt ResponseStatus gt DELETE lt ResponseStatus gt An image overlay can contain time information and static text with color a
17. None Inbound Data None Success Return SmartDetection Description It is used to update a particular smart detection configuration Query None Inbound Data SmartDetection Success Return ResponseStatus Notes SmartDetection XML Block lt SmartDetection version 1 0 xmins http www isapi org ver20 XMLSchema gt lt enabled gt lt req xs boolean gt lt enabled gt lt SmartDetection gt 13 ISAPI ContentMgmt IOProxy URI IISAPI ContentMgmt IOProxy Type Service Methods Query String s Inbound Data Return Result GET lt OProxyPortLists Notes The allocation of IDs between dynamic input and output ports must be unique IOProxyPortList XML Block lt IOProxyPortList version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt IOProxyInputPortList gt lt opt gt lt IOProxyOutputPortList gt lt opt gt lt IOProxyPortList gt 2009 2014 by HIKVISION All rights reserved 69 13 1 ISAPI ContentMgmt IOProxy status URI ISAPI ContentMgmt IOProxy status Type Resource Function Query the dynamic IO status Methods Query String s Inbound Data Return Result GET lt lOProxyPortStatusList gt Notes The allocation of IDs between dynamic input and output ports must be unique IOProxyPortStatusList XML Block please refer to IPMD 13 2 ISAPI ContentMgmt IOProxy inputs
18. Proxy lt MediaDeviceMgmtMode gt lt MediaDeviceModel gt DS 2CD876MF lt MediaDeviceModel gt lt MediaDeviceModel gt DS 2CD877MF lt MediaDeviceModel gt lt MediaDeviceModel gt DS 2CD855MF lt MediaDeviceModel gt lt MediaDeviceSource gt lt SupportedMediaDeviceList gt lt CMSourceSupport gt Please note that the manufacturer name string is treated in a case insensitive manner Also manufacturer strings that contain spaces must use the W3C special character replacement scheme For example a fictitious vendor named Volcano Vision would have a QSP that looks like mfgr Volcano 20Vision RaCM devices must parse out and convert the special character symbols just like the processing associated with a standard URI Additionally a consumer may place multiple mfgr QSPs in a request For example GET ISAPI ContentMgmt souceSupport mfgr HIKVISION amp mfgr ONVIF is a valid REST URI for the sourceSupport resource The recommendation is that a consumer should not send more than 3 manufacturer IDs per request If a RaCM device cannot process the number of mfgr QSPs sent in a single request it should return an HTTP status code of 503 Bad Request 6 ISAPI ContentMgmt Capabilities ISAPI ContentMgmt capabilities General Resource v2 0 GET Description It is used to get device capability Query None Inbound Data None Success Return lt RacmCap gt Notes RacmCap X
19. XML lt MouniList gt lt xml version 1 0 encoding UTF 8 gt lt MountList version 1 0 xmins http www isapi org ver20 XMLSchema gt lt Mount gt lt id gt 1 lt id gt lt path gt dev hda lt path gt lt dir gt racm1 record_tracks lt dir gt lt size gt 200000000000 lt size gt lt descr gt master ide lt descr gt lt Mount gt lt Mount gt lt id gt 2 lt id gt lt path gt dev sda lt path gt lt dir gt racm1 record_tracks lt dir gt lt size gt 500000000000 lt size gt lt descr gt first scsi lt descr gt lt Mount gt lt Mount gt lt id gt 3 lt id gt lt path gt d lt path gt lt dir gt racm1 record_tracks lt dir gt lt size gt 100000000000 lt size gt lt descr gt win dos drive lt descr gt lt Mount gt lt MountList gt XSD File cmRacmMount xsd 2009 2014 by HIKVISION All rights reserved 22 HIKVISION 7 2 ASAPI ContentMgmt record profile RaCM devices have the ability to support more than one type of track Since a track is nothing more than a named handle to a virtual content container ISAPI does not specify how the content is actually recorded indexed etc However the attributes and properties that define how a track is configured how a track s content is understood and how its contents may be played are critical to interoperability The definitions and descriptions of track attributes and track types are defined in following Sections
20. accordingly 7 4 3 ISAPI ContentMgmt record control locks URI ISAPI ContentMgmt record control locks Type Resource Requirement Basi Description of the REST method parameters and formats available to functionally Function manipulate the ISAPI ContentMgmt record control locks resource Methods Query String s Inbound Data Return Result GET None None lt RecordingLockList gt PUT None lt RecordingLockList gt lt ResponseStatus gt POST None lt RecordingLock gt lt ResponseStatus gt DELETE N A N A lt ResponseStatus gt Notes Used to manage the list of recording locks Please refer to ISAPI REST List Entry lt id gt Creation method above 2009 2014 by HIKVISION All rights reserved 34 URI ISAPI ContentMgmt record control locks lt id gt Type Resource RequirementL Basic evel Function Resource used to manage a single lt RecordingLock gt entry Methods Query String s Inbound Data Return Result GET None None lt RecordingLock gt PUT None lt RecordingLock gt lt ResponseStatus gt lt ResponseStatus w error POST N A N A codes DELETE None None lt ResponseStatus gt Notes XSD File cmTrackLockList xsd 2009 2014 by HIKVISION All rights reserved 35 8 ISAPI ContentMgmt search This section of the specification defines the operation and parameters associated with the search service within the
21. gt lt MediaDeviceSource gt lt MediaDeviceMfgr gt ClearView lt MediaDeviceMfgr gt lt MediaDeviceMake gt MaxView Series lt MediaDeviceMake gt lt MediaDeviceMgmtMode gt Simple lt MediaDeviceMgmtMode gt lt MediaDeviceModel gt MCV 100F lt MediaDeviceModel gt lt MediaDeviceModel gt MCV 250PTZ lt MediaDeviceModel gt lt MediaDeviceModel gt MCV 500 lt MediaDeviceModel gt lt MediaDeviceSource gt lt SupportedMediaDeviceList gt lt CMSourceSupport gt Send bottom Example request GET ISAPI ContentMgmt sourceSupport send bottom HTTP 1 1 response HTTP 1 1 200 OK Content type application xml Content length lt nnn gt lt xml version 1 0 encoding UTF 8 gt lt CMSourceSupport version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt MediaDeviceModelCount gt 2 lt MediaDeviceModelCount gt lt MediaDeviceSource gt lt MediaDeviceMfgr gt ISAPI lt MediaDeviceMfgr gt lt MediaDeviceMake gt Any ISAPI compliant IP Media device lt MediaDeviceMake gt lt MediaDeviceMgmtModel gt Standard lt MediaDeviceMgmtModel gt lt MediaDeviceMgmtModel gt PTZ lt MediaDeviceMgmtModel gt lt MediaDeviceSource gt lt CMSourceSupport gt The above examples are for reference The data set they contain is hypothetical and relatively small for the sake of simplicity Please note that in these examples the RaCM device made its own arbitrary decision as to where to subdivide the CMSourceSupport information of
22. gt 2013 05 18T10 32 54 lt endTime gt lt timeSpan gt lt mediaSegmentDescriptor gt lt contenType gt video lt contenT ype gt lt codecType gt MPEG4 SP lt codecType gt lt rateType gt 3 Mbps 30 fps lt rateType gt lt playbackURiI gt rtsp 144 70 13 92 554 ISAPI Streaming tracks 27 offset a07724 amp amp endtime 2013 05 18T10 31 25 lt playbackURI gt lt mediaSegmentDescriptor gt lt metadataMatches gt lt metadataDescriptor gt recordT ype meta hikvision com motion lt metadataDescriptor gt lt metadataMatches gt lt matchElement gt lt matchList gt lt CMSearchResult gt The above example is in response to a search query for video motion events with respect to a set of specific sources i e b049902e72 0049 1158 c0d2 7e330680d93c and b049902e72 0049 1158 c0d2 7e330680755e for video motion events between 10 30 and 10 45AM on May igi 2013 One match matchElements was found that matched the search criteria The status combination of true and OK indicate a complete response If there had been more matches than the requester had allowed for reply the status would have been true and MORE in the responseStatus and responseStatusStrg fields respectively The mediaURIDescriptor s provided is exemplary only The playback URIs within the match elements are fictional examples that are syntactically correct Match element playback URIs are opaque to the requester
23. lower casing can be matched open matching e Any search string that contains whitespace or special characters MUST be started and ended with double quotes Since raw text searches are compute intensive requesters and RaCM devices that honor search timeouts should either A ignore timeouts for text searches or B timeouts should be lengthened significantly for text searches Finally RaCM devices that support search timeout limits must allow requesters to dynamically optionally specify desired timeout limits on a per search basis Please note that this is a hint to the RaCM device to restrict in a best effort manner the search operation duration to the time limit specified in the XML parameter set If a RaCM device cannot honor the timeout it will process the search as best it can Additionally a RaCM device that does not support search timeouts should ignore a timeout if it errantly receives one on search request instance XSD File cmSearchDescription xsd 2009 2014 by HIKVISION All rights reserved 40 8 2 2Search Query Results Schema The response to a ContentMgmt search operation using the CMSearchDescription schema is defined by the CMSearchResult schema definition below Fundamentally the response echoes the initiator s search ID and an overall status value The status consists of 2 parts A a boolean called responseStatus indicates overall success or failure which is followed by B t
24. lt ipv6Address gt lt adminPortNo gt lt req xs integer gt lt adminPortNo gt lt srcinputPort gt lt req xs string id gt lt srcInputPort gt lt userName gt lt req xs string gt lt userName gt lt password gt lt _req wo xs string gt lt password gt lt connMode gt lt opt xs string plugplay manual gt lt connMode gt lt streamType gt lt opt xs string auto tcp udp gt lt streamType gt lt sourcelnputPortDescriptor gt lt enableAnr gt lt opt xs boolean lt enableAnr gt lt InputProxyChannel gt 12 8 ISAPI ContentMgmt InputProxy channels lt ID gt passwor d URI ISAPI ContentMgmt InputProxy channels lt ID gt password Type Resource Function set channel password Methods Query String s Inbound Data Return Result PUT None lt InputProxyChannelPassword gt 2009 2014 by HIKVISION All rights reserved 61 lt oldPassword gt lt newPassword gt Notes InputProxyChannelPassword XML Block lt InputProxyChannelPassword version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt oldPassword gt lt req xs string gt lt oldPassword gt lt newPassword gt lt req xs string gt lt newPassword gt lt InputProxyChannelPassword gt 12 9 ISAPI ContentMgmt InputProxy channels lt ID gt netPara m uRI ISAPI
25. lt Actions gt to perform during the defined period A period is defined by a start time and end time with each time expressed as Day of Week and Time of Day The 2009 2014 by HIKVISION All rights reserved 25 HIKVISION Day of Week value is identified by a restricted name string The Time of Day is expressed in local time in order to allow for a more human intuitive definition of time from the local administrators perspective and also account for Day Light Savings Time Thus for a time period expressed as midnight to 8 am local time the intended elapsed time is 8 hours normally However if Day Light Savings Time is enabled on the morning of transition in the Spring and assuming the switch occurs at 2 00 am the actual elapsed time would represent just 7 hours of time during this morning of transition In the fall the reverse would be true and the actual elapsed time for just that morning would be 9 hours Example XML fragment lunch time period lt ScheduleActionStartTime gt lt DayOfWeek gt Monday lt DayOfWeek gt lt inclusive gt lt TimeOfDay gt 12 00 00 lt TimeOfDay gt lt ScheduleActionStartTime gt lt ScheduleActionEndTime gt lt DayOfWeek gt Monday lt DayOfWeek gt lt exclusive gt lt TimeOfDay gt 1 00 00 lt TimeOfDay gt lt ScheduleActionEndTime gt lt ScheduleDSTEnable gt true lt ScheduleDST Enable gt The start time is inclusive of the time specified The end time is
26. middle one third of the CMSourceSupport list data 2009 2014 by HIKVISION All rights reserved 16 HIKVISION bottom GET Similar to the two above tags this tag ISAPI ContentMgmt sourceSupport send middle value indicates that the consumer wants the last 1 3 roughly of the source support list RaCM devices receiving this QSP should provide approximately the final one third of the CMSourceSupport list data Please note that it is up to the RaCM device on how to apportion the source support info into chunks When a RaCM device receives a send head request the returned schema should only contain the MediaDeviceModelCount element and its value For all of the other QSP strings the RaCM device is to provide portions of the schema document that align on list element boundaries i e manufacturer make boundaries This apportioning scheme prohibits the use of the mfgr QSP which is described in the following section The following examples are provided as additional descriptive information These examples are based on the example XML schema instance listed in the table at the top of Section ISAPI ContentMgmi sourceSupport Send head Example request GET ISAPI ContentMgmt sourceSupport send head HTTP 1 1 response HTTP 1 1 200 OK Content type application xml Content length 165 lt xml version 1 0 encoding UTF 8 gt lt CMSourceSupport
27. storage Type Service Function Methods Query String s Inbound Data Return Result GET lt storage gt Notes storage XML Block lt storage version 1 0 xmins http www isapi org ver20 XMLSchema gt lt hddList gt lt opt gt lt hddList gt lt nasList gt lt opt gt lt nasList gt lt workMode gt lt opt xs string group quota extract gt lt workMode gt lt storage gt 20 1 ISAPI ContentMgmt Storage hdd URI ISAPI ContentMgmt Storage hdd Type Resource Function Device HDD management Methods Query String s Inbound Data Return Result GET lt hddList gt Notes hddList XML Block lt hddList version 1 0 xmins http www isapi org ver20 XMLSchema gt lt hdd gt lt opt gt lt hdd gt lt hddList gt 20 2 ISAPI ContentMgmt Storage hdd lt ID gt URI ISAPI ContentMgmt Storage hdd lt ID gt Type Resource Function set specify hdisk Methods Query String s Inbound Data Return Result 2009 2014 by HIKVISION All rights reserved 80 GET lt hdd gt PUT lt hdd gt lt ResponseStatus gt Notes lt property gt hdisk attribute RW RO and Redund lt group gt hdisk group hdd XML Block lt hdd version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt id gt lt ro req xs string id gt lt id gt
28. the source prior to making track setting changes In all cases in Simple management mode the management application VMS etc is responsible for the settings at all the devices and for the synchronization of those settings between the sources and consumers The recommendation in this mode is that management applications SHOULD always change the settings at the source device camera encoder and then modify the appropriate track settings on the dependent RaCM device s Please note that this can produce race conditions between the source and recoding device in some cases Proxy RaCM devices that have the ability to remotely manage other source device s codec streaming parameters are called proxy managers Modifications to codec streaming settings on a proxy managing RaCM device will also be performed at the external source device by the RaCM device for those devices the RaCM unit knows how to configure Basically in proxy management mode the RaCM device receives the settings that affect streams and or tracks and performs based on the sources behavior all of the necessary configuration adjustments on behalf of the management application 2009 2014 by HIKVISION All rights reserved 11 HIK VISION In order to aid interoperability and to support the use of Proxy management mode three new RaCM REST resources have been created ISAPI ContentMgmt sourceSupport IISAPI ContentMgmt InputProxy ISAPI Conte
29. timespan lists and metadata lists Only one of these criteria is required for a valid search Optional information includes the ability for an initiator to specify that it only wants to receive a maximum number of responses to a search criteria i e limit the potential number of responses This is specified by the maxResults element When this limit is specified in a search request the responding device must not send more than the requested number of responses matches If the querying entity 2009 2014 by HIKVISION All rights reserved 39 specifies a maxResult limit that is less than the number of total results that matched the original search criteria it must re issue the search query with the search ResultsPosition parameter indicating the number of prior results the inquirer has already received For example a client application searches for Video Motion events from the prior night and indicates it only wants a maximum of ten results passed back The ContentMgmt device while performing the search discovers 23 matches However the device is only allowed to pass back the first ten results based on the inquirer s maxResults value The device does so but indicates in the search response schema instance a status string of MORE After this if the inquirer desires to retrieve the next set of matching results it must do so with the same search criteria and a searchResultsPosition value that indicates the cum
30. type HIKVISION Required Field codecType See Appendix A Required Field resolution Required for audio video Field indicating resolution of the data elements in a datastream For video this is the horizontal by vertical resolution in a Horizontal x Vertical format where ASCII x separates the horizontal and vertical integer numbers The assumed video format is progressive i e frame based For video streams that are interlaced i e field based and ASCII lower case i needs to be For audio it is the bit width of the samples If a text protocol is enabled for double byte characters this field should be used to indicate 2B character sets Required for Audio Video framerate Frame rate of encoder output as a floating point number Required for Video bitrate Bit rate of datastream bps or kbps integer Optional Examples lt Description gt trackType standard sourceTag AXIS210a contentType video codecType MPEG4 SP resolution 640x480 framerate 25 0 bitrate 3200 kbps lt Description gt 2009 2014 by HIKVISION All rights reserved 27 7 3 7 ISAPI ContentMgmt record tracks URI Function Methods GET PUT POST DELETE Notes ISAPI ContentMgmt record tracks Type Resource Description of the REST method parameters and formats available to functionally manipulate the record storage tracks resource lt ResponseStatus w error code g
31. version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt MediaDeviceModelCount gt 8 lt MediaDeviceModelCount gt lt CMSourceSupport gt Send top Example request GET ISAPI ContentMgmt sourceSupport send top HTTP 1 1 response HTTP 1 1 200 OK Content type application xml Content length lt nnn gt lt xml version 1 0 encoding UTF 8 gt lt CMSourceSupport version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt MediaDeviceModelCount gt 3 lt MediaDeviceModelCount gt lt SupportedMediaDeviceSourceList gt lt MediaDeviceSource gt lt MediaDeviceMfgr gt HIKVISION lt MediaDeviceMfgr gt lt MediaDeviceMgmtMode gt Proxy lt MediaDeviceMgmtMode gt lt MediaDeviceModel gt DS 2CD876MF lt MediaDeviceModel gt lt MediaDeviceModel gt DS 2CD877MF lt MediaDeviceModel gt lt MediaDeviceModel gt DS 2CD855MF lt MediaDeviceModel gt lt MediaDeviceSource gt lt SupportedMediaDeviceList gt lt CMSourceSupport gt Send middle Example 2009 2014 by HIKVISION All rights reserved 17 HIKVISION request GET ISAPI ContentMgmt sourceSupport send middle HTTP 1 1 response HTTP 1 1 200 OK Content type application xml Content length lt nnn gt lt xml version 1 0 encoding UTF 8 gt lt CMSourceSupport version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt MediaDeviceModelCount gt 3 lt MediaDeviceModelCount gt lt SupportedMediaDeviceSourceList
32. 1 2 2 1 Range header field The Range field MUST be expressed using absolute times only the other formats defined by RFC 2326 shall not be used Either open or closed ranges may be used In the case of a closed range the range is increasing end time later than start time for forward playback and decreasing for reverse playback The direction of the range MUST correspond to the value of the Scale header In all cases the first point of the range indicates the starting point for replay Examples PLAY rtsp 192 168 0 1 path to recording RTSP 1 0 CSeg 123 Session 12345678 Range clock 20090615T114900 440Z 20090615T115000 Rate Control no PLAY rtsp 192 168 0 1 path to recording RTSP 1 0 2009 2014 by HIKVISION All rights reserved 54 CSeg 123 Session 12345678 Range clock 20090615T115000 440Z 20090615T114900 Rate Control no Scale 1 0 11 2 2 2 Rate Control header field The Rate Control field is an ONVIF extension and may be either yes or no If this field is not present yes is assumed and the stream is delivered in real time using standard RTP timing mechanisms If this field is no the stream is delivered as fast as possible using only the flow control provided by the transport to limit the delivery rate 2009 2014 by HIKVISION All rights reserved 55 12 ISAPI ContentMgmt InputProxy URI ISAPI ContentMgmt InputProxy Type Service Methods Query String s In
33. 40 lt maxResults gt lt metadataList gt lt metadataDescriptor gt recordT ype meta hikvision com motion lt metadataDescri ptors lt metadataList gt lt CMSearchDescription gt The above example is for a search of tracks 9 22 and 43 between twelve noon and 1 30PM on June 10th 2013 for Video Motion events The requester does not want more than 40 results passed back in the search response and that matching results should only be video segments based on the above contentTypeList 8 2 1Search Query Parameter Schema Definition The following XML schema definition defines the search parameters that are provided to the ContentMgmt search service Basically an entity can search based on time and or source and or tracks and or metadata Basic profile devices are not required to support metadata in their search criteria Each search must be given a unique ID searchID by the initiator This ID is an ISO IEC 9834 8 ITU X 667 compliant UUID GUID The responder echoes this value back in the search response see next section to correlate the results to the corresponding query Basic profile devices are only required to support one query at a time Full profile devices MUST advertise the number of concurrent search queries they can support via the ISAPI ContentMgmt search profile Resource The cmSearchDescription schema allows searches based on track lists track state lists source ID lists channel ID lists
34. Chan startVoiceTalk 2009 2014 by HIKVISION All rights reserved 49 stopVoiceTalk remoteArm remoteDisArm remoteAddNas remoteDelNas remoteSetNas remoteConfRebRaid remoteConfSpareRaid remoteAddRaid remoteDelRaid remoteMigRaid remoteRebRaid remoteQuickConfRaid remoteAddVd remoteDelVd remoteRpVd remoteUpgradeRaid remoteStartPicRec remoteStopPicRec remotePicBackUp remoteSetSnmp remoteTagOperation remoteDelHdisk remoteLoadHdisk remoteUnloadHdisk localExpandVd localStopRaid remoteExpandVd remoteStopRaid Information hddinfo smartinfo startRec stopRec delExpiredRec nasinfo raidinfo runStatusinfo 10 1 3 Domain recordType meta hikvision com Domain recordType meta hikvison com Class Type Attribute LID Local ID TransID Transaction ID Timing 2009 2014 by HIKVISION All rights reserved 50 Motion Alarm Manual motionOrAlarm motionAnd Alarm Smart 2009 2014 by HIKVISION All rights reserved 51 11 Streaming and Playback RaCM devicea must offer ISAPI compliant streaming services for the playback of recorded media information For RaCM devices that also offer the ability to serve live strea
35. ContentMgmt InputProxy channels lt ID gt netParam Type Resource Function set netparam for spec channel Methods Query String s Inbound Data Return Result PUT None lt DynVideolnputNetParam gt lt ipAddress gt Notes cipv6Address gt lt managePortNo gt InputProxyChannelNetParam XML Block lt InputProxyChannelNetParam version 1 0 xmins http www isapi org ver20 XMLSchema gt lt ipAddress gt lt opt xs string gt lt ipAddress gt lt ipv6Address gt lt opt xs string gt lt ipv6Address gt lt managePortNo gt lt opt xs integer gt lt managePortNo gt lt InputProxyChannelNetParam gt 12 10 ISAPI ContentMgmt InputProxy channels lt ID gt status ISAPI ContentMgmt InputProxy channels ID status Type Resource URI Function Access dynamical input channels status Methods Query String s Inbound Data Return Result GET None lt InputProxyChannelStatusList gt 2009 2014 by HIKVISION All rights reserved 62 lt online gt the channel online or outline Notes SteamingProxyChannelldList the channel dynamic streaming lt relatedIOProxy gt channel IO InputProxyChannelStatus XML Block lt InputProxyChannelStatus version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt id gt lt req xs string id gt lt id gt lt sourcelnputPortDescriptor gt lt req gt lt sourcelnputPortDescrip
36. HIK VISION IP Surveillance API RaCM Part User Guide Version 2 0 Revision 1 2014 01 HIKVISION http www hikvision com COPYRIGHT 2012 Hikvision Digital Technology Co Ltd HIK VISION 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 1 HIK VISION 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 lt 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 com
37. ID gt video privacyMask regi ons lt ID gt ISAPI ContentMgmt InputProxy channels ID video privacyMask URI regions ID 9 P y P y Type Resource Function Access and configure a particular privacy mask region Methods Query String s Inbound Data Return Result GET lt PrivacyMaskRegion gt PUT lt PrivacyMaskRegion gt lt ResponseStatus gt DELETE lt ResponseStatus gt Region coordinates are dependent on video resolution Regions will be drawn from the coordinates provided in a top down fashion At least three lt RegionCoordinates gt blocks must be provided for a single PrivacyMaskRegion gt block Notes PrivacyMaskRegion XML Block please refer to IPMD 2009 2014 by HIKVISION All rights reserved 66 12 14 ISAPI ContentMgmt InputProxy channels lt ID gt video tamperDetection URI ISAPI ContentMgmt InputProxy channels ID video tamperDetecti Type Service on Function Tamper detection configuration for a dynamic video input channel Methods Query String s Inbound Data Return Result GET lt TamperDetectionChannel gt PUT lt TamperDetectionChannel gt lt ResponseStatus gt Notes lt coordinateCapabilities gt coordinate for every regional TamperDetectionChannel XML Block please refer to IPMD 12 14 1 InputProxy channels lt ID gt video tamperDetection regions URI ISAPI C
38. ISAPI Content Management hierarchy Tables examples and schemas are provided for defining and explaining the search functions 8 1 ISAPI ContentMgmt search profile Due to the complexity of the functions entailed in a recording and content management RaCM device all RaCM devices MUST provide a profile resource schema instance such that entities accessing them may determine their functional level and basic attributes Details are outlined below URI Function Methods GET PUT POST DELETE Notes ISAP ContentMgmt search profile Type Resource RaCM Mandatory REST resource object that publishes the functional profile level of a RaCM device and its operable service resource structure Query String s Inbound Data Return Result lt ResponseStatus w error codes N A N A N A N A lt ResponseStatus w error codes N A N A lt ResponseStatus w error codes The GET request issued to retrieve an instance of the CMCapabilities XML schema 2009 2014 by HIKVISION All rights reserved 36 lt xml version 1 0 encoding UTF 8 gt lt CMSearchProfile version 1 0 xmins ISAPIllianxce org resourcedescription gt lt searchProfile gt full lt searchProfile gt lt textSearch gt true lt textSearch gt lt maxSearchTimespans gt 2 lt maxSearchTimespans gt lt maxSearchTracks gt 40 lt maxSearchtracks gt lt maxSearchSources gt 40 lt maxSearchSources gt lt maxSearchMetadatas gt 16 lt max
39. ISAPI ContentMgmt ZeroVideo channels lt ID gt switchScreen 75 ISAPI ContentMgmt ZeroVideo channels lt ID gt previeWCfg 75 IISAPI ContentMgmt IMageProXY ii 76 ISAPI ContentMgmt SnapshotProxY i 76 ISAPl GonieniMgmiPTZGtriProxy ra pie 76 ISAP1 ContentMgmt StreamingProxy 77 ISAP1 ContentMgmt ZeroStreaming see ee ee ee ee Re Ee ee Ee 17 ISAPI ContentMgmt ZeroStreaming status ee ee ee 77 ISAPI ContentMgmt ZerStreaming channels 77 ISAPI ContentMgmt ZeroStreaming channels lt ID gt 78 ISAPI ContentMgmt ZeroStreaming channels lt ID gt status ese ee ee 79 SAPI CanteniMamt Storage es sesse ses seks ks Re Ra Res Re ERA Re Res ER RE RE GER ei 80 ISAPI GontentMamustorage hdd ss aan ESEG Nine 80 ISAP1 ContentMgmt Storage hdd lt ID gt Re ee ee Ee 80 ISAPI ContentMgmt Storage hdd lt ID gt format ees ee ee Re Re Re Re ee 81 SAPI ContentMgmt Storage hdd lt ID gt formatStatus 81 MISAFIGOnIEnIMamLUStorage Gee ESE na iii 82 ISAPI ContentMgmt Storage nas sID esse see ee ee AR ee ee Re ee ee Ee 82 ISAPI ContentMgmt Storage nas lt ID gt format ee Re Re ee ee ee 83 ISAPI ContentMgmt St
40. ISION MediaDeviceMfgr Mandatory XML string field that lists the manufacturer of the supported IP Media Device This field is treated as case insensitive to aid in searching and matching e g Luminati luminati effectively MediaDeviceMake Optional Optional XML string field that lists the make of an IP Media device Some manufacturers come out with lines i e product lines of cameras that share protocol attributes This field is to aid in identifying products that belong to a certain product line where when that information is pertinent and relevant MediaDeviceModel Mandatory XML string that identifies the model of a certain IP Media device MediaDeviceMgmtMode Mandatory XML type restricted to Simple or Proxy Please note that all of the values contained in the above fields are treated in a case insensitive manner to aid in better interoperability between management applications clients and the RaCM devices The purpose of the CMSourceSupport schema is to provide consumers with a well ordered list of the media devices that it can record and stream It is also acceptable for generic media device support to be listed where the RaCM device has an industry or mfgr standards based driver that supports compliant cameras generically i e the MediaDeviceMfgr does not have to contain a literal manufacturer it could contain a value like PSIA or ONVIF etc The full schema defin
41. ML Block lt RacmCap version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt isSupportZeroChan gt lt opt xs boolean gt lt isSupportZeroChan gt 2009 2014 by HIKVISION All rights reserved 19 lt inputProxyNums gt lt opt xs integer gt lt inputProxyNums gt lt eSATANums gt lt opt xs integer gt lt eSATANums gt lt miniSASNums gt lt opt xs integer gt lt miniSASNums gt lt nasNums gt lt opt xs integer gt lt nasNums gt lt ipSanNums gt lt opt xs integer gt lt ipSanNums gt lt isSupportRaid gt lt opt xs boolean gt lt isSupportRaid gt lt isSupportExtHdCfg gt lt opt xs boolean gt lt isSupportExtHdCfg gt lt isSupportTransCode gt lt opt xs boolean gt lt isSupportTransCode gt sisSupportlpclmport lt opt xs boolean gt lt isSupportlpclmport gt lt NasMountType gt lt opt gt lt isNFSSupportAuthentication gt lt opt xs boolean gt lt isCIFSSupportAuthentication gt lt opt xs boolean gt lt NasMountType gt lt isSupportlpcStreamType gt lt opt xs boolean gt lt isSupportlOInputProxy gt lt opt xs boolean gt sisSupportlOOutputProxy lt opt xs boolean gt lt isSupportPTZRs485Proxy gt lt opt xs boolean gt lt RacmCap gt HIKVISION XSD File cmRacmCap xsd 2009 2014 by HIKVISION All rights reserved 20
42. None or ResponseStatus w error code gt lt ResponseStatus w error code gt N A N A lt CMSearchResult None lt CMSearchDescription gt or ResponseStatus w error code gt N A N A lt ResponseStatus w error code gt The GET or POST messages require a CMSearchDescription XML document to engage a search An example XML document instance follows 2009 2014 by HIKVISION All rights reserved 44 lt xml version 1 0 encoding UTF 8 gt lt CMSearchDescription version 1 0 xmins http www isapi org ver20 XMLSchema gt lt searchID gt 812F04E0 4089 1 1A3 9A0C 0305E82C2906 lt searchID gt lt timeSpanList gt lt timeSpan gt lt startTime gt 2013 06 10T12 00 00Z lt startTime gt lt endTIme gt 2013 06 10T13 30 00Z lt endTime gt lt timeSpan gt lt timeSpanList gt lt metalD gt log hikvision com Alarm motionstart lt metalD gt lt searchResultPostion gt 20 lt searchResultPostion gt lt maxResults gt 40 lt maxResults gt lt CMSearchDescription gt Example s The above example is for a search of log of video motion detection between twelve noon and 1 30PM on June 10th 2013 for Video Motion events The requester does not want more than 40 results passed back in the search response 9 1 1Search Query Parameter Schema Definition XSD File cmSearchDescription xsd 9 1 2Search Query Results Schema XSD File cmSearchResult xsd 2009 2014 by HIKVISION All rights r
43. OrderList gt 2009 2014 by HIKVISION All rights reserved 75 lt ZeroVideoPreview gt 15 ISAPI ContentMgmt ImageProxy URI ISAPI ContentMgmt ImageProxy Type Service Methods Query String s Inbound Data Return Result Notes Image Proxy service Image Proxy service please refer to IPMD 16 ISAPI ContentMgmt SnapshotProxy URI ISAPI ContentMgmt SnapshotProxy Type Service Methods Query String s Inbound Data Return Result Notes Snapshot Proxy service Snapshot Proxy service please refer to IPMD 17 ISAPI ContentMgmt PTZCtrlProxy URI ISAPI ContentMgmt PTZCtrIProxy Type Service Methods Query String s Inbound Data Return Result Notes Ptz Proxy service PTZ Control Proxy service please refer to IPMD PTZ 2009 2014 by HIKVISION All rights reserved 76 18 ISAPI ContentMgmt StreamingProxy URI ISAPI ContentMgmt StreamingProxy Type Service Methods Query String s Inbound Data Return Result Notes dynamical Streaming service Streaming Proxy service please refer to IPMD Streaming 19 ISAPI ContentMgmt ZeroStreaming URI ISAPI ContentMgmt ZeroStreaming Type Service Methods Query String s Inbound Data Return Result Notes Zero Streaming service 19 1 ISAPI ContentMgmt ZeroStreaming status
44. RI ISAPI ContentMgmt ZeroVideo channels Type Resource Function Access zero video channels Methods Query String s Inbound Data Return Result GET None lt ZeroVideoChannelList gt Notes Since zero video input channels are resources that are defined by the hardware configuration of the device they cannot be created or deleted ZeroVideoChannelList XML Block lt opt gt lt ZeroVideoChannelList version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt ZeroVideoChannel gt lt ZeroVideoChannelList gt 2009 2014 by HIKVISION All rights reserved 73 14 2 ISAPI ContentMgmt ZeroVideo channels lt ID gt URI ISAPI ContentMgmt ZeroVideo channels ID Type Resource Function Access zero video input channel properties Methods Query String s Inbound Data Return Result GET lt ZeroVideoChannel gt PUT lt ZeroVideoChannel gt lt ResponseStatus gt Notes None ZeroVideoChannel XML Block lt ZeroVideoChannel version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt id gt lt req xs string id gt lt id gt lt enabled gt lt req xs Boolean gt lt eanbled gt lt inputPort gt lt req xs string id gt s inputPort lt brightnessLevel gt lt opt xs integer 0 100 gt lt brightnessLevel gt lt contrastLevel gt lt opt xs
45. SearchMetadatas gt lt maxSearchMatchResults gt 100 lt maxSearchMatchResults gt lt maxSearchTimeout gt 120 lt maxSearchTimeout gt lt maxConcurrentSearches gt 8 lt maxConcurrentSearches gt Example s lt CMSearchProfile gt The above example represents a hypothetical RaCM device that supports a Full profile for search its functionality see below for more details The succeeding textSearch parameter indicates that this device performs raw text string searches on recorded text and text based metadata such as Point of Sale or Automated Teller Machine output The next set of optional parameters though recommended for Full devices indicates the maximum number of specific search parameters that can be part of a single instance of a search criterion The following parameter maxSearchResults indicates the maximum number of results the RaCM will pass back per search instance The optional maxSearchTimeout parameter indicates that the RaCM devices will timeout searches that exceed two minutes 120 seconds to execute The final parameter which is optional indicates the maximum number of concurrent search operations the RaCM device can support 8 1 1 ISAPI ContentMgmt search profile Schema Definition The ContentMgmt search profile schema is used to define the types of searches a RaCM device supports A device with a search profile of Basic only performs searches with one timespan per search request see
46. annels lt ID gt video motionDetection URI ISAPI ContentMgmt InputProxy channels ID video motionDetecti Type Service on Function Tamper detection configuration for a dynamic video input channel Methods Query String s Inbound Data Return Result GET lt MotionDetection gt PUT lt MotionDetection gt lt ResponseStatus gt Notes MotionDetection XML Block please refer to IPMD 12 15 1 InputProxy channels lt ID gt video motionDetection layout URI ISAPI ContentMgmt InputProxy channels D video motionDetectio Type Resource n layout Function Access the list of regions for tamper detection on a particular video input channel Methods Query String s Inbound Data Return Result GET lt MotionDetectionGridLayout gt PUT lt MotionDetectionGridLayout gt lt ResponseStatus gt Notes MotionDetectionGridLayout XML Block please refer to IPMD 2009 2014 by HIKVISION All rights reserved 68 12 15 2 ISAPI ContentMgmt InputProxy channels ID video smartDetection When some smart events are detetected or triggered these devices support to pop up an alarm image audio alarm Email alarm trigger alarm output trigger recording on a channel or capture a picture etc ISAPI ContentMgmt InputProxy channels ID video smartDetection General Resource v2 0 Description It is used to get a particular smart detection configuration Query
47. ated parameters More details and examples follow URI ISAP ContentMgmt search Type Service Mandatory description of the REST method parameters and formats available to Function functionally manipulate the search resource object Methods Query String s Inbound Data Return Result lt CMSearchDescription gt lt CMSearchResult or GET None ResponseStatus w error code gt lt ResponseStatus w error PUT N A N A code gt lt CMSearchResult or ResponseStatus w error POST None lt CMSearchDescription gt 3 codes DELETE N A N A lt ResponseStatus w error code gt Notes The GET or POST message requires a CMSearchDescription XML document to engage a search An example XML document instance follows 2009 2014 by HIKVISION All rights reserved 38 lt xml version 1 0 encoding UTF 8 gt lt CMSearchDescription version 1 0 xmins http www isapi org ver20 XMLSchema gt lt searchID gt 812F04E0 4089 1 1A3 9A0C 0305E82C2906 lt searchID gt lt trackIDList gt lt trackID gt 9 lt trackID gt lt trackID gt 22 lt trackID gt lt trackID gt 43 lt trackID gt lt trackIDList gt lt timeSpanList gt lt timeSpan gt lt startTime gt 2013 06 10T12 00 00Z lt startTime gt lt endTIme gt 2013 06 10T13 30 00Z lt endTime gt lt timeSpan gt Example s lt timeSpanList gt lt contentTypeList gt lt contentType gt video lt contentType gt lt contentTypeList gt lt maxResults gt
48. bound Data Return Result Notes Dynamical input service In this document expanding the InputProxy and StreamingProxy interfaces to realize the configuration of the source parameters Dynamic video channel generates dynamic stream When the dynamic video channel is deleted all the related dynamic streams will also be deleted 12 1 ISAPI ContentMgmt InputProxy sourceCapability URI ISAPI ContentMgmit InputPorxy sourceCapability Type Pesante Function get the source s capability Methods Query String s Inbound Data Return Result GET lt sourceDescriptor gt lt sourceCapability gt POST lt sourceDescriptor gt lt sourceCapability gt Notes XSD File cmlnputProxy xsd sourceDescriptor XML Block lt sourceDescriptor version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt adminProtocol gt lt req xs string HIKVISION SONY ISAPI ONVIF gt lt adminProtocol gt lt addressingFormatType gt lt req xs string ipaddress hostname gt lt addressingFormatType gt lt hostName gt lt dep xs string gt lt hostName gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt ipv6Address gt lt dep xs string gt lt ipv6Address gt lt adminPortNo gt lt req xs integer gt lt adminPortNo gt lt userName gt lt req xs string gt lt userName gt lt password gt lt r
49. bps lt Description gt lt TrackGUID gt A01AAAAA BBBB CCCC DDDD 033595353625 lt TrackGUID gt lt Size gt 4000000000 lt Size gt lt Duration gt P10DT15H lt Duration gt lt DefaultRecordingMode gt CMR lt DefaultRecordingMode gt lt LoopEnable gt true lt LoopEnable gt lt SourceDescriptor gt lt SrcGUID gt E800A543 9D53 4520 8BB8 9509062C692D lt SrcGUID gt lt SrcChannel gt 1 lt SrcChannel gt lt StreamHint gt video mp4 640x480 20 fps 6000 kbps lt StreamHint gt lt SrcDriver gt RTP RTSP lt SrcDriver gt lt SrcType gt mp4 video lt SrcType gt lt SrcUrl gt rtsp 10 3 2 26 mpeg4 media amp lt SrcUrl gt lt SrcUrlMethods gt DESCRIBE SETUP PLAY TEARDOWN lt SrcUrlMethods gt lt SrcLogin gt admin admin lt SrcLogin gt lt SourceDescriptor gt lt TrackSchedule gt lt ExternalScheduleBlockReferences gt lt ScheduleBlockReference gt lt ScheduleBlockGUID gt F018AD02 BC04 4520 8BB8 123409AC5678 lt ScheduleBlockGUID gt lt ScheduleBlockReference gt lt ScheduleReference gt lt ScheduleBlockGUID gt C2F37123 DD19 4520 8BB8 444307DB5565 lt ScheduleBlockGUID gt lt ScheduleReference gt lt ExternalScheduleBlockReferences gt lt ScheduleBlock gt lt ScheduleBlockGUID gt ABC12345 CDEF 4520 8BB8 7135789C8790 lt ScheduleBlockGUID gt lt ScheduleBlockType gt ISAPI recording schedule default lt ScheduleBlockType gt lt ScheduleAction gt lt id gt 1 lt id gt lt ScheduleActionStartTime gt lt DayOfWe
50. configuration and use The channel IDs in the schema must be preset by the DVR e All audio codec hardware present on a DVR must be listed as existing pre configured i e using default values hardware input channels in the ISAPI System Audio channels resource hierarchy The channel IDs must be pre populated in the AudioChannelList XML schema document returned by GETS to the ISAPI System Audio channels resource The channels IDs assigned by a DVR are immutable by external entities e Multiple ISAPI Streaming channels lt id gt may have the same lt videolnputChannellD gt Multiple ISAPI ContentMgmt StreamingProxy channels lt id gt may have the same lt dynVideolnputChannellD gt In consideration of the relationship between stream and track video input id dynVideo input id stream id dynStream id use the following encoding 1 To ensure the compatibilities of different devices please use unified id No in IISAPI System Video inputs channels lt ID gt and ISAPI ContentMgmt InputProxys channels lt ID gt video For example if a device supports 16 channels the ID No should be 1 16 in Video inputs channels lt ID gt in this case the ID No should start with 17 in InputProxys channels lt ID gt video 2 lt ID gt of dynamic stream adopts binary coded decimal the former 6 digits stand for channel number the last 2 digits stand for stream number for example if channel 1 of a Hybrid DVR suppor
51. ction regions lt ID gt 67 2009 2014 by HIKVISION All rights reserved 4 12 15 13 13 1 13 2 133 13 4 13 5 13 6 13 7 13 8 14 14 1 14 2 14 3 14 4 14 5 15 16 17 18 19 19 1 19 2 19 3 19 4 20 20 1 20 2 20 3 20 4 20 5 20 6 20 7 20 8 20 9 20 10 20 11 20 12 20 13 20 14 HIKVISION ISAPI ContentMgmt InputProxy channels lt ID gt video motionDetection 68 12 15 1 InputProxy channels lt ID gt video motionDetection layout 68 12 15 2 ISAPI ContentMgmt InputProxy channels ID video smartDetection 69 ISAPI ContentMgmt IOProxy assesseer 69 ISAPI GonteniMgmt IOProxy status ria 70 FISAPWContentMgmtIOProxy inputs ara ani 70 ISAPI ContentMgmt IOProxy inputs ID ese see ee ee ee ee Re ee ee ee 70 ISAPI ContentMgmt lOProxy inputs ID Status esse sesse ee ee Re ee RR Re 71 ISAPI ContentMgmt IOProxy outputs iss isa lil ai 71 FISAPIConentMamtiOProxy outputs ID 225228888888 72 ISAPI ContentMgmt IOProxy outputs ID trigger iii 72 ISAPI ContentMgmt IOProxy outputs ID status ee ee Re RR Re 73 ISAPIGonieniMamizersVided sissies SEER SEG ERGE ESE GR EES SE Ge SEE 73 ISAP1 ContentMgmt ZeroVideo channels iese ee ee ee ee ee Re ee ee Ee 73 ISAPI ContentMgmt ZeroVideo channels lt ID gt es ee Re Re RR Re 74 ISAPI ContentMgmt ZeroVideo channels lt ID gt enlarge iese ee 74
52. d control manual start resource Methods Query String s Inbound Data Return Result GET N A N A lt ResourceDescription gt PUT N A None lt ResponseStatus gt lt ResponseStatus w error POST N A N A codes lt ResponseStatus w error DELETE N A N A code gt 2009 2014 by HIKVISION All rights reserved 32 Notes This resource is used to manually Start the recording track regardless of recording mode To Enable or Disable i e permanent Stop the track the configuration interface should be used to update the track configuration object to set the enable disable value accordingly 2009 2014 by HIKVISION All rights reserved 33 7 4 2 ISAPI ContentMgmt record control manual stop tracks lt IDs URI evel Function Methods GET PUT POST DELETE Notes ISAPI ContentMgmt record control manual stop tracks lt id gt Type Resource RequirementL Basic Description of the REST method parameters and formats available to functionally manipulate the record control manual stop resource Query String s Inbound Data Return Result lt ResponseStatus w error lt ResponseStatus w error code gt This resource is used to manually stop the recording track and regardless of recording mode To enable or disable i e permanent Stop the track the configuration interface should be used to update the track configuration object to set the enable disable value
53. de gt lt statusString gt OK lt statusString gt lt ID gt 777 lt ID gt lt ResponseStatus gt Please note that the lt ID gt tag is uppercase This is to match the example in Service Model Specification Section 10 1 4 The returned Track lt id gt value is 777 which will be used in the following Track Deletion example Example Track Deletion Message Exchange A Client attempts track deletion with DELETE ISAPI ContentMgmt record tracks 777 no payload using lt id gt previously given by the creation example response above B If deletion is successful RaCM Device responds with lt xml version 1 0 encoding UTF 8 gt lt ResponseStatus version 1 0 xmins http www isapi org ver20 XMLSchema gt lt requestURL gt ISAPI ContentMgmt record tracks lt requestURL gt lt statusCode gt 1 lt statusCode gt lt statusString gt OK lt statusString gt lt ID gt 777 lt ID gt lt ResponseStatus gt 2009 2014 by HIKVISION All rights reserved 29 More detailed Single Track XML example sSchedule incomplete lt xml version 1 0 encoding UTF 8 gt lt TrackList version 1 0 xmins http www isapi org ver20 XMLSchema gt lt Track gt lt id gt 1 lt id gt lt Channel gt 12345 lt Channel gt lt Enable gt true lt Enable gt lt Description gt trackType standard sourceTag AXIS210a contentType video codecType MPEG4 SP resolution 640x480 frameRate 20 fps bitrate 6000 k
54. diaDeviceMake gt lt MediaDeviceMgmtMode gt Simple lt MediaDeviceMgmtMode gt lt MediaDeviceModel gt MCV 100F lt MediaDeviceModel gt lt MediaDeviceModel gt MCV 250PTZ lt MediaDeviceModel gt lt MediaDeviceModel gt MCV 500 lt MediaDeviceModel gt lt MediaDeviceSource gt lt MediaDeviceSource gt zMediaDeviceMfgrsISAP Ix MediaDeviceMfgrs lt MediaDeviceMake gt Any ISAPI compliant IP Media device lt MediaDeviceMake gt lt MediaDeviceMgmtModel gt Standard lt MediaDeviceMgmtModel gt lt MediaDeviceMgmtModel gt PTZ lt MediaDeviceMgmtModel gt lt MediaDeviceSource gt lt supportedMediaDeviceSourceList gt lt CMSourceSupport gt The above example represents a RaCM device that supports 9 different camera models from 3 different manufacturers Please note that the make element is not used on every manufacturer Also the ISAPI IP Media Device support is listed as a generic manufacturer with Standard i e non PTZ and a PTZ generic model support This example is only referential Accesses to the session Support resource returns a CMSourceSupport schema document instance This schema document is primarily a list of the types and models of IP media devices that a RaCM device supports as compatible input sources Each element in a list element is comprised of the following parameters Element name Requirement Description 2009 2014 by HIKVISION All rights reserved 14 HIK V
55. ds Query String s Inbound Data Return Result PUT lt ZeroVideoSwitch gt lt ResponseStatus gt Notes ZeroVideoSwitch XML Block lt ZeroVideoSwitch version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt mode gt lt req xs string back next gt lt mode gt lt ZeroVideoSwitch gt 14 5 ISAPI ContentMgmt ZeroVideo channels lt ID gt previewC fg URI ISAPI ContentMgmt ZeroVideo channels ID previewCfg Type Resource Function Get or set zero chan video input preview configuration Methods Query String s Inbound Data Return Result GET lt ZeroVideoPreview gt PUT lt ZeroVideoPreview gt lt ResponseStatus gt screenMode sub screen nums per screen Notes subScreenOrder sub screen order Attribute order represent sub screen order for example order 1 3 5 2 4 ZeroVideoPreview XML Block lt ZeroVideoPreview version 1 0 xmInsz http www isapi org ver20 XMLSchema 5 lt screenMode gt lt req xs integer gt lt screenMode gt lt enAudio gt lt req xs boolean gt lt enAudio gt lt switchInterval gt lt req xs integer in sec gt lt switchInterval gt lt subScreenOrderList gt lt opt gt lt subScreenOrder order gt lt id gt lt xs string id gt lt id gt lt screenMode gt lt req xs integer gt lt screeMode gt lt subScreenOrder gt lt subScreen
56. e Streams RaCM devices record multimedia information onto tracks which are accessible for RTSP Streaming via track IDs The URI structure for Streaming this media information is rtsp lt addr gt lt port gt ISAPI Streaming tracks lt id gt The above 2 URI constructs are direct derivatives of the ISAPI REST resource hierarchy for media information and match the RaCM notations described herein Additionally a client consumer that establishes an RTSP session to a RACM device and issues a DESCRIBE see RFC 2326 for a channel or track only receives an SDP description of the media information for that specific channel or track not for an entire presentation see RFC 2326 For the use of time as a parameter in the management of streaming sessions please see Time related streaming below 2009 2014 by HIKVISION All rights reserved 52 11 1 3 Time related Streaming For archive streams there usually is a time component that indicates the desired time range with respect to a track In the cases where a consumer needs to specify the specific time range associated with a streaming session URI request line parameters are employed for defining the specific time range The following parameter tags are used e starttime This parameter tag indicates that it will be followed by and ISO 8601 timestamp indicating the start time of the media stream the consumer is targeting for description setup or playi
57. e Track s size is determined by the lt Size gt value However optionally some flexibility is allowed for best effort by the implementation to honor the lt Duration gt value 2009 2014 by HIKVISION All rights reserved 24 HIKVISION 7 3 1Custom Configuration Data Extensions Custom configuration information can be added using lt CustomExtensionList gt but for interoperability the name is assigned to each extension object which MUST be registered with ISAPI and a schema XSD MUST be provided for the xs any object s 7 3 2ISAPI REST List Entry lt id gt Creation method Track sid s along with most other list based sid s are managed SET by the target RaCM Device The method for track creation and return of lt id gt value is in accordance with other list based XML object examples in IPMD See the ISAPI ContentMgmt record tracks Resource Description below 7 3 3Streaming URL implied in lt Track gt configuration There is an implied relationship between the REST URL s and RTSP URL s Within the lt Track gt configuration the lt Channel gt value is used for live viewing of the media stream being recorded to that track using the URL described in section Live Streams The Track s REST lt id gt value is used for recorded i e archive media streaming see below 7 3 4Recording Source Description The source for a recording track is logically described by the lt SourceDescriptor gt
58. e gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt ipv6Address gt lt dep xs string gt lt ipv6Address gt lt portNo gt sl req xs integer gt lt portNo gt lt userName gt lt opt xs string gt lt userName gt lt password gt lt opt xs string gt lt password gt lt nasType gt lt req xs string NFS iSCSI gt lt nasType gt lt path gt lt req xs string gt lt path gt lt status gt lt ro req xs string ok unformatted error idle mismatch offline smartFailed reparing formating notexist gt lt status gt lt capacity gt lt ro req xs float in MB gt lt capacity gt lt freeSpace gt lt ro req xs float in MB lt freeSpace gt lt property gt lt req xs string RW RO RDD gt lt property gt lt group gt lt opt xs string id gt lt group gt lt nas gt 20 7 ISAPI ContentMgmt Storage nas lt ID gt format URI ISAPI ContentMgmt nas lt ID gt format Type Resource Function Remote format specified NFS ISCSI Methods Query String s Inbound Data Return Result PUT lt hdd gt Notes 20 8 ISAPI ContentMgmt Storage nas lt ID gt formatStatus URI ISAPI ContentMgmt Storage nas lt ID gt formatStatus Type Resource Function Get format process Methods Query String s Inbound Data Return Result
59. e replaced with their Entity Reference equivalents akin to ANSI Escapes to avoid parsing errors Character Description Entity Reference Comments 2009 2014 by HIKVISION All rights reserved 8 HIKVISION lt Less than amp lt May never appear in amp Ampersand amp amp May never appear in gt Greater than amp gt Replace as best Double quote quot Replace as best Single quote amp apos Replace as best Percent amp 37 Replace as best Note that amp 0 null is not permitted For example the URL rtsp 144 70 13 92 554 ISAPI Streaming tracks 27 starttime 20130731T092241 amp endtime 20130731T093000 would appear as follows in XML lt playbackURI gt rtsp 144 70 13 92 554 ISAPI Streaming tracks 27 starttime 20130731T092241 amp amp endtime 20130731 T093000 lt playbackURI gt 4 General Rules and Guidelines The following guidelines and requirements apply to those parties implementing this specification All RaCM devices shall comply with the guidelines formats syntax and base protocol definitions contained in the ISAPI Service Model specification All RaCM devices shall implement the following ISAPI REST Resource hierarchies as outlined on the ISAPI IP Media Device IPMD Specification O O For DVRs the ISAPI System Video REST resources and services as is pertinent for the hardware capabilities for a given RaCM de
60. ek gt Monday lt DayOfWeek gt lt inclusive gt lt TimeOfDay gt 00 00 00 lt TimeOfDay gt lt ScheduleActionStartTime gt lt ScheduleActionEndTime gt 2009 2014 by HIKVISION All rights reserved 30 lt DayOfWeek gt Monday lt DayOfWeek gt lt exclusive gt lt TimeOfDay gt 08 00 00 lt TimeOfDay gt lt ScheduleActionEndTime gt lt ScheduleDSTEnable gt true lt ScheduleDSTEnable gt lt Description gt PreMorning Midnight to 8am local time lt Description gt lt Actions gt lt alarm or motion detection triggers a recording gt lt ActionRecordingMode gt EDR lt ActionRecordingMode gt lt PreRecordTimeSeconds gt 30 lt PreRecordTimeSeconds gt lt PostRecordTimeSeconds gt 30 lt PostRecordTimeSeconds gt lt Actions gt lt ScheduleAction gt lt ScheduleAction gt lt id gt 2 lt id gt lt ScheduleActionStartTime gt lt DayOfWeek gt Monday lt DayOfWeek gt lt inclusive gt lt TimeOfDay gt 08 00 00 lt TimeOfDay gt lt ScheduleActionStartTime gt lt ScheduleActionEndTime gt lt DayOfWeek gt Monday lt DayOfWeek gt lt exclusive gt lt TimeOfDay gt 12 00 00 lt TimeOfDay gt lt ScheduleActionEndTime gt lt ScheduleDSTEnable gt true lt ScheduleDSTEnable gt lt Description gt Morning 8am to noon local time lt Description gt lt Actions gt lt ActionRecordingMode gt CMR lt ActionRecordingMode gt lt PreRecordTimeSeconds gt 30 lt PreRecordTimeSeconds gt
61. entMgmt InputProxy channels status 60 12 7 ISAPI ContentMgmt InputProxy channels lt ID gt ii 60 12 8 ISAPI ContentMgmt InputProxy channels lt ID gt paSsword 61 12 9 ISAPI ContentMgmt InputProxy channels lt ID gt netParam ese see ee 62 12 10 ISAPI ContentMgmt InputProxy channels lt ID gt status esse ee ee 62 12 11 ISAPI ContentMgmt InputProxy channels lt ID gt VIdeo 63 12 12 ISAPI ContentMgmt InputProxy channels lt ID gt video overlays 63 12 12 1 InputProxy channels lt ID gt video overlaySMeXt i 64 12 12 2 InputProxy channels lt ID gt video overlays text lt ID gt ee 64 12 12 3 InputProxy channels lt ID gt video overlays image 65 12 12 4 InputProxy channels lt ID gt video overlays image lt ID gt 65 12 13 ISAPI ContentMgmt InputProxy channels lt ID gt video privacyMask 65 12 13 1 InputProxy channels lt ID gt video privacyMask regions 66 12 13 2 InputProxy channels lt ID gt video privacyMask regions lt ID gt 66 12 14 ISAPI ContentMgmt InputProxy channels lt ID gt video tamperDetection 67 12 14 1 InputProxy channels lt ID gt video tamperDetection regions 67 12 14 2 InputProxy channels lt ID gt video tamperDete
62. eq xs string gt lt password gt lt sourceDescriptor gt 2009 2014 by HIKVISION All rights reserved 56 sourceCapability XML Block lt sourceCapability version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt videolnputNums gt lt req xs integer gt lt videolnputNums gt lt audiolnputNums gt lt opt xs integer gt lt audioInputNums gt lt sourceCapability gt 12 2 ISAPI ContentMgmt InputProxy search URI ISAPI ContentMgmt InputProxy search Type Resource Function serach proxy inputs Methods Query String s Inbound Data Return Result GET lt VideoSourceList gt lt adminProtocol gt Notes lt adminPort gt VideoSourceList XML Block lt VideoSourceList version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt VideoSourceDescriptor gt lt opt gt lt id gt lt req xs string id gt lt id gt lt proxyProtocol gt lt req xs string HIKVISION SONY ISAPI ONVIF gt lt proxyProtocol gt lt addressingFormatType gt lt req xs string ipaddress hostname gt lt addressingFormatT ype gt lt hostName gt lt dep xs string gt lt hostName gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt subnetMask gt lt opt xs string subnet mask for IPv4 address gt lt subnetMask gt lt ipv6Address gt lt dep xs string
63. eroStreamingChannelList XML Block lt opt gt lt ZeroStreamingChannelList version 1 0 xmins http www isapi org ver20 XMLSchema gt lt ZeroStreamingChannel gt lt ZeroStreamingChannelList gt 19 3 ISAPI ContentMgmt ZeroStreaming channels lt ID gt URI ISAPI ContentMgmt ZeroStreaming channels D Type Resource Function Access zero streaming channels Methods Query String s Inbound Data Return Result GET lt ZeroStreamingChannel gt PUT lt ZeroStreamingChannel gt lt ResponseStatus gt DELETE lt ResponseStatus gt o lt videolnputChannellD gt refers to ISAPI ContentMgmt ZeroVideo channels D ZeroStreamingChannel XML Block 2009 2014 by HIKVISION All rights reserved 78 lt ZeroStreamingChannel version 1 0 xmIns http www isapi org ver20 XML Schema 5 lt id gt lt l req xs string id gt lt id gt lt channelName gt lt req xs string gt lt channelName gt lt enabled gt lt req xs boolean gt lt enabled gt lt Video gt lt opt gt lt enabled gt lt req xs boolean gt lt enabled gt lt VideolnputChannellD gt lt req xs string id gt lt videolnputChannellD gt lt videoCodecType gt lt req xs string MPEG4 MJPEG 3GP H 264 MPNG gt lt videoCodecType gt lt videoResolutionWidth gt lt req xs integer gt lt videoResolutionWidth gt lt videoR
64. eserved 45 10 Metadata metalD In order to have a large variety of metadata types that can be commonly processed and yet Identity String allow flexibility in designing and developing metadata product components a hierarchical namespace forming a metadata taxonomy is employed This notation is based on a URI structure The format is lt domain gt lt class gt lt type gt attribute LID TransID Definitions for the above URI fields are 10 1 MIDS Field Definitions Field Name Requirement Level Comments Domain Mandatory The virtual domain name of the ordaining body for the format and definitions that are used for the associated metadata event information The domain determines the format and thus the processing and do of metadata event instance ata Class Optional Domain specific Class of the metadata event information Some examples are Alarm Exception etc If Class is not contained it stands for all of classes Type Optional Class dependent type of metadata event information For example within a class called Alarm there would be types such as motionStart motionStop etc If Type is not contained it stands for all of types iby LID Local Dependent Optional Free form field that is available for use as additional descriptive information using the following rules gt The convention is that th
65. esolutionHeight gt lt req xs integer gt lt videoResolutionHeight gt lt videoQualityControlType gt lt opt xs string cbr vbr gt lt videoQualityControlT ype gt lt constantBitRate gt lt dep xs integer in kbps gt lt constantBitRate gt lt vbrUpperCap gt lt dep xs integer in kbps gt lt vbrUpperCap gt lt vbrLowerCap gt lt dep xs integer in kbps gt lt vbrLowerCap gt lt maxFrameRate gt lt req xs integer maximum frame rate x100 gt lt maxFrameRate gt lt Video gt lt ZeroStreamingChannel gt 19 4 ISAPI ContentMgmt ZeroStreaming channels lt ID gt statu S URI ISAPI ContentMgmt ZeroStreaming channels D status Type Resource Function Get the list of zero streaming sessions associated with a particular channel Methods Query String s Inbound Data Return Result GET lt ZeroStreamingSessionStatusList gt Use of IPv4 or IPv6 addresses depends on the value of the lt ipVersion gt field in Notes SAPI System Network interfaces DfipAddress StreamingSessionStatus XML Block lt ZeroStreamingSessionStatusList version 1 0 xmins http www isapi org ver20 XMLSchema gt lt StreamingSessionStatus gt lt ZeroStreamingSessionStatusList gt 2009 2014 by HIKVISION All rights reserved 79 20 ISAPI ContentMgmt Storage URI ISAPI ContentMgmt
66. exclusive to allow aggregation of time period definitions to create a continuum without overlap conflict lt ExternalScheduleBlockReferences gt allow for reduction in size and simplification of the lt Track gt configuration object by enabling references to shared schedules in a database as opposed to embedding them within each lt Track gt configuration 7 3 6 Track Description NVP One of the key elements in each track s parameter base is the lt Description gt element This field is a Comma Separated Variable CSV string which contains a list of Name Value Pairs NVP of form Name Value With this scheme the comma and equal are treated as reserved characters however if a Name or Value string must contain and these characters the XML encoding standard can be used to embed them if necessary i e replace the with amp 61 and replace the with amp 44 Parameter Parameter Values Comments Name trackType gt standard normal single content base track Required Field gt polymorphic multi content type track gt polytemporal multi time segmented track sourceTag Manufacturer specific device type string e g make model Optional 2009 2014 by HIKVISION All rights reserved 26 contentType video audio metadata text VVV Vv NOTE For polymorphic tracks this indicates the primary or predominant content
67. gt lt ipv6Address gt lt bitMask gt lt opt xs integer bitmask IPv6 address lt bitMask gt lt serialNumber gt lt opt xs string gt lt serialNumber gt lt macAddress gt sl opt xs string gt lt macAddress gt lt firmwareVersion gt lt opt req xs string gt lt firmwareVersion gt lt managePortNo gt lt opt xs integer gt lt managePortNo gt lt userName gt lt opt xs string gt lt userName gt lt password gt lt opt xs string gt lt password gt lt srcInputPortNums gt lt req xs integer gt lt srcinputPortNums gt lt VideoSourceDescriptor gt lt VideoSourceList gt 12 3 ISAPI ContentMgmt InputProxy ipcConfig ISAPI ContentMgmt InputProxy ipcConfig General Resource v2 0 2009 2014 by HIKVISION All rights reserved 57 GET Description Export ipc s configuration data Query None Inbound Data None Success Opaque Data Return PUT Description Import ipc s configuration data Query None Inbound Data Opaque Data Success lt ImportlpcCfgError gt Return statusCode subStatusCode description 2 upgrading device upgrading aaa ETE 2 noMemory noMemory 6 importErrorData importErrorData 2 configOperating device importing or exporting Notes Configuration file is device dependant it may be binary or any other format May reboot device after configura
68. he responseStatusString which indicates a readable status string that further qualifies the overall status e g TRUE OK or TRUE MORE indicating more matches were found than the initiator desired to receive or FALSE NO MATCHES search failed to find matches to specified criteria or FALSE INVALID TRACK ID indicating an invalid track ID had been provided The combination of an overall Boolean status indicator plus a qualifying string allows a requester to quickly determine if a search was successful and then have information detailing the operation After the response status the responder provides the number of matches found and a list of matchElements that corresponding the each matching multimedia segment Each matchElement contains the following information e The source ID of the input source that corresponds to the matching segment e The track ID of the multimedia track that corresponds to the matching segment e The timespan of the matching segment since it is probably a subset of the overall search s timespan e A media segment descriptor that the search initiator can directly use to playback the corresponding match segment It contains the following oThe content type of the segment video audio metadata text other oThe codecType of the content in the segment e g MPEG4 SP or G 726 o The rate attribute of the segment if applicable o The playback URI for the match segment
69. integer 0 100 gt lt contrastLevel gt lt sharpnessLevel gt lt opt xs integer 0 100 gt lt sharpnessLevel gt lt saturationLevel gt lt opt xs integer 0 100 gt lt saturationLevel gt lt hueLevel gt lt opt xs integer 0 100 lt hueLevel gt lt ZeroVideoChannel gt 14 3 ISAPI ContentMgmt ZeroVideo channels lt ID gt enlarge URI ISAPI ContentMgmt ZeroVideo channels ID enlarge Type Resource Function Get or set zero chan video input enlarge configuration Methods Query String s Inbound Data Return Result GET lt ZeroVideoEnlarge gt PUT lt ZeroVideoEnlarge gt lt ResponseStatus gt mousePosition the device uses this element to decide which sub screen should be Noe enlarged ZeroVideoEnlarge XML Block lt ZeroVideoEnlarge version 1 0 xmins http www isapi org ver20 XMLSchema gt lt stat gt lt req xs string normal enlarge gt lt stat gt lt mousePosition gt lt wr dep gt lt X gt lt req xs integer gt lt x gt lt y gt lt req xs integer gt lt y gt lt mousePosition gt lt ZeroVideoEnlarge gt 2009 2014 by HIKVISION All rights reserved 74 14 4 ISAPI ContentMgmt ZeroVideo channels lt ID gt switchScr een URI ISAPI ContentMgmt ZeroVideo channels ID switchScre Type Resource en Function Switch screen Metho
70. ir product classes Unlike NVRs DVRs have onboard video and in many cases audio codec hardware as their input sources Since this hardware is intrinsic to the device i e it is not dynamically assignable to the unit like NVR input 2009 2014 by HIKVISION All rights reserved 9 HIKVISION sources DVRs must comply with the following design operational items in addition to the general requirements listed in the above section of this document e All video codec hardware must be listed as pre configured i e with default settings input channels in the following ISAPI resource hierarchies o For DVR video input hardware that provides image setting parameters such as brightness contrast sharpness etc these settings must be accessible in the IISAPI System Video inputs channels resource hierarchy This means that the VideolnputChannelList XML schema document returned by a GET to the ISAPI System Video inputs channels resource must list all of the existing input channels as VideolnputChannel elements The IDs for each element must be set for each channel by the DVR and cannot be allowed to be changed by external entities o DVR video codec hardware must be listed as pre configured i e using default values input channels in the ISAPI Streaming channels resource The returned StreamingChannelList XML schema document must be pre populated with all of the codec channels that are available for
71. is field MUST be used as the Local ID field for all metadata event occurrences that are related to or associated with a channel port stream ID gt For metadata event occurrences that have no correlation to a channel or port etc this field is optional 2009 2014 by HIKVISION All rights reserved 46 MIDS TransID Transaction ID Optional A string field that uniquely identifies this occurrence instance to the source If a source entity requires a transactional level acknowledgement then this field MAY be used as an identifier for expressly acknowledging a specific metadata event instance Please note that the source UUID GUID and timestamp of a metadata event instance are the standard fields used for uniqueness Additional fields are optional In this hierarchical namespace scheme the Domain is REQUIRED The Class and Type fields Attribute LID and TransID fields are optional To provide consistent parsing and decoding the above described fields are positonal within an MIDS URI Empty slots after the Domain Class Type need not be present 10 1 1 Domain event hikvision com Domain event hikvison com Class Type Attribute LID Local TransID ID Transaction ID VideoMotion motion video input motionStart port dynamical video motionStop input port Intrusion alarmin alarm In port 10 1 2 Domain log hikvision com Domain log hi
72. iskGroupList version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt diskGroup gt lt opt gt lt diskGroup gt lt diskGroupList gt 20 14 ISAPI ContentMgmt Storage diskGroup lt ID gt URI __ ISAPI ContentMgmt Storage diskGroup lt ID gt Type Resource Function Methods Query String s Inbound Data Return Result GET lt diskGroup gt PUT lt diskGroup gt lt ResponseStatus gt Notes diskGroup XML Block lt diskGroup version 1 0 xmins http www isapi org ver20 XMLSchema gt lt id gt lt req xs string id lt id gt lt videolnputChannellDList gt lt req gt lt videolnputChannellD gt lt opt xs string id gt lt videolnputChannellD gt lt videoInputChannelIDList gt lt diskGroup gt 20 15 ISAPI ContentMgmt Storage extension URI ISAPI ContentMgmt Storage extension Type Resource Function Get or set the configuration information of network extension Methods Query String s Inbound Data Return Result GET lt storageExtension gt PUT lt storageExtension gt lt ResponseStatus gt Notes BondList XML Block 2009 2014 by HIKVISION All rights reserved 86 lt storageExtension version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt LoopEnable gt lt opt xs boolean gt lt LoopEnable gt lt enableDormant gt lt
73. ition follows 5 1 1Source Support XML Schema Definition XSD File cmSourceSupport xsd This schema definition is basically a list of elements that define the types of IP media devices that are supported or are compatible with a RaCM device The first element is a count of the number of IP media device models i e MediaDeviceModel entries that are listed in a CMSourceSupport document instance This is important since the size of the schema can be huge in some cases and due to the fact that consumers can ask for only the count of the supported media devices see following section Please note that each list element which has one manufacturer value can support multiple model numbers strings per that manufacturer value The manufacturer name can also identify standards organizations not specific manufacturers 5 1 2Access and Operation of Source Support The REST URI structure of the ISAPI ContentMgmt sourceSupport resource allows consumers to ask for portions or all of the schema document information see table in above Section 8 4 A consumer accessing source support by a simple GET to the ISAPI ContentMgmt sourceSupport resource will get the entire data list of all supported IP media devices in the CMSourceSupport schema instance However due to the fact that the size of this XML list could be prohibitively large RaCM devices MUST support the following options for getting portions of the source supp
74. k based output media connection output identifier e Track A recorded channel Since input characteristics may change over time tracks are the virtual containers for recorded content associated with a channel Channels may be extant or extinct with respect to a track That is why tracks are separate from channels Channels are mapped to tracks for recording The following diagram depicts the relationships between the streams channels and tracks RaCM Terminology Relationships Client Application N EE NYA NZ IP Media Device So SV Aa Source GUID X NG io VA A LL NG Zac N A Wa NG Input Channel i mapped to Track n aa at ier Pia eel lle IP Media Device advertises its Streams by channels Based on configuration the RaCM device selects the IPMD s stream channel ID i which is indigenous to the IP Media Device This input stream becomes Channel m on the RaCM device since it has multiple inputs for this particular live stream Via configuration it is mapped to track n for recording The track ID n may or may not be equal to m When a client requests a live stream from the RaCM device it uses the advertised Channel ID m When it requests a stream from the archived track it uses the Advertised track ID n 3 3 XML Reserved Characters Within an XML document some characters are reserved for language use If these characters appear in data values they should b
75. kvison com Class Type Attribute LID TransID Local ID Transaction ID Alarm alarmin alarm in port alarmOut alarm out port motionStart video input port motionStop video input port hideStart video input port hideStop video input port vcaStart video input port vcaStop video input port lineDetectionStart video input port lineDetectionStop video input port fieldDetectionStart video input port fieldDetectionStop video input port 2009 2014 by HIKVISION All rights reserved 47 audiolnputExceptionStart video input port audiolnputExceptionStop video input port soundintensityMutationStart video input port soundintensityMutationStop video input port faceDetectionStart video input port faceDetectionStop video input port defocusDetectionStart video input port defocusDetectionStop video input port sceneChangeDetectionStart video input port sceneChangeDetectionStop video input port Exception videoLost video input port videoException video input port videoFormatMismatch video input port illlegealAccess hdError hdFull netBroken recordError video input port ipcDisconnect video input port ipclpConfilict video input port ipConflict video input port poePowerException video input port Operation devicePowerOn
76. l is used to identify remote media stream which if from an IPMD should come from the remote device s ISAPI Streaming channels lt id gt Resource The term channel is used as a guiding principle and logical construct e Track Virtual storage container for a set of contents e g VIDEO AUDIO METADATA etc Channels and tracks are kept separate to allow the ability to mix and match channels totracks RESTRICTION At this time a Track s configuration contains only 1 lt SourceDescriptor gt which is intended to describe the source for the recorded media stream This media stream will be construed as the equivalent of the input channel for the track which means that each Track can only record one input stream The media stream however can be Multi Media if the source delivers such a stream to be found at the lt SrcUrl gt as is the case with IPMD e Source Any input media device is a source whether the input is a hardware oriented port e g NTSC PAL audio input jack etc or an IP based media device All sources are identified by ISO IEC 9834 8 2005 128 bit UUIDs GUIDs to guarantee uniqueness within any given system Using the RaCM nomenclature specified herein sources send their data to RaCM devices on via streams which are mapped to channels Channels are handles used to identify the specific input streams for a RaCM device Channels that are recorded are then mapped onto tracks for
77. l rights reserved 59 lt streamTransMode gt lt req xs string UDP gt lt streamTransMode gt lt streamPort gt lt req xs integer gt lt streamPort gt lt streamPath gt lt req xs string gt lt streamPath gt lt streaming gt lt streamingList gt 12 5 ISAPI ContentMgmt InputProxy channels URI ISAPI ContentMgmt InputProxy channels Type Resource Function Access dynamical video input channels Methods Query String s Inbound Data Return Result GET None lt InputProxyChannelList gt PUT lt InputProxyChannelList gt lt ResponseStatus gt POST lt InputProxyChannel gt lt ResponseStatus gt Notes Dynamical video inputport can be created or deleted InputProxyChannelList XML Block lt InputProxyChannelList version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt InputProxyChannel gt lt opt gt lt InputProxyChannelList gt 12 6 ISAPI ContentMgmt InputProxy channels status URI ISAPI ContentMgmt InputProxy channels status Type Resource Function Access dynamical video input channels status Methods Query String s Inbound Data Return Result GET None lt InputProxyChannelStatusList gt Notes InputProxyChannelStatusList XML Block lt InputProxyChannelStatusList version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt InputProxyChannelSta
78. lays Type Resource 2009 2014 by HIKVISION All rights reserved 63 Function Configure and access text and image overlays Methods Query String s Inbound Data Return Result GET lt VideoOverlay gt PUT lt VideoOverlay gt lt ResponseStatus gt DELETE lt ResponseStatus gt IP media devices can overlay additional information on the encoded video stream Notes These overlays can be either text information or a set of images Overlays are composited together in ID order when displayed in the video VideoOverlay XML Block refer to IPMD 12 12 1 InputProxy channels lt ID gt video overlays text URI EE ME gto AS ER Type Basgured Function Access and configure text overlays for a particular video channel Methods Query String s Inbound Data Return Result GET lt TextOverlayList gt PUT lt TextOverlayList gt lt ResponseStatus gt POST lt TextOverlay gt lt ResponseStatus gt DELETE lt ResponseStatus gt Notes A set of text overlays ismanaged They are composited over the video signal in increasing ID order TextOverlayList XML Block refer to IPMD 12 12 2 InputProxy channels lt ID gt video overlays text lt ID gt URI ISAPI ContentMgmt InputProxy channels D video overlays Type Resource Itext ID Function Access and configure a particular text overlay for a video channel
79. lt GET lt hik IOProxyOutputPortList gt PUT lt hik IOProxyOutputPortList gt lt ResponseStatus gt 2009 2014 by HIKVISION All rights reserved 71 POST lt hik IOProxyOutputPort gt lt ResponseStatus gt Notes IOProxyOutPortList XML Block lt IOProxyOutputPortList version 1 0 xmins http www isapi org ver20 XMLSchema gt lt lOProxyOutputPort gt lt opt gt lt IOProxyOutputPortList gt 13 6 ISAPI ContentMgmt IOProxy outputs ID URI ISAPI ContentMgmt IOProxy outputs ID Type Resource Function Access the particular dynamic output port Methods Query String s Inbound Data Return Result GET lt hik IOProxyOutputPort gt PUT lt hik IOProxyOutputPort gt lt ResponseStatus gt DELETE lt ResponseStatus gt Notes IOProxyOutputPort XML Block lt lOProxyOutputPort version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt id gt lt req xs string gt lt id gt lt lODescriptor gt lt req gt lt PowerOnState gt lt req gt lt defaultState gt lt req xs string high low gt lt defaultState gt lt outputState gt lt req xs string high low pulse gt lt outputState gt lt pulseDuration gt lt dep xs integer milliseconds gt lt pulseDuration gt lt PowerOnState gt lt name gt lt opt xs string gt lt name gt lt IOP
80. ms to clients and other multimedia consumers as a proxy server these streams must also be provided in an ISAPI compliant manner The requirements for multimedia streaming are specified in the ISAPI IP Media Device API Specification These sections of the IP Media Device specification cover just live streaming Additionally a RaCM device has the ability to stream recorded data Due to these unique functional differences the following exceptions qualifications and additions to the IP Media Device specification 11 1 Streaming URIs 11 1 1 Live Streams The IP Media Device specification specifies the following URI structure for a client consumer to initiate and RTSP Streaming session rtsp lt addr gt lt port gt ISAPI Streaming Channels lt id gt This is compatible with channel definitions for RaCM devices as well All input streams port or network based are mapped to RaCM device channels identified by channel IDs Each track in its configuration information also contains the corresponding channel ID for its input stream So channel IDs can be obtained by reading track configuration information see ISAPI ContentMgmt record tracks Recording Session Configuration rtsp 10 1 2 55 ISAPI Streaming channels 701 In the above example a client desires to retrieve an RTSP description of channels 701 Please note that this RTSP URI construct will only work for the RTSP DESCRIBE message method 11 1 2 Archiv
81. municated 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 2 HIK VISION Content 1 IntOdUELDR EES i 7 2 CoNo AOE ee ee ene 7 3 Glossary and Relationship maa AA 7 3d Glossary ON ii EE OR OR AA EN 7 3 2 Relationship of Entities and Terminology iese i 8 3 3 XML Reserved Characters si SESSE ANAN 8 4 General Rules and Guidelines iaia aaa 9 4 1 DVR amp NVR Design Considerations aa 9 4 2 Input Source Management Remote Camera Configuration 11 5 ContentMgmt BasesSsenvico a a a lai 13 8 1 ISAPICOontentiMgmisourceSUppolt aaa a ions 13 5 1 1 Source Support XML Schema DefinitioN Re 15 5 1 2 Access and Operation of Source Support 15 6 ISAPI GonteniMgmit Capabililleg iii 19 7 ISAPI ConteniMgmt record cani 21 7 14 SAPI ContentMgmt record storageMOuUnts iii 21 7 2 ISAPIContentMgmtrecord p
82. nd transparency information Notes In order to enable image overlay an image must have been previously uploaded to the device using the ISAPI System Video overlayImages command ImageOverlay XML Block please refer to IPMD 12 13 ISAPI ContentMgmt InputProxy channels lt ID gt video pri vacyMask URI ER ER AA UA Type Pescia Access and configure privacy masking Function 2009 2014 by HIKVISION All rights reserved 65 Methods Query String s Inbound Data Return Result GET lt PrivacyMask gt PUT lt PrivacyMask gt lt ResponseStatus gt Notes Privacy masking can be enabled and the region list configured per channel PrivacyMask XML Block please refer to IPMD 12 13 1 InputProxy channels lt ID gt video privacyMask regi ons URI ISAPI ContentMgmt InputProxy channels D Video privacyMask regions Type Resource Function Access and configure privacy mask regions Methods Query String s Inbound Data Return Result GET lt PrivacyMaskRegionList gt PUT lt PrivacyMaskRegionList gt lt ResponseStatus gt POST lt PrivacyMaskRegion gt lt ResponseStatus gt DELETE lt ResponseStatus gt Privacy masking consists of a set of regions that are combined to grey or black out Notes areas of a video input PrivacyMaskRegionList XML Block please refer to IPMD 12 13 2 InputProxy channels lt
83. ng e endtime This parameter tag indicates that it will be followed by an ISO 8601 time stamp indicating the ending time the consumer desires to be the termination point for a media stream This parameter field is optional If it is not present the stream is to proceed from the start time until the session is manually terminated or paused by the consumer The format of the time stamps is ISO 8601 as specified in Section 3 7 of RFC 2326 Absolute Time This format is almost identical to XML dateTime except there are no dashes to separate the fields Basically the format is YYYYMMDD T HHmmSS fraction Z where Y year M month D day T is the time separator H hour m minutes S seconds and Z is the optional field indicating Zulu GMT time A time stamp example is 20130526T134258Z which represents May pel 2013 at 1 42 58 PM GMT Given the above formatting information a client using RTSP session management would append the time stamps to the end of its URI either track or source based as a way of designating the target timeframe associated with a streaming session A track based example follows rtsp 10 1 2 39 554 ISAPI Streaming tracks 18 starttime 20130731T092241Z amp endtime 20130731T 093000Z In the above example a requester desires to describe setup play a media stream that spans the time range on July 31 a 2013 from 9 22 48 AM GMT to 9 30AM GMT The appending of timestamps as parameters to a URI reque
84. ng s Inbound Data Return Result GET lt diskQuotaList gt Notes diskQuotaList XML Block lt diskQuotaList version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt diskQuota gt lt opt gt lt diskQuota gt lt diskQuotaList gt 20 11 ISAPI ContentMgmt Storage quota lt ID gt URI ISAPI ContentMgmt Storage quota lt ID gt Type Resource Function Manage specify channel quota Methods Query String s Inbound Data Return Result GET lt diskQuota gt 2009 2014 by HIKVISION All rights reserved 84 PUT lt diskQuota gt lt ResponseStatus gt Notes diskQuota XML Block lt diskQuota version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt id gt lt req xs integer channel gt lt id gt lt useVideoQuota gt lt ro integer MB gt lt useVideoQuota gt lt usePictureQuota gt lt ro integer MB gt lt usePictureQuota gt lt totalDiskVolume gt lt ro integer MB gt lt totalDiskVolume gt lt videoQuota gt lt req integer MB gt lt videoQuota gt lt pictureQuota gt lt opt integer MB gt lt pictureQuota gt lt type gt lt opt xs string volume ratio gt lt type gt absent ratio otherwise volume lt videoQuotaRatio gt lt dep integer 0 100 percentage gt lt videoQuotaRatio gt lt pictureQuotaRatio gt l
85. ntMgmt StreamingProxy ISAPI ContentMgmt sourceSupport identifies which mode of management and level of interoperability a RaCM device provides for each advertised camera encode device it claims support for see ISAPI ContentMgmt sourceSupport Fundamentally ISAPI ContentMgmt sourceSupport resource provides a list of IP cameras and encoders by manufacture and model that are supported i e compatible along with the management mode for each 2009 2014 by HIKVISION All rights reserved 12 HIKVISION 5 ContentMgmt Base Service The ContentMgmt base service is the root for all Recording and Content Management RaCM device function related to the recording and management of multimedia data This service is the base node in the REST resource hierarchy for all active functions provided by a RaCM device As mentioned in the previous section the RaCM device must also comply with the ISAPI Service Model specification and also implement the required IPMD Services 5 1 ISAPI ContentMgmt sourceSupport For RaCM devices that support external IP cameras and encoders as input devices the sourceSupport REST resource MUST be supported in order to advertise the types and models of devices that a unit is compatible with Section Input Source Management of this specification describes the management modes a RaCM device may support for managing external IP input sources GETS from the ISAPI ContentMgmt sourceSuppor
86. ny implementation is free to return an error for that operation if that capability is undesirable Notes Low level drive configuration should be done through ISAPI System storage This resource manages the lt MountList gt XML object and follows the same scheme used for lt TrackList gt manipulation and other similar examples from IPMD that manage a list based XML resource see ISAPI REST List Entry lt id gt Creation method below As such GET and PUT methods are used to access the entire lt MountList gt POST is used with a dummy lt id gt of 0 to create an individual entry within the list where the newly created lt id gt is returned in the lt ResponseStatus gt given for the POST request Once an lt Mount gt entry is created it can be accessed by its lt id gt using this resource 2009 2014 by HIKVISION All rights reserved 21 HIK VISION URI ISAPI ContentMgmt record storageMounts lt id gt Type Resource Description of the REST method parameters and formats available to access a single Function Mount gt entry Methods Query String s Inbound Data Return Result GET None None lt Mount gt PUT None lt Mount gt lt ResponseStatus gt POST N A N A lt ResponseStatus w error code gt DELETE None None lt ResponseStatus gt POST i e Create is not allowed for individual lt Mount gt entry with given explicit lt id gt Notes Example
87. oding G 726 ITU G 726 ADPCM audio codec format bitrate advertised by SDP or XML G 723 1 ITU G 723 1 audio codec format G 728 ITU G 728 audio codec format G 722 G 722 1 G 722 2 ITU G 722 1 2 audio codec formats SB ADPCM G 728 ITU G 728 LD CELP audio codec format G 729 G 729 1 ITU G 729 1 CS ACELP audio codec format MP3 MPEG 1 Layer 3 audio codec format AAC MPEG 2 4 Advanced Audio Codec format Video Codecs MPEG4 SP ISO IEC 14496 2 MPEG 4 Simple Profile MPEG4 ASP ISO IEC 14496 2 MPEG 4 Advanced Simple Profile MPEG4 MP ISO IEC 14496 2 MPEG 4 Main Profile H 264 BP ISO IEC 14496 10 ITU H 264 Baseline Profile H 264 MP ISO IEC 14496 10 ITU H 264 Main Profile H 264 HP ISO IEC 14496 10 ITU H 264 High Profile H 264SVC BP ISO IEC 14496 10 ITU H 264 Scalable Video Codec SVC Baseline Profile encoding Must read s props p props and SDP for embedded stream info H 264SVC MP ISO IEC 14496 10 ITU H 264 Scalable Video Codec SVC Main Profile encoding Must read s props p props and SDP for embedded stream info MPEG2 MP ISO IEC 13818 MPEG 2 Main Profile MJPEG Motion version multi frame of ISO IEC JPEG video encoding see below JPEG ISO IEC 10918 JPEG video encoding JPEG2000 ISO IEC 154 2009 2014 by HIKVISION All rights reserved 89
88. ontentMgmt InputProxy channels D video tamperDetecti Type Resource on regions Function Access the list of regions for tamper detection on a particular video input channel Methods Query String s Inbound Data Return Result GET lt TamperDetectionRegionList gt PUT lt TamperDetectionRegionList gt lt ResponseStatus gt POST lt TamperDetectionRegion gt lt ResponseStatus gt DELETE lt ResponseStatus gt Notes TamperDetectionRegionList XML Block please refer to IPMD 12 14 2 InputProxy channels lt ID gt video tamperDetection regions lt ID gt URI ISAP Custom SelfExt TamperDetection channels D regions D Type Resource Function ISAPI ContentMgmt InputProxy channels D video tamperDetection region ID Methods Query String s Inbound Data Return Result GET lt TamperDetectionRegion gt 2009 2014 by HIKVISION All rights reserved 67 PUT lt TamperDetectionRegion gt lt ResponseStatus gt DELETE lt ResponseStatus gt Notes Region coordinates are dependent on video resolution Regions will be drawn from the coordinates provided in a top down fashion At least three lt RegionCoordinates gt blocks must be provided for a single lt TamperDetectionRegion gt block Ordering of lt TamperDectectionRegion gt blocks is insignificant TamperDetectionRegion XML Block please refer to IPMD 12 15 ISAPI ContentMgmt InputProxy ch
89. opt xs boolean gt lt enableDormant gt lt packDuration gt lt opt xs int unit is minutes lt packDuration gt lt storageExtension gt 2009 2014 by HIKVISION All rights reserved 87 21 ISAPI ContentMgmt download Type Resource URI ISAPI ContentMgmt download Function Down load a special record segment Methods Query String s Inbound Data Return Result GET lt downloadRequest gt Record data PUT lt downloadRequest gt lt ResponseStatus gt Playback URI is returned by the search service In the url there may be some Notes information about the name or size of the segment For example rtsp lt host gt Streaming tracks lt id gt name track1segment1 amp size 1024B downloadRequest XML Block lt downloadRequest version 1 0 xmIns http http www isapi org ver20 XMLSchema gt lt playbackURI gt lt req xs string gt lt playbackURI gt lt downloadRequest gt 2009 2014 by HIKVISION All rights reserved 88 22 Appendix A Codec Type Dictionary The Codec Tag s below represent the literal ASCII strings employed to identify the specific codec standards listed below Codec Tag Literal Codec Tag Description Audio Codecs G 711 ITU G 711 PCM audio codec format a u law determined by SDP or XML G 711a ITU G 711 PCM audio codec format a law encoding G 711u ITU G 711 PCM audio codec format u law enc
90. orage nas lt ID gt formatStatus 83 ISAPI ContentMgmt Storage nas search iii 83 ASAPV ContentMgmt Storage Quota nine 84 ISAPI ContentMgmt Storage quota lt ID gt ees ee Re ee ee 84 ISAPI ContentMgmt Storage extract iese ese ee ee ee ee ee ee ee ee 85 ISAPI ContentMgmt Storage diskGroUp iii 85 ISAPI ContentMgmt Storage diskGroup lt ID gt iii 86 2009 2014 by HIKVISION All rights reserved 5 HIKVISION 20 15 ISAPI ContentMgmt Storage extension ii 86 21 ISAPIWConieniMgmidewnlbadi ili 88 22 Appendix A Codec Type Dictionary 89 2009 2014 by HIKVISION All rights reserved 6 HIKVISION 1 Introduction This document specifies an interface that enables physical security and video management systems to communicate with a Recording and Content Management RaCM device in a standardized way 2 Conformance The RaCM Device will host ISAPI compliant services and adhere to the ISAPI Service Model 3 Glossary and Relationship 3 1 Glossary of Terms e Channel Handle tag for an input source port or stream see IPMD spec for usage For DVR channel is the identifier or handle used to identify a local input stream which may also be accessible to remote entities via a local ISAPI Streaming channel lt id gt Resource The stream may contain Video Audio and or Metadata For NVR channe
91. ort information without requiring the entire data set There are two query parameters that can be added to the REST URI for getting portions of the overall information set They are e send The send designator identifies that the consumer only wants a portion of the overall source support information A value is supplied with the send string as an NVP that designates the portion 2009 2014 by HIKVISION All rights reserved 15 HIKVISION of the information to be sent This is discussed in more detail below e mfgr The data designator specifies a filter for the information to be returned Basically a consumer specifies what type of information it is looking for This is described in detail below Please note that the send and mfgr query parameters are mutually exclusive they cannot be used in the same HTTP REST GET message since they each counter actively affect what and how much of the source support information is returned by a RaCM device Consumers of source information are to use these query string parameters to govern the amount of source information that is transferred since this information base can be very large Each of the query string parameters is described below in detail 5 1 2 1 send Query String Parameter The send query string parameter QSP enables consumers to specify or control in a coarse manner the amount of source support information that they desire
92. ow the implementation may actually store the archived media on disk The track is generally accessed or referred to by its lt id gt The lt Stream gt number is a logical outbound streaming channel number for the track and is not tightly coupled to the lt id gt which is treated as an index into the lt TrackList gt Note on GUIDs All UUIDs GUIDs MUST be universally unique They can be assigned by a central VMS Server or GUID broker or auto generated locally However all UUIDs GUIDs MUST be compliant with the ISO IEC 9834 8 ITU X 667 formats and definitions Note on Recording Modes Currently those recording modes are defined CMR Continuous Mode Recording which implies recording media as it is available EDR Alarm or Motion Driven Recording which implies recording media when VO alarms or video motion are detected ALARM alarm Driven Recording which implies recording media when VO alarms are detected MOTION alarm or motion Driven Recording which implies recording media when io alarms or video motion are detected ALARMANDMOTION alarm or motion Driven Recording which implies recording media when VO alarms or video motion are detected COMMAND alarm or motion Driven Recording which implies recording media when I O alarms or video motion are detected SMART SMART Event Driven Recording which implies recording media when intelligent events are detected or triggered Track Size Th
93. rations of customProtocols Query None Inbound Data customProtocolList Success ResponseStatus Return Notes customProtocalList XML Block lt customProtocolList version 1 0 xmins http www isapi org ver20 XMLSchema gt lt customProtocol gt lt opt gt lt customProtocolList gt 12 4 1 ISAPI ContentMgmt InputProxy customProtocols lt ID gt ISAPI ContentMgmtlnputProxy customProtocols ID aah 9G GET Description It is used to get the configurations of customProtocols Query None Inbound Data None Success customProtocol Return PUT Description It is used to set the configurations of customProtocols Query None Inbound Data CustomProtocol Success ResponseStatus Return Notes customProtocol XML Block lt customProtocol version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt id gt lt req xs string gt lt id gt lt protocalName gt lt req xs string gt lt protocalName gt lt streamingList gt lt req gt lt streamingList gt lt customProtocol gt streamingList XML Block lt streamingList gt lt streaming gt lt opt gt lt id gt lt req xs string gt lt id gt lt enableStream gt lt req xs boolean gt lt enableStream gt lt streamProType gt lt req xs string RTSP gt lt streamProType gt 2009 2014 by HIKVISION Al
94. recording See the following diagram for more details Within the RaCM Device such sources are not explicitly configured These logical sources are visible Read Only fashion via the ISAPI ContentMgmt status sources Resource It is also possible to search based on these sources via ISAPI ContentMgmt search Resource e Metadata All streaming data except video and audio This includes events alarms etc e URI A virtual path that specifically identifies a REST resource this path must follow the 2009 2014 by HIKVISION All rights reserved 7 HIK VISION service resource hierarchy see ISAPI Service Model specification Segment A general term addressing a single contiguous portion of a media track or in some cases a stream Basically a media clip that is less than the whole of a respective media track or stream yet is individually accessible via one of the mechanisms specified in this document 3 2 Relationship of Entities and Terminology Below are the basic relationships between the terms defined above e Source The device is the original point for input to a RaCM device This is usually a camera an encoder video and or audio or a metadata generator All devices have their own ISO IEC 9834 8 ITU X 667 128 bit UUID GUID as their based identity e Channel Incoming media stream input identifier This is a handle identifier for a specific input stream e Stream In general a networ
95. rmation using a structured extension mechanism The schema is described below 7 2 1 ISAPI ContentMgmt record profile Schema Definition XSD File cmRecordProfile xsd RaCM devices list the track types they support which affects the configuration characteristics of the tracks i e polymorphic tracks can have video and audio sources mixed for example whereas standard tracks contain only one form of media data For vendors that desire to add their own track type extensions this is provided for in the schema with the following conditions 2009 2014 by HIKVISION All rights reserved 23 HIK VISION All RaCM devices MUST support at least one of the sanctioned track types standard polymorphic polytemporal Any custom track type extensions must be in addition to this requirement This is to ensure that all RaCM have a base level of interoperability All custom extensions listed in a CMRecordProfile MUST have the following contents o Thelisted track type of other for the custom extended track type o In the profileExtension element o A URI link to where the formal definition of the extension information can be accessed o A brief description embedded in the document instance of what the extension information means o The extension information itself 7 3 IISAPI ContentMgmt record tracks This REST interface is used to configure a recording session or track A track is treated virtually with regards to h
96. rofile aaa 23 7 2 1 ISAPI ContentMgmt record profile Schema Definition 23 7 8 ASAPI ContentMgmt record tracks cilea 24 7 3 1 Custom Configuration Data Extensions 25 7 3 2 ISAPI REST List Entry lt id gt Creation method n 25 7 33 Streaming URL implied in lt Track gt configuration 25 734 Recording Source Description asili 25 7 3 5 Recording Schedule overview 25 7 3 6 Track Description NVP ii 26 7 3 7 ISAP I ContentMgmt record tracks iese ese esse see ee ee ee ee 28 7 3 8 ISAPI ContentMgmt record tracks lt id gt 28 7 3 9 Example Track Creation Message Exchange 29 7 3 10 Track List CR 31 7 3 11 ISAPI ContentMgmt record tracks lt id gt dailyDistribution 32 74 SAPWContentMgmtrecord control aiar 32 74 1 ISAPI ContentMgmt record control manual start tracks lt ID gt 32 742 ISAPIContentMgmt record control manual stop tracks lt ID gt 34 743 ISAPI ContentMgmt record control lOCkS ee ee Re ee 34 8 ISAPl ConteniMgmi search allea 36 8 1 ISAPI ContentMgmt search profile i 36 8 1 1 ISAPI ContentMgmt search profile Schema Definition 37 82 JISAPIGomeniMgmisearchi sla 37 2009 2014 by HIKVISION All rights reserved 3 HIK VISION 8 2 1 Search Query Parameter Schema Definition
97. roxyOutputPort gt 13 7 ISAPI ContentMgmit IOProxy outputs ID trigger URI ISAPI ContentMgmt IOProxy outputs ID trigger Type Resource Function Manually trigger an dynamical output port Methods Query String s Inbound Data Return Result PUT guipukjate lt lOPortData gt lt ResponseStatus gt pulseDuration 2009 2014 by HIKVISION All rights reserved 72 Notes Either the inbound data or query string values are used The IO output port is toggled to a high or low signal accordingly If the lt outputState gt refers to pulse then the lt pulseDuration gt tag must be provided and the output port will be triggered to the specified state for the duration specified by lt pulseDuration gt IOPortData XML Block please refer to IPMD 13 8 ISAPI ContentMgmt IOProxy outputs ID status URI ISAPI ContentMgmt IOProxy outputs ID status Type Resource Function Query the status of a dynamic output port Methods Query String s Inbound Data Return Result GET lt lOPortStatus gt Notes See ISAPI ContentMgmt IOProxy status for an explanation of the fileds IOPortStatus XML Block please refer to IPMD 14 ISAPI ContentMgmt ZeroVideo URI ISAPI ContentMgmt ZeroVideo Type Service Methods Query String s Inbound Data Return Result Notes Zero Video service 14 1 ISAPI ContentMgmt ZeroVideo channels U
98. ry Strin s Inbound Data Return Result GET None None lt Track gt PUT None lt Track gt lt ResponseStatus gt POST N A N A lt ResponseStatus w error code gt 2009 2014 by HIKVISION All rights reserved 28 DELETE None None lt ResponseStatus gt 7 3 9Example Track Creation Message Exchange A Client attempts track creation with POST ISAPI ContentMgmt record tracks containing lt xml version 1 0 encoding UTF 8 gt lt Track version 1 0 xmins http www isapi org ver20 XMLSchema gt lt new dummy value gt lt id gt 0 lt id gt lt Channel gt 12345 lt Channel gt lt Enable gt true lt Enable gt lt Description gt trackType standard sourceTag AXIS210a contentType video codecType MPEG 4 SP resolution 640x480 framerate 20 0 bitrate 6000 kbps lt Description gt lt TrackGUID gt A01AAAAA BBBB CCCC DDDD 033595353625 lt TrackGUID gt lt Size gt 4000000000 lt Size gt lt Duration gt P10DT15H lt Duration gt lt DefaultRecordingMode gt CMR lt DefaultRecordingMode gt lt LoopEnable gt true lt LoopEnable gt lt REST OF OBJ NOT INCLUDED gt lt Track gt B If creation is successful RaCM Device responds with lt xml version 1 0 encoding UTF 8 gt lt ResponseStatus version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt requestURL gt ISAPI ContentMgmt record tracks lt requestURL gt lt statusCode gt 1 lt statusCo
99. st line is pertinent for all URIs even those returned by the SearchResponse since a requester may not desire an entire time segment Please reference RFC 2326 for more details on URI and parameter formats 2009 2014 by HIKVISION All rights reserved 53 11 2 Playback 11 2 1 Use of RTSP The replay protocol is based on RTSP RFC 2326 In addition we make the following stipulations on the usage of RTSP 1 Interleaved mode RFC 2326 section 10 12 MUST be supported by the RACM DEVICE 2 Clients should use either interleaved mode or RTP TCP if supported 3 The RACM DEVICE MAY elect not to send RTCP packets during replay In typical usage at least with an ONVIF aware client RTCP packets are not required because usually a reliable transport will be used and because absolute time information is sent within the stream making the timing information in RTCP sender reports redundant 11 2 2 Initiating Playback Playback is initiated by means of the RTSP PLAY method For example PLAY rtsp 192 168 0 1 path to recording RTSP 1 0 CSeg 123 Session 12345678 Range clock 20090615T114900 440Z Rate Control no Reverse playback is indicated using the Scale header field with a negative value For example to play in reverse without any data loss a value of 1 0 would be used PLAY rtsp 192 168 0 1 path to recording RTSP 1 0 CSeg 123 Session 12345678 Range clock 20090615T114900 440Z Rate Control no Scale 1 0 1
100. t Track Creation POST Create will expect as HTTP Payload an individual lt Track gt object instead of the lt TrackList gt For the Create operation the lt id gt tag within the lt Track gt XML must contain a dummy value of 0 zero To lessen possibility for ambiguity it is not permissible for the Client xMS to set the lt id gt during track creation though it is possible for the Client to update PUT the entire lt TrackList gt with each entry containing valid lt id gt s already set by the target This is in alignment with other such list based REST Resources in IPMD Reference Example lt ResponseStatus gt from Service Model Specification lt xml version 1 0 encoding UTF 8 gt lt ResponseStatus version 1 0 xmins http www isapi org ver20 XMLSchema gt lt requestURL gt Streaming Channels lt requestURL gt lt statusCode gt 1 lt statusCode gt lt O 1 OK 2 Device Busy 3 Device Error 4 Invalid Operation 5 Invalid XML Format 6 Invalid XML Content 7 Reboot Required gt lt statusString gt OK lt statusString gt lt ID gt 1 lt ID gt lt ResponseStatus gt 7 3 8 ISAPI ContentMgmt record tracks lt id gt Once created individual Tracks are managed via URI ISAPI ContentMgmt record tracks lt id gt Type Resource as eats Basic Function _ Resource to address Read Update single lt Track gt by lt id gt Methods Que
101. t dep 0 100 percentage gt lt pictureQuotaRatio gt lt totalVideoVolume gt lt ro integer MB gt lt useVideoQuota gt lt totalPictureVolume gt lt ro integer MB gt lt usePictureQuota gt lt freeVideoQuota gt lt ro integer MB gt lt useVideoQuota gt lt freePictureQuota gt lt ro integer MB gt lt usePictureQuota gt lt diskQuota gt 20 12 ISAPI ContentMgmt Storage extract URI ASAPI ContentMgmt Storage extract Type Resource Function Manage specify channel extract Methods Query String s Inbound Data Return Result GET lt diskExtract gt PUT lt diskExtract gt lt ResponseStatus gt Notes diskExtract XML Block lt diskExtract version 1 0 xmIns http www isapi org ver20 XMLSchema 5 lt nomalVideoPercent gt lt req integer 0 100 gt lt nomalVideoPercent gt lt extractVideoPercent gt lt req integer 0 100 gt lt extractVideoPercent gt lt picturePercent gt lt opt integer 0 100 gt lt picturePercent gt lt diskExtract gt 20 13 ISAPI ContentMgmt Storage diskGroup URI ASAPI ContentMgmt Storage diskGroup Type Resource Function 2009 2014 by HIKVISION All rights reserved 85 Methods Query String s Inbound Data Return Result GET lt diskGroupList gt Notes diskGroupList XML Block lt d
102. t resource return a schema that describes the manufacturers makes and models of IP media devices that a RaCM device is compatible with The following table provides the base details for the sessionSupport resource 2009 2014 by HIKVISION All rights reserved 13 HIKVISION ISAPI ContentMgmt sourceSupport General Resource v1 0 Description of the IP media devices in mfgr make and model that a RaCM Pees allen devices supports as input sources Query Optional send head send top send middle send bottom or mfgr lt mfgrName gt Inbound Data None Success Return lt CMSourceSupport gt Notes The schema and element definitions for this resource follow Example XML lt xml version 1 0 encoding UTF 8 gt lt CMSourceSupport version 1 0 xmins http www isapi org ver20 XMLSchema gt lt mediaDeviceListSize gt 8 lt mediaDeviceListSize gt lt supportedMediaDeviceSourceList gt lt MediaDeviceSource gt lt MediaDeviceMfgr gt HIKVISION lt MediaDeviceMfgr gt lt MediaDeviceMgmtMode gt Proxy lt MediaDeviceMgmtMode gt lt MediaDeviceModel gt DS 2CD876MF lt MediaDeviceModel gt lt MediaDeviceModel gt DS 2CD877MF lt MediaDeviceModel gt lt MediaDeviceModel gt DS 2CD855MF lt MediaDeviceModel gt lt MediaDeviceSource gt lt MediaDeviceSource gt lt MediaDeviceMfgr gt ClearView lt MediaDeviceMfgr gt lt MediaDeviceMake gt MaxView Series lt Me
103. tion file is applied ImportErrorStatus XML Block lt ImportlpcCfgError version 1 0 xmins http www isapi org ver20 XMLSchema gt lt existError gt lt req xs boolean gt lt existError gt lt errorCode gt lt opt xs string chanNumReachLimit configOperating badDevType badLanguage importErrorData importFail gt lt errorCode gt lt lpcErrorList gt lt opt gt lt ImportlpcCfgError gt lt IpcErrorList version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt IpcError gt lt opt gt lt id gt lt req xs string gt lt id gt lt errorRowNo gt lt req xs integer gt lt errorRowNo gt error number lt errorType gt lt req xs string channelNolnvalid channelNoConflict channel IP Domain invalid channel IP Domain conflict channel IP conflict with local IP protocolError adminPortError channelError UserNamelnvalid passwordlnvalid transProtocalError gt lt errorType gt lt lpcError gt lt IpcErrorList gt 12 4 ISAPI ContentMgmt InputProxy customProtocols ISAPI ContentMgmt InputProxy customProtocols General Resource v2 0 GET Description It is used to get the configurations of customProtocols 2009 2014 by HIKVISION All rights reserved 58 Query None Inbound Data None Success customProtocolList Return PUT Description It is used to set the configu
104. to receive If the send QSP is not present when a GET to the ISAPI ContentMgmt sourceSupport resource is issued ALL the source support information will be returned in the CMSourceSupport schema instance In order to prevent data overrun the send QSP is provided such that the consumer can ask for the source support list information in chunks The amount and type of information is specified by the value tag supplied with the send QSP The value tags that can be supplied are listed below with descriptions Tag URI Example Description Value head GET This tag value indicates that the ISAPI ContentMgmt sourceSupport send head consumer only wants the returned schema instance to contain the count of the number of source support models in its list No element data should be returned This allows consumers to gauge the approximate size of the source support information base in total top GET This tag value indicates that the ISAPI ContentMgmt sourceSupport send top consumer wants the top 1 1314 roughly of the source support list RaCM devices receiving this QSP should provide approximately the first one third of the CMSourceSupport list middle GET This tag value indicates that the ISAPI ContentMgmt sourceSupport send middle consumer wants the middle 4 39 roughly of the source support list RaCM devices receiving this QSP should provide approximately the
105. tor gt lt online gt lt req xs boolean gt lt online gt lt supportCreateStream gt lt opt xs boolean gt lt streamingProxyChannelldList gt lt req gt lt streamingProxyChannelld gt lt req xs string id gt lt streamingProxyChannelld gt lt streamingProxyChannelldList gt lt relatedlOProxy gt lt opt gt lt inputProxyPortldList gt lt opt gt lt inputProxyPortld gt lt opt gt lt inputProxyPortldList gt lt outputProxyPortldList gt lt opt gt lt outputProxyPortld gt lt opt gt lt outputProxyPortldList gt lt relatedlOProxy gt lt chanDetectResult gt lt opt xs string connect overSysBandwidth domainError ipcStreamFail connecting chanNoError ipAddrConflictWithDev ipAddrConflicWithlpc errorUserNameOrPasswd netUnreachable unknownError notExist ipeStreamTypeNotSupport ipcResolutionNotSupport lt chanDetectResult gt lt InputProxyChannelStatus gt 12 11 ISAPI ContentMgmt InputProxy channels lt ID gt video URI ISAPI ContentMgmt InputProxy channels D video Type Recas Function Access the special dynamical video input Methods Query String s Inbound Data Return Result PUT None lt VideolnputChannel gt lt VideolnputChannel gt Notes 12 12 ISAPI ContentMgmt InputProxy channels lt ID gt video ov erlays URI ISAPI ContentMgmt InputProxy channels D video over
106. ts 9 ch streams the ninth stream should be 109 for the 99 ch stream of the channle100 the number should be10099 e Tracks will record from their respective lt SourceDescriptor gt s o Thus each active Track implicitly creates an input channel o In addition ISAPI ContentMgmt InputProxy channels can also be used to create an input channel It is recommended to use the service to create an input channel This service can also manage configure some corresponding paramters related with input channel such as image parameter compression parameter OSD Motion Detection and so on o The sid for these channels are determined by the RaCM Device automatically The above design items are described here to aid in providing commonality in the implementation of this specification and provide clarity for those developing to the interfaces defined herein Hybrid DVR NVR products must still follow the above guidelines for the onboard codec hardware that is present on their respective devices Please note that these design guidelines pertain to the definition and configuration of the video audio input hardware The information related to track configuration etc is addressed later in this document 2009 2014 by HIKVISION All rights reserved 10 HIKVISION 4 2 Input Source Management Remote Camera Configuration NVRs and hybrid DVRs support external IP network devices as their input sources These devices us
107. tus gt lt opt gt lt InputProxyChannelStatusList gt 12 7 SAPI ContentMgmt InputProxy channels lt ID gt URI ISAPI ContentMgmt InputProxy channels D Type P coure 2009 2014 by HIKVISION All rights reserved 60 Function Access dynamical input channel properties Methods Query String s Inbound Data Return Result GET lt InputProxyChannel gt PUT lt InputProxyChannel gt lt ResponseStatus gt DELETE lt ResponseStatus gt lt sourcelnputPortDescriptor gt creates channel by content from the tag lt adminProtocol gt protocol of the IPC Notes lt adminPort gt adminPOrt lt srcInputPort gt specify inputPort lt srcLogin gt username and password of the channel InputProxyChannel XML Block lt InputProxyChannel version 1 0 xmIns http www isapi org ver20 XMLSchema gt lt id gt lt req xs string id gt lt id gt lt name gt lt opt xs string gt lt name gt lt sourcelnputPortDescriptor gt lt req gt lt adminProtocol gt lt req xs string HIKVISION SONY ISAPI ONVIF gt lt adminProtocol gt lt addressingFormatType gt lt req xs string ipaddress hostname gt lt addressingFormatType gt lt hostName gt lt dep xs string gt lt hostName gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt ipv6Address gt lt dep xs string gt
108. ually IP cameras may or may not be ISAPI protocol compliant This specification does not require the external input sources to be ISAPI compliant in order to be supported by a RaCM device However within the industry there are different methods for managing the support for configuration and status of input IP media devices ISAPI RaCM devices must fall into one of two possible categories regarding the management of external IP media sources The management categories are listed below Management Mode Mode Description Simple This mode describes as RaCM device that manages track configuration but does not manage the settings related to video audio codecs and streaming at the external source camera encoder This means that management entities such as VMS applications are required to manage the settings on the RaCM devices and the external source devices separately l e the RaCM device does not change the settings on a source device when a codec or streaming related parameter is changed on a track A Simple RaCM device will attempt to open a new session to the respective source with the new codec streaming settings but it will NOT modify the codec streaming configuration settings on an external camera encoder In some cases this is sufficient since codec settings on some cameras can be modified on the fly via the session setup parameters in other cases the VMS management application will have to modify the codec streaming settings at
109. ulative number of results received by the inquirer In other words the searchResultsPosition is a walking index used to indicate where an inquirer desires the searching entity to resume the search Another optional search parameter that governs or conditions the search result contents is the contentTypeList This element allows one or more contentType designators These designators instruct the searching Content Manager to only provide matching result segments that correspond to the designated content types The supported content types are video audio metadata text mixed and other If a search specifies one or more content types the searching Content Manager will ignore matches to the search criteria if the content segment track does not match the specified content type s If a RaCM device supports raw text searches searches are allowed to pass in searchText as a search criteria but only for text and or metadata content types The following conditions and restrictions apply regarding text searching e The content type MUST be specified when conducting searches that involve text The applicable content types are text and metadata e There is an inherent limitation of one text string per search instance e The search string may not exceed 128 characters e ALL text searches are performed in a case insensitive manner such that any combination of upper and
110. vice For DVRs that support PTZ commands the ISAPI PTZ REST resources and services are to be implemented as outlined in IPMD where the PTZ capabilities in the IPMD specification are functionally compatible for the DVR device For DVRs and NVRs the ISAPI System REST resource hierarchies must be implemented as defined in PMD Sections for the configurable system based devices and VO capabilities network serial I O supported by a given RaCM device For DVRs the ISAPI Streaming Channels REST resource hierarchy for each hardware channel it supports The picture and requestKeyFrame resources are not required NVRs and hybrid DVRs must comply with the management guidelines outlined in the following Section regarding the management of external IP media devices All RaCM devices shall support the ISAPI System time REST resources for setting reporting local time on their devices unless they use a network domain controller to access network time Though the resource hierarchy described herein does cite specific resources in the IPMD and Service Model specifications it does not preclude RaCM device implementers from incorporating other ISAPI resources that are relevant The objective of this specification is to provide the design details and intent for the base protocol implementation 4 1 DVR 8 NVR Design Considerations Digital Video Recorder DVR devices have design issues unique to the
111. xyProtocol gt lt userName gt lt req wo xs string gt lt userName gt lt password gt lt req wo xs string gt lt password gt lt addressingFormatType gt lt dep gt lt reg xs enumeration ipaddress hostname gt lt addressingFormatType gt lt hostName gt lt dep xs string gt lt hostName gt lt ipAddress gt lt dep xs string gt lt ipAddress gt lt ipv6Address gt lt dep xs string gt lt ipv6Address gt lt managePortNo gt lt req xs integer gt lt managePortNo gt lt innerlOPortID gt lt req xs string id gt lt innerlOPortID gt lt any other protocol address gt lt lODescriptor gt lt triggering gt lt req xs string high low rising falling gt lt triggering gt lt name gt lt opt xs string gt lt name gt lt IOProxyInputPort gt 13 4 ISAPI ContentMgmt IOProxy inputs ID status URI ISAPI ContentMgmt IOProxy input ID status Type Resource Function Query the status of a dynamic input port Methods Query String s Inbound Data Return Result GET lt lOPortStatus gt Notes IOPortStatus XML Block please refer to IPMD 13 5 ISAPI ContentMgmt IOProxy outputs URI ISAPI ContentMgmt IOProxy outputs Type Resource Function Access dynamic input ports Methods Query String s Inbound Data Return Resu

Download Pdf Manuals

Related Search

Related Contents

COFFRE-FORT DE SECURITE EN ACIER  TVC Controller Hardware Setup Manual  P2P IPCamera - Electroimpulso  BEDIENUNGSANWEISUNG  Poulan 545186803 Chainsaw User Manual    PDF形式（6087KB）  Epson EB-X10  écoconso - nettoyer sans s`empoisonner    

Copyright © All rights reserved. Failed to retrieve file