forked from onvif/specs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathReplay.xml
414 lines (414 loc) · 17.9 KB
/
Replay.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
<?xml version="1.0"?>
<?xml-stylesheet href="docbook.xsl" type="text/xsl" ?>
<book xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
<title>Replay Control Service Specification</title>
<titleabbrev>Replay Control</titleabbrev>
<releaseinfo>21.12</releaseinfo>
<author>
<orgname>ONVIF™</orgname>
<uri>www.onvif.org</uri>
</author>
<pubdate>December 2021</pubdate>
<mediaobject>
<imageobject>
<imagedata fileref="media/logo.png" contentwidth="60mm" />
</imageobject>
</mediaobject>
<copyright>
<year>2008-2021</year>
<holder>ONVIF™ All rights reserved.</holder>
</copyright>
<legalnotice>
<para>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.</para>
<para>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.</para>
<para>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.</para>
</legalnotice>
<revhistory>
<revision>
<revnumber>2.1</revnumber>
<date>Jul-2011</date>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Split from Core 2.0 without change of content.</revremark>
</revision>
<revision>
<revnumber>2.1.1</revnumber>
<date>Jan-2012</date>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Change Requests 287, 342, 535</revremark>
</revision>
<revision>
<revnumber>2.2</revnumber>
<date>May-2012</date>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Change Requests 608, 677</revremark>
</revision>
<revision>
<revnumber>2.2.1</revnumber>
<date>Dec-2012</date>
<author>
<personname>Hans Busch</personname>
</author>
<revremark>Change Requests 708, 742, 743</revremark>
</revision>
<revision>
<revnumber>16.12</revnumber>
<date>Dec-2016</date>
<author>
<personname>Sujith Raman</personname>
</author>
<revremark>Added RTSP over WebSocket</revremark>
</revision>
<revision>
<revnumber>17.06</revnumber>
<date>Jun-2017</date>
<author>
<personname>Stefan Andersson</personname>
</author>
<author>
<personname>Hiroyuki Sano</personname>
</author>
<revremark>Update method layouts
Change Request 1843
Change Request 2054, 2065</revremark>
</revision>
<revision>
<revnumber>21.12</revnumber>
<date>Dec-2021</date>
<author>
<personname>Oksana Tyushkina, SergeyBogdanov</personname>
</author>
<revremark>Fix typo in commands names and role names.</revremark>
</revision>
</revhistory>
</info>
<chapter>
<title>Scope</title>
<para>This document defines the web service interface for the control of a replay of recorded Video, Audio and Metadata. Additionally the associated events are defined.</para>
<para>For a definition of the storage model see the ONVIF Recording Control Specification.</para>
<para>Web service usage is outside of the scope of this document. Please refer to the ONVIF core specification.</para>
</chapter>
<chapter>
<title>Normative references</title>
<para>ONVIF Core Specification</para>
<para role="reference"><<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.onvif.org/specs/core/ONVIF-Core-Specification.pdf"></link>></para>
<para>ONVIF Recording Control Specification</para>
<para role="reference"><<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.onvif.org/specs/srv/rec/ONVIF-RecordingControl-Service-Spec.pdf"></link>></para>
<para>ONVIF Streaming Specification</para>
<para role="reference"><<link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.onvif.org/onvif/specs/stream/ONVIF-Streaming-Spec.pdf"></link>></para>
</chapter>
<chapter>
<title>Terms and Definitions</title>
<section>
<title>Definitions</title>
<informaltable>
<tgroup cols="2">
<colspec colname="c1" colwidth="24*" />
<colspec colname="c2" colwidth="76*" />
<tbody valign="top">
<row>
<entry align="left">
<para>
<emphasis role="bold">Metadata</emphasis>
</para>
</entry>
<entry align="left">
<para>All streaming data except video and audio, including video analytics results, PTZ position data and other <phrase>metadata (such as textual data from POS applications)</phrase>.</para>
</entry>
</row>
<row>
<entry align="left">
<para>
<emphasis role="bold">Recording</emphasis>
</para>
</entry>
<entry align="left">
<para>A container for a set of audio, video and metadata tracks. A recording can hold one or more tracks. A track is viewed as an infinite timeline that holds data at certain times.</para>
</entry>
</row>
<row>
<entry align="left">
<para>
<emphasis role="bold">Recording Event</emphasis>
</para>
</entry>
<entry align="left">
<para>An event associated with a Recording, represented by a notification message in the APIs</para>
</entry>
</row>
<row>
<entry align="left">
<para>
<emphasis role="bold">Recording Job</emphasis>
</para>
</entry>
<entry align="left">
<para>A job performs the transfer of data from a data source to a particular recording using a particular configuration</para>
</entry>
</row>
<row>
<entry align="left">
<para>
<emphasis role="bold">Track</emphasis>
</para>
</entry>
<entry align="left">
<para>An individual data channel consisting of video, audio, or metadata. This definition is consistent with the definition of track in [RFC 2326]</para>
</entry>
</row>
<row>
<entry align="left">
<para>
<emphasis role="bold">Video Analytics</emphasis>
</para>
</entry>
<entry align="left">
<para>Algorithms or programs used to analyze video data and to generate data describing object location and behaviour.</para>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</section>
</chapter>
<chapter>
<title>Overview</title>
<para>The replay service provides a mechanism for replay of stored video, audio and metadata. This mechanism may also be used to download data from the storage device so that export functionality can be provided.</para>
<para>The replay protocol is based on RTSP [RFC 2326]. However because RTSP does not directly support all of the requirements for replay, several extensions have been added to the protocol. In particular, an RTP header extension is defined to allow an absolute timestamp to be associated with each access unit (e.g. video frame), and to convey information about stream continuity.</para>
<para>The GetReplayUri command in the replay service returns the RTSP URL of a recording to allow it to be replayed using RTSP.</para>
<para>WSDL for this service is specified in <link xmlns:xlink="http://www.w3.org/1999/xlink" xlink:href="http://www.onvif.org/ver10/replay.wsdl">http://www.onvif.org/ver10/replay.wsdl</link>. The following table shows the namespace prefix mapping used throughout this specification.</para>
<table>
<title>Referenced namespaces (with prefix)</title>
<tgroup cols="2">
<colspec colname="c1" colwidth="13*" />
<colspec colname="c2" colwidth="87*" />
<thead>
<row>
<entry>
<para>Prefix</para>
</entry>
<entry>
<para>Namespace URI</para>
</entry>
</row>
</thead>
<tbody valign="top">
<row>
<entry>
<para>env</para>
</entry>
<entry>
<para>http://www.w3.org/2003/05/soap-envelope</para>
</entry>
</row>
<row>
<entry>
<para>ter</para>
</entry>
<entry>
<para>http://www.onvif.org/ver10/error</para>
</entry>
</row>
<row>
<entry>
<para>xs </para>
</entry>
<entry>
<para>http://www.w3.org/2001/XMLSchema </para>
</entry>
</row>
<row>
<entry>
<para>tt</para>
</entry>
<entry>
<para>http://www.onvif.org/ver10/schema</para>
</entry>
</row>
<row>
<entry>
<para>trp</para>
</entry>
<entry>
<para>http://www.onvif.org/ver10/replay/wsdl</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
</chapter>
<chapter>
<title>Replay Control</title>
<para>This section defines a service for mapping replay endpoints to URI for use in RTSP.</para>
<section>
<title>GetReplayUri</title>
<para>GetReplayUri requests a URI that can be used to initiate playback of a recorded stream using RTSP as the control protocol. The URI is valid only as it is specified in the response. A device supporting the Replay Service shall support the GetReplayUri command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">StreamSetup [tt:StreamSetup]</para>
<para role="text">The StreamSetup element contains two parts. StreamType defines if a unicast or multicast media stream is requested. Transport specifies a chain of transport protocols defining the tunnelling of the media stream over different network protocols.</para>
<para role="param">RecordingToken [tt:RefernceToken]</para>
<para role="text">Indicates the recording to be streamed.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Uri [xs:anyURI]</para>
<para role="text">Contains the Uri to be used for requesting the media stream.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:InvalidStreamSetup</para>
<para role="text">Specification of StreamType or Transport part in StreamSetup is not supported.</para>
<para role="param">env:Sender - ter:OperationProhibited - ter:StreamConflict</para>
<para role="text">Specification of StreamType or Transport part in StreamSetup causes conflict with other streams.</para>
<para role="param">env:Sender - ter:InvalidArgVal - ter:NoRecording</para>
<para role="text">The recording does not exist.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>ReplayConfiguration</title>
<para>The ReplayConfiguration provides optional configuration information. Currently it only contains the deprecated RTSP SessionTimeout which can be controlled via the RTSP layer.</para>
</section>
<section>
<title>SetReplayConfiguration</title>
<para>SetReplayConfiguration changes the configuration of the replay service. The replay service shall allow its configuration to be changed using this command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="param">Configuration [tt:ReplayConfiguration]</para>
<para role="text">Holds the new configuration for the replay service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="param">env:Sender - ter:InvalidArgVal - ter:ConfigModify</para>
<para role="text">The values in the configuration cannot be set.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">ACTUATE</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>GetReplayConfiguration</title>
<para>GetReplayConfiguration returns the current configuration of the replay service. The replay service shall allow its configuration to be retrieved using this command.</para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Configuration [tt:ReplayConfiguration]</para>
<para role="text">Holds the current configuration for the replay service.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">READ_MEDIA</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<section>
<title>GetServiceCapabilities</title>
<para>The capabilities reflect optional functions and functionality of a service. The information is static and does not change during device operation. </para>
<variablelist role="op">
<varlistentry>
<term>request</term>
<listitem>
<para role="text">This is an empty message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>response</term>
<listitem>
<para role="param">Capabilities [trp:Capabilities]</para>
<para role="text">Contains the requested service capabilities using a hierarchical XML capability structure.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>faults</term>
<listitem>
<para role="text">None</para>
</listitem>
</varlistentry>
<varlistentry>
<term>access class</term>
<listitem>
<para role="access">PRE_AUTH</para>
</listitem>
</varlistentry>
</variablelist>
<para>The following capabilites are available:</para>
<variablelist>
<varlistentry>
<term>ReversePlayback</term>
<listitem><para>Indicator that the Device supports reverse playback as defined in the ONVIF Streaming Specification.</para></listitem>
</varlistentry>
<varlistentry>
<term>SessionTimeoutRange</term>
<listitem><para>Lists the upper and lower bound of the supported range for the
session timeout. This capability defaults to the RTSP default value.</para></listitem>
</varlistentry>
<varlistentry>
<term>RTP_RTSP_TCP</term>
<listitem><para>Indication if the device supports RTP/RTSP/TCP transport, see Section
5.1.1.3 of the ONVIF Streaming Specificiation.</para></listitem>
</varlistentry>
<varlistentry>
<term>RTSPOverWebSocket</term>
<listitem><para>Indicates if the device supports RTSP/RTP Playback Streaming support
over WebSocket and provides the WebSocket URI for replay as described in the ONVIF Streaming
Specification section 5.1.1.5.</para></listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
<appendix role="revhistory">
<title>Revision History</title>
<para />
</appendix>
</book>