Project

General

Profile

Htsp » History » Version 151

Kai Sommerfeld, 2015-07-01 16:01

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