imaging.wsdl 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <?xml-stylesheet type="text/xsl" href="../../../ver20/util/onvif-wsdl-viewer.xsl"?>
  3. <!--
  4. Copyright (c) 2008-2012 by ONVIF: Open Network Video Interface Forum. All rights reserved.
  5. Recipients of this document may copy, distribute, publish, or display this document so long as this copyright notice, license and disclaimer are retained with all copies of the document. No license is granted to modify this document.
  6. THIS DOCUMENT IS PROVIDED "AS IS," AND THE CORPORATION AND ITS MEMBERS AND THEIR AFFILIATES, MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THIS DOCUMENT ARE SUITABLE FOR ANY PURPOSE; OR THAT THE IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
  7. IN NO EVENT WILL THE CORPORATION OR ITS MEMBERS OR THEIR AFFILIATES BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE OR CONSEQUENTIAL DAMAGES, ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT, WHETHER OR NOT (1) THE CORPORATION, MEMBERS OR THEIR AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR (2) SUCH DAMAGES WERE REASONABLY FORESEEABLE, AND ARISING OUT OF OR RELATING TO ANY USE OR DISTRIBUTION OF THIS DOCUMENT. THE FOREGOING DISCLAIMER AND LIMITATION ON LIABILITY DO NOT APPLY TO, INVALIDATE, OR LIMIT REPRESENTATIONS AND WARRANTIES MADE BY THE MEMBERS AND THEIR RESPECTIVE AFFILIATES TO THE CORPORATION AND OTHER MEMBERS IN CERTAIN WRITTEN POLICIES OF THE CORPORATION.
  8. -->
  9. <wsdl:definitions xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:timg="http://www.onvif.org/ver20/imaging/wsdl" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:tt="http://www.onvif.org/ver10/schema" name="ImagingService" targetNamespace="http://www.onvif.org/ver20/imaging/wsdl">
  10. <wsdl:types>
  11. <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tt="http://www.onvif.org/ver10/schema" xmlns:timg="http://www.onvif.org/ver20/imaging/wsdl" targetNamespace="http://www.onvif.org/ver20/imaging/wsdl" elementFormDefault="qualified" version="2.2">
  12. <xs:import namespace="http://www.onvif.org/ver10/schema" schemaLocation="./onvif.xsd"/>
  13. <!-- Message Request/Responses elements -->
  14. <!--===============================-->
  15. <xs:element name="GetServiceCapabilities">
  16. <xs:complexType>
  17. <xs:sequence/>
  18. </xs:complexType>
  19. </xs:element>
  20. <xs:element name="GetServiceCapabilitiesResponse">
  21. <xs:complexType>
  22. <xs:sequence>
  23. <xs:element name="Capabilities" type="timg:Capabilities">
  24. <xs:annotation>
  25. <xs:documentation>The capabilities for the imaging service is returned in the Capabilities element.</xs:documentation>
  26. </xs:annotation>
  27. </xs:element>
  28. </xs:sequence>
  29. </xs:complexType>
  30. </xs:element>
  31. <!--===============================-->
  32. <xs:complexType name="Capabilities">
  33. <xs:sequence>
  34. <xs:any namespace="##any" processContents="lax" minOccurs="0" maxOccurs="unbounded"/>
  35. </xs:sequence>
  36. <xs:attribute name="ImageStabilization" type="xs:boolean">
  37. <xs:annotation>
  38. <xs:documentation>Indicates whether or not Image Stabilization feature is supported.</xs:documentation>
  39. </xs:annotation>
  40. </xs:attribute>
  41. <xs:anyAttribute processContents="lax"/>
  42. </xs:complexType>
  43. <xs:element name="Capabilities" type="timg:Capabilities"/>
  44. <!--===============================-->
  45. <xs:element name="GetImagingSettings">
  46. <xs:complexType>
  47. <xs:sequence>
  48. <xs:element name="VideoSourceToken" type="tt:ReferenceToken">
  49. <xs:annotation>
  50. <xs:documentation>
  51. Reference token to the VideoSource for which the ImagingSettings.
  52. </xs:documentation>
  53. </xs:annotation>
  54. </xs:element>
  55. </xs:sequence>
  56. </xs:complexType>
  57. </xs:element>
  58. <xs:element name="GetImagingSettingsResponse">
  59. <xs:complexType>
  60. <xs:sequence>
  61. <xs:element name="ImagingSettings" type="tt:ImagingSettings20">
  62. <xs:annotation>
  63. <xs:documentation>
  64. ImagingSettings for the VideoSource that was requested.
  65. </xs:documentation>
  66. </xs:annotation>
  67. </xs:element>
  68. </xs:sequence>
  69. </xs:complexType>
  70. </xs:element>
  71. <!--===============================-->
  72. <xs:element name="SetImagingSettings">
  73. <xs:complexType>
  74. <xs:sequence>
  75. <xs:element name="VideoSourceToken" type="tt:ReferenceToken"/>
  76. <xs:element name="ImagingSettings" type="tt:ImagingSettings20"/>
  77. <xs:element name="ForcePersistence" type="xs:boolean" maxOccurs="1" minOccurs="0"/>
  78. </xs:sequence>
  79. </xs:complexType>
  80. </xs:element>
  81. <xs:element name="SetImagingSettingsResponse">
  82. <xs:complexType/>
  83. </xs:element>
  84. <!--===============================-->
  85. <xs:element name="GetOptions">
  86. <xs:complexType>
  87. <xs:sequence>
  88. <xs:element name="VideoSourceToken" type="tt:ReferenceToken">
  89. <xs:annotation>
  90. <xs:documentation>
  91. Reference token to the VideoSource for which the imaging parameter options are requested.
  92. </xs:documentation>
  93. </xs:annotation>
  94. </xs:element>
  95. </xs:sequence>
  96. </xs:complexType>
  97. </xs:element>
  98. <xs:element name="GetOptionsResponse">
  99. <xs:complexType>
  100. <xs:sequence>
  101. <xs:element name="ImagingOptions" type="tt:ImagingOptions20">
  102. <xs:annotation>
  103. <xs:documentation>
  104. Valid ranges for the imaging parameters that are categorized as device specific.
  105. </xs:documentation>
  106. </xs:annotation>
  107. </xs:element>
  108. </xs:sequence>
  109. </xs:complexType>
  110. </xs:element>
  111. <!--===============================-->
  112. <xs:element name="Move">
  113. <xs:complexType>
  114. <xs:sequence>
  115. <xs:element name="VideoSourceToken" type="tt:ReferenceToken">
  116. <xs:annotation>
  117. <xs:documentation>
  118. Reference to the VideoSource for the requested move (focus) operation.
  119. </xs:documentation>
  120. </xs:annotation>
  121. </xs:element>
  122. <xs:element name="Focus" type="tt:FocusMove">
  123. <xs:annotation>
  124. <xs:documentation>
  125. Content of the requested move (focus) operation.
  126. </xs:documentation>
  127. </xs:annotation>
  128. </xs:element>
  129. </xs:sequence>
  130. </xs:complexType>
  131. </xs:element>
  132. <xs:element name="MoveResponse">
  133. <xs:complexType>
  134. <xs:sequence/>
  135. </xs:complexType>
  136. </xs:element>
  137. <!--===============================-->
  138. <xs:element name="GetMoveOptions">
  139. <xs:complexType>
  140. <xs:sequence>
  141. <xs:element name="VideoSourceToken" type="tt:ReferenceToken">
  142. <xs:annotation>
  143. <xs:documentation>
  144. Reference token to the VideoSource for the requested move options.
  145. </xs:documentation>
  146. </xs:annotation>
  147. </xs:element>
  148. </xs:sequence>
  149. </xs:complexType>
  150. </xs:element>
  151. <xs:element name="GetMoveOptionsResponse">
  152. <xs:complexType>
  153. <xs:sequence>
  154. <xs:element name="MoveOptions" type="tt:MoveOptions20">
  155. <xs:annotation>
  156. <xs:documentation>
  157. Valid ranges for the focus lens move options.
  158. </xs:documentation>
  159. </xs:annotation>
  160. </xs:element>
  161. </xs:sequence>
  162. </xs:complexType>
  163. </xs:element>
  164. <!--===============================-->
  165. <xs:element name="Stop">
  166. <xs:complexType>
  167. <xs:sequence>
  168. <xs:element name="VideoSourceToken" type="tt:ReferenceToken">
  169. <xs:annotation>
  170. <xs:documentation>
  171. Reference token to the VideoSource where the focus movement should be stopped.
  172. </xs:documentation>
  173. </xs:annotation>
  174. </xs:element>
  175. </xs:sequence>
  176. </xs:complexType>
  177. </xs:element>
  178. <xs:element name="StopResponse">
  179. <xs:complexType>
  180. <xs:sequence>
  181. </xs:sequence>
  182. </xs:complexType>
  183. </xs:element>
  184. <!--===============================-->
  185. <xs:element name="GetStatus">
  186. <xs:complexType>
  187. <xs:sequence>
  188. <xs:element name="VideoSourceToken" type="tt:ReferenceToken">
  189. <xs:annotation>
  190. <xs:documentation>
  191. Reference token to the VideoSource where the imaging status should be requested.
  192. </xs:documentation>
  193. </xs:annotation>
  194. </xs:element>
  195. </xs:sequence>
  196. </xs:complexType>
  197. </xs:element>
  198. <xs:element name="GetStatusResponse">
  199. <xs:complexType>
  200. <xs:sequence>
  201. <xs:element name="Status" type="tt:ImagingStatus20">
  202. <xs:annotation>
  203. <xs:documentation>
  204. Requested imaging status.
  205. </xs:documentation>
  206. </xs:annotation>
  207. </xs:element>
  208. </xs:sequence>
  209. </xs:complexType>
  210. </xs:element>
  211. <!--===============================-->
  212. </xs:schema>
  213. </wsdl:types>
  214. <wsdl:message name="GetServiceCapabilitiesRequest">
  215. <wsdl:part name="parameters" element="timg:GetServiceCapabilities"/>
  216. </wsdl:message>
  217. <wsdl:message name="GetServiceCapabilitiesResponse">
  218. <wsdl:part name="parameters" element="timg:GetServiceCapabilitiesResponse"/>
  219. </wsdl:message>
  220. <wsdl:message name="GetImagingSettingsRequest">
  221. <wsdl:part name="parameters" element="timg:GetImagingSettings"/>
  222. </wsdl:message>
  223. <wsdl:message name="GetImagingSettingsResponse">
  224. <wsdl:part name="parameters" element="timg:GetImagingSettingsResponse"/>
  225. </wsdl:message>
  226. <wsdl:message name="SetImagingSettingsRequest">
  227. <wsdl:part name="parameters" element="timg:SetImagingSettings"/>
  228. </wsdl:message>
  229. <wsdl:message name="SetImagingSettingsResponse">
  230. <wsdl:part name="parameters" element="timg:SetImagingSettingsResponse"/>
  231. </wsdl:message>
  232. <wsdl:message name="GetOptionsRequest">
  233. <wsdl:part name="parameters" element="timg:GetOptions"/>
  234. </wsdl:message>
  235. <wsdl:message name="GetOptionsResponse">
  236. <wsdl:part name="parameters" element="timg:GetOptionsResponse"/>
  237. </wsdl:message>
  238. <wsdl:message name="MoveRequest">
  239. <wsdl:part name="parameters" element="timg:Move"/>
  240. </wsdl:message>
  241. <wsdl:message name="MoveResponse">
  242. <wsdl:part name="parameters" element="timg:MoveResponse"/>
  243. </wsdl:message>
  244. <wsdl:message name="GetMoveOptionsRequest">
  245. <wsdl:part name="parameters" element="timg:GetMoveOptions"/>
  246. </wsdl:message>
  247. <wsdl:message name="GetMoveOptionsResponse">
  248. <wsdl:part name="parameters" element="timg:GetMoveOptionsResponse"/>
  249. </wsdl:message>
  250. <wsdl:message name="StopRequest">
  251. <wsdl:part name="parameters" element="timg:Stop"/>
  252. </wsdl:message>
  253. <wsdl:message name="StopResponse">
  254. <wsdl:part name="parameters" element="timg:StopResponse"/>
  255. </wsdl:message>
  256. <wsdl:message name="GetStatusRequest">
  257. <wsdl:part name="parameters" element="timg:GetStatus"/>
  258. </wsdl:message>
  259. <wsdl:message name="GetStatusResponse">
  260. <wsdl:part name="parameters" element="timg:GetStatusResponse"/>
  261. </wsdl:message>
  262. <wsdl:portType name="ImagingPort">
  263. <wsdl:operation name="GetServiceCapabilities">
  264. <wsdl:documentation>Returns the capabilities of the imaging service. The result is returned in a typed answer.</wsdl:documentation>
  265. <wsdl:input message="timg:GetServiceCapabilitiesRequest"/>
  266. <wsdl:output message="timg:GetServiceCapabilitiesResponse"/>
  267. </wsdl:operation>
  268. <wsdl:operation name="GetImagingSettings">
  269. <wsdl:documentation>Get the ImagingConfiguration for the requested VideoSource.</wsdl:documentation>
  270. <wsdl:input message="timg:GetImagingSettingsRequest"/>
  271. <wsdl:output message="timg:GetImagingSettingsResponse"/>
  272. </wsdl:operation>
  273. <wsdl:operation name="SetImagingSettings">
  274. <wsdl:documentation>Set the ImagingConfiguration for the requested VideoSource.</wsdl:documentation>
  275. <wsdl:input message="timg:SetImagingSettingsRequest"/>
  276. <wsdl:output message="timg:SetImagingSettingsResponse"/>
  277. </wsdl:operation>
  278. <wsdl:operation name="GetOptions">
  279. <wsdl:documentation>This operation gets the valid ranges for the imaging parameters that have device specific ranges.
  280. This command is mandatory for all device implementing the imaging service. The command returns all supported parameters and their ranges
  281. such that these can be applied to the SetImagingSettings command.<br/>
  282. For read-only parameters which cannot be modified via the SetImagingSettings command only a single option or identical Min and Max values
  283. is provided.</wsdl:documentation>
  284. <wsdl:input message="timg:GetOptionsRequest"/>
  285. <wsdl:output message="timg:GetOptionsResponse"/>
  286. </wsdl:operation>
  287. <wsdl:operation name="Move">
  288. <wsdl:documentation>The Move command moves the focus lens in an absolute, a relative or in a continuous manner from its current position.
  289. The speed argument is optional for absolute and relative control, but required for continuous. If no speed argument is used, the default speed is used.
  290. Focus adjustments through this operation will turn off the autofocus. A device with support for remote focus control should support absolute,
  291. relative or continuous control through the Move operation. The supported MoveOpions are signalled via the GetMoveOptions command.
  292. At least one focus control capability is required for this operation to be functional. <br/>
  293. The move operation contains the following commands:<br/>
  294. <b>Absolute</b> – Requires position parameter and optionally takes a speed argument. A unitless type is used by default for focus positioning and speed. Optionally, if supported, the position may be requested in m-1 units. <br/>
  295. <b>Relative</b> – Requires distance parameter and optionally takes a speed argument. Negative distance means negative direction.
  296. <b>Continuous</b> – Requires a speed argument. Negative speed argument means negative direction.
  297. </wsdl:documentation>
  298. <wsdl:input message="timg:MoveRequest"/>
  299. <wsdl:output message="timg:MoveResponse"/>
  300. </wsdl:operation>
  301. <wsdl:operation name="GetMoveOptions">
  302. <wsdl:documentation>Imaging move operation options supported for the Video source.</wsdl:documentation>
  303. <wsdl:input message="timg:GetMoveOptionsRequest"/>
  304. <wsdl:output message="timg:GetMoveOptionsResponse"/>
  305. </wsdl:operation>
  306. <wsdl:operation name="Stop">
  307. <wsdl:documentation>The Stop command stops all ongoing focus movements of the lense. A device with support for remote focus control as signalled via
  308. the GetMoveOptions supports this command. <br/>The operation will not affect ongoing autofocus operation.</wsdl:documentation>
  309. <wsdl:input message="timg:StopRequest"/>
  310. <wsdl:output message="timg:StopResponse"/>
  311. </wsdl:operation>
  312. <wsdl:operation name="GetStatus">
  313. <wsdl:documentation>Via this command the current status of the Move operation can be requested. Supported for this command is available if the support for the Move operation is signalled via GetMoveOptions.</wsdl:documentation>
  314. <wsdl:input message="timg:GetStatusRequest"/>
  315. <wsdl:output message="timg:GetStatusResponse"/>
  316. </wsdl:operation>
  317. </wsdl:portType>
  318. <wsdl:binding name="ImagingBinding" type="timg:ImagingPort">
  319. <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http"/>
  320. <wsdl:operation name="GetServiceCapabilities">
  321. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/GetServiceCapabilities"/>
  322. <wsdl:input>
  323. <soap:body use="literal"/>
  324. </wsdl:input>
  325. <wsdl:output>
  326. <soap:body use="literal"/>
  327. </wsdl:output>
  328. </wsdl:operation>
  329. <wsdl:operation name="GetImagingSettings">
  330. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/GetImagingSettings"/>
  331. <wsdl:input>
  332. <soap:body use="literal"/>
  333. </wsdl:input>
  334. <wsdl:output>
  335. <soap:body use="literal"/>
  336. </wsdl:output>
  337. </wsdl:operation>
  338. <wsdl:operation name="SetImagingSettings">
  339. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/SetImagingSettings"/>
  340. <wsdl:input>
  341. <soap:body use="literal"/>
  342. </wsdl:input>
  343. <wsdl:output>
  344. <soap:body use="literal"/>
  345. </wsdl:output>
  346. </wsdl:operation>
  347. <wsdl:operation name="GetOptions">
  348. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/GetOptions"/>
  349. <wsdl:input>
  350. <soap:body use="literal"/>
  351. </wsdl:input>
  352. <wsdl:output>
  353. <soap:body use="literal"/>
  354. </wsdl:output>
  355. </wsdl:operation>
  356. <wsdl:operation name="Move">
  357. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/Move"/>
  358. <wsdl:input>
  359. <soap:body use="literal"/>
  360. </wsdl:input>
  361. <wsdl:output>
  362. <soap:body use="literal"/>
  363. </wsdl:output>
  364. </wsdl:operation>
  365. <wsdl:operation name="Stop">
  366. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/FocusStop"/>
  367. <wsdl:input>
  368. <soap:body use="literal"/>
  369. </wsdl:input>
  370. <wsdl:output>
  371. <soap:body use="literal"/>
  372. </wsdl:output>
  373. </wsdl:operation>
  374. <wsdl:operation name="GetStatus">
  375. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/GetStatus"/>
  376. <wsdl:input>
  377. <soap:body use="literal"/>
  378. </wsdl:input>
  379. <wsdl:output>
  380. <soap:body use="literal"/>
  381. </wsdl:output>
  382. </wsdl:operation>
  383. <wsdl:operation name="GetMoveOptions">
  384. <soap:operation soapAction="http://www.onvif.org/ver20/imaging/wsdl/GetMoveOptions"/>
  385. <wsdl:input>
  386. <soap:body use="literal"/>
  387. </wsdl:input>
  388. <wsdl:output>
  389. <soap:body use="literal"/>
  390. </wsdl:output>
  391. </wsdl:operation>
  392. </wsdl:binding>
  393. <wsdl:service name="ImagingService">
  394. <wsdl:port name="ImagingPort" binding="timg:ImagingBinding">
  395. <soap:address location="http://192.168.0.51:8888/onvif/Imaging"/>
  396. </wsdl:port>
  397. </wsdl:service>
  398. </wsdl:definitions>