Project

General

Profile

Htsp » History » Version 158

Kai Sommerfeld, 2015-09-27 09:07

1 157 Kai Sommerfeld
h1. Home Tv Streaming Protocol (HTSP) - Version 23
2 1 Andreas Smas
3
h2. General
4 58 sbi -
5
HTSP is a TCP based protocol primarily intended for streaming of live TV and related meta data such as channels, group of channels (called tags in HTSP) and electronic program guide (EPG) information.
6
7 61 Adam Sutton
The transmission and reception of a channel over HTSP is referred to as a subscription. A single HTSP session can handle as many concurrent subscriptions as the bandwidth and CPU permits.
8 1 Andreas Smas
9 61 Adam Sutton
The HTSP server in tvheadend has a payload-aware scheduler for prioritizing more important packets (such as I-frames) before less important ones (such as B-frames). This makes HTSP suitable for long-distance transmissions and/or paths with non-perfect delivery.
10 1 Andreas Smas
(It has been tested with a server in Stockholm and the client in Berlin).
11
12 17 Andreas Smas
For information about the HTSP wire format please read [[htsmsgbinary|HTSMSG binary format]]
13 1 Andreas Smas
14 61 Adam Sutton
If you're looking to develop a new client, there are several existing client implementations from which you might be able to gain knowledge:
15
16 157 Kai Sommerfeld
* "Kodi":https://github.com/kodi-pvr/pvr.hts
17 61 Adam Sutton
* "Showtime":https://github.com/andoma/showtime/tree/master/src/backend/htsp
18 65 John Törnblom
* "TVHGuide":https://github.com/john-tornblom/TVHGuide
19 69 Adam Sutton
* "PyHTSP":https://github.com/adamsutton/tvheadend/tree/master/lib/py/tvh/htsp.py (This is a demo client and is WIP, it has limited functionality).
20 1 Andreas Smas
21 22 Andreas Smas
----
22 18 Andreas Smas
23 1 Andreas Smas
h2. Protocol Changes
24
25 157 Kai Sommerfeld
h3. v22..23
26
27
* extended addDvrEntry, updateDvrEntry, dvrEntryAdd method
28
** added enabled
29 158 Kai Sommerfeld
* extended getSysTime
30
** added gmtoffset
31 157 Kai Sommerfeld
32 151 Kai Sommerfeld
h3. v21..22
33
34
* extended updateDvrEntry method
35
** added channelId
36
37 145 Jaroslav Kysela
h3. v20..v21
38
39
* dvrEntry structures
40
** added files msg (multiple files) to the files field
41
** added dataSize field to show actual (last) file size in dvrEntry updates
42
* epg events - added subtitle field
43
44 126 Jaroslav Kysela
45 131 Jaroslav Kysela
h3. v19..v20
46
47
* dvrEntry structures
48
** added subscriptionError, streamErrors, dataErrors fields
49
** added subtitle fields
50
* autorecEntry structures
51
** added dupDetect and fulltext fields
52 144 Jaroslav Kysela
* added errors fields to the stream status
53
* added satpos to the subscription start
54 131 Jaroslav Kysela
* added subscriptionError field to subscriptionStatus server-to-client method
55
56
h3. v18..v19
57
58 126 Jaroslav Kysela
* autorec/timerec structures
59
** added directory field (forced output directory)
60 127 Jaroslav Kysela
** added enabled field
61
62 126 Jaroslav Kysela
63 119 Jaroslav Kysela
h3. v17..v18
64
65
* added addTimerecEntry, deleteTimerecEntry methods
66
* added timerecEntryAdd, timerecEntryUpdate, timerecEntryDelete server-to-client methods
67
* extended addAutorecEntry method
68
** added start/startWindow/name fields
69
** added owner/creator fields
70
** obsoleted creator field
71
* extended dvrEntryAdd, dvrEntryUpdate
72
** added timerecId field
73
** added owner/creator fields
74
* extended addAutorecEntry, deleteAutorecEntry methods
75
** added start/startWindow fields
76
** obsoleted approxTime
77
** added name/owner/creator fields
78
* extended autorecEntryAdd, autorecEntryUpdate server-to-client methods
79
** fields like for addAutorecEntry
80
* extended getTag method
81
** added tagIndex field
82
83 110 Jaroslav Kysela
h3. v16..v17
84
85
* extended subscriptionStart server-to-client method
86
** added meta field
87
* changed H264 meta data handling (codec meta data are in the meta field only in start message)
88
* VORBIS and AAC codecs have codec specific meta data in the meta field in start message
89 115 Jaroslav Kysela
* changed subscribe method
90
** the normts is always active and the parameter is ignored
91
92 110 Jaroslav Kysela
93 107 Jaroslav Kysela
h3. v15..v16
94
95
* added getProfiles, getDvrConfigs methods
96
* removed getCodecs methods
97
* extended subscribe method
98
** add profile field
99
100 105 Jaroslav Kysela
h3. v14..v15
101
102
* extended channelAdd, channelUpdate server-to-client methods
103 106 Jaroslav Kysela
** the channelIcon URL can be relative 'imagecache/%d' or '/imagecache/%d'
104 1 Andreas Smas
* extended getChannel method
105 106 Jaroslav Kysela
** the channelIcon URL can be relative 'imagecache/%d' or '/imagecache/%d'
106
107 105 Jaroslav Kysela
108 100 Jaroslav Kysela
h3. v13..v14
109
110
* added getChannel method
111
112 85 Jaroslav Kysela
h3. v12..v13
113
114
* added addAutorecEntry method
115
* added deleteAutorecEntry method
116 92 Jaroslav Kysela
* added autorecEntryAdd, autorecEntryUpdate, autorecEntryDelete server-to-client methods
117 85 Jaroslav Kysela
* extended channelAdd server-to-client method
118 87 Jaroslav Kysela
** added channelNumberMinor (for {major}.{minor} channel numbers)
119
* extended dvrEntryAdd and dvrEntryUpdate server-to-client methods
120 88 Jaroslav Kysela
** added eventId, autorecId, startExtra, stopExtra, retention, priority, contentType fields
121 97 Jaroslav Kysela
* extended addDvrEntry method
122
** added retention
123
* extended updateDvrEntry method
124
** added retention, priority
125
* extended epgQuery method
126
** added minduration, maxduration
127 85 Jaroslav Kysela
* added subscriptionGrace server-to-client method
128 97 Jaroslav Kysela
129 85 Jaroslav Kysela
130 83 Jaroslav Kysela
h3. v11..v12
131
132
* added subscriptionFilterStream method
133
* added getDvrCutpoints method
134
135
136
h3. v10..v11
137
138 86 Jaroslav Kysela
* added audio_type in the subscriptionStart server-to-client method
139 83 Jaroslav Kysela
* added getCodecs method
140
141 58 sbi -
h2. Communication
142
143
144 69 Adam Sutton
This communication is currently implemented by using htsmsg's. All strings are encoded as UTF-8.
145 1 Andreas Smas
146
There are two distinct ways for communication within HTSP.
147
148 28 Andreas Smas
Apart from this there is a number of messages that needs to be exchanged during login, see the login section below.
149
150 1 Andreas Smas
151 58 sbi -
h3. RPC communication
152
153
154 1 Andreas Smas
There is a normal RPC way of doing things. I.e. the client sends a request and the server responds with a reply. All the RPC methods are listed below as the 'Client to Server' methods. Apart from all message fields listed within each message type the client can add an additional field:
155 18 Andreas Smas
156 17 Andreas Smas
RPC request extra fields:
157 58 sbi -
<pre>
158 28 Andreas Smas
seq              int  optional   Sequence number. This field will be echoed back by the server in the reply.
159 1 Andreas Smas
username         str  optional   Username, in combination with 'digest' this can be used to raise the privileges
160
                                 for the session in combination with invocation of a method. 
161 28 Andreas Smas
digest           bin  optional   Used to raise privileges.
162 58 sbi -
</pre>
163 18 Andreas Smas
164 1 Andreas Smas
The followings field should be used by the client to match the reply with the request.
165
All replies are guaranteed to arrive in the same order as the requests.
166
Even so, probably the best way to implement the request-reply client is by taking advantage of the 'seq' field.
167
168
RPC reply extra fields:
169 58 sbi -
<pre>
170 18 Andreas Smas
seq              int  optional   Sequence number. Same as in the request.
171 19 Andreas Smas
error            str  optional   If present an error has occurred and the text describes the error.
172
noaccess         int  optional   If present and set to '1' the user is prohibited from invoking the method due to 
173 1 Andreas Smas
                                 access restrictions. 
174 58 sbi -
</pre>
175 1 Andreas Smas
176 18 Andreas Smas
177 58 sbi -
h3. Streaming communication
178
179
180 19 Andreas Smas
For streaming of live TV and various related messages the server will continuously push data to the client.
181 1 Andreas Smas
These messages are referred to as asynchronous messages and always have the 'method' field set and never have the 'seq' field set.
182
Also, the client can enable an additional asyncMetadata mode and by doing so it will be notified by the server when meta data changes. (EPG updates, creation of channels and tags, etc). 
183
184 34 Andreas Smas
185 58 sbi -
h3. Authentication
186
187
188 29 Andreas Smas
In Tvheadend, each method has an associated access restriction. Currently there is only one restriction (Streaming). However, this may change in the future.
189 1 Andreas Smas
190
Privileges for these restrictions may be granted in two ways: Username + Password and/or Source IP address.
191
Therefore it is possible to gain permissions to the system without entering a username and password.
192
While this is really useful it also complicates the authentication schema a bit.
193
Upon connect the initial privileges will be raised based on the source address.
194
195
Before any username / password based authentication has taken place the client must have
196 34 Andreas Smas
obtained a challenge (which stays fixed for the session). This is done via the 'hello' method.
197 1 Andreas Smas
198
In principle it's possible to use two different authentication idioms with HTSP.
199
Depending on how your application works one or another may be more suitable.
200
While they do not really differ from a protocol point of view it's worth mentioning a bit about them here:
201
202
203 58 sbi -
h3. Initial login authentication
204
205
206 1 Andreas Smas
The client performs all of its authentication using the 'login' method.
207
208
It may choose to send:
209 58 sbi -
* Username and password: Privileges will be raised based on these credentials.
210
* Username only: Privileges will be based on just the source address. The username will be used for various logging purposes.
211
* Nothing: Privileges will be based on just the source address.
212 1 Andreas Smas
213
If no privileges are granted after the login message has been received by the server (i.e. both network and username + password based)
214
the server will reply with 'noaccess' set to 1. A client that only employs initial login should honor this flag and ask the
215
user for a username + password and retry by using the 'authenticate' method. I.e. it should not send the 'login' method again.
216
217
218 58 sbi -
h3. On-demand authentication
219
220
221 1 Andreas Smas
The client performs all of its authentication when it needs to.
222
223
When using this method, the client will check every RPC reply for the 'noaccess' field.
224
If it set to 1 it whould ask the user for username + password and retry the request but also
225 58 sbi -
add 'username' and 'digest' to the original message. (See _RPC request extra fields_ above)
226 1 Andreas Smas
227
Typically it would not send a username or digest during login.
228 29 Andreas Smas
229
----
230 34 Andreas Smas
231 66 Adam Sutton
h2. Client to Server (RPC) methods
232 34 Andreas Smas
233
h3. hello
234 58 sbi -
235
Used to identify the client toward the server and to get the session challenge used to
236 1 Andreas Smas
hash passwords into digests. The client can request a different version of the HTSP
237 66 Adam Sutton
protocol with this method. If no 'hello' message is sent the server assumes latest version
238 1 Andreas Smas
is to be used.
239 34 Andreas Smas
240 66 Adam Sutton
Client/Server should select lowest common version, if this is not possible connection should be terminated.
241 1 Andreas Smas
242
Request message fields:
243
<pre>
244 66 Adam Sutton
htspversion        u32   required   Client preferred HTSP version.
245
clientname         str   required   Client software name.
246
clientversion      str   required   Client software version.
247 58 sbi -
</pre>
248 1 Andreas Smas
249
Reply message fields:
250 34 Andreas Smas
<pre>
251 66 Adam Sutton
htspversion        u32   required   The server supports all versions of the protocol up to and including this number.
252
servername         str   required   Server software name.
253
serverversion      str   required   Server software version.
254
servercapability   str[] required   Server capabilities (Added in version 6)
255 1 Andreas Smas
challenge          bin   required   32 bytes randomized data used to generate authentication digests
256 73 Adam Sutton
webroot            str   optional   Server HTTP webroot (Added in version 8)
257
                                    Note: any access to TVH webserver should include this at start of URL path
258 1 Andreas Smas
</pre>
259
260 70 Adam Sutton
Note: possible values for servercapability[]:
261
<pre>
262
cwc                Descrambling available
263
v4l                Analogue TV available
264
linuxdvb           Linux DVB API available
265 1 Andreas Smas
imagecache         Image caching available
266 73 Adam Sutton
timeshift          Timeshifting available (Added in version 9).
267 70 Adam Sutton
</pre>
268
269 58 sbi -
h3. authenticate
270 1 Andreas Smas
271
This can be used to issue authentication without doing anything else.
272
If no privileges are gained it will return with 'noaccess' set to 1.
273
274 33 Andreas Smas
Request message fields:
275 1 Andreas Smas
<pre>
276 66 Adam Sutton
None   
277 33 Andreas Smas
</pre>
278 58 sbi -
279
Reply message fields:
280
<pre>
281 66 Adam Sutton
noaccess           u32   optional   If set to 1, no privileges were granted.
282 33 Andreas Smas
</pre>
283 1 Andreas Smas
284
----
285
286 66 Adam Sutton
h3. getDiskSpace (Added in version 3)
287 58 sbi -
288 66 Adam Sutton
Return diskspace status from Tvheadend's PVR storage
289 1 Andreas Smas
290 66 Adam Sutton
Request message fields:
291
<pre>
292
None
293
</pre>
294 1 Andreas Smas
295 66 Adam Sutton
Reply message fields:
296
<pre>
297
freediskspace      s64   required   Bytes available.
298
totaldiskspace     s64   required   Total capacity.
299
</pre>
300 1 Andreas Smas
301 66 Adam Sutton
h3. getSysTime (Added in version 3)
302 1 Andreas Smas
303 66 Adam Sutton
Return system time on the server.
304
305 1 Andreas Smas
Request message fields:
306
<pre>
307
None
308
</pre>
309
310
Reply message fields:
311 66 Adam Sutton
<pre>
312 1 Andreas Smas
time               s64  required   UNIX time.
313 158 Kai Sommerfeld
timezone           s32  required   Hours west of GMT. (deprecated, does not work reliable, use gmtoffset instead)
314 156 Kai Sommerfeld
gmtoffset          s32  optional   Minutes east of GMT.
315 1 Andreas Smas
</pre>
316 23 Andreas Smas
317 1 Andreas Smas
----
318
319 66 Adam Sutton
h3. enableAsyncMetadata
320 1 Andreas Smas
321 66 Adam Sutton
When this is enabled the client will get continuous updates from the server about added, update or deleted channels, tags, dvr and epg entries.
322 1 Andreas Smas
323 66 Adam Sutton
An interactive application that presents the user with information about these things should probably enable this and the implement the various server to client methods.
324 1 Andreas Smas
325
Request message fields:
326
<pre>
327 66 Adam Sutton
epg                u32   optional   Set to 1, to include EPG data in async, implied by epgMaxTime (Added in version 6).
328
lastUpdate         s64   optional   Only provide metadata that has changed since this time (Added in version 6).
329
epgMaxTime         s64   optional   Maximum time to return EPG data up to (Added in version 6)
330
language           str   optional   RFC 2616 compatible language list (Added in version 6)
331 1 Andreas Smas
</pre>
332
333
Reply message fields:
334
<pre>
335 66 Adam Sutton
None
336 1 Andreas Smas
</pre>
337
338 66 Adam Sutton
Once the reply as been sent the initial data set will be provided, and then updates will arrive asynchronously after that. The initial data dump is sent using the following messages:
339 1 Andreas Smas
340 66 Adam Sutton
<pre>
341
tagAdd                   optional
342
channelAdd               optional
343
tagUpdate                optional
344
dvrEntryAdd              optional
345
eventAdd                 optional   (Added in version 6)
346
initialSyncComplete      required
347
</pre>
348 1 Andreas Smas
349 66 Adam Sutton
----
350 1 Andreas Smas
351 101 Jaroslav Kysela
h3. getChannel (Added in version 14)
352
353
Request information about the given channel.
354
355
Request message fields:
356
<pre>
357
channelId          u32   required   Channel ID.
358
</pre>
359
360
Reply message fields:
361
<pre>
362
see channelAdd
363
</pre>
364
365
----
366
367 66 Adam Sutton
h3. getEvent
368 1 Andreas Smas
369 66 Adam Sutton
Request information about the given event. An event typically corresponds to a program on a channel.
370 1 Andreas Smas
371 66 Adam Sutton
The language field in the request allows preference for languages to be requested for the various string fields.
372
373 1 Andreas Smas
Request message fields:
374 45 mdd -
<pre>
375 66 Adam Sutton
eventId            u32   required   Event ID.
376
language           str   optional   RFC 2616 compatible language list (Added in version 6)
377 1 Andreas Smas
</pre>
378
379
Reply message fields:
380
<pre>
381 66 Adam Sutton
see eventAdd
382 1 Andreas Smas
</pre>
383
384 66 Adam Sutton
h3. getEvents (Added in version 4)
385 1 Andreas Smas
386 66 Adam Sutton
Request information about a set of events. If no options are specified the entire EPG database will be returned.
387 57 sbi -
388 58 sbi -
Request message fields:
389 1 Andreas Smas
<pre>
390 66 Adam Sutton
eventId            u32   optional   Event ID to begin from (Optional since version 6)
391
channelId          u32   optional   Channel ID to get data for (Added in version 6)
392
numFollowing       u32   optional   Number of events to add (Optional since version 6)
393
maxTime            u64   optional   Maximum time to return data up to (Added in version 6)
394
language           str   optional   RFC 2616 compatible language list (Added in version 6)
395 1 Andreas Smas
</pre>
396
397
Reply message fields:
398
<pre>
399 66 Adam Sutton
events             msg[] required   List of events, using response message fields from eventAdd
400 1 Andreas Smas
</pre>
401 45 mdd -
402 66 Adam Sutton
h3. epgQuery (Added in version 4)
403 1 Andreas Smas
404 66 Adam Sutton
Query the EPG (event titles) and optionally restrict to channel/tag/content type.
405 1 Andreas Smas
406 66 Adam Sutton
Request message fields:
407
<pre>
408
query              str   required  Title regular expression to search for
409
channelId          u32   optional  [[ChannelId]] to restrict search to
410
tagId              u32   optional  [[TagId]] to restrict search to
411
contentType        u32   optional  DVB content type to restrict search to
412 98 Jaroslav Kysela
minduration        u32   optional  Minimal duration in seconds (Added in version 13)
413
maxduration        u32   optional  Maximal duration in seconds (Added in version 13)
414 66 Adam Sutton
language           str   optional  RFC 2616 compatible language list for title (Added in version 6)
415
full               u32   optional  Output full event list rather than just IDs
416
</pre>
417 1 Andreas Smas
418 66 Adam Sutton
Reply message fields:
419 1 Andreas Smas
420 66 Adam Sutton
if full == 1
421
<pre>
422
events             msg[] optional   List of events, using response message fields from eventAdd
423
</pre>
424
else
425
<pre>
426
eventIds           u32[] optional  List of eventIds that match the query
427
</pre>
428 1 Andreas Smas
429 66 Adam Sutton
h3. getEpgObject
430
431
Get detailed EPG Object info.
432
433 58 sbi -
Request message fields:
434 1 Andreas Smas
<pre>
435 66 Adam Sutton
id                 u32   required  Object ID
436
type               u32   optional  Object type
437 1 Andreas Smas
</pre>
438 58 sbi -
439 1 Andreas Smas
Reply message fields:
440 66 Adam Sutton
441 1 Andreas Smas
<pre>
442 66 Adam Sutton
TODO
443 1 Andreas Smas
</pre>
444
445 58 sbi -
----
446 1 Andreas Smas
447 109 Jaroslav Kysela
h3. getDvrConfigs (Added in version 16)
448
449
Return a list of DVR configurations.
450
451
Reply message fields:
452
<pre>
453
dvrconfigs         msg[]      optional   Supported DVR configurations.
454
</pre>
455
456
Message fields:
457
<pre>
458
uuid               str        required   DVR configuration ID
459
name               str        required   DVR configuration Name
460
comment            str        required   DVR configuration Comment
461
</pre>
462
463 66 Adam Sutton
h3. addDvrEntry (Added in version 4)
464
465 1 Andreas Smas
Create a new DVR entry. Either eventId or channelId, start and stop must be specified.
466
467
Request message fields:
468 66 Adam Sutton
<pre>
469
eventId            u32   optional   Event ID (Optional since version 5).
470
channelId          u32   optional   Channel ID (Added in version 5)
471
start              s64   optional   Time to start recording (Added in version 5)
472 96 Jaroslav Kysela
stop               s64   optional   Time to stop recording (Added in version 5)
473 66 Adam Sutton
retention          u32   optional   Retention time in days (Added in version 13)
474 117 Jaroslav Kysela
creator            str   optional   Name of the event creator (Added in version 5, obsoleted in version 18 - applications are not allowed to change credential)
475 66 Adam Sutton
priority           u32   optional   Recording priority (Added in version 5)
476
startExtra         s64   optional   Pre-recording buffer in minutes (Added in version 5)
477
stopExtra          s64   optional   Post-recording buffer in minutes (Added in version 5)
478
title              str   optional   Recording title, if no eventId (Added in version 6)
479 132 Jaroslav Kysela
subtitle           str   optional   Recording subtitle, if no eventId (Added in version 20)
480 1 Andreas Smas
description        str   optional   Recording description, if no eventId (Added in version 5)
481
configName         str   optional   DVR configuration name or UUID
482 157 Kai Sommerfeld
enabled            u32   optional   Enabled flag (Added in version 23).
483 40 Andreas Smas
</pre>
484 1 Andreas Smas
485
Reply message fields:
486
<pre>
487 66 Adam Sutton
success            u32   required   1 if entry was added, 0 otherwise
488
id                 u32   optional   ID of created DVR entry
489 1 Andreas Smas
error              str   optional   English clear text of error message
490
</pre>
491 66 Adam Sutton
492 1 Andreas Smas
h3. updateDvrEntry (Added in version 5)
493 66 Adam Sutton
494 1 Andreas Smas
Update an existing DVR entry.
495
496 66 Adam Sutton
Request message fields:
497
<pre>
498 1 Andreas Smas
id                 u32   required   DVR Entry ID
499 151 Kai Sommerfeld
channelId          u32   optional   New channel ID (Added in version 22)
500 66 Adam Sutton
start              s64   optional   New start time
501 1 Andreas Smas
stop               s64   optional   New stop time
502 66 Adam Sutton
title              str   optional   New entry title
503 151 Kai Sommerfeld
subtitle           str   optional   New entry subtitle (Added in version 21)
504 66 Adam Sutton
description        str   optional   New entry description (Added in version 6)
505 1 Andreas Smas
startExtra         s64   optional   New pre-record buffer (Added in version 6)
506 66 Adam Sutton
stopExtra          s64   optional   New post-record buffer (Added in version 6)
507 109 Jaroslav Kysela
configName         str   optional   New DVR configuration name or UUID
508 1 Andreas Smas
retention          u32   optional   Retention in days (Added in version 13)
509 99 Jaroslav Kysela
priority           u32   optional   Recording priority (Added in version 13)
510 157 Kai Sommerfeld
enabled            u32   optional   Enabled flag (Added in version 23).
511 1 Andreas Smas
</pre>
512
513
Reply message fields:
514
<pre>
515 66 Adam Sutton
success            u32   required   1 if update as successful, otherwise 0
516
error              str   optional   Error message if update failed
517 40 Andreas Smas
</pre>
518
519 66 Adam Sutton
h3. cancelDvrEntry (Added in version 5)
520 1 Andreas Smas
521 66 Adam Sutton
Cancel an existing recording, but don't remove the entry from the database.
522 1 Andreas Smas
523 66 Adam Sutton
Request message fields:
524
<pre>
525
id                 u32   required   dvrEnryId to delete
526
</pre>
527 1 Andreas Smas
528 66 Adam Sutton
Reply message fields:
529
<pre>
530
success            int   required   1 if entry was cancelled
531
error              str   optional   Error message if cancellation failed
532
</pre>
533 1 Andreas Smas
534 66 Adam Sutton
h3. deleteDvrEntry (Added in version 4)
535
536
Delete an existing DVR entry from the database.
537
538
Request message fields:
539 1 Andreas Smas
<pre>
540 66 Adam Sutton
id                 u32   required   DVR Entry ID
541 1 Andreas Smas
</pre>
542
543 11 Andreas Smas
Reply message fields:
544 1 Andreas Smas
<pre>
545 66 Adam Sutton
success            u32   required   1 if entry was removed
546
error              str   optional   Error message if the delete fails
547 1 Andreas Smas
</pre>
548
549 103 Jaroslav Kysela
h3. getDvrCutpoints (Added in version 12)
550
551
Get DVR cutpoints.
552
553
Request message fields:
554
<pre>
555
id                 u32   required   DVR Entry ID
556
</pre>
557
558
Reply message fields:
559
<pre>
560
cutpoints          msg[] optional   List of cutpoint entries, if a file is found and has some valid data.
561
</pre>
562
563
Cutpoint fields:
564
<pre>
565
start              u32   required   Cut start time in ms.
566
end                u32   required   Cut end time in ms.
567
type               u32   required   Action type: 
568
                                      0=Cut, 1=Mute, 2=Scene, 
569
                                      3=Commercial break.
570
</pre>
571
572 102 Jaroslav Kysela
---
573
574 91 Jaroslav Kysela
h3. addAutorecEntry (Added in version 13)
575
576
Create a new Autorec DVR entry. Title must be specified.
577
578
Request message fields:
579
<pre>
580 128 Jaroslav Kysela
enabled            u32   optional   Enabled flag (Added in version 19).
581 91 Jaroslav Kysela
title              str   required   Title for the recordings.
582 133 Jaroslav Kysela
fulltext           u32   optional   Full text flag (Added in version 20).
583 121 Jaroslav Kysela
directory          str   optional   Forced directory name - missing or empty = auto (Added in version 19).
584 120 Jaroslav Kysela
name               str   optional   Name of this autorec entry (Added in version 18).
585 91 Jaroslav Kysela
configName         str   optional   DVR Configuration Name / UUID.
586
channelId          u32   optional   Channel ID.
587
minDuration        u32   optional   Minimal duration in seconds (0 = Any).
588
maxDuration        u32   optional   Maximal duration in seconds (0 = Any).
589 1 Andreas Smas
daysOfWeek         u32   optional   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
590
priority           u32   optional   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
591 117 Jaroslav Kysela
approxTime         u32   optional   Minutes from midnight (up to 24*60) (window +- 15 mintes) (Obsoleted from version 18).
592
start              s32   optional   Minutes from midnight (up to 24*60) for the start of the time window (including) (Added in version 18).
593
startWindow        s32   optional   Minutes from modnight (up to 24*60) for the end of the time window (including, cross-noon allowed) (Added in version 18).
594 91 Jaroslav Kysela
startExtra         s64   optional   Extra start minutes (pre-time).
595
stopExtra          s64   optional   Extra stop minutes (post-time).
596 134 Jaroslav Kysela
dupDetect          u32   optional   Dup Detect (0 = all, 1 = diff episode, 2 = diff subtitle, 3 = diff description, 4 = once per week, 5 = once per day) (Added in version 20).
597 91 Jaroslav Kysela
comment            str   optional   User Comment.
598
</pre>
599 83 Jaroslav Kysela
600
Reply message fields:
601
<pre>
602
success            u32   required   1 if entry was added, 0 otherwise
603
id                 str   optional   ID (string!) of created autorec DVR entry
604
error              str   optional   English clear text of error message
605
</pre>
606
607
h3. deleteAutorecEntry (Added in version 13)
608
609
Delete an existing autorec DVR entry from the database.
610
611
Request message fields:
612
<pre>
613
id                 str   required   Autorec DVR Entry ID (string!)
614
</pre>
615
616
Reply message fields:
617
<pre>
618
success            u32   required   1 if entry was removed
619
error              str   optional   Error message if the delete fails
620 1 Andreas Smas
</pre>
621 83 Jaroslav Kysela
622 117 Jaroslav Kysela
---
623 1 Andreas Smas
624 117 Jaroslav Kysela
h3. addTimerecEntry (Added in version 18)
625
626
Create a new Timerec DVR entry. Title must be specified.
627
628
Request message fields:
629
<pre>
630 129 Jaroslav Kysela
enabled            u32   optional   Enabled flag (Added in version 19).
631 117 Jaroslav Kysela
title              str   required   Title for the recordings.
632 125 Jaroslav Kysela
directory          str   optional   Forced output directory name (Added in version 19).
633 117 Jaroslav Kysela
name               str   optional   Name for this timerec entry.
634
configName         str   optional   DVR Configuration Name / UUID.
635 150 Jaroslav Kysela
channelId          u32   optional   Channel ID.
636 117 Jaroslav Kysela
daysOfWeek         u32   optional   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
637
priority           u32   optional   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
638 150 Jaroslav Kysela
start              u32   optional   Minutes from midnight (up to 24*60) for the start of the time window (including)
639
stop               u32   optional   Minutes from modnight (up to 24*60) for the end of the time window (including, cross-noon allowed)
640 117 Jaroslav Kysela
retention          u32   optional   Retention in days. 
641
comment            str   optional   User Comment.
642
</pre>
643
644
Reply message fields:
645
<pre>
646
success            u32   required   1 if entry was added, 0 otherwise
647
id                 str   optional   ID (string!) of created timerec DVR entry
648
error              str   optional   English clear text of error message
649
</pre>
650
651
h3. deleteTimerecEntry (Added in version 18)
652
653
Delete an existing timerec DVR entry from the database.
654
655
Request message fields:
656
<pre>
657
id                 str   required   Timerec DVR Entry ID (string!)
658
</pre>
659
660
Reply message fields:
661
<pre>
662
success            u32   required   1 if entry was removed
663
error              str   optional   Error message if the delete fails
664
</pre>
665
666
----
667
668 66 Adam Sutton
h3. getTicket (Added in version 5)
669 1 Andreas Smas
670 66 Adam Sutton
Get a ticket to allow access to a channel or recording via HTTP
671 1 Andreas Smas
672 66 Adam Sutton
Request message fields:
673 1 Andreas Smas
<pre>
674 66 Adam Sutton
channelId          u32  optional   Channel to gain access for
675
dvrId              u32  optional   DVR file to gain access for
676 1 Andreas Smas
</pre>
677
678
Reply message fields:
679
<pre>
680 66 Adam Sutton
path               str  required   The full path for access URL (no scheme, host or port)
681
ticket             str  required   The ticket to pass in the URL query string
682 1 Andreas Smas
</pre>
683
684 66 Adam Sutton
h3. subscribe
685 1 Andreas Smas
686 66 Adam Sutton
Request subscription to the given channel. 
687 1 Andreas Smas
688 66 Adam Sutton
Request message fields:
689
<pre>
690
channelId          u32   required   ID for channel. 
691
subscriptionId     u32   required   Subscription ID. Selected by client. This value is not interpreted by the server in any form. 
692
                                    The value is used from now on in all messages related to the subscription.
693 1 Andreas Smas
weight             u32   optional   Weighting of this subscription (same as recording priority).
694 73 Adam Sutton
90khz              u32   optional   Request PTS/DTS in default 90kHz timebase, default is 1MHz (Added in version 7)
695
normts             u32   optional   Request PTS/DTS normalisation (Added in version 7)
696
                                    Note: this will mean missing timestamps are added, first packet should be ~0 and will always be an i-frame.
697
                                    Note: this is implied if timeshiftPeriod is enabled
698 114 Jaroslav Kysela
                                    Note: from version 17, this is always enabled and this parameter is ignored.
699 73 Adam Sutton
queueDepth         u32   optional   Change the default packet queue lengths, default 500000 bytes (Added in version 7)
700
                                    Note: I-frame depth is 3*queueDepth, P-frame is 2*queueDepth and B-frame is queueDepth
701
timeshiftPeriod    u32   optional   The number of seconds to keep in the timeshift buffer (Added in version 9)
702
                                    Note: this may be bounded by server configuration settings
703 108 Jaroslav Kysela
profile            str   optional   Select stream profile (Added in version 16).
704 11 Andreas Smas
</pre>
705 66 Adam Sutton
706 1 Andreas Smas
Reply message fields:
707
<pre>
708 73 Adam Sutton
90khz              u32   optional   Indicates 90khz timestamps will be used
709
normts             u32   optional   Indicates timestamps will be normalised (and fixed)
710
timeshiftPeriod    u32   optional   The actual timeshiftPeriod to be used
711 66 Adam Sutton
</pre>
712 1 Andreas Smas
713 66 Adam Sutton
h3. unsubscribe
714
715
Stop a subscription.
716
717
Request message fields:
718 1 Andreas Smas
<pre>
719 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
720 58 sbi -
</pre>
721
722 11 Andreas Smas
Reply message fields:
723 1 Andreas Smas
<pre>
724 66 Adam Sutton
None
725 58 sbi -
</pre>
726 11 Andreas Smas
727 66 Adam Sutton
h3. subscriptionChangeWeight (Added in version 5)
728 1 Andreas Smas
729 66 Adam Sutton
Change the weight of an existing subscription
730 1 Andreas Smas
731 66 Adam Sutton
Request message fields:
732
<pre>
733
subscriptionId     u32   required   Subscription ID.
734
weight             u32   optional   The new subscription weight.
735 1 Andreas Smas
</pre>
736
737
Reply message fields:
738
<pre>
739 69 Adam Sutton
None
740 1 Andreas Smas
</pre>
741
742 73 Adam Sutton
h3. subscriptionSkip (Added in version 9)
743
744
Skip a timeshift enabled subscription. The response will be asynchronous subscriptionSkip().
745
746
Request message fields:
747
<pre>
748
subscriptionId     u32   required   Subscription ID.
749
absolute           u32   optional   The skip request is absolute
750
time               u64   optional   Specify skip using time (units are as for PTS)
751
size               u64   optional   Specify skip using size (Not currently used)
752
</pre>
753
754
Reply message fields:
755
<pre>
756
None
757
</pre>
758
759
h3. subscriptionSeek (Added in version 9)
760
761
Synonym for subscriptionSkip
762
763
h3. subscriptionSpeed (Added in version 9)
764
765
Set the playback speed for the subscription. The response will be asynchronous subscriptionSpeed().
766
767
Request message fields:
768
<pre>
769
subscriptionId     u32   required   Subscription ID.
770
speed              u32   required   Specify speed (0=pause, 100=1x fwd, -100=1x backward)
771
</pre>
772
773
Reply message fields:
774
<pre>
775
None
776
</pre>
777
778
h3. subscriptionLive (Added in version 9)
779
780
Return a timeshifted session to live. Reply will be asynchronous subscriptionSkip().
781
782
Request message fields:
783
<pre>
784
subscriptionId     u32   required   Subscription ID.
785
</pre>
786
787
Reply message fields:
788
<pre>
789
None
790 82 Jaroslav Kysela
</pre>
791 1 Andreas Smas
792 83 Jaroslav Kysela
h3. subscriptionFilterStream (Added in version 12)
793 1 Andreas Smas
794 83 Jaroslav Kysela
Enable or disable specified streams by index.
795
796
Request message fields:
797
<pre>
798
subscriptionId     u32        required   Subscription ID.
799
enable             list[u32]  optional   Enable stream indexes
800
disable            list[u32]  optional   Disable (filter out) stream indexes
801
</pre>
802
803
Reply message fields:
804 1 Andreas Smas
<pre>
805
None
806 109 Jaroslav Kysela
</pre>
807
808
---
809
810
h3. getProfiles (Added in version 16)
811
812
Return a list of stream profiles (configurations).
813
814
Reply message fields:
815
<pre>
816
profiles           msg[]      optional   Supported profiles
817
</pre>
818
819
Message fields:
820
<pre>
821
uuid               str        required   Profile ID
822
name               str        required   Profile Name
823
comment            str        required   Profile Comment
824 83 Jaroslav Kysela
</pre>
825
826
h3. getCodecs (Added in version 11, Removed in version 16)
827
828 82 Jaroslav Kysela
Return a list of encoders (codecs).
829
830 1 Andreas Smas
Reply message fields:
831 82 Jaroslav Kysela
<pre>
832 83 Jaroslav Kysela
encoders           list[str]  optional   Supported encoders
833 82 Jaroslav Kysela
</pre>
834
835 70 Adam Sutton
h3. fileOpen (Added in version 8)
836 69 Adam Sutton
837
Open a file within the Tvheadend file system. This is now the preferred method (in place of HTTP) for accessing recordings.
838
839
Accessing recordings via HTSP will overcome the limitations of standard HTTP streaming which cannot handle both skipping and growing files (i.e. in-progress recordings) at the same time.
840
841 1 Andreas Smas
Request message fields:
842 69 Adam Sutton
<pre>
843 70 Adam Sutton
file               str   required   File path to open
844 1 Andreas Smas
</pre>
845
846 70 Adam Sutton
Valid file paths:
847
<pre>
848
/dvrfile/ID        will open the file associated with DVR entry ID
849 74 Adam Sutton
/imagecache/ID     will open the file associated with imagecache entry ID (Note: only works for HTSPv10+)
850 70 Adam Sutton
</pre>
851
852 69 Adam Sutton
Reply message fields:
853
<pre>
854
id                 u32   required   The file handle used for further file operations
855
size               u64   optional   The size of the file in bytes
856 1 Andreas Smas
mtime              u64   optional   The last time the file was modified
857 69 Adam Sutton
</pre>
858
859 70 Adam Sutton
h3. fileRead (Added in version 8)
860 69 Adam Sutton
861 1 Andreas Smas
Read data from a file.
862
863 69 Adam Sutton
Request message fields:
864
<pre>
865
id                 u32   required   The file handle used for further file operations
866 70 Adam Sutton
size               u64   required   The amount of data to read
867
offset             u64   optional   Offset into the file to read (default is current position)
868 69 Adam Sutton
</pre>
869 1 Andreas Smas
870 69 Adam Sutton
Reply message fields:
871
<pre>
872
data               bin   required   The data read from the file (size may be less than requested)
873
</pre>
874
875 70 Adam Sutton
h3. fileClose (Added in version 8)
876 69 Adam Sutton
877
Close an opened file.
878
879
Request message fields:
880
<pre>
881 1 Andreas Smas
id                 u32   required   The file handle to be closed
882 69 Adam Sutton
</pre>
883
884
Reply message fields:
885
<pre>
886
None
887
</pre>
888 70 Adam Sutton
889 69 Adam Sutton
h3. fileStat (Added in version 8)
890
891
Get status of a file.
892
893
Request message fields:
894
<pre>
895
id                 u32   required   The file handle to be stat'd
896 1 Andreas Smas
</pre>
897
898
Reply message fields:
899
<pre>
900
size               u64   optional   The size of the file in bytes
901
mtime              u64   optional   The last time the file was modified
902
</pre>
903 70 Adam Sutton
904
h3. fileSeek (Added in version 8)
905
906
Seek to position in a file.
907
908
Request message fields:
909
<pre>
910
id                 u32   required   The file handle to be stat'd
911
offset             u64   required   The position to seek in the file
912
whence             str   required   Where to seek relative to (default=SEEK_SET)
913
</pre>
914
915
Note: valid values for whence
916
<pre>
917
SEEK_SET           Seek relative to start of file
918
SEEK_CUR           Seek relative to current position in file
919 72 Adam Sutton
SEEK_END           Seek relative (backwards) to end of file
920 70 Adam Sutton
</pre>
921
922
Reply message fields:
923
<pre>
924
offset             u64   optional   The new absolute position within the file
925
</pre>
926 66 Adam Sutton
927 1 Andreas Smas
h1. Server to Client methods
928
929
----
930
931
h3. channelAdd
932
933
A new channel has been created on the server.
934
935
Message fields:
936
<pre>
937
channelId          u32   required   ID of channel.
938 66 Adam Sutton
channelNumber      u32   required   Channel number, 0 means unconfigured.
939 90 Jaroslav Kysela
channelNumberMinor u32   optional   Minor channel number (Added in version 13).
940 1 Andreas Smas
channelName        str   required   Name of channel.
941 70 Adam Sutton
channelIcon        str   optional   URL to an icon representative for the channel
942
                                    (For v8+ clients this could be a relative /imagecache/ID URL
943 73 Adam Sutton
                                     intended to be fed to fileOpen() or HTTP server)
944 104 Jaroslav Kysela
                                    (For v15+ clients this could be a relative imagecache/ID URL
945
                                     intended to be fed to fileOpen() or HTTP server)
946 66 Adam Sutton
eventId            u32   optional   ID of the current event on this channel.
947
nextEventId        u32   optional   ID of the next event on the channel.
948
tags               u32[] optional   Tags this channel is mapped to.
949
services           msg[] optional   List of available services (Added in version 5)
950 13 Andreas Smas
</pre>
951 1 Andreas Smas
952 66 Adam Sutton
Service fields:
953 1 Andreas Smas
<pre>
954 66 Adam Sutton
name               str   required   Service name
955
type               str   required   Service type
956
caid               u32   optional   Encryption CA ID
957
caname             str   optional   Encryption CA name
958 11 Andreas Smas
</pre>
959 1 Andreas Smas
960 66 Adam Sutton
h3. channelUpdate
961 11 Andreas Smas
962 66 Adam Sutton
Same as channelAdd, but all fields (except channelId) are optional.
963
964 58 sbi -
h3. channelDelete
965 1 Andreas Smas
966
A channel has been deleted on the server.
967 58 sbi -
968
Message fields:
969 1 Andreas Smas
<pre>
970
channelId          u32   required   ID of channel.
971
</pre>
972
973
----
974
975 11 Andreas Smas
h3. tagAdd
976 1 Andreas Smas
977
A new tag has been created on the server.
978
979
Message fields:
980
<pre>
981 66 Adam Sutton
tagId              u32   required   ID of tag.
982
tagName            str   required   Name of tag.
983 117 Jaroslav Kysela
tagIndex           u32   optional   Index value for sorting (default by from min to max) (Added in version 18).
984 66 Adam Sutton
tagIcon            str   optional   URL to an icon representative for the channel.
985
tagTitledIcon      u32   optional   Icon includes a title
986 1 Andreas Smas
members            u32[] optional   Channel IDs of those that belong to the tag
987 11 Andreas Smas
</pre>
988 39 elupus -
989 58 sbi -
h3. tagUpdate
990 66 Adam Sutton
991 11 Andreas Smas
Same as tagAdd, but all fields (except tagId) are optional.
992
993 1 Andreas Smas
h3. tagDelete
994 58 sbi -
995 1 Andreas Smas
A tag has been deleted from the server.
996
997
Message fields:
998 66 Adam Sutton
<pre>
999 58 sbi -
tagId              u32   required   ID of tag.
1000
</pre>
1001 12 Andreas Smas
1002 1 Andreas Smas
----
1003 66 Adam Sutton
1004 58 sbi -
h3. dvrEntryAdd (Added in version 4)
1005 1 Andreas Smas
1006 58 sbi -
A new recording has been created on the server.
1007 1 Andreas Smas
1008 2 Andreas Smas
Message fields:
1009 66 Adam Sutton
<pre>
1010
id                 u32   required   ID of dvrEntry.
1011 155 Kai Sommerfeld
channel            u32   optional   Channel of dvrEntry.
1012 66 Adam Sutton
start              s64   required   Time of when this entry was scheduled to start recording.
1013 89 Jaroslav Kysela
stop               s64   required   Time of when this entry was scheduled to stop recording.
1014
startExtra         s64   required   Extra start time (pre-time) in minutes (Added in version 13).
1015 1 Andreas Smas
stopExtra          s64   required   Extra stop time (post-time) in minutes (Added in version 13).
1016 152 Adam Sutton
retention          s64   required   DVR Entry retention time in days (Added in version 13).
1017 89 Jaroslav Kysela
priority           u32   required   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set) (Added in version 13).
1018
eventId            u32   optional   Associated EPG Event ID (Added in version 13).
1019 117 Jaroslav Kysela
autorecId          str   optional   Associated Autorec UUID (Added in version 13).
1020
timerecId          str   optional   Associated Timerec UUID (Added in version 18).
1021 89 Jaroslav Kysela
contentType        u32   optional   Content Type (like in the DVB standard) (Added in version 13).
1022 66 Adam Sutton
title              str   optional   Title of recording
1023 137 Jaroslav Kysela
subtitle           str   optional   Subtitle of recording (Added in version 20).
1024 1 Andreas Smas
summary            str   optional   Short description of the recording (Added in version 6).
1025
description        str   optional   Long description of the recording.
1026 66 Adam Sutton
state              str   required   Recording state
1027
error              str   optional   Plain english error description (e.g. "Aborted by user").
1028 117 Jaroslav Kysela
owner              str   optional   Name of the entry owner (Added in version 18).
1029
creator            str   optional   Name of the entry creator (Added in version 18).
1030 135 Jaroslav Kysela
subscriptionError  str   optional   Subscription error string (Added in version 20).
1031
streamErrors       str   optional   Number of recording errors (Added in version 20).
1032
dataErrors         str   optional   Number of stream data errors (Added in version 20).
1033 146 Jaroslav Kysela
path               str   optional   Recording path for playback.
1034 1 Andreas Smas
files              msg   optional   All recorded files for playback (Added in version 21).
1035 146 Jaroslav Kysela
dataSize           s64   optional   Actual file size of the last recordings (Added in version 21).
1036 157 Kai Sommerfeld
enabled            u32   optional   Enabled flag (Added in version 23).
1037 1 Andreas Smas
</pre>
1038 66 Adam Sutton
1039 153 Kai Sommerfeld
Valid values for state:
1040
<pre>
1041
TODO
1042
</pre>
1043 1 Andreas Smas
1044 153 Kai Sommerfeld
Valid values for subscriptionError:
1045
<pre>
1046
noFreeAdapter            No free adapter for this service.
1047
scrambled                Service is scrambled.
1048
badSignal                Bad signal status.
1049
tuningFailed             Tuning of this service failed.
1050
subscriptionOverridden   Subscription overridden by another one.
1051
muxNotEnabled            No mux enabled for this service.
1052
invalidTarget            Recording/livestream cannot be saved to filesystem or recording/streaming configuration is incorrect.
1053
userAccess               User does not have access rights for this service.
1054
userLimit                Maximum number of streaming connections set in user's profile reached.
1055
</pre>
1056
1057 48 mdd -
h3. dvrEntryUpdate
1058 66 Adam Sutton
1059
Message fields:
1060
<pre>
1061
Same as dvrEntryAdd, but all fields (except id) are optional.
1062 51 elupus -
</pre>
1063 66 Adam Sutton
1064 58 sbi -
h3. dvrEntryDelete (Added in version 4)
1065 66 Adam Sutton
1066 58 sbi -
A recording has been deleted from the server.
1067 48 mdd -
1068
Message fields:
1069 66 Adam Sutton
<pre>
1070 1 Andreas Smas
id                 u32   required   ID of recording to delete.
1071 48 mdd -
</pre>
1072 58 sbi -
1073 48 mdd -
----
1074 95 Jaroslav Kysela
1075
h3. autorecEntryAdd (Added in version 13)
1076
1077
A new autorec recording has been created on the server.
1078
1079 1 Andreas Smas
Message fields:
1080 95 Jaroslav Kysela
<pre>
1081
id                 str   required   ID (string!) of dvrAutorecEntry.
1082
enabled            u32   required   If autorec entry is enabled (activated).
1083 117 Jaroslav Kysela
name               str   required   Name of the autorec entry (Added in version 18).
1084 95 Jaroslav Kysela
minDuration        u32   required   Minimal duration in seconds (0 = Any).
1085
maxDuration        u32   required   Maximal duration in seconds (0 = Any).
1086
retention          u32   required   Retention time (in days).
1087
daysOfWeek         u32   required   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
1088
priority           u32   required   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
1089
approxTime         u32   required   Minutes from midnight (up to 24*60).
1090 149 Jaroslav Kysela
start              s32   required   Exact start time (minutes from midnight) (Added in version 18).
1091
startWindow        s32   required   Exact stop time (minutes from midnight) (Added in version 18).
1092 1 Andreas Smas
startExtra         s64   required   Extra start minutes (pre-time).
1093
stopExtra          s64   required   Extra stop minutes (post-time).
1094 95 Jaroslav Kysela
title              str   optional   Title.
1095 136 Jaroslav Kysela
fulltext           u32   optional   Fulltext flag (Added in version 20).
1096 122 Jaroslav Kysela
directory          str   optional   Forced directory name (Added in version 19).
1097 95 Jaroslav Kysela
channel            u32   optional   Channel ID.
1098 117 Jaroslav Kysela
owner              str   optional   Owner of this autorec entry (Added in version 18).
1099
creator            str   optional   Creator of this autorec entry (Added in version 18).
1100 136 Jaroslav Kysela
dupDetect          u32   optional   Duplicate detection (see addAutorecEntry) (Added in version 20).
1101 95 Jaroslav Kysela
</pre>
1102 1 Andreas Smas
1103 95 Jaroslav Kysela
h3. autorecEntryUpdate (Added in version 13)
1104
1105
Message fields:
1106
<pre>
1107 117 Jaroslav Kysela
Same as autorecEntryAdd but all fields (except id) are optional.
1108 95 Jaroslav Kysela
</pre>
1109
1110 1 Andreas Smas
h3. autorecEntryDelete (Added in version 13)
1111
1112
Message fields:
1113
<pre>
1114
id                 str   required   Autorec Entry ID (string!)
1115 117 Jaroslav Kysela
</pre>
1116
1117
----
1118
1119 118 Jaroslav Kysela
h3. timerecEntryAdd (Added in version 18)
1120 117 Jaroslav Kysela
1121
A new autorec recording has been created on the server.
1122
1123
Message fields:
1124
<pre>
1125
title              str   required   Title for the recordings.
1126 123 Jaroslav Kysela
directory          str   optional   Forced directory name (Added in version 19).
1127 117 Jaroslav Kysela
enabled            u32   required   Title for the recordings.
1128
name               str   required   Name for this timerec entry.
1129
configName         str   required   DVR Configuration Name / UUID.
1130 148 Jaroslav Kysela
channel            u32   required   Channel ID.
1131 117 Jaroslav Kysela
daysOfWeek         u32   optional   Bitmask - Days of week (0x01 = Monday, 0x40 = Sunday, 0x7f = Whole Week, 0 = Not set).
1132
priority           u32   optional   Priority (0 = Important, 1 = High, 2 = Normal, 3 = Low, 4 = Unimportant, 5 = Not set).
1133
start              u32   required   Minutes from midnight (up to 24*60) for the start of the time window (including)
1134
stop               u32   required   Minutes from modnight (up to 24*60) for the end of the time window (including, cross-noon allowed)
1135 148 Jaroslav Kysela
retention          u32   optional   Retention in days.
1136 117 Jaroslav Kysela
owner              str   optional   Owner of this timerec entry.
1137
creator            str   optional   Creator of this timerec entry.
1138
</pre>
1139
1140
h3. timerecEntryUpdate (Added in version 18)
1141
1142
Message fields:
1143
<pre>
1144
Same as timerecEntryAdd but all fields (except id) are optional.
1145
</pre>
1146
1147
h3. timerecEntryDelete (Added in version 18)
1148
1149
Message fields:
1150
<pre>
1151
id                 str   required   Timerec Entry ID (string!)
1152 95 Jaroslav Kysela
</pre>
1153
1154
----
1155
1156 66 Adam Sutton
h3. eventAdd (Added in version 6)
1157 48 mdd -
1158 66 Adam Sutton
Message fields:
1159
<pre>
1160
eventId            u32   required   Event ID
1161
channelId          u32   required   The channel this event is related to.
1162
start              u64   required   Start time of event, UNIX time.
1163
stop               u64   required   Ending time of event, UNIX time.
1164
title              str   optional   Title of event.
1165
summary            str   optional   Short description of the event (Added in version 6).
1166
description        str   optional   Long description of the event.
1167
serieslinkId       u32   optional   Series Link ID (Added in version 6).
1168
episodeId          u32   optional   Episode ID (Added in version 6).
1169
seasonId           u32   optional   Season ID (Added in version 6).
1170
brandId            u32   optional   Brand ID (Added in version 6).
1171
contentType        u32   optional   DVB content code (Added in version 4, Modified in version 6*).
1172
ageRating          u32   optional   Minimum age rating (Added in version 6).
1173
starRating         u32   optional   Star rating (1-5) (Added in version 6).
1174
firstAired         s64   optional   Original broadcast time, UNIX time (Added in version 6).
1175
seasonNumber       u32   optional   Season number (Added in version 6).
1176
seasonCount        u32   optional   Show season count (Added in version 6).
1177
episodeNumber      u32   optional   Episode number (Added in version 6).
1178
episodeCount       u32   optional   Season episode count (Added in version 6).
1179
partNumber         u32   optional   Multi-part episode part number (Added in version 6).
1180
partCount          u32   optional   Multi-part episode part count (Added in version 6).
1181
episodeOnscreen    str   optional   Textual representation of episode number (Added in version 6).
1182
image              str   optional   URL to a still capture from the episode (Added in version 6).
1183
dvrId              u32   optional   ID of a recording (Added in version 5).
1184
nextEventId        u32   optional   ID of next event on the same channel.
1185
</pre>
1186 48 mdd -
1187 66 Adam Sutton
* *contentType previously had the major DVB category in the bottom 4 bits, 
1188
  however in v6 this has been changed to properly match DVB, so top 4 bits
1189
  as major category and bottom 4 bits has sub-category. Clients requesting
1190
  v5 or lower will get the old output.
1191 48 mdd -
1192 66 Adam Sutton
h3. eventUpdate (Added in version 6)
1193 35 Andreas Smas
1194 58 sbi -
Message fields:
1195
<pre>
1196 66 Adam Sutton
Same as eventAdd but all fields (except eventId) are optional.
1197 35 Andreas Smas
</pre>
1198 58 sbi -
1199 77 John Törnblom
h3. eventDelete (Added in version 6)
1200 35 Andreas Smas
1201 66 Adam Sutton
Message fields:
1202
<pre>
1203
eventId            u32   required   Event ID
1204
</pre>
1205 14 Andreas Smas
1206 66 Adam Sutton
---
1207 14 Andreas Smas
1208 66 Adam Sutton
h3. initialSyncCompleted (Added in version 2)
1209 14 Andreas Smas
1210 66 Adam Sutton
Sent after all the initial metadata has been sent when session has been set to async mode.
1211 38 Andreas Smas
1212
Message fields:
1213 14 Andreas Smas
<pre>
1214
</pre>
1215
1216
----
1217
1218
h3. subscriptionStart
1219 53 Andreas Smas
1220 66 Adam Sutton
Asynchronous message output when a new subscription is successfully started.
1221 14 Andreas Smas
1222
Message fields:
1223 1 Andreas Smas
<pre>
1224 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1225
streams            msg[] required   Array of messages with stream information
1226
sourceinfo         msg   optional   Source information.
1227
</pre>
1228 37 Andreas Smas
1229 66 Adam Sutton
Stream message fields:
1230
<pre>
1231
index              u32   required   Index for this stream
1232
type               str   required   Type of stream
1233 113 Jaroslav Kysela
meta               bin   optional   Codec metadata (private data, libav - extradata) (Added in version 17)
1234 66 Adam Sutton
language           str   optional   Language for stream
1235
Video components only:
1236
width              u32   optional   Width of video in pixels
1237
height             u32   optional   Height of video in pixels
1238 68 Andreas Smas
aspect_num         u32   optional   Aspect ratio numerator (Added in version 5) *Can be incorrect and should not be relied upon*
1239
aspect_den         u32   optional   Aspect ratio denonminator (Added in version 5) *Can be incorrect and should not be relied upon*
1240 66 Adam Sutton
Audio components only:
1241 76 Dave Chapman
audio_type         u32   optional   Audio type - 0=Normal; 1=Clean effects; 2=Hearing impaired; 3=Visually impaired commentary; 4-255=Reserved (Added in version 11)
1242 66 Adam Sutton
channels           u32   optional   Number of audio channels (Added in version 5)
1243
rate               u32   optional   Audio bitrate (Added in version 5)
1244
Subtitle components only:
1245
composition_id     u32   optional   ??? (Added in version 5)
1246
ancillary_id       u32   optional   ??? (Added in version 5)
1247
</pre>
1248 2 Andreas Smas
1249 66 Adam Sutton
Sourceinfo message fields:
1250
<pre>
1251
adapter            str   optional   Adapter name
1252
mux                str   optional   Transponder name
1253
network            str   optional   Network name
1254 142 Jaroslav Kysela
provider           str   optional   Provide name (like 'Sky UK')
1255 1 Andreas Smas
service            str   optional   Service name
1256 143 Jaroslav Kysela
satpos             str   optional   Satellite position name (Added in version 20).
1257 66 Adam Sutton
</pre>
1258 15 Andreas Smas
1259 66 Adam Sutton
Video Stream types:
1260 1 Andreas Smas
<pre>
1261 79 Jaroslav Kysela
MPEG2VIDEO                    MPEG2 video, meta field is present (configuration blocks)
1262
H264                          H264 video, meta field is present (configuration blocks)
1263
HEVC                          HEVC video, meta field is present (configuration blocks)
1264 66 Adam Sutton
</pre>
1265 15 Andreas Smas
1266 1 Andreas Smas
Audio Stream types:
1267
<pre>
1268 66 Adam Sutton
MPEG2AUDIO                    MPEG2 audio (MP2)
1269
AC3                           AC3 audio
1270 79 Jaroslav Kysela
AAC                           ADTS framed AAC (one AAC packet per ADTS frame), meta field is present (MPEG4 config)
1271 66 Adam Sutton
EAC3                          Enhanced AC3 audio
1272 79 Jaroslav Kysela
VORBIS                        Vorbis audio, meta field is present with the main vorbis header
1273 16 Andreas Smas
</pre>
1274
1275 66 Adam Sutton
Subtitle Stream types:
1276
<pre>
1277
TELETEXT                      ???
1278
DVBSUB                        ???
1279
</pre>
1280 55 Lars Op den Kamp -
1281 112 Jaroslav Kysela
h3. subscriptionGrace
1282
1283
Notifies client about the grace timeout (timeout for stream activation). It can be issues multiple times.
1284
For example a configuration with satellite rotors requires more than 120 seconds to tune, so users
1285
should be notified..
1286
1287
Message fields:
1288
<pre>
1289
subscriptionId     u32   required   Subscription ID.
1290
graceTimeout       u32   required   Grace timeout in seconds.
1291
</pre>
1292
1293 55 Lars Op den Kamp -
h3. subscriptionStop
1294
1295 66 Adam Sutton
A subscription has been stopped.
1296 55 Lars Op den Kamp -
1297
Message fields:
1298
<pre>
1299 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1300 1 Andreas Smas
status             str   optional   Error message if subscription stopped unexpectedly.
1301 141 Jaroslav Kysela
subscriptionError  str   optional   Subscription error code (Added in version 20).
1302 1 Andreas Smas
</pre>
1303
1304 153 Kai Sommerfeld
Valid values for subscriptionError:
1305
<pre>
1306
see dvrEntryAdd
1307
</pre>
1308 1 Andreas Smas
1309 73 Adam Sutton
h3. subscriptionSkip (Added version 9)
1310
1311
A subscription has been skipped.
1312
1313
Message fields:
1314
<pre>
1315
subscriptionId     u32   required   Subscription ID.
1316
error              u32   optional   The last skip command caused an error.
1317
absolute           u32   optional   Indicates the output is absolute (Note: should always be 1 at the moment)
1318
time               u64   optional   The time the subscription has skipped to.
1319
size               u64   optional   The position in the file we've skipped to (Note: not currently used).
1320
</pre>
1321
1322
h3. subscriptionSpeed (Added version 9)
1323
1324
A subscription's playback speed has changed.
1325
1326
This can happen even without a speed request, should playback reach either end of the buffer.
1327
1328
Message fields:
1329
<pre>
1330
subscriptionId     u32   required   Subscription ID.
1331
speed              u32   required   The new speed of the subscription
1332
</pre>
1333
1334 55 Lars Op den Kamp -
h3. subscriptionStatus
1335
1336 66 Adam Sutton
Subscription status update.
1337 58 sbi -
1338
Message fields:
1339
<pre>
1340 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1341
status             str   optional   English clear text of error status. Absence of this field means that the status is OK. 
1342 1 Andreas Smas
subscriptionError  str   optional   Subscription error code (Added in version 20).
1343 153 Kai Sommerfeld
</pre>
1344
1345
Valid values for subscriptionError:
1346
<pre>
1347
see dvrEntryAdd
1348 139 Jaroslav Kysela
</pre>
1349 58 sbi -
1350 16 Andreas Smas
h3. queueStatus
1351
1352 1 Andreas Smas
The queueStatus message is sent every second during normal data delivery.
1353 60 John Törnblom
1354
The transmit scheduler have different drop thresholds for different frame types.
1355 66 Adam Sutton
1356 1 Andreas Smas
If congestion occurs it will favor dropping B-frames before P-frames before I-frames.
1357
All audio is recognized as I-frames. 
1358 58 sbi -
1359 1 Andreas Smas
Message fields:
1360
<pre>
1361 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1362
packets            u32   required   Number of data packets in queue.
1363
bytes              u32   required   Number of bytes in queue.
1364
delay              u32   optional   Estimated delay of queue (in µs).
1365 1 Andreas Smas
Bdrops             u32   required   Number of B-frames dropped
1366 66 Adam Sutton
Pdrops             u32   required   Number of P-frames dropped
1367
Idrops             u32   required   Number of I-frames dropped
1368 73 Adam Sutton
delay              s64   required   Delta between first and last DTS (Added in version 9)
1369 1 Andreas Smas
</pre>
1370
1371
h3. signalStatus
1372
1373
The signalStatus message is sent every second during normal data delivery.
1374
1375
The optional fields may not have been implemented or may not be supported by the active adapter.
1376
1377
Message fields:
1378
<pre>
1379 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1380
feStatus           str   required   Frontend status.
1381
feSNR              u32   optional   Signal to noise ratio.
1382 1 Andreas Smas
feSignal           u32   optional   Signal status percentage.
1383
feBER              u32   optional   Bit error rate.
1384
feUNC              u32   optional   Uncorrected blocks.
1385 73 Adam Sutton
</pre>
1386
1387
h3. timeshiftStatus
1388
1389
Provide status every second about the timeshift buffer.
1390
1391
Message fields:
1392
<pre>
1393
subscriptionId     u32   required   Subscription ID.
1394
full               u32   required   Indicates whether the buffer is full
1395
shift              s64   required   Current position relative to live
1396
start              s64   optional   PTS of the first frame in the buffer
1397
end                s64   optional   PTS of the last frame in the buffer
1398 1 Andreas Smas
</pre>
1399
1400
h3. muxpkt
1401
1402
Streaming data.
1403
1404
Message fields:
1405
<pre>
1406 66 Adam Sutton
subscriptionId     u32   required   Subscription ID.
1407
frametype          u32   required   Type of frame as ASCII value: 'I', 'P', 'B'
1408
stream             u32   required   Stream index. Corresponds to the streams reported in the subscriptionStart message.
1409
dts                s64   optional   Decode Time Stamp in µs.
1410
pts                s64   optional   Presentation Time Stamp in µs.
1411
duration           u32   required   Duration of frame in µs.
1412
payload            bin   required   Actual frame data.
1413 1 Andreas Smas
</pre>