Project

General

Profile

Htsp » History » Version 131

Jaroslav Kysela, 2015-05-29 22:22

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