common.xsd 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--W3C XML Schema generated by XMLSpy v2017 (x64) (http://www.altova.com)-->
  3. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tt="http://www.onvif.org/ver10/schema" xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2" targetNamespace="http://www.onvif.org/ver10/schema" elementFormDefault="qualified" version="19.06">
  4. <!--===============================-->
  5. <!-- Generic Types -->
  6. <!--===============================-->
  7. <xs:simpleType name="ReferenceToken">
  8. <xs:annotation>
  9. <xs:documentation>Unique identifier for a physical or logical resource.
  10. Tokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class.
  11. Length up to 64 characters.</xs:documentation>
  12. </xs:annotation>
  13. <xs:restriction base="xs:string">
  14. <xs:maxLength value="64"/>
  15. </xs:restriction>
  16. </xs:simpleType>
  17. <!--===============================-->
  18. <xs:complexType name="IntRange">
  19. <xs:annotation>
  20. <xs:documentation>Range of values greater equal Min value and less equal Max value.</xs:documentation>
  21. </xs:annotation>
  22. <xs:sequence>
  23. <xs:element name="Min" type="xs:int"/>
  24. <xs:element name="Max" type="xs:int"/>
  25. </xs:sequence>
  26. </xs:complexType>
  27. <!--===============================-->
  28. <!-- Start PTZ Related Types -->
  29. <!--===============================-->
  30. <xs:complexType name="Vector2D">
  31. <xs:attribute name="x" type="xs:float" use="required"/>
  32. <xs:attribute name="y" type="xs:float" use="required"/>
  33. <xs:attribute name="space" type="xs:anyURI" use="optional">
  34. <xs:annotation>
  35. <xs:documentation>
  36. Pan/tilt coordinate space selector. The following options are defined:<ul>
  37. <li> http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace</li>
  38. <li> http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace</li>
  39. <li> http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace</li>
  40. <li> http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace</li>
  41. </ul>
  42. </xs:documentation>
  43. </xs:annotation>
  44. </xs:attribute>
  45. </xs:complexType>
  46. <xs:complexType name="Vector1D">
  47. <xs:attribute name="x" type="xs:float" use="required"/>
  48. <xs:attribute name="space" type="xs:anyURI" use="optional">
  49. <xs:annotation>
  50. <xs:documentation>
  51. Zoom coordinate space selector. The following options are defined:<ul style="">
  52. <li> http://www.onvif.org/ver10/tptz/ZoomSpaces/PositionGenericSpace</li>
  53. <li> http://www.onvif.org/ver10/tptz/ZoomSpaces/TranslationGenericSpace</li>
  54. <li> http://www.onvif.org/ver10/tptz/ZoomSpaces/VelocityGenericSpace</li>
  55. <li> http://www.onvif.org/ver10/tptz/ZoomSpaces/ZoomGenericSpeedSpace</li>
  56. </ul>
  57. </xs:documentation>
  58. </xs:annotation>
  59. </xs:attribute>
  60. </xs:complexType>
  61. <xs:complexType name="PTZVector">
  62. <xs:sequence>
  63. <xs:element name="PanTilt" type="tt:Vector2D" minOccurs="0">
  64. <xs:annotation>
  65. <xs:documentation>Pan and tilt position. The x component corresponds to pan and the y component to tilt.</xs:documentation>
  66. </xs:annotation>
  67. </xs:element>
  68. <xs:element name="Zoom" type="tt:Vector1D" minOccurs="0">
  69. <xs:annotation>
  70. <xs:documentation>
  71. A zoom position.
  72. </xs:documentation>
  73. </xs:annotation>
  74. </xs:element>
  75. </xs:sequence>
  76. </xs:complexType>
  77. <xs:complexType name="PTZStatus">
  78. <xs:sequence>
  79. <xs:element name="Position" type="tt:PTZVector" minOccurs="0">
  80. <xs:annotation>
  81. <xs:documentation>
  82. Specifies the absolute position of the PTZ unit together with the Space references. The default absolute spaces of the corresponding PTZ configuration MUST be referenced within the Position element.
  83. </xs:documentation>
  84. </xs:annotation>
  85. </xs:element>
  86. <xs:element name="MoveStatus" type="tt:PTZMoveStatus" minOccurs="0">
  87. <xs:annotation>
  88. <xs:documentation>
  89. Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state.
  90. </xs:documentation>
  91. </xs:annotation>
  92. </xs:element>
  93. <xs:element name="Error" type="xs:string" minOccurs="0">
  94. <xs:annotation>
  95. <xs:documentation>
  96. States a current PTZ error.
  97. </xs:documentation>
  98. </xs:annotation>
  99. </xs:element>
  100. <xs:element name="UtcTime" type="xs:dateTime">
  101. <xs:annotation>
  102. <xs:documentation>
  103. Specifies the UTC time when this status was generated.
  104. </xs:documentation>
  105. </xs:annotation>
  106. </xs:element>
  107. <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> <!-- first Vendor then ONVIF -->
  108. </xs:sequence>
  109. <xs:anyAttribute processContents="lax"/>
  110. </xs:complexType>
  111. <xs:complexType name="PTZMoveStatus">
  112. <xs:sequence>
  113. <xs:element name="PanTilt" type="tt:MoveStatus" minOccurs="0">
  114. <xs:annotation>
  115. <xs:documentation>
  116. </xs:documentation>
  117. </xs:annotation>
  118. </xs:element>
  119. <xs:element name="Zoom" type="tt:MoveStatus" minOccurs="0">
  120. <xs:annotation>
  121. <xs:documentation>
  122. </xs:documentation>
  123. </xs:annotation>
  124. </xs:element>
  125. </xs:sequence>
  126. </xs:complexType>
  127. <xs:simpleType name="MoveStatus">
  128. <xs:restriction base="xs:string">
  129. <xs:enumeration value="IDLE"/>
  130. <xs:enumeration value="MOVING"/>
  131. <xs:enumeration value="UNKNOWN"/>
  132. </xs:restriction>
  133. </xs:simpleType>
  134. <!--===============================-->
  135. <!-- Event and Analytics Types -->
  136. <!--===============================-->
  137. <xs:complexType name="Vector">
  138. <xs:attribute name="x" type="xs:float"/>
  139. <xs:attribute name="y" type="xs:float"/>
  140. </xs:complexType>
  141. <xs:complexType name="Rectangle">
  142. <xs:attribute name="bottom" type="xs:float"/>
  143. <xs:attribute name="top" type="xs:float"/>
  144. <xs:attribute name="right" type="xs:float"/>
  145. <xs:attribute name="left" type="xs:float"/>
  146. </xs:complexType>
  147. <xs:complexType name="Polygon">
  148. <xs:sequence>
  149. <xs:element name="Point" type="tt:Vector" minOccurs="3" maxOccurs="unbounded"/>
  150. </xs:sequence>
  151. </xs:complexType>
  152. <xs:element name="Polygon" type="tt:Polygon"/>
  153. <xs:complexType name="Color">
  154. <xs:attribute name="X" type="xs:float" use="required"/>
  155. <xs:attribute name="Y" type="xs:float" use="required"/>
  156. <xs:attribute name="Z" type="xs:float" use="required"/>
  157. <xs:attribute name="Colorspace" type="xs:anyURI">
  158. <xs:annotation>
  159. <xs:documentation>
  160. Acceptable values:
  161. <ul>
  162. <li>http://www.onvif.org/ver10/colorspace/YCbCr - YCbCr
  163. <ul><li>X attribute = Y value</li>
  164. <li>Y attribute = Cb value</li>
  165. <li>Z attribute = Cr value</li></ul>
  166. </li>
  167. <li>http://www.onvif.org/ver10/colorspace/RGB - RGB
  168. <ul><li>X attribute = R value</li>
  169. <li>Y attribute = G value</li>
  170. <li>Z attribute = B value</li></ul>
  171. </li>
  172. </ul>
  173. If the Colorspace attribute is absent, YCbCr is implied.
  174. Deprecated values:
  175. <ul>
  176. <li>http://www.onvif.org/ver10/colorspace/CIELUV - CIE LUV</li>
  177. <li>http://www.onvif.org/ver10/colorspace/CIELAB - CIE 1976 (L*a*b*)</li>
  178. <li>http://www.onvif.org/ver10/colorspace/HSV - HSV</li>
  179. </ul>
  180. </xs:documentation>
  181. </xs:annotation>
  182. </xs:attribute>
  183. </xs:complexType>
  184. <xs:complexType name="ColorCovariance">
  185. <xs:attribute name="XX" type="xs:float" use="required"/>
  186. <xs:attribute name="YY" type="xs:float" use="required"/>
  187. <xs:attribute name="ZZ" type="xs:float" use="required"/>
  188. <xs:attribute name="XY" type="xs:float"/>
  189. <xs:attribute name="XZ" type="xs:float"/>
  190. <xs:attribute name="YZ" type="xs:float"/>
  191. <xs:attribute name="Colorspace" type="xs:anyURI">
  192. <xs:annotation>
  193. <xs:documentation>
  194. Acceptable values are the same as in tt:Color.
  195. </xs:documentation>
  196. </xs:annotation>
  197. </xs:attribute>
  198. </xs:complexType>
  199. <!--===============================-->
  200. <!-- Scene Description Types -->
  201. <!--===============================-->
  202. <xs:complexType name="Transformation">
  203. <xs:sequence>
  204. <xs:element name="Translate" type="tt:Vector" minOccurs="0"/>
  205. <xs:element name="Scale" type="tt:Vector" minOccurs="0"/>
  206. <xs:element name="Extension" type="tt:TransformationExtension" minOccurs="0"/>
  207. </xs:sequence>
  208. <xs:anyAttribute processContents="lax"/>
  209. </xs:complexType>
  210. <xs:complexType name="TransformationExtension">
  211. <xs:sequence>
  212. <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> <!-- first Vendor then ONVIF -->
  213. </xs:sequence>
  214. </xs:complexType>
  215. <!--===============================-->
  216. <!-- Location/Orientation Types -->
  217. <!--===============================-->
  218. <xs:complexType name="GeoLocation">
  219. <xs:sequence>
  220. <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> <!-- first ONVIF then Vendor -->
  221. </xs:sequence>
  222. <xs:attribute name="lon" type="xs:double">
  223. <xs:annotation>
  224. <xs:documentation>East west location as angle.</xs:documentation>
  225. </xs:annotation>
  226. </xs:attribute>
  227. <xs:attribute name="lat" type="xs:double">
  228. <xs:annotation>
  229. <xs:documentation>North south location as angle.</xs:documentation>
  230. </xs:annotation>
  231. </xs:attribute>
  232. <xs:attribute name="elevation" type="xs:float">
  233. <xs:annotation>
  234. <xs:documentation>Hight in meters above sea level.</xs:documentation>
  235. </xs:annotation>
  236. </xs:attribute>
  237. <xs:anyAttribute/>
  238. </xs:complexType>
  239. <!--===============================-->
  240. <xs:complexType name="GeoOrientation">
  241. <xs:sequence>
  242. <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> <!-- first ONVIF then Vendor -->
  243. </xs:sequence>
  244. <xs:attribute name="roll" type="xs:float">
  245. <xs:annotation>
  246. <xs:documentation>Rotation around the x axis.</xs:documentation>
  247. </xs:annotation>
  248. </xs:attribute>
  249. <xs:attribute name="pitch" type="xs:float">
  250. <xs:annotation>
  251. <xs:documentation>Rotation around the y axis.</xs:documentation>
  252. </xs:annotation>
  253. </xs:attribute>
  254. <xs:attribute name="yaw" type="xs:float">
  255. <xs:annotation>
  256. <xs:documentation>Rotation around the z axis.</xs:documentation>
  257. </xs:annotation>
  258. </xs:attribute>
  259. <xs:anyAttribute/>
  260. </xs:complexType>
  261. <!--===============================-->
  262. <xs:complexType name="LocalLocation">
  263. <xs:sequence>
  264. <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> <!-- first ONVIF then Vendor -->
  265. </xs:sequence>
  266. <xs:attribute name="x" type="xs:float">
  267. <xs:annotation>
  268. <xs:documentation>East west location as angle.</xs:documentation>
  269. </xs:annotation>
  270. </xs:attribute>
  271. <xs:attribute name="y" type="xs:float">
  272. <xs:annotation>
  273. <xs:documentation>North south location as angle.</xs:documentation>
  274. </xs:annotation>
  275. </xs:attribute>
  276. <xs:attribute name="z" type="xs:float">
  277. <xs:annotation>
  278. <xs:documentation>Offset in meters from the sea level.</xs:documentation>
  279. </xs:annotation>
  280. </xs:attribute>
  281. <xs:anyAttribute/>
  282. </xs:complexType>
  283. <!--===============================-->
  284. <xs:complexType name="LocalOrientation">
  285. <xs:sequence>
  286. <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/> <!-- first ONVIF then Vendor -->
  287. </xs:sequence>
  288. <xs:attribute name="pan" type="xs:float">
  289. <xs:annotation>
  290. <xs:documentation>Rotation around the y axis.</xs:documentation>
  291. </xs:annotation>
  292. </xs:attribute>
  293. <xs:attribute name="tilt" type="xs:float">
  294. <xs:annotation>
  295. <xs:documentation>Rotation around the z axis.</xs:documentation>
  296. </xs:annotation>
  297. </xs:attribute>
  298. <xs:attribute name="roll" type="xs:float">
  299. <xs:annotation>
  300. <xs:documentation>Rotation around the x axis.</xs:documentation>
  301. </xs:annotation>
  302. </xs:attribute>
  303. <xs:anyAttribute/>
  304. </xs:complexType>
  305. <!--===============================-->
  306. <xs:simpleType name="Entity">
  307. <xs:restriction base="xs:string">
  308. <xs:enumeration value="Device"/>
  309. <xs:enumeration value="VideoSource"/>
  310. <xs:enumeration value="AudioSource"/>
  311. </xs:restriction>
  312. </xs:simpleType>
  313. <!--===============================-->
  314. <xs:complexType name="LocationEntity">
  315. <xs:sequence>
  316. <xs:element name="GeoLocation" type="tt:GeoLocation" minOccurs="0">
  317. <xs:annotation><xs:documentation>Location on earth.</xs:documentation></xs:annotation>
  318. </xs:element>
  319. <xs:element name="GeoOrientation" type="tt:GeoOrientation" minOccurs="0">
  320. <xs:annotation><xs:documentation>Orientation relative to earth.</xs:documentation></xs:annotation>
  321. </xs:element>
  322. <xs:element name="LocalLocation" type="tt:LocalLocation" minOccurs="0">
  323. <xs:annotation><xs:documentation>Indoor location offset.</xs:documentation></xs:annotation>
  324. </xs:element>
  325. <xs:element name="LocalOrientation" type="tt:LocalOrientation" minOccurs="0">
  326. <xs:annotation><xs:documentation>Indoor orientation offset.</xs:documentation></xs:annotation>
  327. </xs:element>
  328. </xs:sequence>
  329. <xs:attribute name="Entity" type="xs:string">
  330. <xs:annotation><xs:documentation>Entity type the entry refers to, use a value from the tt:Entity enumeration.</xs:documentation></xs:annotation>
  331. </xs:attribute>
  332. <xs:attribute name="Token" type="tt:ReferenceToken">
  333. <xs:annotation><xs:documentation>Optional entity token.</xs:documentation></xs:annotation>
  334. </xs:attribute>
  335. <xs:attribute name="Fixed" type="xs:boolean">
  336. <xs:annotation><xs:documentation>If this value is true the entity cannot be deleted.</xs:documentation></xs:annotation>
  337. </xs:attribute>
  338. <xs:attribute name="GeoSource" type="xs:anyURI">
  339. <xs:annotation><xs:documentation>Optional reference to the XAddr of another devices DeviceManagement service.</xs:documentation></xs:annotation>
  340. </xs:attribute>
  341. <xs:attribute name="AutoGeo" type="xs:boolean">
  342. <xs:annotation><xs:documentation>If set the geo location is obtained internally.</xs:documentation></xs:annotation>
  343. </xs:attribute>
  344. </xs:complexType>
  345. <!--===============================-->
  346. </xs:schema>